継承図

協調図

解説

■ 仕様と使い方

SFYMultipleTextWidget は、複数行のテキストの描画に必要な機能だけが実装されているレスポンダです。 通常、複数行のテキストを扱うレスポンダで内部的に保持する子レスポンダとして使います。

たとえば、SFYMultipleTextWidget は SFZMultipleTextLabelControl、 SFZMultipleTextBoxControl、 SFYMultipleEditWidget などの複数行のテキストを扱うコントロールの子レスポンダとして内部的に利用されます。

複数行のテキストを描画するこれらのコントロールでは、 複数行のテキストの設定、色の設定、フォントの設定、配置、スクロールなどの処理はすべて SFYMultipleTextWidget に委譲して行われます。

複数行のテキストを描画する必要がある場合、SFYMultipleTextWidget を利用すれば、 その処理を記述することなく簡単に実装することが可能です。 また、SFYMultipleTextWidget に複数行のテキストの描画処理が一元化されるので保守性の優れたコードになります。

	使用するときの状態の値
	このクラスを利用するときは、 可視状態:ON、活性状態:ON、操作可能状態:OFF、フォーカス状態:OFF の状態に設定します。 通常、このクラスはキーイベントに応答しないクラスとして使用します。

	透過属性のデフォルト値
	このクラスの透過属性のデフォルト値は true なので、 SFYResponder::SetPropertyTransparent 関数で透過属性を false に設定しない限り、 SFYWidget::SetBackgroundColor 関数で設定した色で背景が塗り潰されることはありません。

	仮想領域
	SFYMultipleTextWidget では、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ＞ [実領域の横幅] のとき、[仮想領域の横幅]よりも長い行はこの横幅の長さに合わせて折り返して描画されるので、 左端、右端、または両端のテキストを表示できません。左右にスクロールして表示することもできません。 [仮想領域の縦幅] ≧ [複数行テキストの縦幅] ＞ [実領域の縦幅] のときは、複数行テキストは画面上にすべて表示されませんが、上下キーを押下してもスクロールしません。

	引数（矩形領域）を指定しないで GetSuitableBound 関数を呼び出すときの注意
	このレスポンダの SFYResponder::GetSuitableBound 関数を呼び出すときに引数（矩形領域）を指定しない場合は、 予め SFYResponder::SetRealBound 関数を使用して実領域（＝ローカル領域※）を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。 通常、実領域の横幅には使用しているフォントの横幅以上の値を設定します。 ※仮想領域を設定しない限り、 実領域はローカル領域と同じです。 参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

参照

SFZMultipleTextLabelControl | SFZMultipleTextBoxControl | SFYMultipleEditWidget | 実領域 | ローカル領域 | 仮想領域 | 複数行のテキストを表示するレスポンダに最適な大きさを取得する

メンバ

解説

このコンストラクタは、以下の初期化処理を行います。

内部実装

このコンストラクタの内部実装は以下の通りです。

/*protected */SFYMultipleTextWidget::SFYMultipleTextWidget(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0x00, 0x00, 0x00}}}
    };

    if (static_try()) {
        SetType(CODE_TYPE);
        SetPropertyTransparent(true);
        _font = AEE_FONT_NORMAL;
        _color.text.Set(rgb[0]);
        _align.horizontal = DEFAULT_HORIZONTAL;
        _align.vertical = DEFAULT_VERTICAL;
        _step = Measure();
        Relocate();
    }
}// SFYMultipleTextWidget::SFYMultipleTextWidget //

/*private */SInt16 SFYMultipleTextWidget::Measure(Void)
{
    _bound.SetSize(SFXSize::ZeroInstance());
    _size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        _bound.SetSize(SFXGraphics::MeasureMultipleText(_font, _text, GetLocalBound().GetWidth()));
    }
    return _size.GetHeight();
}// SFYMultipleTextWidget::Measure //

/*private */Void SFYMultipleTextWidget::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    _bound.SetOrigin(lx.GetOrigin());
    _offset = 0;
    if (lx.GetHeight() > _bound.GetHeight()) {
        switch (_align.vertical) {
            case VERTICAL_TOP:
                _bound.AddY(0);
                break;
            case VERTICAL_BOTTOM:
                _bound.AddY(lx.GetHeight() - _bound.GetHeight());
                break;
            case VERTICAL_MIDDLE:
            default:
                _bound.AddY((lx.GetHeight() - _bound.GetHeight()) / 2);
                break;
        }
    }
    else {
        switch (_align.vertical) {
            case VERTICAL_TOP:
                _offset += 0;
                break;
            case VERTICAL_BOTTOM:
                _offset += lx.GetHeight() - _bound.GetHeight();
                break;
            case VERTICAL_MIDDLE:
            default:
                _offset += (lx.GetHeight() - _bound.GetHeight()) / 2;
                break;
        }
    }
    _bound.AddY(SFXGraphics::GetFontDescent(_font) / 2);
    return;
}// SFYMultipleTextWidget::Relocate //

参照

SFYResponder::SetType | SFYResponder::SetPropertyTransparent | SFYMultipleTextWidget::CodeEnum | SFYMultipleTextWidget::SetFont | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetTextColor | SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::SetScrollStep | SFYMultipleTextWidget::HorizontalEnum | SFYMultipleTextWidget::VerticalEnum | SFYMultipleTextWidget::DefaultEnum | SFXRGBColor | タイプ | 属性

解説

このデストラクタは、何も行いません。

内部実装

このデストラクタの内部実装は以下の通りです。

/*protected virtual */SFYMultipleTextWidget::~SFYMultipleTextWidget(Void)
{
}// SFYMultipleTextWidget::~SFYMultipleTextWidget //

解説

単一行のテキストを描画します。

独自の処理を行う場合は、この関数をオーバーライドします。

	注意
	この関数は SFYMultipleTextWidget::HandleRenderRequest 関数の中から呼び出されます。

内部実装

この関数の内部実装は以下の通りです。

/*protected */Void SFYMultipleTextWidget::DrawText(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    SFXRectangle                                lx;
    SFXGrid                                     origin;
    SFXRGBColor                                 rgb;

    lx.Set(GetLocalBound());
    origin.Set(grid);
    origin.AddY(_offset);
    rgb.Set(_color.text);
    if (!GetStateActive(true)) {
        if (rgb.GetBrightness() > 0x7F) {
            rgb.SubRGB(0x44);
        }
        else {
            rgb.AddRGB(0x44);
        }
    }
    graphics->SetFont(_font);
    switch (_align.horizontal) {
        case HORIZONTAL_LEFT:
            graphics->DrawMultipleTextLeft(_text, lx, origin, rgb, lx.GetWidth());
            break;
        case HORIZONTAL_RIGHT:
            graphics->DrawMultipleTextRight(_text, lx, origin, rgb, lx.GetWidth());
            break;
        case HORIZONTAL_CENTER:
        default:
            graphics->DrawMultipleTextCenter(_text, lx, origin, rgb, lx.GetWidth());
            break;
    }
    return;
}// SFYMultipleTextWidget::DrawText //

参照

SFYMultipleTextWidget::HandleRenderRequest

戻り値

フォント。

解説

この関数は、フォントを取得します。

参照

SFYMultipleTextWidget::SetFont | BREW API AEEFont

戻り値

フォントの大きさ。

解説

この関数は、フォントの大きさを取得します。

設定されているフォントの半角 1 文字分（' ' で計算）の大きさを取得します。

参照

SFYMultipleTextWidget::SetFont | BREW API AEEFont

戻り値

水平アライメントの値。

解説

この関数は、水平アライメントの値を取得します。

参照

SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::HorizontalEnum

戻り値

スクロールオフセットの値。

解説

この関数は、スクロールの結果による始点からのオフセットを取得します。

戻り値

スクロール移動量。[単位:ピクセル]

解説

この関数は、スクロール移動量を取得します。[単位:ピクセル]

参照

SFYMultipleTextWidget::SetScrollStep

戻り値

テキスト。

解説

この関数は、テキストを取得します。

参照

SFYMultipleTextWidget::SetText

戻り値

テキストの色。

解説

この関数は、テキストの色を取得します。

参照

SFYMultipleTextWidget::SetTextColor | SFXRGBColor

戻り値

テキスト領域の始点。

解説

この関数は、テキスト領域の始点を取得します。

解説

設定されているフォントで描画した場合のテキストの大きさを取得します。

参照

SFYMultipleTextWidget::SetFont | BREW API AEEFont

戻り値

垂直アライメントの値。

解説

この関数は、垂直アライメントの値を取得します。

参照

SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::VerticalEnum

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] を受信したときに呼び出されます。

引数 rectangle で指定した矩形領域に収まる範囲内で、レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素（サイズ）に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素（始点）はこの関数内で変更しないことを推奨します。

デフォルトの実装は、以下のサイズを返します。

ここで、w、h、sw、sh、fw、fh は以下のように定義されます。

	複数行テキストのサイズ : sw と sh の計算方法
	複数行テキストのサイズは、 SFYMultipleTextWidget::SetFont 関数で設定したフォント、 SFYMultipleTextWidget::SetText 関数で設定したテキストの内容、 引数で指定した矩形領域の横幅から SFXGraphics::MeasureMultipleText 関数を使用して計算します。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数にヒント領域を指定した場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundOptimize 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle にはヒント領域が初期設定されています。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント受信時の最適な領域計算
	SFYWidget::HandleBoundOptimize 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 最適な領域の計算は、最初に SFYWidget::HandleBoundOptimize 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundOptimize 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    SFXRectangle                                bound;
    SFXSize                                     size;

    bound.SetSize(SFXSize::ZeroInstance());
    size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        bound.SetSize(SFXGraphics::MeasureMultipleText(_font, _text, rectangle->GetWidth()));
    }
    if (rectangle->GetWidth() > bound.GetWidth()) {
        rectangle->SetWidth(bound.GetWidth());
    }
    else if (rectangle->GetWidth() > size.GetWidth()) {
        rectangle->DivWidth(size.GetWidth());
        rectangle->MulWidth(size.GetWidth());
    }
    if (rectangle->GetHeight() > bound.GetHeight()) {
        rectangle->SetHeight(bound.GetHeight());
    }
    else if (rectangle->GetHeight() > size.GetHeight()) {
        rectangle->DivHeight(size.GetHeight());
        rectangle->MulHeight(size.GetHeight());
    }
    return;
}// SFYMultipleTextWidget::HandleBoundOptimize //

参照

SFYResponder::GetSuitableBound | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetFont | SFXGraphics::MeasureMultipleText | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] を受信したときに呼び出されます。

実領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、仮想領域を実領域に一致させます。

	仮想領域
	SFYMultipleTextWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ＞ [実領域の横幅] のとき、[仮想領域の横幅]よりも長い行はこの横幅の長さに合わせて折り返して描画されるので、 左端、右端、または両端のテキストを表示できません。左右にスクロールして表示することもできません。 [仮想領域の縦幅] ≧ [複数行テキストの縦幅] ＞ [実領域の縦幅] のときは、複数行テキストは画面上にすべて表示されませんが、上下キーを押下してもスクロールしません。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベント]
	SFYResponder::SetRealBound 関数は、この関数内の処理により実領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundReal 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の実領域が設定されています。

	実領域が変化した時の処理
	SFYWidget::HandleBoundReal 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 実領域の変更処理は、最初に SFYWidget::HandleBoundReal 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundReal 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYMultipleTextWidget::HandleBoundReal //

参照

SFYResponder::SetRealBound | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 仮想領域 | 実領域 | ローカル領域

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] を受信したときに呼び出されます。

レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素（サイズ）に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素（始点）はこの関数内で変更しないことを推奨します。

デフォルトの実装は以下の通りです。

	前提条件
	予め SFYResponder::SetRealBound 関数を使用して実領域（＝ローカル領域）を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。

事前に設定されたローカル領域の横幅（ヒント値）で折り返した複数行テキストの矩形領域を返します。

複数行テキストの矩形領域のサイズは、 SFYMultipleTextWidget::SetFont 関数で設定されたフォントと SFYMultipleTextWidget::SetText 関数で設定されたテキストの内容、ローカル領域の横幅から SFXGraphics::MeasureMultipleText 関数を使用して計算します。

複数行テキストと、ヒント値として与えたローカル領域の横幅に下記のような関係があった場合、 計算結果である最適な矩形領域の横幅は MaxOfAllStatements（『複数行テキストを "\n" で区切った文字列の長さ』の最大値）が返ります。

HintWidth ＞ MaxOfAllStatements

HintWidth : ヒント値として与えたローカル領域の横幅
MaxOfAllStatements :『複数行テキストを "\n" で区切った文字列の長さ』の最大値

逆に、この関係が成り立たない場合は、 ヒント値を超えないが、１文字分の横幅の整数倍で最大値が計算結果の領域の横幅になります。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数に何も指定しない場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundRequest 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には実領域が初期設定されています。 Tip 実領域のデフォルト値は SFXRectangle(0, 0, 0, 0) です。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント受信時の最適な領域計算
	SFYWidget::HandleBoundRequest 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 最適な領域の計算は、最初に SFYWidget::HandleBoundRequest 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundRequest 仮想関数をオーバーライドして処理を記述します。

	注意
	この関数を呼び出す前に、 SFYResponder::SetRealBound 関数を使用してこのレスポンダの実領域（＝ローカル領域※）の横幅をヒント値として予め設定しておく必要があります。 "\n(改行)"で区切られた複数行テキストの各文字列の長さがこのヒント値より小さい場合、 計算結果の領域の横幅は、これらの文字列のなかで最も長い文字列の長さが返されます。 この関数を使うと、 事前に設定されたローカル領域の横幅を最大値として複数行テキストを折り返して表示できる最適な矩形領域の縦幅を取得することができます。 ※仮想領域を設定しない限り、 実領域はローカル領域と同じです。 参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数に何も指定しない場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundRequest 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には実領域が初期設定されています。 Tip 実領域のデフォルト値は SFXRectangle(0, 0, 0, 0) です。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント受信時の最適な領域計算
	SFYWidget::HandleBoundRequest 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 最適な領域の計算は、最初に SFYWidget::HandleBoundRequest 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundRequest 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->SetSize(_bound.GetSize());
    return;
}// SFYMultipleTextWidget::HandleBoundRequest //

/*private */SInt16 SFYMultipleTextWidget::Measure(Void)
{
    _bound.SetSize(SFXSize::ZeroInstance());
    _size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        _bound.SetSize(SFXGraphics::MeasureMultipleText(_font, _text, GetLocalBound().GetWidth()));
    }
    return _size.GetHeight();
}// SFYMultipleTextWidget::Measure //

参照

SFYResponder::GetSuitableBound | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetFont | SFXGraphics::MeasureMultipleText | 実領域 | ローカル領域 | 仮想領域 | 複数行のテキストを表示するレスポンダに最適な大きさを取得する | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] を受信したときに呼び出されます。

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、 仮想領域の変更に伴い水平方向と垂直方向のアライメントの設定に従って複数行テキストを再配置します。

複数行テキストの配置は、 SFYMultipleTextWidget::SetHorizontalAlign 関数で水平方向のアライメント、 SFYMultipleTextWidget::SetVerticalAlign 関数で垂直方向のアライメントを設定します。 デフォルトの設定では、水平方向、垂直方向ともに中央揃えのアライメントになります。

	仮想領域
	SFYMultipleTextWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ＞ [実領域の横幅] のとき、[仮想領域の横幅]よりも長い行はこの横幅の長さに合わせて折り返して描画されるので、 左端、右端、または両端のテキストを表示できません。左右にスクロールして表示することもできません。 [仮想領域の縦幅] ≧ [複数行テキストの縦幅] ＞ [実領域の縦幅] のときは、複数行テキストは画面上にすべて表示されませんが、上下キーを押下してもスクロールしません。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]
	SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

	仮想領域の変更処理
	SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFYMultipleTextWidget::HandleBoundVirtual(Void)
{
    Measure();
    Relocate();
    return;
}// SFYMultipleTextWidget::HandleBoundVirtual //

/*private */SInt16 SFYMultipleTextWidget::Measure(Void)
{
    _bound.SetSize(SFXSize::ZeroInstance());
    _size.Set(SFXGraphics::MeasureSingleText(_font, " "), SFXGraphics::GetFontHeight(_font));
    if (!_text.IsEmpty()) {
        _bound.SetSize(SFXGraphics::MeasureMultipleText(_font, _text, GetLocalBound().GetWidth()));
    }
    return _size.GetHeight();
}// SFYMultipleTextWidget::Measure //

/*private */Void SFYMultipleTextWidget::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    _bound.SetOrigin(lx.GetOrigin());
    _offset = 0;
    if (lx.GetHeight() > _bound.GetHeight()) {
        switch (_align.vertical) {
            case VERTICAL_TOP:
                _bound.AddY(0);
                break;
            case VERTICAL_BOTTOM:
                _bound.AddY(lx.GetHeight() - _bound.GetHeight());
                break;
            case VERTICAL_MIDDLE:
            default:
                _bound.AddY((lx.GetHeight() - _bound.GetHeight()) / 2);
                break;
        }
    }
    else {
        switch (_align.vertical) {
            case VERTICAL_TOP:
                _offset += 0;
                break;
            case VERTICAL_BOTTOM:
                _offset += lx.GetHeight() - _bound.GetHeight();
                break;
            case VERTICAL_MIDDLE:
            default:
                _offset += (lx.GetHeight() - _bound.GetHeight()) / 2;
                break;
        }
    }
    _bound.AddY(SFXGraphics::GetFontDescent(_font) / 2);
    return;
}// SFYMultipleTextWidget::Relocate //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 仮想領域 | 実領域 | ローカル領域

解説

この関数は、 描画イベント [SFXEvent(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, graphics)] を受信したときに呼び出されます。

独自の描画処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は以下の通りです。

■テキスト、色、フォント

SFYMultipleTextWidget::SetText 関数で設定したテキストを SFYMultipleTextWidget::SetTextColor 関数で設定した色と SFYMultipleTextWidget::SetFont 関数で設定したフォントを使用して描画します。

■アライメント

ローカル領域内での複数行テキストの配置は、 SFYMultipleTextWidget::SetHorizontalAlign 関数で水平方向のアライメント、 SFYMultipleTextWidget::SetVerticalAlign 関数で垂直方向のアライメントを設定します。

■スクロール

テキストの矩形領域の横幅がローカル領域の横幅よりも大きいときに、 SFYMultipleTextWidget::ScrollUp / SFYMultipleTextWidget::ScrollDown / SFYMultipleTextWidget::PageUp / SFYMultipleTextWidget::PageDown / SFYMultipleTextWidget::SnapUp / SFYMultipleTextWidget::SnapDown 関数を呼び出すと、複数行テキストは上下にスクロールします。

SFYMultipleTextWidget::SetScrollStep 関数でスクロールステップを設定します。

	仮想領域
	SFYMultipleTextWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ＞ [実領域の横幅] のとき、[仮想領域の横幅]よりも長い行はこの横幅の長さに合わせて折り返して描画されるので、 左端、右端、または両端のテキストを表示できません。左右にスクロールして表示することもできません。 [仮想領域の縦幅] ≧ [複数行テキストの縦幅] ＞ [実領域の縦幅] のときは、複数行テキストは画面上にすべて表示されませんが、上下キーを押下してもスクロールしません。

レスポンダの描画手順

SFYResponder::Invalidate 関数を使用して再描画領域を登録します。 イベントループの最後、 アプリ開始/レジュームまたは優先的イベントハンドラ終了のタイミング、 あるいは、コールバックなどのイベントループの外で、 自動的に、あるいは、明示的に SFYResponder::Render 関数を呼び出します。 描画エンジンが起動されます。 再描画が必要なレスポンダだけが描画イベントを受信します。 SFYWidget クラスを継承するレスポンダが描画イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した描画ハンドラの処理により、 SFYWidget::HandleRenderRequest 仮想関数が呼び出されます。 その後、描画ハンドラが登録した順に呼び出されます。 実際にレスポンダが描画されます。 Tip 描画ハンドラの宣言と登録の手間を省けるので、 通常は SFYWidget::HandleRenderRequest 仮想関数だけを利用してレスポンダを描画します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFYMultipleTextWidget::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawText(graphics, _bound.GetOrigin());
    return;
}// SFYMultipleTextWidget::HandleRenderRequest //

参照

SFYMultipleTextWidget::DrawText | SFYMultipleTextWidget::SetText | SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::SetTextColor | SFYMultipleTextWidget::SetFont | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | 仮想領域 | 実領域 | ローカル領域

引数

戻り値

解説

この関数は、SFYMultipleTextWidget クラスの新しいインスタンスを作成します。

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、複数行テキストウィジェットのインスタンスを生成するためのコードです。

// 複数行テキストウィジェットのインスタンスを生成する
SFCError error;
SFYMultipleTextWidgetSmp _multipletextwidget;

if ((_multipletextwidget = SFYMultipleTextWidget::NewInstance(&error)) != null) {
    // ...
}

戻り値

解説

この関数は、 ローカル領域に表示されている複数行テキストを１ページ分下にスクロールします。

ローカル領域内に複数行テキストの一番下のテキストが表示されている場合は、スクロールしません。

参照

SFYMultipleTextWidget::PageUp | ローカル領域

戻り値

解説

この関数は、 ローカル領域に表示されている複数行テキストを１ページ分上にスクロールします。

ローカル領域内に複数行テキストの一番上のテキストが表示されている場合は、スクロールしません。

参照

SFYMultipleTextWidget::PageDown | ローカル領域

戻り値

解説

この関数は、 ローカル領域に表示されている複数行テキストを SFYMultipleTextWidget::SetScrollStep 関数で設定したスクロールステップだけ下方向にスクロールします。

ローカル領域内に複数行テキストの一番下のテキストが表示されている場合は、スクロールしません。

参照

SFYMultipleTextWidget::SetScrollStep | SFYMultipleTextWidget::ScrollUp | ローカル領域

戻り値

解説

この関数は、 ローカル領域に表示されている複数行テキストを SFYMultipleTextWidget::SetScrollStep 関数で設定したスクロールステップだけ上方向にスクロールします。

ローカル領域内に複数行テキストの一番上のテキストが表示されている場合は、スクロールしません。

参照

SFYMultipleTextWidget::SetScrollStep | SFYMultipleTextWidget::ScrollDown | ローカル領域

解説

この関数は、フォントを設定します。

デフォルト値: AEE_FONT_NORMAL

参照

SFYMultipleTextWidget::GetFont | BREW API AEEFont

解説

この関数は、水平アライメントを設定します。

デフォルト値: SFYMultipleTextWidget::DEFAULT_HORIZONTAL

SFYMultipleTextWidget::DEFAULT_HORIZONTAL の値は SFYMultipleTextWidget::HorizontalEnum を参照してください。

参照

SFYMultipleTextWidget::GetHorizontalAlign | SFYMultipleTextWidget::HorizontalEnum

解説

この関数は、1 回のスクロールで移動するピクセル数を設定します。

−1（デフォルト値）を設定すると、使用しているフォントの高さがスクロール移動量となります。

デフォルト値: SFYMultipleTextWidget::DEFAULT_STEP [単位:ピクセル]

SFYMultipleTextWidget::DEFAULT_STEP の値は SFYMultipleTextWidget::DefaultEnum を参照してください。

参照

SFYMultipleTextWidget::GetScrollStep | SFYMultipleTextWidget::DefaultEnum

戻り値

解説

表示する文字列を設定します。

文字列を直接、あるいは、リソースファイルから読み込むように指定します。

参照

SFYMultipleTextWidget::GetText | SFYMultipleTextWidget::SetHorizontalAlign | SFYMultipleTextWidget::SetVerticalAlign | SFYMultipleTextWidget::SetTextColor | SFYMultipleTextWidget::SetFont | BREW API AEEFont

解説

この関数は、テキストの色を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

非活性状態にあるときは、この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色でテキストは描画されます。

色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

参照

SFYMultipleTextWidget::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

この関数は、垂直アライメントを設定します。

デフォルト値: SFYMultipleTextWidget::DEFAULT_VERTICAL

SFYMultipleTextWidget::DEFAULT_VERTICAL の値は SFYMultipleTextWidget::VerticalEnum を参照してください。

参照

SFYMultipleTextWidget::GetVerticalAlign | SFYMultipleTextWidget::VerticalEnum

解説

この関数は、 複数行テキストのスクロール位置を SFYMultipleTextWidget::SetVerticalAlign 関数で設定した初期状態に戻します。

SFYMultipleTextWidget::SetVerticalAlign 関数の設定により、SFYMultipleTextWidget::SnapAlign 関数の実行結果は以下のように異なります。

ローカル領域内に複数行テキストの一番上と一番下のテキストが表示されている場合は、何も変化しません。

参照

SFYMultipleTextWidget::SetVerticalAlign

戻り値

解説

この関数は、 ローカル領域に表示されている複数行テキストを下端までスクロールします。

ローカル領域内に複数行テキストの一番下のテキストが表示されている場合は、スクロールしません。

参照

SFYMultipleTextWidget::SnapUp | ローカル領域

戻り値

解説

この関数は、 ローカル領域に表示されている複数行テキストを上端までスクロールします。

ローカル領域内に複数行テキストの一番上のテキストが表示されている場合は、スクロールしません。

参照

SFYMultipleTextWidget::SnapDown | ローカル領域

参照

SFYResponder::GetType | SFYResponder::SetType

解説

DEFAULT_STEP は、１回のスクロールで移動するピクセル数を設定します。 −１(デフォルト値)を設定すると、使用しているフォントの高さがスクロール移動量となります。

解説

水平方向のアライメントについて：

複数行テキストでは、ローカル領域の横幅より長い場合はローカル領域の横幅に合わせて折り返して描画します。 その結果、折り返しの結果余った各行の最後の部分のテキストはローカル領域の横幅以下の長さになります。

複数行テキストの水平方向のアライメントとは、各行の余ったテキストを水平方向にどのように配置するかという指定です。

	複数行テキストの矩形領域
	複数行テキストは、一行のテキストの長さがローカル領域の横幅よりも長い場合はその横幅で折り返して描画します。 この操作により描画される複数行テキストに内接する矩形領域を「複数行テキストの矩形領域」と呼びます。

	注釈
	ワープロや表計算ソフトの水平方向アライメントと基本的に同じです。

参照

SFYMultipleTextWidget::SetHorizontalAlign | ローカル領域

解説

垂直方向のアライメントについて：

複数行テキストでは、ローカル領域の横幅より長い場合はローカル領域の横幅に合わせて折り返して描画します。 その結果、ローカル領域の横幅に等しい「複数行テキストの矩形領域」を考えることができます。

複数行テキストの垂直方向のアライメントとは、この複数行テキストの矩形領域を垂直方向にどのように配置するかという指定です。

	複数行テキストの矩形領域
	複数行テキストは、一行のテキストの長さがローカル領域の横幅よりも長い場合はその横幅で折り返して描画します。 この操作により描画される複数行テキストに内接する矩形領域を「複数行テキストの矩形領域」と呼びます。

参照

SFYMultipleTextWidget::SetVerticalAlign | ローカル領域