継承図

協調図

解説

■ 仕様と使い方

SFYWidget クラスは、描画や領域に関する基本的な処理を行うクラスです。 SFYResponder を除くすべてのレスポンダクラスは、このクラスを継承します。

■ イベントとハンドラ

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

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

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

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

	グローバル領域イベントについて
	グローバル領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) イベント]と SFYWidget::HandleBoundGlobal 関数は、 SophiaFramework UNIVERSE 6.0 で廃止される予定です。 描画ハンドラの処理などでグローバル領域が必要な場合は、 SFYResponder::GetGlobalBound 関数を呼び出して取得してください。

参照

SFYWidget::SFYWidget | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER]

メンバ

解説

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

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

内部実装

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

/*protected */SFYWidget::SFYWidget(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xFF, 0xFF, 0xFF}}}
    };
    static SFXEventRange::AtomRecConst          trange[] = {
        { SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND,  SFP16_BOUND_REQUEST,  SFP16_BOUND_REQUEST},
        { SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, SFP16_BOUND_OPTIMIZE},
        { SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND,     SFP16_BOUND_REAL,     SFP16_BOUND_REAL},
        { SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND,  SFP16_BOUND_VIRTUAL,  SFP16_BOUND_VIRTUAL},
        { SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND,   SFP16_BOUND_GLOBAL,   SFP16_BOUND_GLOBAL},
        {SFEVT_RESPONDER_RENDER, SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, SFP16_RENDER_REQUEST}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnBoundRequest);
        trule[0].reference = this;
        trule[1].spp = XANDLER_FUNCTION(OnBoundOptimize);
        trule[1].reference = this;
        trule[2].spp = XANDLER_FUNCTION(OnBoundReal);
        trule[2].reference = this;
        trule[3].spp = XANDLER_FUNCTION(OnBoundVirtual);
        trule[3].reference = this;
        trule[4].spp = XANDLER_FUNCTION(OnBoundGlobal);
        trule[4].reference = this;
        trule[5].spp = XANDLER_FUNCTION(OnRenderRequest);
        trule[5].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            _color.background.Set(rgb[0]);
        }
    }
}// SFYWidget::SFYWidget //

/*private */XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundRequest, invoker, reason, rectangle)
{
    unused(invoker);
    unused(reason);
    HandleBoundRequest(rectangle);
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundRequest) //

/*private */XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundOptimize, invoker, reason, rectangle)
{
    unused(invoker);
    unused(reason);
    HandleBoundOptimize(rectangle);
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundOptimize) //

/*private */XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundReal, invoker, reason, rectangle)
{
    unused(invoker);
    unused(reason);
    unused(rectangle);
    HandleBoundReal();
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundReal) //

/*private */XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundVirtual, invoker, reason, rectangle)
{
    unused(invoker);
    unused(reason);
    unused(rectangle);
    HandleBoundVirtual();
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundVirtual) //

/*private */XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundGlobal, invoker, reason, rectangle)
{
    unused(invoker);
    unused(reason);
    HandleBoundGlobal(*rectangle);
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFYWidget, OnBoundGlobal) //

/*private */XANDLER_IMPLEMENT_VOIDRENDER(SFYWidget, OnRenderRequest, invoker, reason, graphics)
{
    unused(invoker);
    unused(reason);
    if (!GetPropertyTransparent()) {
        graphics->FillRectangle(GetLocalBound(), _color.background);
    }
    HandleRenderRequest(graphics);
    return;
}// XANDLER_IMPLEMENT_VOIDRENDER(SFYWidget, OnRenderRequest) //

参照

SFYResponder::SetType | SFYWidget::CodeEnum | SFYWidget::SetBackgroundColor | SFYWidget::HandleBoundRequest | SFYWidget::HandleBoundOptimize | SFYWidget::HandleBoundReal | SFYWidget::HandleBoundVirtual | SFYWidget::HandleBoundGlobal | SFYWidget::HandleRenderRequest | SFYWidget::SetBackgroundColor | SFXEvent | SFXRGBColor | タイプ | イベント | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER]

解説

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

内部実装

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

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

戻り値

背景の色。

解説

この関数は、背景の色を取得します。

内部実装

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

/*public */inline SFXRGBColorConstRef SFYWidget::GetBackgroundColor(Void) const
{
    return _color.background;
}// SFYWidget::GetBackgroundColor //

参照

SFYWidget::SetBackgroundColor

解説

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

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

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

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) イベントの送信
	領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL, rectangle)] は SFYResponder::SetRealBound または SFYResponder::SetVirtualBound 関数の呼び出しによってグローバル領域が変化したときに発生します。 このとき、(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) イベントは描画エンジンを起動した直後、描画エンジンによって送信されます。

	グローバル領域の変更時の処理
	この仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 グローバル領域の変更処理は、最初に仮想関数を実行し、次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常はこの仮想関数をオーバーライドして処理を記述します。

	[非推奨（廃止予定　API）]
	この関数は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。 描画ハンドラの処理などでグローバル領域が必要な場合は、 SFYResponder::GetGlobalBound 関数を呼び出して取得してください。

内部実装

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

/*protected virtual */Void SFYWidget::HandleBoundGlobal(SFXRectangleConstRef /*rectangle*/)
{
    return;
}// SFYWidget::HandleBoundGlobal //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYResponder::GetGlobalBound | グローバル領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

引数 rectangle で指定した矩形領域に収まる範囲内でレスポンダの最適な領域を計算する場合、 この関数をオーバーライドします。

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

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

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

参照

SFYResponder::GetSuitableBound | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

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

	領域イベント[(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 SFYWidget::HandleBoundReal(Void)
{
    return;
}// SFYWidget::HandleBoundReal //

参照

SFYResponder::SetRealBound | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

レスポンダの最適な領域を計算する場合、この関数をオーバーライドします。

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

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

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

参照

SFYResponder::GetSuitableBound | SFYResponder::SetRealBound | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

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

	領域イベント[(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 SFYWidget::HandleBoundVirtual(Void)
{
    return;
}// SFYWidget::HandleBoundVirtual //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 仮想領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

レスポンダの描画処理を行いたい場合は、この関数をオーバーライドします。

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

Tip

SFYWidget::HandleRenderRequest 関数は、 レスポンダが描画イベントを受信したとき、 最初に起動される下記の SFYWidget クラスに登録されているデフォルトの描画ハンドラから呼び出されます。 // 最初に呼び出される SFYWidget クラスに登録されているデフォルトの描画ハンドラ /*private */XANDLER_IMPLEMENT_VOIDRENDER(SFYWidget, OnRenderRequest, invoker, reason, graphics) { unused(invoker); unused(reason); if (!GetPropertyTransparent()) { // 透過属性が設定されていないなら // レスポンダの領域を SetBackgroundColor() を利用して設定した背景色で塗り潰す graphics->FillRectangle(GetLocalBound(), _color.background); } // レスポンダを描画する仮想関数を呼び出す HandleRenderRequest(graphics); return; }// XANDLER_IMPLEMENT_VOIDRENDER(SFYWidget, OnRenderRequest) // SFYResponder::SetPropertyTransparent 関数を使用して透過属性を設定していない場合、 レスポンダの領域は SFYWidget::HandleRenderRequest 関数を実行する前に SFYWidget::SetBackgroundColor 関数を使用して設定した背景色(デフォルト値: 白色)で塗り潰されます。

レスポンダの描画手順

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

内部実装

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

/*protected virtual */Void SFYWidget::HandleRenderRequest(SFXGraphicsPtr /*graphics*/) const
{
    return;
}// SFYWidget::HandleRenderRequest //

参照

SFYResponder::Invalidate | SFYResponder::Render | SFYWidget::SetBackgroundColor | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | イベントループ | レスポンダツリー

解説

この関数は、レスポンダの背景を塗り潰す色を設定します。

SFYWidget を継承するレスポンダのローカル領域は、 描画ハンドラ実行前にこの関数で設定された色で塗り潰されますので、 描画ハンドラで背景を塗り潰す必要はありません。

ただし、SFYResponder::SetPropertyTransparent 関数を使用して透過属性が設定されているときは背景が塗り潰されません。

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

	ソフトキーコントロールの背景色
	ソフトキーコントロール（SFZSoftKeyControl）のデフォルトの背景色は、 SFXRGBColor(0xCC, 0xCC, 0xCC, 0x00) [灰色]です。

	透過属性がデフォルトで true に設定されるクラス
	以下のクラスは、透過属性がデフォルトで true に設定されています。 これらのクラスでは、デフォルト設定では SFYWidget::SetBackgroundColor 関数で設定される色で背景は塗り潰されません。 SFYImageWidget | SFYSingleTextWidget | SFYSingleEditWidget | SFYMultipleTextWidget | SFYMultipleEditWidget | SFZSingleTextLabelControl | SFZSingleEditLabelControl | SFZMultipleTextLabelControl | SFZMultipleEditLabelControl | SFZImageLabelControl | SFZCheckboxControl | SFZRadiobuttonControl

内部実装

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

/*public */Void SFYWidget::SetBackgroundColor(SFXRGBColorConstRef param)
{
    if (!param.Equals(_color.background)) {
        _color.background.Set(param);
        Invalidate();
        InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0), true);
    }
    return;
}// SFYWidget::SetBackgroundColor //

参照

SFYWidget::GetBackgroundColor | ローカル領域 | 描画ハンドラ | 属性 | SFYResponder::SetPropertyTransparent | SFXRGBColor

参照

SFYResponder::GetType | SFYResponder::SetType