継承図

協調図

解説

■ 仕様と使い方

SFYCheckboxControl は、各種チェックボックスコントロールを実装するための起点となります。

SFYCheckboxControl は、 チェックボックスと影の描画機能とチェック状態の切り替えを実装し、 いくつかの仮想関数のデフォルトの動作も実装します。

操作キーは、 SFYButtonControl::SetOperateKey 関数を使用して設定します。 デフォルトでは、セレクトキーが操作キーとして割り当てられています。

■ イベントとハンドラ

SFYCheckboxControl を継承するレスポンダでは、 SFYCheckboxControl::SFYCheckboxControl / SFYButtonControl::SFYButtonControl / SFYControl::SFYControl / SFYWidget::SFYWidget コンストラクタで登録されたハンドラの処理により、 下記のイベントを受信すると、対応する下記の仮想関数（ハンドラ）が最初に呼び出されます。 その後、開発者がレスポンダに登録したハンドラが呼び出されることになります。

	注意
	ハンドラの詳細については、 SFYCheckboxControl::SFYCheckboxControl / SFYButtonControl::SFYButtonControl / SFYControl::SFYControl / SFYWidget::SFYWidget コンストラクタの解説を参照してください。

	Tip
	ハンドラを登録する手間を省略できるので、 通常、これらのイベント処理は仮想関数をオーバーライドして記述します。

※デフォルトの動作にある "−" は何も実装していないことを表す。

	注釈
	※1. チェック状態を切り替えた後、SFYResponder::InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetCurrentValue()), false) を実行します。 ※2. SFYResponder::SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize())) を実行します。つまり、仮想領域を実領域に一致させます。

ユーザー定義チェックボックスコントロールを作成するときに最低限必要なコードを示します。

SFMTYPEDEFRESPONDER(USRCheckboxControl)
class USRCheckboxControl : public SFYCheckboxControl {
    SFMSEALRESPONDER(USRCheckboxControl)
    SFMRESPONDERINSTANTIATEFIVE(USRCheckboxControl, SFYCheckboxControl, SFYButtonControl, SFYControl, SFYWidget, SFYResponder)
public:

    // レスポンダのタイプを定義する
    // 小文字と記号のみからなるタイプは予約されているので使えない
    enum CodeEnum {
        CODE_TYPE = four_char_code('U', 'C', 'H', 'K')
    };
    SFMTYPEDEFTYPE(CodeEnum)

public:
    static USRCheckboxControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit USRCheckboxControl(Void) static_throws;
    virtual ~USRCheckboxControl(Void);

    // 親クラスで定義されている仮想関数のうち、実装が推奨される仮想関数
    virtual Void HandleBoundRequest(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundOptimize(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundVirtual(Void);
    virtual Void HandleRenderRequest(SFXGraphicsPtr graphics) const;
};

USRCheckboxControl::USRCheckboxControl(Void) static_throws
{
    if (static_try()) {

        // レスポンダのタイプを設定する
        SetType(CODE_TYPE);

        // チェックボックスコントロールのラベル部分は背景を持たないので透過モードに設定する
        SetPropertyTransparent(true);

        // 初期化処理を記述する
    }
}

USRCheckboxControl::~USRCheckboxControl(Void)
{
    // 終了処理を記述する
}

USRCheckboxControlSmp USRCheckboxControl::NewInstance(SFCErrorPtr exception)
{
    return static_pointer_cast<USRCheckboxControl>(Factory(::new USRCheckboxControl, exception));
}

Void USRCheckboxControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    // チェックボックスコントロールに最適な大きさを計算して rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRCheckboxControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    // チェックボックスコントロールに最適な大きさを rectangle パラメータ内の大きさに
    // 収まるように計算し、rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRCheckboxControl::HandleBoundVirtual(Void)
{
    // 仮想領域が変更された場合に再計算が必要なものがあれば、ここに記述する
    return;
}

Void USRCheckboxControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    SFXGrid grid;

    // SFYCheckboxControl::DrawButton**/DrawShadow**/ DrawCheckmark** 関数を使用して、
    // チェックボックスと影を描画する

    // _height 変数はチェックボックス部分の高さを表し、
    // _origin 変数はチェックボックス部分の原点を表すものとする
    // ※これらの変数は、ラベル部分に使用するフォントの高さより計算する

    if (_height >= 28) {
        grid.Set(DrawShadow28(graphics, _origin));
        DrawButton27(graphics, grid);
        grid.Add(3, 3);
        DrawCheckmark21(graphics, grid);
    }
    else if (_height >= 14) {
        grid.Set(DrawShadow14(graphics, _origin));
        DrawButton13(graphics, grid);
        grid.Add(2, 2); 
        DrawCheckmark09(graphics, grid);
    }

    // チェックボックスコントロールのラベル部分を描画する

    return;
}

参照

SFYCheckboxControl::SFYCheckboxControl | SFYButtonControl::SFYButtonControl | SFYControl::SFYControl | SFYWidget::SFYWidget | SFYControl | SFYButtonControl | SFZCheckboxControl | SFZRadiobuttonControl | キーイベント[SFEVT_KEY/SFEVT_KEY_PRESS/SFEVT_KEY_RELEASE] | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER] | チェックボックスコントロールを表す抽象クラス[SFYCheckboxControl]

メンバ

解説

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

内部実装

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

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

    if (static_try()) {
        SetType(CODE_TYPE);
        SetMaximumValue(true);
        _color.checkmark.Set(rgb[0]);
    }
}// SFYCheckboxControl::SFYCheckboxControl //

参照

SFYResponder::SetType | SFYCheckboxControl::CodeEnum | SFYControl::SetMaximumValue | SFYCheckboxControl::SetCheckmarkColor | SFXRGBColor | タイプ

解説

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

内部実装

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

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

解説

この関数は、チェックボックス用 13 × 13 ピクセルのボタンを描画します。

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

	Tip
	この関数は、SFZCheckboxControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */Void SFYCheckboxControl::DrawButton13(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    static SFXRectangle::AtomRecConst           rectangle[] = {
        {{ 0,  0}, {13, 13}},
        {{ 2,  2}, { 9,  9}}
    };

    RenderButton(graphics, grid, atomic_cast(rectangle));
    return;
}// SFYCheckboxControl::DrawButton13 //

/*private */Void SFYCheckboxControl::RenderButton(SFXGraphicsPtr graphics, SFXGridConstRef grid, SFXRectangleConst rectangle[2]) const
{
    SFXBevelColor                               bevel;
    SFXRGBColorConstRef                         base(GetButtonColor().GetBase());
    SFXRGBColor                                 rgb;

    graphics->SetTranslate(-grid);
    bevel.Set((GetStateFocus(true)) ? (GetFocusColor()) : (GetButtonColor()));
    rgb.Set(base);
    if (!GetStateActive(true)) {
        bevel.SetLight(bevel.GetBase());
        bevel.SetDark(bevel.GetBase());
    }
    if (GetStatePress()) {
        if (base.GetBrightness() > 0x7F) {
            bevel.SubRGB(0x11);
            rgb.SubRGB(0x11);
        }
        else {
            bevel.AddRGB(0x11);
            rgb.AddRGB(0x11);
        }
    }
    graphics->FillBevelRectangle(rectangle[0], bevel);
    graphics->FillRectangle(rectangle[1], rgb);
    graphics->SetTranslate(grid);
    return;
}// SFYCheckboxControl::RenderButton //

参照

SFZCheckboxControl::HandleRenderRequest

解説

この関数は、チェックボックス用 27 × 27 ピクセルのボタンを描画します。

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

	Tip
	この関数は、SFZCheckboxControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */Void SFYCheckboxControl::DrawButton27(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    static SFXRectangle::AtomRecConst           rectangle[] = {
        {{ 0,  0}, {27, 27}},
        {{ 2,  2}, {23, 23}}
    };

    RenderButton(graphics, grid, atomic_cast(rectangle));
    return;
}// SFYCheckboxControl::DrawButton27 //

/*private */Void SFYCheckboxControl::RenderButton(SFXGraphicsPtr graphics, SFXGridConstRef grid, SFXRectangleConst rectangle[2]) const
{
    SFXBevelColor                               bevel;
    SFXRGBColorConstRef                         base(GetButtonColor().GetBase());
    SFXRGBColor                                 rgb;

    graphics->SetTranslate(-grid);
    bevel.Set((GetStateFocus(true)) ? (GetFocusColor()) : (GetButtonColor()));
    rgb.Set(base);
    if (!GetStateActive(true)) {
        bevel.SetLight(bevel.GetBase());
        bevel.SetDark(bevel.GetBase());
    }
    if (GetStatePress()) {
        if (base.GetBrightness() > 0x7F) {
            bevel.SubRGB(0x11);
            rgb.SubRGB(0x11);
        }
        else {
            bevel.AddRGB(0x11);
            rgb.AddRGB(0x11);
        }
    }
    graphics->FillBevelRectangle(rectangle[0], bevel);
    graphics->FillRectangle(rectangle[1], rgb);
    graphics->SetTranslate(grid);
    return;
}// SFYCheckboxControl::RenderButton //

参照

SFZCheckboxControl::HandleRenderRequest

解説

この関数は、チェックボックス用 9 × 9 ピクセルのチェックマークを描画します。

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

	Tip
	この関数は、SFZCheckboxControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */Void SFYCheckboxControl::DrawCheckmark09(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    static SFXLine::AtomRecConst                line[] = {
        {{ 0,  5}, { 2,  7}},
        {{ 3,  6}, { 8,  1}},
        {{ 0,  6}, { 2,  8}},
        {{ 3,  7}, { 8,  2}}
    };

    RenderCheckmark(graphics, grid, atomic_cast(line));
    return;
}// SFYCheckboxControl::DrawCheckmark09 //

/*private */Void SFYCheckboxControl::RenderCheckmark(SFXGraphicsPtr graphics, SFXGridConstRef grid, SFXLineConst line[4]) const
{
    SFXRGBColor                                 rgb;
    Bool                                        checkmarkBright;

    if (GetCurrentValue()) {
        graphics->SetTranslate(-grid);
        rgb.Set(_color.checkmark);
        checkmarkBright = _color.checkmark.GetBrightness() > 0x7F;
        if (!GetStateActive(true)) {
            (checkmarkBright) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
        }
        graphics->SetForeColor(rgb);
        graphics->DrawLine(line[0]);
        graphics->DrawLine(line[1]);
        (checkmarkBright) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
        graphics->SetForeColor(rgb);
        graphics->DrawLine(line[2]);
        graphics->DrawLine(line[3]);
        graphics->SetTranslate(grid);
    }
    return;
}// SFYCheckboxControl::RenderCheckmark //

参照

SFZCheckboxControl::HandleRenderRequest

解説

この関数は、チェックボックス用 21 × 21 ピクセルのチェックマークを描画します。

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

	Tip
	この関数は、SFZCheckboxControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */Void SFYCheckboxControl::DrawCheckmark21(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    static SFXLine::AtomRecConst                line[] = {
        {{ 0, 15}, { 4, 19}},
        {{ 5, 18}, {20,  3}},
        {{ 0, 16}, { 4, 20}},
        {{ 5, 19}, {20,  4}}
    };

    RenderCheckmark(graphics, grid, atomic_cast(line));
    return;
}// SFYCheckboxControl::DrawCheckmark21 //

/*private */Void SFYCheckboxControl::RenderCheckmark(SFXGraphicsPtr graphics, SFXGridConstRef grid, SFXLineConst line[4]) const
{
    SFXRGBColor                                 rgb;
    Bool                                        checkmarkBright;

    if (GetCurrentValue()) {
        graphics->SetTranslate(-grid);
        rgb.Set(_color.checkmark);
        checkmarkBright = _color.checkmark.GetBrightness() > 0x7F;
        if (!GetStateActive(true)) {
            (checkmarkBright) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
        }
        graphics->SetForeColor(rgb);
        graphics->DrawLine(line[0]);
        graphics->DrawLine(line[1]);
        (checkmarkBright) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
        graphics->SetForeColor(rgb);
        graphics->DrawLine(line[2]);
        graphics->DrawLine(line[3]);
        graphics->SetTranslate(grid);
    }
    return;
}// SFYCheckboxControl::RenderCheckmark //

参照

SFZCheckboxControl::HandleRenderRequest

解説

この関数は、チェックボックス用 14 × 14 ピクセルの影を描画します。

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

	Tip
	この関数は、SFZCheckboxControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */SFXGrid SFYCheckboxControl::DrawShadow14(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    static SFXLine::AtomRecConst                line[][2] = {
        {{{13,  0}, {13, 13}}, {{ 0, 13}, {13, 13}}},
        {{{ 0,  0}, {13,  0}}, {{ 0,  0}, { 0, 13}}}
    };
    SFXGrid                                     result(grid);

    if (GetStatePress()) {
        RenderShadow(graphics, grid, atomic_cast(line[1]));
        result.Add(1, 1);
    }
    else {
        RenderShadow(graphics, grid, atomic_cast(line[0]));
        result.Add(0, 0);
    }
    return result;
}// SFYCheckboxControl::DrawShadow14 //

/*private */Void SFYCheckboxControl::RenderShadow(SFXGraphicsPtr graphics, SFXGridConstRef grid, SFXLineConst line[2]) const
{
    SFXRGBColor                                 rgb;

    graphics->SetTranslate(-grid);
    rgb.Set(GetShadowColor());
    if (!GetStateActive(true)) {
        (rgb.GetBrightness() > 0x7F) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
    }
    graphics->SetForeColor(rgb);
    graphics->DrawLine(line[0]);
    graphics->DrawLine(line[1]);
    graphics->SetTranslate(grid);
    return;
}// SFYCheckboxControl::RenderShadow //

参照

SFZCheckboxControl::HandleRenderRequest

解説

この関数は、チェックボックス用 28 × 28 ピクセルの影を描画します。

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

	Tip
	この関数は、SFZCheckboxControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */SFXGrid SFYCheckboxControl::DrawShadow28(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    static SFXLine::AtomRecConst                line[][2] = {
        {{{27,  0}, {27, 27}}, {{ 0, 27}, {27, 27}}},
        {{{ 0,  0}, {27,  0}}, {{ 0,  0}, { 0, 27}}}
    };
    SFXGrid                                     result(grid);

    if (GetStatePress()) {
        RenderShadow(graphics, grid, atomic_cast(line[1]));
        result.Add(1, 1);
    }
    else {
        RenderShadow(graphics, grid, atomic_cast(line[0]));
        result.Add(0, 0);
    }
    return result;
}// SFYCheckboxControl::DrawShadow28 //

/*private */Void SFYCheckboxControl::RenderShadow(SFXGraphicsPtr graphics, SFXGridConstRef grid, SFXLineConst line[2]) const
{
    SFXRGBColor                                 rgb;

    graphics->SetTranslate(-grid);
    rgb.Set(GetShadowColor());
    if (!GetStateActive(true)) {
        (rgb.GetBrightness() > 0x7F) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
    }
    graphics->SetForeColor(rgb);
    graphics->DrawLine(line[0]);
    graphics->DrawLine(line[1]);
    graphics->SetTranslate(grid);
    return;
}// SFYCheckboxControl::RenderShadow //

参照

SFZCheckboxControl::HandleRenderRequest

戻り値

チェックマークの色。

解説

この関数は、チェックマークの色を取得します。

参照

SFYCheckboxControl::SetCheckmarkColor

解説

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

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

デフォルトの実装では、 選択状態の切替を行い、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 現在値)] を送信します。 現在値は、SFYControl::GetCurrentValue 関数を呼び出すことで取得できる値です。

内部実装

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

/*protected virtual */Void SFYCheckboxControl::HandleOperateKeyRelease(Void)
{
    SetCurrentValue(!GetCurrentValue());
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetCurrentValue()), false);
    return;
}// SFYCheckboxControl::HandleOperateKeyRelease //

参照

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

解説

この関数は、チェックボックスコントロールまたはラジオボタンコントロールのチェックマークを描画する色を設定します。

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

■チェックボックスコントロールの場合

チェックボックスコントロールのチェックマークは、図にあるように４本の直線で描画されます。 上側にある２本の直線の色は、SFYCheckboxControl::SetCheckmarkColor 関数で設定される色です。

下側にある２本の直線の色は、上側の直線の色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色になります。

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

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

非活性状態にあるときは、この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色でチェックマークの上側２本の直線は描画されます。 下側の２本の直線は、上述のこの上側の２本の直線の色の明度を基準にして計算した色になります。

■ラジオボタンコントロールの場合

ラジオボタンコントロールのチェックマークは、図にあるように領域の中央に描画されます。 この色は、SFYCheckboxControl::SetCheckmarkColor 関数で設定される色です。

図 307. ラジオボタンコントロールの拡大図[活性状態または操作可能状態]

図 308. ラジオボタンコントロールの拡大図[非活性状態]

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

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

参照

SFYCheckboxControl::GetCheckmarkColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

参照

SFYResponder::GetType | SFYResponder::SetType