継承図

協調図

解説

■ 仕様と使い方

チェックボックスコントロール(SFZCheckboxControl)は、 SFYButtonControl::SetOperateKey 関数で設定する操作キーを押下後に離すと、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] を受信します。

	注意
	この結果イベントは SFYCheckboxControl::HandleOperateKeyRelease 関数内で発生します。

文字数が多くスクロールして表示する必要がある場合には、 フォーカスされているときに自動的にスクロールを開始します。

図 332. 動作例

□チェックボックスコントロールの構成

デフォルトの実装では、 チェックボックスコントロールは状態に応じて以下のように描画されます。

図 333. チェックボックスの拡大図[活性状態または操作可能状態]

図 334. チェックボックスの拡大図[フォーカス状態、非押下時]

図 335. チェックボックスコントロールの拡大図[活性状態または操作可能状態]

チェックボックスは左側の領域、 テキストは右側の領域にそれぞれ描画されます。

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

非活性状態やフォーカス状態（およびボタンコントロール押下時）にあるときは、 チェックボックスコントロールの枠と内部、影、テキストの色が変化します。

図 336. チェックボックスコントロールの拡大図[非活性状態]

非活性状態にあるとき、 テキストは SFZCheckboxControl::SetTextColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 337. チェックボックスコントロールの拡大図[フォーカス状態・非押下時]

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 338. チェックボックスコントロールの拡大図[フォーカス状態・押下時]

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

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

参照

チェックボックスコントロール[SFZCheckboxControl] | 状態 | SFYControl | SFYButtonControl | SFYCheckboxControl | SFYSingleTextWidget

メンバ

解説

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

	注意
	SFZCheckboxControl クラスを継承するレスポンダでは、 上記イベントが発生すると、それに対応するハンドラが呼び出されます。

内部実装

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

/*protected */SFZCheckboxControl::SFZCheckboxControl(Void) static_throws
{
    static SFXEventRange::AtomRecConst          trange[] = {
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_FOCUS,    SFP16_STATE_FOCUS}
    };
    static SFXEventRange::AtomRecConst          crange[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];
    SFYHandler::RuleRec                         crule[lengthof(crange)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnStateFocus);
        trule[0].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            if ((_widget = SFYSingleTextWidget::NewInstance(&error)) != null) {
                crule[0].spp = XANDLER_FUNCTION(OnWidgetStyle);
                crule[0].reference = this;
                static_throw(_widget->RegisterHandler(atomic_cast(crange), crule, lengthof(crange)));
                if (static_try()) {
                    static_throw(_widget->SetParent(GetThis()));
                    if (static_try()) {
                        SetPropertyTransparent(true);
                        _widget->SetState(true, true, false, false);
                        Relocate();
                    }
                }
            }
            else {
                static_throw(error);
            }
        }
    }
}// SFZCheckboxControl::SFZCheckboxControl //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFZCheckboxControl, OnStateFocus, invoker, reason, state)
{
    unused(invoker);
    unused(reason);
    (state) ? (_widget->StartScroll()) : (_widget->StopScroll());
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFZCheckboxControl, OnStateFocus) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZCheckboxControl, OnWidgetStyle, invoker, reason)
{
    unused(invoker);
    switch (reason) {
        case SFP16_STYLE_ALIGN:
        case SFP16_STYLE_TEXT:
        case SFP16_STYLE_FONT:
            Relocate();
            break;
        default:
            break;
    }
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZCheckboxControl, OnWidgetStyle) //

/*private */Void SFZCheckboxControl::Relocate(Void)
{
    static SFXSize::AtomRecConst                style[] = {
        {14, 14},
        {28, 28}
    };
    SFXRectangle                                lx;
    SFXRectangle                                widget;
    SFXSize                                     font;
    SInt32                                      r0;
    SInt16                                      size;
    SInt16                                      offset;

    font.Set(_widget->GetFontSize());
    for (r0 = 0; r0 < static_cast<SInt32>(lengthof(style)) - 1; ++r0) {
        if (font.GetHeight() < style[r0 + 1].height) {
            break;
        }
    }
    lx.Set(GetLocalBound());
    _bound.Set(lx.GetOrigin(), style[r0]);
    widget.Set(lx.GetOrigin(), _widget->GetSuitableBound().GetSize());
    widget.SnapLeft(_bound.GetRight() + font.GetWidth() / 2);
    if (widget.GetRight() > lx.GetRight()) {
        widget.SetRight(lx.GetRight());
    }
    size = _bound.GetWidth();
    if (!widget.IsEmpty()) {
        size += font.GetWidth() / 2 + widget.GetWidth();
    }
    offset = 0;
    switch (_widget->GetHorizontalAlign()) {
        case SFYSingleTextWidget::HORIZONTAL_LEFT:
            offset += 0;
            break;
        case SFYSingleTextWidget::HORIZONTAL_RIGHT:
            offset += lx.GetWidth() - size;
            break;
        case SFYSingleTextWidget::HORIZONTAL_CENTER:
        default:
            offset += (lx.GetWidth() - size) / 2;
            break;
    }
    _bound.AddX(offset);
    widget.AddX(offset);
    size = ((_bound.GetHeight() > widget.GetHeight()) ? (_bound.GetHeight()) : (widget.GetHeight()));
    offset = 0;
    switch (_widget->GetVerticalAlign()) {
        case SFYSingleTextWidget::VERTICAL_TOP:
            offset += 0;
            break;
        case SFYSingleTextWidget::VERTICAL_BOTTOM:
            offset += lx.GetHeight() - size;
            break;
        case SFYSingleTextWidget::VERTICAL_MIDDLE:
        default:
            offset += (lx.GetHeight() - size) / 2;
            break;
    }
    _bound.AddY(offset + (size - _bound.GetHeight()) / 2);
    widget.AddY(offset + (size - widget.GetHeight()) / 2);
    _widget->SetRealBound(widget);
    return;
}// SFZCheckboxControl::Relocate //

参照

SFYResponder::SetType | SFZCheckboxControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZCheckboxControl::SetText | SFZCheckboxControl::SetFont | SFZCheckboxControl::SetTextColor | SFZCheckboxControl::SetHorizontalAlign | SFZCheckboxControl::SetVerticalAlign | SFZCheckboxControl::SetScrollDirection | SFZCheckboxControl::SetScrollInterval | SFZCheckboxControl::SetScrollStep | SFZCheckboxControl::SetWaitInterval | SFZCheckboxControl::HorizontalEnum | SFZCheckboxControl::VerticalEnum | SFZCheckboxControl::DirectionEnum | SFZCheckboxControl::DefaultEnum | SFYSingleTextWidget::NewInstance | SFYSingleTextWidget | SFXRGBColor | タイプ | 状態 | イベント | 状態イベント[SFEVT_RESPONDER_STATE]

解説

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

内部実装

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

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

戻り値

ボタン領域の矩形。

解説

この関数は、チェックボックスコントロールのボタン領域の矩形を取得します。

	注意
	チェックボックスコントロールはボタン部分とテキスト部分から構成されます。 この関数は、そのボタン部分の矩形を取得するのに使います。

戻り値

フォント。

解説

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

参照

SFZCheckboxControl::SetFont | BREW API AEEFont

戻り値

水平アライメントの値。

解説

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

参照

SFZCheckboxControl::SetHorizontalAlign | SFZCheckboxControl::HorizontalEnum

戻り値

スクロールの移動方向。

解説

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

参照

SFZCheckboxControl::SetScrollDirection

戻り値

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

解説

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

参照

SFZCheckboxControl::SetScrollInterval

戻り値

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

解説

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

参照

SFZSingleTextBoxControl::SetScrollStep

戻り値

テキスト。

解説

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

参照

SFZCheckboxControl::SetText

戻り値

テキストの色。

解説

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

参照

SFZCheckboxControl::SetTextColor | SFXRGBColor

戻り値

垂直アライメントの値。

解説

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

参照

SFZCheckboxControl::SetVerticalAlign | SFZCheckboxControl::VerticalEnum

戻り値

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

解説

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

参照

SFZCheckboxControl::SetWaitInterval

戻り値

チェックボックステキスト描画用に子レスポンダとして内部で保持する SFYSingleTextWidget インスタンス。

解説

この関数は、チェックボックステキスト描画用に子レスポンダとして内部で保持する SFYSingleTextWidget インスタンスを返します。

チェックボックステキストの描画は、SFYSingleTextWidget インスタンスに委譲して処理します。

参照

SFYSingleTextWidget

解説

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

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

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

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

	チェックマークのサイズ
	チェックマークのサイズは、SFXSize(14, 14) または SFXSize(28, 28) です。 使用するフォントのサイズに合わせて自動的に選択されます。

	領域イベント[(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 仮想関数をオーバーライドして処理を記述します。

参照: SFYSingleTextWidget::HandleBoundOptimize

内部実装

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

SFYSingleTextWidgetSmp          _widget;
SFXRectangle                    _bound;

/*protected virtual */Void SFZCheckboxControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    SFXSize                                     size;
    SInt16                                      width;

    width = _bound.GetWidth() + _widget->GetFontSize().GetWidth() / 2;
    rectangle->Deflate(width, 0, 0, 0);
    size.Set(_widget->GetSuitableBound(*rectangle).GetSize());
    rectangle->Inflate(width, 0, 0, 0);
    if (!size.IsEmpty()) {
        size.AddWidth(width);
        if (size.GetHeight() < _bound.GetHeight()) {
            size.SetHeight(_bound.GetHeight());
        }
    }
    else {
        size.Set(_bound.GetSize());
    }
    if (rectangle->GetWidth() > size.GetWidth()) {
        rectangle->SetWidth(size.GetWidth());
    }
    if (rectangle->GetHeight() > size.GetHeight()) {
        rectangle->SetHeight(size.GetHeight());
    }
    return;
}// SFZCheckboxControl::HandleBoundOptimize //

参照

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

解説

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

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

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

デフォルトの実装は、以下のようにテキストの大きさをもとにチェックボックスに最適な矩形を計算します。

	チェックマークのサイズ
	チェックマークのサイズは、SFXSize(14, 14) または SFXSize(28, 28) です。 使用するフォントのサイズに合わせて自動的に選択されます。

	領域イベント[(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 仮想関数をオーバーライドして処理を記述します。

参照: SFYSingleTextWidget::HandleBoundRequest

内部実装

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

SFYSingleTextWidgetSmp          _widget;
SFXRectangle                    _bound;

/*protected virtual */Void SFZCheckboxControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    SFXSize                                     size;

    size.Set(_widget->GetSuitableBound().GetSize());
    if (!size.IsEmpty()) {
        size.AddWidth(_bound.GetWidth() + _widget->GetFontSize().GetWidth() / 2);
        if (size.GetHeight() < _bound.GetHeight()) {
            size.SetHeight(_bound.GetHeight());
        }
    }
    else {
        size.Set(_bound.GetSize());
    }
    rectangle->SetSize(size);
    return;
}// SFZCheckboxControl::HandleBoundRequest //

参照

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

解説

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

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

デフォルトの実装は、 チェックボックスコントロールの右の配置されるテキスト領域を内部で保持するテキストウィジェット(SFYSingleTextWidget)の実領域として設定します。

SFZCheckboxControl::SetText 関数によって設定されたテキストは、 内部でテキストウィジェット(SFYSingleTextWidget)として保持されます。

	領域イベント[(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 仮想関数をオーバーライドして処理を記述します。

内部実装

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

SFYSingleTextWidgetSmp          _widget;
SFXRectangle                    _bound;

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

/*private */Void SFZCheckboxControl::Relocate(Void)
{
    static SFXSize::AtomRecConst                style[] = {
        {14, 14},
        {28, 28}
    };
    SFXRectangle                                lx;
    SFXRectangle                                widget;
    SFXSize                                     font;
    SInt32                                      r0;
    SInt16                                      size;
    SInt16                                      offset;

    font.Set(_widget->GetFontSize());
    for (r0 = 0; r0 < static_cast<SInt32>(lengthof(style)) - 1; ++r0) {
        if (font.GetHeight() < style[r0 + 1].height) {
            break;
        }
    }
    lx.Set(GetLocalBound());
    _bound.Set(lx.GetOrigin(), style[r0]);
    widget.Set(lx.GetOrigin(), _widget->GetSuitableBound().GetSize());
    widget.SnapLeft(_bound.GetRight() + font.GetWidth() / 2);
    if (widget.GetRight() > lx.GetRight()) {
        widget.SetRight(lx.GetRight());
    }
    size = _bound.GetWidth();
    if (!widget.IsEmpty()) {
        size += font.GetWidth() / 2 + widget.GetWidth();
    }
    offset = 0;
    switch (_widget->GetHorizontalAlign()) {
        case SFYSingleTextWidget::HORIZONTAL_LEFT:
            offset += 0;
            break;
        case SFYSingleTextWidget::HORIZONTAL_RIGHT:
            offset += lx.GetWidth() - size;
            break;
        case SFYSingleTextWidget::HORIZONTAL_CENTER:
        default:
            offset += (lx.GetWidth() - size) / 2;
            break;
    }
    _bound.AddX(offset);
    widget.AddX(offset);
    size = ((_bound.GetHeight() > widget.GetHeight()) ? (_bound.GetHeight()) : (widget.GetHeight()));
    offset = 0;
    switch (_widget->GetVerticalAlign()) {
        case SFYSingleTextWidget::VERTICAL_TOP:
            offset += 0;
            break;
        case SFYSingleTextWidget::VERTICAL_BOTTOM:
            offset += lx.GetHeight() - size;
            break;
        case SFYSingleTextWidget::VERTICAL_MIDDLE:
        default:
            offset += (lx.GetHeight() - size) / 2;
            break;
    }
    _bound.AddY(offset + (size - _bound.GetHeight()) / 2);
    widget.AddY(offset + (size - widget.GetHeight()) / 2);
    _widget->SetRealBound(widget);
    return;
}// SFZCheckboxControl::Relocate //

参照

SFYSingleTextWidget | SFZCheckboxControl::SetText | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、SFYButtonControl::SetOperateKey 関数で設定した操作キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

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

デフォルトの実装は、テキストのスクロール位置を初期化します。

内部実装

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

SFYSingleTextWidgetSmp          _widget;

/*protected virtual */Void SFZCheckboxControl::HandleOperateKey(Void)
{
    _widget->StopScroll();
    _widget->StartScroll();
    return;
}// SFZCheckboxControl::HandleOperateKey //

参照

SFYButtonControl::SetOperateKey | キーイベント[SFEVT_KEY]

解説

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

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

デフォルトの実装では、 状態に応じて以下のようなチェックボックスコントロールを描画します。 ボタン部分の描画の詳細については、SFYButtonControl::DrawButton 関数と SFYButtonControl::DrawShadow 関数の説明を参照してください。 チェックマーク、テキストの描画の詳細については、 それぞれ SFYCheckboxControl::SetCheckmarkColor、 SFZCheckboxControl::SetTextColor関数の説明を参照してください。

■チェックボックスコントロールの構成

■チェックボックスコントロールの描画処理

チェックボックスは、14 × 14 ピクセルと 28 × 28 ピクセルの 2 種類が存在します。 領域の大きさに合わせて自動的に選択されます。

図 339. チェックボックスの拡大図[活性状態または操作可能状態]

図 340. チェックボックスの拡大図[フォーカス状態、非押下時]

図 341. チェックボックスコントロールの拡大図[活性状態または操作可能状態]

チェックボックスは左側の領域、 テキストは右側の領域にそれぞれ描画されます。

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

非活性状態やフォーカス状態（およびボタンコントロール押下時）にあるときは、 チェックボックスコントロールの枠と内部、影、テキストの色が変化します。

図 342. チェックボックスコントロールの拡大図[非活性状態]

非活性状態にあるとき、 テキストは SFZCheckboxControl::SetTextColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 343. チェックボックスコントロールの拡大図[フォーカス状態・非押下時]

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 344. チェックボックスコントロールの拡大図[フォーカス状態・押下時]

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

レスポンダの描画手順

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

内部実装

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

SFXRectangle                    _bound;

/*protected virtual */Void SFZCheckboxControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    SFXGrid                                     grid;

    if (_bound.GetHeight() >= 28) {
        grid.Set(DrawShadow28(graphics, _bound.GetOrigin()));
        DrawButton27(graphics, grid);
        grid.Add(3, 3);
        DrawCheckmark21(graphics, grid);
    }
    else if (_bound.GetHeight() >= 14) {
        grid.Set(DrawShadow14(graphics, _bound.GetOrigin()));
        DrawButton13(graphics, grid);
        grid.Add(2, 2);
        DrawCheckmark09(graphics, grid);
    }
    return;
}// SFZCheckboxControl::HandleRenderRequest //

参照

SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow | SFYCheckboxControl::SetCheckmarkColor | SFYButtonControl::SetButtonColor | SFYButtonControl::SetFocusColor | SFYButtonControl::SetShadowColor | SFYButtonControl::SetOperateKey | SFYCheckboxControl::DrawButton13 | SFYCheckboxControl::DrawButton27 | SFYCheckboxControl::DrawShadow14 | SFYCheckboxControl::DrawShadow28 | SFYCheckboxControl::DrawCheckmark09 | SFYCheckboxControl::DrawCheckmark21 | SFZCheckboxControl::SetText | SFZCheckboxControl::SetHorizontalAlign | SFZCheckboxControl::SetVerticalAlign | SFZCheckboxControl::SetFont | SFZCheckboxControl::SetTextColor | SFYSingleTextWidget | SFYSingleTextWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | 状態

引数

戻り値

解説

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

作成に成功した場合は null 以外のポインタを返し、exception 引数は常に SFERR_NO_ERROR になります。メモリ不足などで作成に失敗した場合は null ポインタを返し、exception 引数にエラー値が返ります。

使用例

以下は、チェックボックスのインスタンスを生成するためのコードです。

// チェックボックスのインスタンスを生成する
SFZCheckboxControlSmp _checkbox;
SFCError error;

if ((_checkbox = SFZCheckboxControl::NewInstance(&error)) != null) {
    // ...
}

解説

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

デフォルト値: AEE_FONT_NORMAL

参照

SFZCheckboxControl::GetFont | BREW API AEEFont

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_HORIZONTAL

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

参照

SFZCheckboxControl::GetHorizontalAlign | SFZCheckboxControl::HorizontalEnum | SFYSingleTextWidget::HorizontalEnum

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_DIRECTION

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

参照

SFZCheckboxControl::GetScrollDirection | SFZCheckboxControl::DirectionEnum | SFYSingleTextWidget::DirectionEnum

解説

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

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

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

参照

SFZCheckboxControl::GetScrollInterval | SFYSingleTextWidget::DefaultEnum

解説

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

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

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

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

参照

SFZCheckboxControl::GetScrollStep | SFZCheckboxControl::DefaultEnum | SFYSingleTextWidget::DefaultEnum

戻り値

解説

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

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

デフォルト値: ""[空文字列]

参照

SFZCheckboxControl::GetText | SFZCheckboxControl::SetHorizontalAlign | SFZCheckboxControl::SetVerticalAlign | SFZCheckboxControl::SetTextColor | SFZCheckboxControl::SetFont

解説

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

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

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

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

参照

SFZCheckboxControl::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_VERTICAL

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

参照

SFZCheckboxControl::GetVerticalAlign | SFZCheckboxControl::VerticalEnum | SFYSingleTextWidget::VerticalEnum

解説

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

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

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

参照

SFZCheckboxControl::GetWaitInterval | SFYSingleTextWidget::DefaultEnum

解説

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

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

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

解説

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

参照

SFYResponder::GetType | SFYResponder::SetType

参照

SFYSingleTextWidget::DefaultEnum

参照

SFYSingleTextWidget::DirectionEnum

参照

SFYSingleTextWidget::HorizontalEnum

参照

SFYSingleTextWidget::VerticalEnum