継承図

協調図

解説

■ 仕様と使い方

SFYButtonControl は、 各種ボタンコントロールを実装するための起点となります。

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

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

□ボタンコントロールの構成

ボタンコントロールはベベル領域、コンテンツ領域、影領域から構成されます。

コンテンツ領域は、ベベル領域の２ピクセル分の枠（フォーカス・フレーム）で囲まれる領域です。

※ ラジオボタンの場合は、矩形ではなく円形の領域で構成されます。

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

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

コンテンツ領域を含むベベル領域は SFYButtonControl::SetButtonColor 関数で設定するベベルカラー(SFXBevelColor) 、 影領域は SFYButtonControl::SetShadowColor 関数で設定する色(SFXRGBColor) でそれぞれ描画されます。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

非活性状態やフォーカス状態（およびボタンコントロール押下時）にあるときは、 ボタンコントロールの枠（フォーカス・フレーム）とコンテンツ領域や影領域の色が変化します。

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

ボタンコントロールが非活性状態にあるときは、 ベベル領域のライトカラーとダークカラーはベベルカラー(SFXBevelColor)のベースカラーで描画されます。 このため、ボタンコントロール内ベベル領域はすべてベースカラーで描画されることになるのでボタンコントロールは平面的に見えます。

影領域は SFYButtonControl::SetShadowColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

色の補正処理の詳細は、 SFYButtonControl::SetShadowColor を参照してください。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

図 294. ボタンコントロールの拡大図[フォーカス状態・非押下時]

ボタンコントロールはフォーカス状態にあるとき、 ベベル領域の左辺・右辺・上辺・下辺からなる２ピクセル分の枠（フォーカス・フレーム）は、 SFYButtonControl::SetFocusColor 関数で設定したベベルカラーで描画されます。

この枠（フォーカス・フレーム）で囲まれるコンテンツ領域は SFYButtonControl::SetButtonColor 関数で設定するベベルカラーのベースカラーで塗り潰されます。

SFYButtonControl::SetOperateKey 関数で設定した操作キーによって押下されていないので SFYButtonControl::SetShadowColor 関数で設定した色で下辺と右辺が描画されます。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

図 295. ボタンコントロールの拡大図[フォーカス状態・押下時]

ボタンコントロールはフォーカス状態にあるとき、 ベベル領域の左辺・右辺・上辺・下辺からなる２ピクセル分の枠は、 SFYButtonControl::SetFocusColor 関数で設定したベベルカラーをフォーカス状態・押下時に合わせて補正した色で描画されます。

この枠（フォーカス・フレーム）で囲まれるコンテンツ領域は SFYButtonControl::SetButtonColor 関数で設定するベベルカラーのベースカラーをフォーカス状態・押下時に合わせて補正した色で描画されます。

SFYButtonControl::SetOperateKey 関数で設定した操作キーによって押下されているので SFYButtonControl::SetShadowColor 関数で設定した色で上辺と左辺が描画されます。

色の補正処理の詳細は、 SFYButtonControl::SetFocusColor、 SFYButtonControl::SetButtonColor を参照してください。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

■ イベントとハンドラ

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

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

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

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

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

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

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

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

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

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

Void USRButtonControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    // SFYButtonControl::DrawButton 関数と SFYButtonControl::DrawShadow 関数を利用するので、
    // ボタンと影の大きさ分だけ縮小する
    rectangle->Deflate(GetShadowMargin());
    rectangle->Deflate(GetButtonMargin());

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

    // SFYButtonControl::DrawButton 関数と SFYButtonControl::DrawShadow 関数を利用するので、
    // ボタンと影の大きさ分だけ拡大する
    rectangle->Inflate(GetButtonMargin());
    rectangle->Inflate(GetShadowMargin());
    return;
}

Void USRButtonControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    // SFYButtonControl::DrawButton 関数と SFYButtonControl::DrawShadow 関数を利用するので、
    // ボタンと影の大きさ分だけ縮小する
    rectangle->Deflate(GetShadowMargin());
    rectangle->Deflate(GetButtonMargin());

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

    // SFYButtonControl::DrawButton 関数と SFYButtonControl::DrawShadow 関数を利用するので、
    // ボタンと影の大きさ分だけ拡大する
    rectangle->Inflate(GetButtonMargin());
    rectangle->Inflate(GetShadowMargin());
    return;
}

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

Void USRButtonControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    // SFYButtonControl::DrawButton 関数と SFYButtonControl::DrawShadow 関数)を利用して
    // ボタンと影を描画する
    DrawButton(graphics, DrawShadow(graphics, GetLocalBound()));

    // ボタン内部を描画する
    return;
}

参照

SFYButtonControl::SFYButtonControl | SFYControl::SFYControl | SFYWidget::SFYWidget | SFYControl | SFYCheckboxControl | SFYRadiobuttonControl | SFZCheckboxControl | SFZRadiobuttonControl | SFZTextButtonControl | SFZImageButtonControl | SFZComboBoxControl | キーイベント[SFEVT_KEY/SFEVT_KEY_PRESS/SFEVT_KEY_RELEASE] | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER] | 状態 | ボタンコントロールを表す抽象クラス[SFYButtonControl]

メンバ

解説

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

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

内部実装

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

/*protected */SFYButtonControl::SFYButtonControl(Void) static_throws
{
    static SFXBevelColor::AtomRecConst          bevel[] = {
        {{{{0x00, 0xCC, 0xCC, 0xCC}}}, {{{0x00, 0xAA, 0xAA, 0xAA}}}, {{{0x00, 0x55, 0x55, 0x55}}}},
        {{{{0x00, 0xFF, 0xFF, 0xFF}}}, {{{0x00, 0xDD, 0xDD, 0xDD}}}, {{{0x00, 0x88, 0x88, 0x88}}}}
    };
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0x00, 0x00, 0x00}}}
    };
    static SFXEventRange::AtomRecConst          trange[] = {
        {     SFEVT_APP_SUSPEND,      SFEVT_APP_SUSPEND,          SFP16_BEGIN,            SFP16_END},
        #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},
        {       SFEVT_KEY_PRESS,        SFEVT_KEY_PRESS,          SFP16_BEGIN,            SFP16_END},
        {     SFEVT_KEY_RELEASE,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_FOCUS,    SFP16_STATE_FOCUS}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnAppSuspend);
        trule[0].reference = this;
        trule[1].spp = XANDLER_FUNCTION(OnShield);
        trule[1].reference = this;
        trule[2].spp = XANDLER_FUNCTION(OnKey);
        trule[2].reference = this;
        trule[3].spp = XANDLER_FUNCTION(OnKeyPress);
        trule[3].reference = this;
        trule[4].spp = XANDLER_FUNCTION(OnKeyRelease);
        trule[4].reference = this;
        trule[5].spp = XANDLER_FUNCTION(OnStateFocus);
        trule[5].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            _press = false;
            _color.focus.Set(bevel[0]);
            _color.button.Set(bevel[1]);
            _color.shadow.Set(rgb[0]);
            _key.operate = AVK_SELECT;
        }
    }
}// SFYButtonControl::SFYButtonControl //

/*private */XANDLER_IMPLEMENT_VOIDSUSPEND(SFYButtonControl, OnAppSuspend, invoker, reason, info)
{
    unused(invoker);
    unused(reason);
    unused(info);
    SetStatePress(false);
    return;
}// XANDLER_IMPLEMENT_VOIDSUSPEND(SFYButtonControl, OnAppSuspend) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFYButtonControl, OnShield, invoker, event)
{
    unused(invoker);
    return (event.GetP16() == _key.operate) ? (true) : (GetStatePress());
}// XANDLER_IMPLEMENT_BOOLEVENT(SFYButtonControl, OnShield) //

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

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

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFYButtonControl, OnKeyPress, invoker, event)
{
    Bool                                        result(false);

    unused(invoker);
    if (event.GetP16() == _key.operate) {
        if (!GetStatePress()) {
            SetStatePress(true);
            HandleOperateKeyPress();
        }
        result = true;
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFYButtonControl, OnKeyPress) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFYButtonControl, OnKeyRelease, invoker, event)
{
    Bool                                        result(false);

    unused(invoker);
    if (event.GetP16() == _key.operate) {
        if (GetStatePress()) {
            SetStatePress(false);
            HandleOperateKeyRelease();
        }
        result = true;
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFYButtonControl, OnKeyRelease) //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFYButtonControl, OnStateFocus, invoker, reason, state)
{
    unused(invoker);
    unused(reason);
    if (!state) {
        SetStatePress(false);
    }
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFYButtonControl, OnStateFocus) //

参照

SFYResponder::SetType | SFYButtonControl::CodeEnum | SFYButtonControl::SetStatePress | SFYButtonControl::SetButtonColor | SFYButtonControl::SetButtonColor | SFYButtonControl::SetFocusColor | SFYButtonControl::SetShadowColor | SFYButtonControl::HandleOperateKey | SFYButtonControl::HandleOperateKeyPress | SFYButtonControl::HandleOperateKeyRelease | SFXEvent | SFXBevelColor | SFXRGBColor | タイプ | イベント | 状態 | キーイベント[SFEVT_KEY/SFEVT_KEY_PRESS/SFEVT_KEY_RELEASE] | 状態イベント[SFEVT_RESPONDER_STATE] | アプリ中断イベント[SFEVT_APP_SUSPEND]

解説

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

内部実装

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

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

解説

この関数は、ボタンコントロールのコンテンツ領域を含むベベル領域を描画します。

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

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

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

■ボタンコントロールの構成

ボタンコントロールはベベル領域、コンテンツ領域、影領域から構成されます。

コンテンツ領域は、ベベル領域の２ピクセル分の枠（フォーカス・フレーム）で囲まれる領域です。

※ ラジオボタンの場合は、矩形ではなく円形の領域で構成されます。

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

コンテンツ領域を含むベベル領域は SFYButtonControl::SetButtonColor 関数で設定するベベルカラー(SFXBevelColor) 、 影領域は SFYButtonControl::SetShadowColor 関数で設定する色(SFXRGBColor) でそれぞれ描画されます。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

非活性状態やフォーカス状態（およびボタンコントロール押下時）にあるときは、 ボタンコントロールの枠（フォーカス・フレーム）とコンテンツ領域や影領域の色が変化します。

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

ボタンコントロールが非活性状態にあるときは、 ベベル領域のライトカラーとダークカラーはベベルカラー(SFXBevelColor)のベースカラーで描画されます。 ボタンコントロール内ベベル領域はすべてベースカラーだけで描画されることになるのでボタンコントロールは平面的に見えます。

影領域は SFYButtonControl::SetShadowColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

色の補正処理の詳細は、 SFYButtonControl::SetShadowColor を参照してください。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

図 298. ボタンコントロールの拡大図[フォーカス状態・非押下時]

ボタンコントロールはフォーカス状態にあるとき、 ベベル領域の左辺・右辺・上辺・下辺からなる２ピクセル分の枠（フォーカス・フレーム）は、 SFYButtonControl::SetFocusColor 関数で設定したベベルカラーで描画されます。

この枠（フォーカス・フレーム）で囲まれるコンテンツ領域は SFYButtonControl::SetButtonColor 関数で設定するベベルカラーのベースカラーで塗り潰されます。

SFYButtonControl::SetOperateKey 関数で設定した操作キーによって押下されていないので SFYButtonControl::SetShadowColor 関数で設定した色で下辺と右辺が描画されます。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

図 299. ボタンコントロールの拡大図[フォーカス状態・押下時]

ボタンコントロールはフォーカス状態にあるとき、 ベベル領域の左辺・右辺・上辺・下辺からなる２ピクセル分の枠は、 SFYButtonControl::SetFocusColor 関数で設定したベベルカラーをフォーカス状態・押下時に合わせて補正した色で描画されます。

この枠（フォーカス・フレーム）で囲まれるコンテンツ領域は SFYButtonControl::SetButtonColor 関数で設定するベベルカラーのベースカラーをフォーカス状態・押下時に合わせて補正した色で描画されます。

SFYButtonControl::SetOperateKey 関数で設定した操作キーによって押下されているので SFYButtonControl::SetShadowColor 関数で設定した色で上辺と左辺が描画されます。

色の補正処理の詳細は、 SFYButtonControl::SetFocusColor、 SFYButtonControl::SetButtonColor を参照してください。

※ SFYWidget::SetBackgroundColor 関数で設定した色でボタンコントロールの背景が塗り潰されることはありません。

内部実装

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

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

    lx.Set(rectangle);
    bevel.Set((GetStateFocus(true)) ? (_color.focus) : (_color.button));
    rgb.Set(_color.button.GetBase());
    if (!GetStateActive(true)) {
        bevel.SetLight(bevel.GetBase());
        bevel.SetDark(bevel.GetBase());
    }
    if (GetStatePress()) {
        (bevel.GetBase().GetBrightness() > 0x7F) ? bevel.SubRGB(0x11) : bevel.AddRGB(0x11);
        (rgb.GetBrightness() > 0x7F) ? rgb.SubRGB(0x11) : rgb.AddRGB(0x11);
    }
    graphics->FillBevelRectangle(lx, bevel);
    lx.Deflate(2, 2);
    graphics->FillRectangle(lx, rgb);
    return;
}// SFYButtonControl::DrawButton //

参照

SFYButtonControl::DrawShadow | SFYButtonControl::SetButtonColor | SFYButtonControl::SetFocusColor | SFYButtonControl::SetShadowColor | SFXRGBColor::GetBrightness | SFYWidget::SetBackgroundColor | SFXBevelColor | SFXRGBColor | 状態

解説

この関数は、ボタンコントロールの影領域を描画します。

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

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

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

図 300. ボタンコントロールの拡大図[非押下時]

ボタンコントロール非押下時は下辺と右辺が影になり、 この２辺が SFYButtonControl::SetShadowColor 関数で設定する色(SFXRGBColor)で描画されます。

図 301. ボタンコントロールの拡大図[押下時]

ボタンコントロール押下時は左辺と上辺が影になり、 この２辺が SFYButtonControl::SetShadowColor 関数で設定する色(SFXRGBColor)で描画されます。

このとき、ボタンコントロールのベベル領域部分はボタンコントロール非押下時と比べて、全体的に (1, 1) だけ移動して描画されます。

ボタンコントロールのベベル領域部分の描画については、SFYButtonControl::DrawButton を参照してください。

内部実装

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

/*protected */SFXRectangle SFYButtonControl::DrawShadow(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXRGBColor                                 rgb;
    SFXRectangle                                result(rectangle);

    rgb.Set(_color.shadow);
    if (!GetStateActive(true)) {
        (rgb.GetBrightness() > 0x7F) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
    }
    graphics->SetForeColor(rgb);
    if (GetStatePress()) {
        graphics->DrawLine(result.GetEdgeLeft());
        graphics->DrawLine(result.GetEdgeTop());
        result.AddLeftTop(1, 1);
    }
    else {
        graphics->DrawLine(result.GetEdgeRight());
        graphics->DrawLine(result.GetEdgeBottom());
        result.SubRightBottom(1, 1);
    }
    return result;
}// SFYButtonControl::DrawShadow //

参照

SFYButtonControl::SetShadowColor | SFXRGBColor | SFYButtonControl::DrawButton

戻り値

ボタンコントロール内ベベル領域を描画するベベルカラー。

解説

この関数は、ボタンコントロール内ベベル領域を描画するベベルカラーを取得します。

参照

SFYButtonControl::SetButtonColor | SFYButtonControl::SetFocusColor | SFXRGBColor::GetBrightness | SFXBevelColor | SFXRGBColor | 状態

戻り値

ボタンコントロールのマージン[SFXMargin(2, 2, 2, 2)]。

解説

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

	注意
	ボタンコントロールのマージンとは、 テキストや画像を描画するためのコンテンツ領域を囲む幅２ピクセルのボタンコントロール内ベベル領域の枠領域のことです。 ローカル領域の影部分を除いたボタンコントロール内ベベル領域の 左端、上端、右端、下端からそれぞれ２ピクセルの余白領域[SFXMargin(2, 2, 2, 2)]です。

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

ボタンコントロールの枠領域（マージン）は、影領域を除いたベベル領域を囲む幅２ピクセルの枠領域です。

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

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

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

参照

SFXMargin | SFYButtonControl::DrawButton | SFYButtonControl::GetShadowMargin | ローカル領域

戻り値

フォーカス状態にあるときのボタンコントロール内ベベル領域の枠を描画するベベルカラー。

解説

この関数は、フォーカス状態にあるときのボタンコントロール内ベベル領域の枠を描画するベベルカラーを取得します。

参照

SFYButtonControl::SetFocusColor | SFXBevelColor | SFXRGBColor | 状態

戻り値

ボタンの操作キー。

解説

この関数は、ボタンの操作キーを取得します。

参照

SFYButtonControl::SetOperateKey | AVKType

戻り値

ボタンコントロールのプレスオフセットの値。

解説

この関数は、プレスオフセットを取得します。

	注意
	プレスオフセットとは、 ボタンコントロール押下時に影を除いたボタンコントロールの領域が移動するオフセット値です。 オフセット値は X 座標方向に 1 ピクセル、 Y 座標方向に 1 ピクセルです。 逆にボタンコントロールをリリースしたとき、 影を除いたボタンコントロール領域がこのオフセット値も分だけ元に戻ります。 X 座標方向に -1 ピクセル、 Y 座標方向に -1 ピクセルだけ移動します。

参照

SFYButtonControl::GetButtonMargin | SFYButtonControl::GetShadowMargin

戻り値

ボタンコントロールの影の色。

解説

この関数は、ボタンコントロールの影の色を取得します。

参照

SFYButtonControl::SetShadowColor | SFXRGBColor

戻り値

ボタンコントロールの影領域のマージン[SFXMargin(0, 0, 1, 1)]。

解説

この関数は、ボタンコントロールの影領域のマージンを取得します。

	注意
	ボタンコントロールの影領域は、ボタンコントロールの影となる領域のことです。 ローカル領域の左端から０ピクセル、 上端から０ピクセル、右端から１ピクセル、下端から１ピクセルの余白領域[SFXMargin(0, 0, 1, 1)]です（領域の下辺と右辺）。

図 303. ボタンコントロールの影領域 : ボタン非押下時の拡大図

ボタンコントロール非押下時は、 幅１ピクセルの右辺と下辺が影領域となります。

図 304. ボタンコントロールの影領域 : ボタン押下時の拡大図

ボタンコントロール押下時は、 幅１ピクセルの左辺と上辺が影領域となります。

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

参照

SFXMargin | SFYButtonControl::DrawShadow | SFYButtonControl::GetButtonMargin | SFYButtonControl::GetPressOffset

戻り値

ボタンコントロールの押下状態。

解説

この関数は、ボタンコントロールの押下状態を取得します。

参照

SFYButtonControl::SetStatePress

解説

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

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

デフォルトの実装は何も行いません。

内部実装

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

/*protected virtual */Void SFYButtonControl::HandleOperateKey(Void)
{
    return;
}// SFYButtonControl::HandleOperateKey //

参照

SFYButtonControl::SetOperateKey

解説

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

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

デフォルトの実装は何も行いません。

内部実装

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

/*protected virtual */Void SFYButtonControl::HandleOperateKeyPress(Void)
{
    return;
}// SFYButtonControl::HandleOperateKeyPress //

参照

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

解説

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

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

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

内部実装

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

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

参照

SFYButtonControl::SetOperateKey | SFYControl::GetCurrentValue | SFXEvent | 結果イベント | キーイベント[SFEVT_KEY_RELEASE]

解説

この関数は、ボタンコントロール内ベベル領域を描画するベベルカラー(SFXBevelColor)を設定します。

フォーカス状態にあるときはボタンコントロール内ベベル領域の SFYButtonControl::GetButtonMargin 関数で得られる余白 SFXMargin(2, 2, 2, 2) 、つまり２ピクセル分の枠部分が SFYButtonControl::SetFocusColor 関数で指定するベベルカラーで描画されます。

デフォルト値: SFXBevelColor(SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00), SFXRGBColor(0xDD, 0xDD, 0xDD, 0x00), SFXRGBColor(0x88, 0x88, 0x88, 0x00))

詳細は SFYButtonControl::DrawButton を参照してください。

参照

SFYButtonControl::GetButtonColor | SFYButtonControl::GetButtonMargin | SFXMargin | SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow | SFYButtonControl::SetFocusColor | SFYButtonControl::SetShadowColor | SFXRGBColor::GetBrightness | SFXBevelColor | SFXRGBColor | 状態

解説

この関数は、 フォーカス状態にあるときの影領域を除いたボタンコントロール領域の枠 （幅２ピクセルの上辺・右辺・下辺・左辺からなる領域）を描画するためのベベルカラー （SFXBevelColor）を設定します。

フォーカス状態にあるとき、 ボタンコントロール内ベベル領域の SFYButtonControl::GetButtonMargin 関数で得られる余白 SFXMargin(2, 2, 2, 2) 、つまり２ピクセル分の枠部分がこの関数で指定するベベルカラーで描画されます。

デフォルト値: SFXBevelColor(SFXRGBColor(0xCC, 0xCC, 0xCC, 0x00), SFXRGBColor(0xAA, 0xAA, 0xAA, 0x00), SFXRGBColor(0x55, 0x55, 0x55, 0x00))

詳細は SFYButtonControl::DrawButton を参照してください。

参照

SFYButtonControl::GetFocusColor | SFYButtonControl::GetButtonMargin | SFYButtonControl::DrawButton | SFYButtonControl::SetButtonColor | SFYButtonControl::SetOperateKey | SFXRGBColor::GetBrightness | SFXBevelColor | SFXRGBColor | 状態

解説

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

デフォルト値: AVK_SELECT

参照

SFYButtonControl::GetOperateKey | AVKType

解説

この関数は、ボタンコントロールの影を描画する色を設定します。

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

ボタンコントロールが非活性状態にあるとき、 影の色の明度が 0x7F より大きい場合は影の色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合は影の色の RGB 値にそれぞれ 0x44 を加算した色で影は描画されます。

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

ボタンコントロールがフォーカス状態にあり、 SFYButtonControl::SetOperateKey 関数で設定される操作キーによって押下されている時は上辺と左辺、 押下されていない時は下辺と右辺にそれぞれ影が描画されます。

詳細は SFYButtonControl::DrawButton を参照してください。

参照

SFYButtonControl::GetShadowColor | SFYButtonControl::DrawShadow | SFYButtonControl::DrawButton | SFYButtonControl::SetButtonColor | SFYButtonControl::SetFocusColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

引数

解説

この関数は、ボタンコントロールの押下状態を設定します。

同時に、自分自身に 状態イベント [SFXEvent(SFEVT_RESPONDER_STATE, SFP16_STATE_PRESS, "設定した値")] を送信します。

デフォルト値: false

	注意
	指定された値がこのボタンコントロールに現在設定されている押下状態と同じ場合は何も起こりません。

参照

SFYButtonControl::GetStatePress | イベント | 状態イベント[SFEVT_RESPONDER_STATE]

参照

SFYResponder::GetType | SFYResponder::SetType