継承図

協調図

解説

■ 仕様と使い方

イメージを表示するラベルコントロール(SFZImageLabelControl)には、 操作可能状態に応じて、 操作可能モードと操作不能モードの 2 種類の使用方法があります。

操作可能モードでは(状態が操作可能であるとき)、コントロールをフォーカスすることができます。 そのとき、SFYLabelControl::SetOperateKey 関数で設定する操作キーを押下すると、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue())] を受信します。

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

操作不能モードでは(状態が操作不能であるとき)、普通のラベルコントロールとして動作します。

図 380. 動作例（左：操作不能モード、右：操作可能モード）

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

図 381. イメージラベルコントロールの拡大図[フォーカス状態]

フォーカス状態では、 図にあるように領域の境界（外枠）とその内側（内枠）に枠線が２本それぞれ１ピクセルの幅で描画されます。

画像は内枠で囲まれるコンテンツ領域に描画されます。

図 382. イメージラベルコントロールの拡大図[フォーカス以外の状態]

フォーカス以外の状態では、外枠も内枠も描画されません。

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

参照

イメージを表示するラベルコントロール [SFZImageLabelControl] | 状態 | SFYControl | SFYLabelControl | SFYImageWidget

メンバ

解説

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

内部実装

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

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

    if (static_try()) {
        SetType(CODE_TYPE);
        if ((_widget = SFYImageWidget::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);
        }
    }
}// SFZImageLabelControl::SFZImageLabelControl //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZImageLabelControl, OnWidgetStyle, invoker, reason)
{
    unused(invoker);
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZImageLabelControl, OnWidgetStyle) //

/*private */Void SFZImageLabelControl::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound().Deflate(GetFocusMargin()));
    return;
}// SFZImageLabelControl::Relocate //

参照

SFYResponder::SetType | SFZImageLabelControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZImageLabelControl::SetHorizontalAlign | SFZImageLabelControl::SetVerticalAlign | SFZImageLabelControl::HorizontalEnum | SFZImageLabelControl::VerticalEnum | SFYImageWidget::NewInstance | SFYImageWidget | タイプ | 状態

解説

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

内部実装

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

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

戻り値

水平アライメントの値。

解説

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

参照

SFZImageLabelControl::SetHorizontalAlign | SFZImageLabelControl::HorizontalEnum

戻り値

画像。

解説

この関数は、画像を取得します。

参照

SFZImageLabelControl::SetImage | SFBImage

戻り値

垂直アライメントの値。

解説

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

参照

SFZImageLabelControl::SetVerticalAlign | SFZImageLabelControl::VerticalEnum

戻り値

ラベル画像描画用に子レスポンダとして内部で保持する SFYImageWidget クラス。

解説

ラベル画像描画用に子レスポンダとして内部で保持する SFYImageWidget クラスを返します。

ラベル画像の描画は、SFYImageWidget クラスに委譲して処理します。

参照

SFYImageWidget

解説

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

参照: SFYImageWidget::HandleBoundOptimize

内部実装

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

SFYImageWidgetSmp               _widget;

/*protected virtual */Void SFZImageLabelControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetFocusMargin());
    rectangle->SetSize(_widget->GetSuitableBound(*rectangle).GetSize());
    rectangle->Inflate(GetFocusMargin());
    return;
}// SFZImageLabelControl::HandleBoundOptimize //

参照

SFYResponder::GetSuitableBound | SFYLabelControl::GetFocusMargin | SFZImageLabelControl::SetImage | SFYImageWidget::HandleBoundOptimize | SFYImageWidget | SFXEvent | 領域イベント[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 仮想関数をオーバーライドして処理を記述します。

参照: SFYImageWidget::HandleBoundRequest

内部実装

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

SFYImageWidgetSmp               _widget;

/*protected virtual */Void SFZImageLabelControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetFocusMargin());
    rectangle->SetSize(_widget->GetSuitableBound().GetSize());
    rectangle->Inflate(GetFocusMargin());
    return;
}// SFZImageLabelControl::HandleBoundRequest //

参照

SFYResponder::GetSuitableBound | SFYLabelControl::GetFocusMargin | SFZImageLabelControl::SetImage | SFYImageWidget::HandleBoundRequest | SFYImageWidget | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

デフォルトの実装は、 ラベルコントロールのコンテンツ領域を内部で保持するイメージウィジェット(SFYImageWidget)の実領域として設定します。

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

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

内部実装

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

SFYImageWidgetSmp               _widget;

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

/*private */Void SFZImageLabelControl::Relocate(Void)
{
    _widget->SetRealBound(GetLocalBound().Deflate(GetFocusMargin()));
    return;
}// SFZImageLabelControl::Relocate //

参照

SFZImageLabelControl::SetImage | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYImageWidget | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

デフォルトの実装では、 フォーカス状態にあるときは SFYLabelControl::DrawFocus 関数を呼び出して枠線（外枠と内枠）を描画します。 その枠線で囲われるコンテンツ領域内に SFZImageLabelControl::SetImage 関数で設定した画像を描画します。

画像の配置は SFZImageLabelControl::SetHorizontalAlign 関数と SFZImageLabelControl::SetVerticalAlign 関数で設定します。

画像の描画はこのクラスが内部で保持する SFYImageWidget クラスに委譲して行われます。

図 383. イメージラベルコントロールの拡大図[フォーカス状態]

フォーカス状態では、 図にあるように領域の境界（外枠）とその内側（内枠）に枠線が２本それぞれ１ピクセルの幅で描画されます。

画像は内枠で囲まれるコンテンツ領域に描画されます。

図 384. イメージラベルコントロールの拡大図[フォーカス以外の状態]

フォーカス以外の状態では、外枠も内枠も描画されません。

レスポンダの描画手順

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

内部実装

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

/*protected virtual */Void SFZImageLabelControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawFocus(graphics, GetLocalBound());
    return;
}// SFZImageLabelControl::HandleRenderRequest //

参照

SFYLabelControl::DrawFocus | SFZImageLabelControl::SetImage | SFZImageLabelControl::SetHorizontalAlign | SFZImageLabelControl::SetVerticalAlign | SFYImageWidget | SFYImageWidget::HandleRenderRequest | SFXEvent | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | 状態

引数

戻り値

解説

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

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、イメージラベルのインスタンスを生成するためのコードです。

// イメージラベルのインスタンスを生成する
SFZImageLabelControlSmp label;
SFCError error;

if ((label = SFZImageLabelControl::NewInstance(&error)) != null) {
    // ...
}

解説

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

デフォルト値: SFYImageWidget::DEFAULT_HORIZONTAL

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

参照

SFZImageLabelControl::GetHorizontalAlign | SFZImageLabelControl::HorizontalEnum | SFYImageWidget::HorizontalEnum

戻り値

解説

この関数は、表示する画像を設定します。

画像オブジェクトを直接、あるいは、リソースファイルから読み込むように指定します。

画像サイズの X または Y 成分が 0 以下のときや画像にアニメーションが含まれるときは、SFERR_INVALID_PARAM が返ります。

参照

SFZImageLabelControl::GetImage | SFZImageLabelControl::SetHorizontalAlign | SFZImageLabelControl::SetVerticalAlign | SFBImage | BREW API IImage

解説

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

デフォルト値: SFYImageWidget::DEFAULT_VERTICAL

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

参照

SFZImageLabelControl::GetVerticalAlign | SFZImageLabelControl::VerticalEnum | SFYImageWidget::VerticalEnum

参照

SFYResponder::GetType | SFYResponder::SetType

参照

SFYImageWidget::HorizontalEnum

参照

SFYImageWidget::VerticalEnum