継承図

協調図

解説

■ 仕様と使い方

SFYBoxControl は各種ボックスコントロールを実装するための起点となるクラスです。

SFYBoxControl は、 ボックスの描画機能と操作キーの管理を実装し、 いくつかの仮想関数のデフォルトの動作も実装します。

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

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

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

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

外枠は SFYBoxControl::SetBevelColor 関数で設定したベベルカラー(SFXBevelColor)、

中枠（フレーム）は SFYBoxControl::SetFrameColor 関数で設定した色(SFXRGBColor)で描画されます。

内枠（フォーカス・フレーム）は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます（コンテンツ領域と同じ色になります）。

コンテンツ領域は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます。

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

外枠は SFYBoxControl::SetBevelColor 関数で設定したベベルカラー(SFXBevelColor)、

中枠（フレーム）は SFYBoxControl::SetFrameColor 関数で設定した色をそれぞれ非活性状態に合わせて補正した色で描画されます。

非活性状態にあるボックスコントロールは、 外枠が SFYBoxControl::SetBevelColor 関数で設定したベベルカラーのベースカラーで描画されるため平面的に見えます。

内枠（フォーカス・フレーム）は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます（コンテンツ領域と同じ色になります）。

コンテンツ領域は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます。

図 287. ボックスコントロールの拡大図[フォーカス状態]

外枠は SFYBoxControl::SetBevelColor 関数で設定したベベルカラー(SFXBevelColor)をフォーカス状態に合わせて補正した色で描画されます。

中枠（フレーム）は SFYBoxControl::SetFocusColor 関数で設定した色をフォーカス状態に合わせて補正した色で描画されます。

内枠（フォーカス・フレーム）は SFYBoxControl::SetFocusColor 関数で設定した色で描画されます。

コンテンツ領域は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます。

	フォーカス状態にあるときのフレームの色
	ボックスコントロールがフォーカス状態にあるとき、中枠（フレーム）は SFYBoxControl::SetFrameColor 関数で設定した色で描画されません。 SFYBoxControl::SetFocusColor 関数で設定した内枠（フォーカス・フレーム）の色をフォーカス状態に合わせて補正した色で描画されます。

■ イベントとハンドラ

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

	注意
	ハンドラの詳細については、 SFYBoxControl::SFYBoxControl / 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(USRBoxControl)
class USRBoxControl : public SFYBoxControl {
    SFMSEALRESPONDER(USRBoxControl)
    SFMRESPONDERINSTANTIATEFOUR(USRBoxControl, SFYBoxControl, SFYControl, SFYWidget, SFYResponder)
public:

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

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

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

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

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

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

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

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

Void USRBoxControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    // SFYBoxControl::DrawBox 関数を利用するので、ボックスマージンの大きさ分だけ縮小する
    rectangle->Deflate(GetBoxMargin());

    // ボックス内部に最適な大きさを計算して rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)


    // SFYBoxControl::DrawBox 関数を利用するので、ボックスマージンの大きさ分だけ拡大する
    rectangle->Inflate(GetBoxMargin());
    return;
}

Void USRBoxControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    // SFYBoxControl::DrawBox 関数を利用するので、ボックスマージンの大きさ分だけ縮小する
    rectangle->Deflate(GetBoxMargin());

    // ボックス内部に最適な大きさを rectangle パラメータ内の大きさに
    // 収まるように計算し、rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)


    // SFYBoxControl::DrawBox 関数を利用するので、ボックスマージンの大きさ分だけ拡大する
    rectangle->Inflate(GetBoxMargin());
    return;
}

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

Void USRBoxControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    // SFYBoxControl::DrawBox 関数を使用してボックスを描画する
    DrawBox(graphics, GetLocalBound());

    // ボックス内部を描画する
    return;
}

参照

SFYBoxControl::SFYBoxControl | SFYControl::SFYControl | SFYWidget::SFYWidget | SFYControl | SFZSingleTextBoxControl | SFZSingleEditBoxControl | SFZMultipleTextBoxControl | SFZMultipleEditBoxControl | SFZImageBoxControl | キーイベント[SFEVT_KEY] | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER] | 状態 | ボックスコントロールを表す抽象クラス[SFYBoxControl]

メンバ

解説

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

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

内部実装

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

/*protected */SFYBoxControl::SFYBoxControl(Void) static_throws
{
    static SFXBevelColor::AtomRecConst          bevel[] = {
        {{{{0x00, 0x99, 0x99, 0x99}}}, {{{0x00, 0xEE, 0xEE, 0xEE}}}, {{{0x00, 0xFF, 0xFF, 0xFF}}}}
    };
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xAA, 0xAA, 0xAA}}},
        {{{0x00, 0x00, 0x00, 0x00}}}
    };
    static SFXEventRange::AtomRecConst          trange[] = {
        #if TARGET_VERSION_GE(3, 0, 0)
        {       SFEVT_KEY_PRESS,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END},
        #else
        {       SFEVT_KEY_PRESS,         SFEVT_KEY_HELD,          SFP16_BEGIN,            SFP16_END},
        #endif
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnShield);
        trule[0].reference = this;
        trule[1].spp = XANDLER_FUNCTION(OnKey);
        trule[1].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            _color.focus.Set(rgb[0]);
            _color.frame.Set(rgb[1]);
            _color.bevel.Set(bevel[0]);
            _key.operate = AVK_SELECT;
        }
    }
}// SFYBoxControl::SFYBoxControl //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFYBoxControl, OnShield, invoker, event)
{
    unused(invoker);
    return (event.GetP16() == _key.operate);
}// XANDLER_IMPLEMENT_BOOLEVENT(SFYBoxControl, OnShield) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFYBoxControl, OnKey, invoker, event)
{
    Bool                                        result(false);

    unused(invoker);
    if (event.GetP16() == _key.operate) {
        HandleOperateKey();
        result = true;
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFYBoxControl, OnKey) //

参照

SFYResponder::SetType | SFYBoxControl::CodeEnum | SFYBoxControl::SetFocusColor | SFYBoxControl::SetFrameColor | SFYBoxControl::SetBevelColor | SFYBoxControl::HandleOperateKey | SFXEvent | SFXBevelColor | SFXRGBColor | タイプ | イベント | キーイベント[SFEVT_KEY]

解説

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

内部実装

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

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

解説

この関数は、ボックスコントロールを描画します。

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

	Tip
	この関数は、SFYBoxControl クラスを継承する具象クラスの HandleRender 関数内で呼び出されます。

デフォルトの実装では、 ボックスコントロールのコンテンツ領域を含むベベル領域を状態に応じて以下のように描画します。

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

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

外枠は SFYBoxControl::SetBevelColor 関数で設定したベベルカラー(SFXBevelColor)、 中枠（フレーム）は SFYBoxControl::SetFrameColor 関数で設定した色(SFXRGBColor)で描画されます。

内枠（フォーカス・フレーム）は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます（コンテンツ領域と同じ色になります）。

コンテンツ領域は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます。

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

外枠は SFYBoxControl::SetBevelColor 関数で設定したベベルカラー(SFXBevelColor)、 中枠（フレーム）は SFYBoxControl::SetFrameColor 関数で設定した色をそれぞれ非活性状態に合わせて補正した色で描画されます。

非活性状態にあるボックスコントロールは、 外枠が SFYBoxControl::SetBevelColor 関数で設定したベベルカラーのベースカラーだけで描画されるため平面的に見えます。

内枠（フォーカス・フレーム）は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます（コンテンツ領域と同じ色になります）。

コンテンツ領域は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます。

図 290. ボックスコントロールの拡大図[フォーカス状態]

外枠は SFYBoxControl::SetBevelColor 関数で設定したベベルカラー(SFXBevelColor)をフォーカス状態に合わせて補正した色で描画されます。

中枠（フレーム）は SFYBoxControl::SetFocusColor 関数で設定した色をフォーカス状態に合わせて補正した色で描画されます。

内枠（フォーカス・フレーム）は SFYBoxControl::SetFocusColor 関数で設定した色で描画されます。

コンテンツ領域は SFYWidget::SetBackgroundColor 関数で設定した色で塗り潰されます。

	フォーカス状態にあるときのフレームの色
	ボックスコントロールがフォーカス状態にあるとき、中枠（フレーム）は SFYBoxControl::SetFrameColor 関数で設定した色で描画されません。 SFYBoxControl::SetFocusColor 関数で設定した内枠（フォーカス・フレーム）の色をフォーカス状態に合わせて補正した色で描画されます。

内部実装

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

/*protected */Void SFYBoxControl::DrawBox(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXRectangle                                lx;
    SFXBevelColor                               bevel;
    SFXRGBColor                                 rgb;

    lx.Set(rectangle);
    bevel.Set(_color.bevel);
    if (!GetStateActive(true)) {
        bevel.SetLight(bevel.GetBase());
        bevel.SetDark(bevel.GetBase());
    }
    graphics->DrawBevelRectangle(lx, bevel);
    lx.Deflate(1, 1);
    if (GetStateFocus(true)) {
        rgb.Set(_color.focus);
        if (GetStateActive(true)) {
            if (rgb.GetBrightness() > 0x7F) {
                rgb.SubRGB(0x55);
            }
            else {
                rgb.AddRGB(0x55);
            }
        }
        graphics->DrawRectangle(lx, rgb);
        lx.Deflate(1, 1);
        graphics->DrawRectangle(lx, _color.focus);
    }
    else {
        rgb.Set(_color.frame);
        if (!GetStateActive(true)) {
            if (rgb.GetBrightness() > 0x7F) {
                rgb.SubRGB(0x44);
            }
            else {
                rgb.AddRGB(0x44);
            }
        }
        graphics->DrawRectangle(lx, rgb);
        lx.Deflate(1, 1);
        graphics->DrawRectangle(lx, GetBackgroundColor());
    }
    lx.Deflate(1, 1);
    graphics->FillRectangle(lx, GetBackgroundColor());
    return;
}// SFYBoxControl::DrawBox //

参照

SFYBoxControl::GetBoxMargin | SFYBoxControl::SetBevelColor | SFYBoxControl::SetFrameColor | SFYBoxControl::SetFocusColor | SFYWidget::SetBackgroundColor | SFXBevelColor | SFXRGBColor | 状態

戻り値

ボックスコントロールの外枠を描画するためのベベルカラー。

解説

この関数は、ボックスコントロールの外枠を描画するためのベベルカラーを取得します。

参照

SFYBoxControl::SetBevelColor | SFXBevelColor | SFXRGBColor

戻り値

ボックスコントロールのマージン[SFXMargin(3, 3, 3, 3)]。

解説

この関数は、ボックスコントロールのマージンの値を取得します。

ボックスコントロールのマージンとは、 テキストや画像を描画するためのコンテンツ領域を囲む幅３ピクセルのボックスコントロールの枠領域のことです。 ローカル領域の左端、上端、右端、下端からそれぞれ３ピクセルの余白領域[SFXMargin(3, 3, 3, 3)]です。

図 291. ボックスコントロールの枠領域 : フォーカス状態にあるときの拡大図

ボックスコントロールの枠領域（マージン）は、外枠、中枠、内枠からなる幅３ピクセルの枠領域です。

ボックスコントロールのコンテンツ領域は、この枠領域に囲まれる部分です。

テキストや画像は、コンテンツ領域に描画されます。

この領域の描画については、SFYBoxControl::DrawBox 関数の説明を参照してください。

参照

SFXMargin | SFYBoxControl::DrawBox | ローカル領域

戻り値

ボックスコントロールがフォーカス状態にあるときに描画される内枠（フォーカスフレーム）の色(SFXRGBColor)

解説

この関数は、フォーカス状態にあるときの内枠の色を取得します。

参照

SFYBoxControl::SetFocusColor

戻り値

ボックスコントロールの中枠（フレーム）の色。

解説

この関数は、中枠の色を取得します。

参照

SFYBoxControl::SetFrameColor

戻り値

ボックスコントロールの操作キー。

解説

この関数は、ボックスコントロールの操作キーを取得します。

参照

SFYBoxControl::SetOperateKey | AVKType

解説

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

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、 自分自身に結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] を送信します。

内部実装

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

/*protected virtual */Void SFYBoxControl::HandleOperateKey(Void)
{
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetCurrentValue()), false);
    return;
}// SFYBoxControl::HandleOperateKey //

参照

SFYBoxControl::SetOperateKey | SFXEvent | SFYControl::GetCurrentValue | キーイベント[SFEVT_KEY] | 結果イベント [SFEVT_RESPONDER_RESULT]

解説

この関数は、 立体的に見えるボックスコントロールの外枠を描画するためのベベルカラー(SFXBevelColor)を設定します。

デフォルト値: SFXBevelColor(SFXRGBColor(0x99, 0x99, 0x99, 0x00), SFXRGBColor(0xEE, 0xEE, 0xEE, 0x00), SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00))

詳細は SFYBoxControl::DrawBox を参照してください。

	活性状態、操作可能状態、フォーカス状態にあるときのボックスコントロールの外枠
	左辺と上辺がベベルカラーのライト部分、右辺と下辺がベベルカラーのダーク部分、 左下隅と右上隅がベベルカラーのベースカラーで描画されます。 この効果により、ボックスコントロールは立体的に見えます。

	ボックスコントロールが非活性状態にあるとき
	ライトカラーとダークカラーはベベルカラー(SFXBevelColor)のベースカラーに設定されます。 ボックスコントロールの外枠はすべてベースカラーで描画されることになるのでボックスコントロールは平面的に見えます。

参照

SFYBoxControl::GetBevelColor | SFYBoxControl::DrawBox | SFYBoxControl::SetFocusColor SFYBoxControl::DrawBox | SFXBevelColor | SFXRGBColor | 状態

解説

この関数は、 ボックスコントロールがフォーカス状態にあるときに描画される内枠（フォーカスフレーム）の色を設定します。

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

詳細は SFYBoxControl::DrawBox を参照してください。

フォーカス状態にあるときの中枠（フレーム）の色

ボックスコントロールがフォーカス状態にあるとき、 中枠（フレーム）は、 SFYBoxControl::SetFocusColor 関数によって設定される色の明度を基準にして計算された色で描画されます。 そのため、SFYBoxControl::SetFrameColor 関数によって設定された色で中枠（フレーム）は描画されません。 内枠（フォーカス・フレーム）の色の明度が 0x7F より大きい場合はその色の RGB 値からそれぞれ 0x55 を減算した色、 0x7F 以下の場合はその色の RGB 値にそれぞれ 0x55 を加算した色で中枠（フレーム）は描画されます。 外枠は SFYBoxControl::SetBevelColor 関数で設定したベベルカラー(SFXBevelColor)で描画されます。 内枠（フォーカス・フレーム）の色は、SFYBoxControl::SetFocusColor 関数によって設定される色です。 色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

参照

SFYBoxControl::GetFocusColor | SFYBoxControl::DrawBox | SFYBoxControl::SetFrameColor | SFYBoxControl::SetBevelColor | SFXRGBColor::GetBrightness | SFXBevelColor | SFXRGBColor | 状態

解説

この関数は、ボックスコントロールの中枠（フレーム）の色を設定します。

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

詳細は SFYBoxControl::DrawBox を参照してください。

	非活性状態にあるときの中枠（フレーム）の色
	非活性状態にあるときの中枠（フレーム）の色は、 SFYBoxControl::SetFrameColor 関数によって設定された色の明度を基準にして計算された色で描画されます。 基準となる色の明度が 0x7F より大きい場合はその色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はその色の RGB 値にそれぞれ 0x44 を加算した色で中枠（フレーム）は描画されます。 色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

フォーカス状態にあるときの中枠（フレーム）の色

フォーカス状態にあるときの中枠（フレーム）の色は、 SFYBoxControl::SetFocusColor 関数によって設定される色の明度を基準にして計算された色になります。 そのため、SFYBoxControl::SetFrameColor 関数によって設定された色で中枠（フレーム）は描画されません。 フォーカス状態にあるときは内枠（フォーカス・フレーム）が描画されます。 内枠（フォーカス・フレーム）の色は、SFYBoxControl::SetFocusColor 関数によって設定される色です。 内枠（フォーカス・フレーム）の色の明度が 0x7F より大きい場合はその色の RGB 値からそれぞれ 0x55 を減算した色、 0x7F 以下の場合はその色の RGB 値にそれぞれ 0x55 を加算した色で中枠（フレーム）は描画されます。 色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

参照

SFYBoxControl::GetFrameColor | SFYBoxControl::DrawBox | SFYBoxControl::SetFocusColor | SFYBoxControl::SetFrameColor | SFYBoxControl::DrawBox | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

この関数は、ボックスコントロールの操作キーを設定します。

操作キーが押下されると、 SFYBoxControl::HandleOperateKey 関数が呼び出されます。

デフォルト値: AVK_SELECT

参照

SFYBoxControl::GetOperateKey | SFYBoxControl::HandleOperateKey | AVKType

参照

SFYResponder::GetType | SFYResponder::SetType