継承図

協調図

解説

■ 仕様と使い方

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

たとえば、SFYSingleTextWidget は SFZTextButtonControl、 SFZSingleTextLabelControl、 SFZSingleTextBoxControl などの単一行のテキストを扱うコントロールの子レスポンダとして内部的に利用されます。

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

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

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

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

	仮想領域
	SFYSingleTextWidget では、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [テキストの横幅] ＞ [実領域の横幅] の関係が成り立ちテキスト全体が画面に表示されないとき、 SFYSingleTextWidget::StartScroll 関数を呼び出してもスクロールは開始しません。

参照

SFZTextButtonControl | SFZSingleTextLabelControl | SFZSingleTextBoxControl | SFZComboBoxControl | SFZCheckboxControl | SFZRadiobuttonControl | SFZTitlePlainFrame | SFZTitleFlatFrame | SFZTitleBevelFrame | SFYSingleEditWidget | 仮想領域 | 実領域 | ローカル領域

メンバ

解説

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

内部実装

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

/*protected */SFYSingleTextWidget::SFYSingleTextWidget(Void) static_throws : _state(STATE_IDLE)
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0x00, 0x00, 0x00}}}
    };
    static SFXEventRange::AtomRecConst          trange[] = {
        {      SFEVT_APP_RESUME,       SFEVT_APP_RESUME,          SFP16_BEGIN,            SFP16_END},
        {     SFEVT_APP_SUSPEND,      SFEVT_APP_SUSPEND,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_VALID,    SFP16_STATE_VALID}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnAppResume);
        trule[0].reference = this;
        trule[1].spp = XANDLER_FUNCTION(OnAppSuspend);
        trule[1].reference = this;
        trule[2].spp = XANDLER_FUNCTION(OnStateValid);
        trule[2].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            SetPropertyTransparent(true);
            _font = AEE_FONT_NORMAL;
            _color.text.Set(rgb[0]);
            _align.horizontal = DEFAULT_HORIZONTAL;
            _align.vertical = DEFAULT_VERTICAL;
            _timer.Set(XALLBACK_INTERNAL(OnTimer));
            _wait = DEFAULT_WAIT;
            _scroll = DEFAULT_SCROLL;
            _direction = DEFAULT_DIRECTION;
            _step = Measure();
            Relocate();
        }
    }
}// SFYSingleTextWidget::SFYSingleTextWidget //

/*private */XANDLER_IMPLEMENT_VOIDRESUME(SFYSingleTextWidget, OnAppResume, invoker, environment)
{
    unused(invoker);
    unused(environment);
    switch (_state) {
        case STATE_WAIT:
            _timer.Schedule(_wait);
            break;
        case STATE_SCROLL:
            _timer.Schedule(_scroll);
            break;
        case STATE_IDLE:
        default:
            break;
    }
    return;
}// XANDLER_IMPLEMENT_VOIDRESUME(SFYSingleTextWidget, OnAppResume) //

/*private */XANDLER_IMPLEMENT_VOIDSUSPEND(SFYSingleTextWidget, OnAppSuspend, invoker, reason, info)
{
    unused(invoker);
    unused(reason);
    unused(info);
    if (_state != STATE_IDLE) {
        _timer.Cancel();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDSUSPEND(SFYSingleTextWidget, OnAppSuspend) //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFYSingleTextWidget, OnStateValid, invoker, reason, state)
{
    unused(invoker);
    unused(reason);
    if (!state) {
        StopScroll();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFYSingleTextWidget, OnStateValid) //

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

/*private */XALLBACK_IMPLEMENT_SFXTIMER(SFYSingleTextWidget, OnTimer)
{
    SInt16                                      offset;

    switch (_state) {
        case STATE_WAIT:
            _state = STATE_SCROLL;
        case STATE_SCROLL:
            offset = 0;
            switch (_direction) {
                case DIRECTION_RIGHT:
                    offset = +_step;
                    break;
                case DIRECTION_LEFT:
                default:
                    offset = -_step;
                    break;
            }
            if (Scroll(offset)) {
                Render();
            }
            _timer.Schedule(_scroll);
            break;
        case STATE_IDLE:
        default:
            break;
    }
    return;
}// XALLBACK_IMPLEMENT_SFXTIMER(SFYSingleTextWidget, OnTimer) //

/*private */Bool SFYSingleTextWidget::Scroll(SInt16 param)
{
    SFXRectangle                                lx;
    Bool                                        result(false);

    lx.Set(GetLocalBound());
    if ((param += _offset) < -_bound.GetWidth()) {
        param = lx.GetWidth();
    }
    if (param > lx.GetWidth()) {
        param = -_bound.GetWidth();
    }
    if (param != _offset) {
        _offset = param;
        Invalidate();
        result = true;
    }
    return result;
}// SFYSingleTextWidget::Scroll //

参照

SFYResponder::SetType | SFYResponder::SetPropertyTransparent | SFYSingleTextWidget::CodeEnum | SFYSingleTextWidget::SetFont | SFYSingleTextWidget::SetText | SFYSingleTextWidget::SetTextColor | SFYSingleTextWidget::SetHorizontalAlign | SFYSingleTextWidget::SetVerticalAlign | SFYSingleTextWidget::SetScrollDirection | SFYSingleTextWidget::SetScrollInterval | SFYSingleTextWidget::SetScrollStep | SFYSingleTextWidget::SetWaitInterval | SFYSingleTextWidget::HorizontalEnum | SFYSingleTextWidget::VerticalEnum | SFYSingleTextWidget::DirectionEnum | SFYSingleTextWidget::DefaultEnum | SFXRGBColor | タイプ | 属性 | イベント | アプリ中断イベント[SFEVT_APP_SUSPEND] | アプリ再開イベント[SFEVT_APP_RESUME]

解説

このデストラクタは、テキストのスクロールを停止します。

内部実装

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

/*protected virtual */SFYSingleTextWidget::~SFYSingleTextWidget(Void)
{
    StopScroll();
}// SFYSingleTextWidget::~SFYSingleTextWidget //

参照

SFYSingleTextWidget::StopScroll

解説

複数行のテキストを描画します。

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

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

内部実装

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

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

    origin.Set(grid);
    origin.AddX(_offset);
    rgb.Set(_color.text);
    if (!GetStateActive(true)) {
        if (rgb.GetBrightness() > 0x7F) {
            rgb.SubRGB(0x44);
        }
        else {
            rgb.AddRGB(0x44);
        }
    }
    graphics->SetFont(_font);
    graphics->DrawSingleText(_text, origin, rgb);
    return;
}// SFYSingleTextWidget::DrawText //

参照

SFYSingleTextWidget::HandleRenderRequest

戻り値

フォント。

解説

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

参照

SFYSingleTextWidget::SetFont | BREW API AEEFont

戻り値

フォントの大きさ。

解説

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

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

参照

SFYSingleTextWidget::SetFont | BREW API AEEFont

戻り値

水平アライメントの値。

解説

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

参照

SFYSingleTextWidget::SetHorizontalAlign | SFYSingleTextWidget::HorizontalEnum

戻り値

スクロールの移動方向。

解説

この関数は、スクロールの移動方向を取得します。

参照

SFYSingleTextWidget::SetScrollDirection

戻り値

スクロールインターバル。[単位:ミリ秒]

解説

この関数は、スクロールインターバルを取得します。[単位:ミリ秒]

参照

SFYSingleTextWidget::SetScrollInterval

戻り値

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

解説

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

戻り値

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

解説

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

参照

SFYSingleTextWidget::SetScrollStep

戻り値

テキスト。

解説

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

参照

SFYSingleTextWidget::SetText

戻り値

テキストの色。

解説

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

参照

SFYSingleTextWidget::SetTextColor | SFXRGBColor

戻り値

テキスト領域の始点。

解説

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

解説

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

参照

SFYSingleTextWidget::SetFont | BREW API AEEFont

戻り値

垂直アライメントの値。

解説

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

参照

SFYSingleTextWidget::SetVerticalAlign | SFYSingleTextWidget::VerticalEnum

戻り値

スクロール開始までの待ち時間。[単位:ミリ秒]

解説

この関数は、スクロール開始までの待ち時間を取得します。[単位:ミリ秒]

参照

SFYSingleTextWidget::SetWaitInterval

解説

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

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

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

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

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

	単一行テキストのサイズ : sw の計算方法
	単一行テキストのサイズは、 SFYSingleTextWidget::SetFont 関数で設定したフォント、 SFYSingleTextWidget::SetText 関数で設定したテキストの内容から SFXGraphics::MeasureSingleText 関数を使用して計算します。

	領域イベント[(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 SFYSingleTextWidget::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    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;
}// SFYSingleTextWidget::HandleBoundOptimize //

参照

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

解説

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

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

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

	仮想領域
	SFYSingleTextWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [テキストの横幅] ＞ [実領域の横幅] の関係が成り立ちテキスト全体が画面に表示されないとき、 SFYSingleTextWidget::StartScroll 関数を呼び出してもスクロールは開始しません。

	領域イベント[(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 SFYSingleTextWidget::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYSingleTextWidget::HandleBoundReal //

参照

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

解説

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

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

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

デフォルトの実装は、単一行テキストの矩形領域を返します。

単一行テキストの矩形領域のサイズは、 SFYSingleTextWidget::SetFont 関数で設定されたフォントと SFYSingleTextWidget::SetText 関数で設定されたテキストの内容から SFXGraphics::MeasureSingleText 関数を使用して計算します。

	領域イベント[(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 SFYSingleTextWidget::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->SetSize(_bound.GetSize());
    return;
}// SFYSingleTextWidget::HandleBoundRequest //

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

参照

SFYResponder::GetSuitableBound | SFYSingleTextWidget::SetText | SFYSingleTextWidget::SetFont | SFXGraphics::MeasureSingleText | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

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

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

	仮想領域
	SFYSingleTextWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [テキストの横幅] ＞ [実領域の横幅] の関係が成り立ちテキスト全体が画面に表示されないとき、 SFYSingleTextWidget::StartScroll 関数を呼び出してもスクロールは開始しません。

	領域イベント[(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 SFYSingleTextWidget::HandleBoundVirtual(Void)
{
    StateEnum                                   state;

    state = _state;
    StopScroll();
    Relocate();
    if (state != STATE_IDLE) {
        StartScroll();
    }
    return;
}// SFYSingleTextWidget::HandleBoundVirtual //

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

    lx.Set(GetLocalBound());
    _bound.SetOrigin(lx.GetOrigin());
    _offset = 0;
    if (lx.GetWidth() > _bound.GetWidth()) {
        switch (_align.horizontal) {
            case HORIZONTAL_LEFT:
                _bound.AddX(0);
                break;
            case HORIZONTAL_RIGHT:
                _bound.AddX(lx.GetWidth() - _bound.GetWidth());
                break;
            case HORIZONTAL_CENTER:
            default:
                _bound.AddX((lx.GetWidth() - _bound.GetWidth()) / 2);
                break;
        }
    }
    else {
        switch (_align.horizontal) {
            case HORIZONTAL_LEFT:
                _offset += 0;
                break;
            case HORIZONTAL_RIGHT:
                _offset += lx.GetWidth() - _bound.GetWidth();
                break;
            case HORIZONTAL_CENTER:
            default:
                _offset += (lx.GetWidth() - _bound.GetWidth()) / 2;
                break;
        }
    }
    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;
    }
    _bound.AddY(SFXGraphics::GetFontDescent(_font) / 2);
    return;
}// SFYSingleTextWidget::Relocate //

参照

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

解説

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

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

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

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

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

■アライメント

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

■スクロール

テキストの矩形領域の横幅がローカル領域の横幅よりも大きいときに、 SFYSingleTextWidget::StartScroll 関数を呼び出すと、テキストはスクロールを開始します。

SFYSingleTextWidget::SetWaitInterval 関数でスクロール開始までの待ち時間、 SFYSingleTextWidget::SetScrollDirection 関数でスクロールの方向、 SFYSingleTextWidget::SetScrollStep 関数でスクロールステップ、 SFYSingleTextWidget::SetScrollInterval 関数でスクロールインターバルを設定します。

SFYSingleTextWidget::StopScroll 関数が呼ばれてスクロールを終えるまで、 時間の経過と共にこれらの関数で設定されたパラメータに応じて、 テキストの矩形領域を横にずらしてテキストを描画することにより横スクロールを実現しています（ただし、サスペンド中は横スクロールしません）。

	仮想領域
	SFYSingleTextWidget クラスでは、 テキストの配置やスクロールを直感的に実現するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [テキストの横幅] ＞ [実領域の横幅] の関係が成り立ちテキスト全体が画面に表示されないとき、 SFYSingleTextWidget::StartScroll 関数を呼び出してもスクロールは開始しません。

レスポンダの描画手順

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

内部実装

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

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

参照

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

引数

戻り値

解説

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

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

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

使用例

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

// 単一行テキストウィジェットのインスタンスを生成する
SFCError error;
SFYSingleTextWidgetSmp _singletextwidget;

if ((_singletextwidget = SFYSingleTextWidget::NewInstance(&error)) != null) {
    // ...
}

解説

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

デフォルト値: AEE_FONT_NORMAL

参照

SFYSingleTextWidget::GetFont | BREW API AEEFont

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_HORIZONTAL

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

参照

SFYSingleTextWidget::GetHorizontalAlign | SFYSingleTextWidget::HorizontalEnum

解説

この関数は、スクロール移動方向を設定します。

デフォルト値: SFYSingleTextWidget::DEFAULT_DIRECTION

SFYSingleTextWidget::DEFAULT_DIRECTION の値は SFYSingleTextWidget::DirectionEnum を参照してください。

参照

SFYSingleTextWidget::GetScrollDirection | SFYSingleTextWidget::DirectionEnum

解説

この関数は、スクロールインターバルを設定します。[単位:ミリ秒]

デフォルト値: SFYSingleTextWidget::DEFAULT_SCROLL ミリ秒

SFYSingleTextWidget::DEFAULT_SCROLL の値は SFYSingleTextWidget::DefaultEnum を参照してください。

参照

SFYSingleTextWidget::GetScrollInterval | SFYSingleTextWidget::DefaultEnum

解説

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

−1（デフォルト値）を設定すると、使用しているフォントの半角空白文字 1 文字分（" "）の幅がスクロール移動量となります。

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

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

参照

SFYSingleTextWidget::GetScrollStep | SFYSingleTextWidget::DefaultEnum

戻り値

解説

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

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

参照

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

解説

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

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

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

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

参照

SFYSingleTextWidget::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_VERTICAL

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

参照

SFYSingleTextWidget::GetVerticalAlign | SFYSingleTextWidget::VerticalEnum

解説

デフォルト値: SFYSingleTextWidget::DEFAULT_SCROLL ミリ秒

SFYSingleTextWidget::DEFAULT_SCROLL の値は SFYSingleTextWidget::DefaultEnum を参照してください。

参照

SFYSingleTextWidget::GetWaitInterval | SFYSingleTextWidget::DefaultEnum

解説

この関数は、テキストのスクロールを開始します。

仮想領域の幅がテキストの幅よりも大きいときは何もしません。

SFEVT_APP_SUSPEND イベントと SFEVT_APP_RESUME イベントに自動的に応答しますが、 SFEVT_APP_SUSPEND イベントの受信後から SFEVT_APP_RESUME イベントの受信までの間にこの関数を呼び出したときの動作は未定です。

参照

SFYSingleTextWidget::StopScroll

解説

この関数は、テキストのスクロールを停止します。

参照

SFYSingleTextWidget::StartScroll

参照

SFYResponder::GetType | SFYResponder::SetType

解説

DEFAULT_STEP は、１回のスクロールで移動するピクセル数を設定します。 −１(デフォルト値)を設定すると、使用しているフォントの半角空白文字１文字分（" "）の幅がスクロール移動量となります。

解説

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

参照

SFYSingleTextWidget::SetHorizontalAlign | ローカル領域

解説

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

参照

SFYSingleTextWidget::SetVerticalAlign | ローカル領域