継承図

協調図

解説

■ 仕様と使い方

SFYImageWidget は、画像の描画に必要な機能だけが実装されているレスポンダです。 通常、画像を扱うレスポンダで内部的に保持する子レスポンダとして使います。

たとえば、SFYImageWidget は SFZImageBoxControl、 SFZImageButtonControl、 SFZImageLabelControl などの画像を使用するコントロールの子レスポンダとして内部的に利用されます。

これらの画像を使用するコントロールでは、 画像の設定や配置などの処理はすべて SFYImageWidget クラスに委譲して行われます。

画像を描画する必要がある場合、SFYImageWidget クラスを利用すれば、 その処理を記述することなく簡単に実装することが可能です。 また、SFYImageWidget クラスに画像描画処理が一元化されるので保守性の優れたコードになります。

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

	使用するときの状態の値
	このクラスを利用するときは、 可視状態:ON、活性状態:ON、操作可能状態:OFF、フォーカス状態:OFF の状態に設定します。 通常、このクラスはキーイベントに応答しないクラスとして使用します。

	仮想領域
	SFYImageWidget では、 画像全体を画面上に表示するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [画像の横幅] ＞ [実領域の横幅] または [仮想領域の縦幅] ≧ [画像の縦幅] ＞ [実領域の縦幅] の関係が成り立つとき、画像全体を画面に表示できません。

参照

SFZImageBoxControl | SFZImageButtonControl | SFZImageLabelControl | SFZMessageDialog | SFZQuestionDialog | 仮想領域 | 実領域 | ローカル領域

メンバ

解説

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

内部実装

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

/*protected */SFYImageWidget::SFYImageWidget(Void) static_throws
{
    if (static_try()) {
        SetType(CODE_TYPE);
        static_throw(Measure(_image));
        if (static_try()) {
            SetPropertyTransparent(true);
            _align.horizontal = DEFAULT_HORIZONTAL;
            _align.vertical = DEFAULT_VERTICAL;
            Relocate();
        }
    }
}// SFYImageWidget::SFYImageWidget //

/*private */SFCError SFYImageWidget::Measure(SFBImageSmpConstRef param)
{
    AEEImageInfo                                info;
    SFCError                                    error(SFERR_NO_ERROR);

    if (param != null) {
        param->GetInfo(&info);
        if (info.cx > 0 && info.cy > 0) {
            if (!info.bAnimated) {
                _bound.SetSize(info.cx, info.cy);
            }
            else {
                error = SFERR_INVALID_PARAM;
            }
        }
        else {
            error = SFERR_INVALID_PARAM;
        }
    }
    else {
        _bound.SetSize(SFXSize::ZeroInstance());
    }
    return error;
}// SFYImageWidget::Measure //

/*private */Void SFYImageWidget::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    _bound.SetOrigin(lx.GetOrigin());
    switch (_align.horizontal) {
        case HORIZONTAL_LEFT:
            _bound.AddX(0);
            break;
        case HORIZONTAL_RIGHT:
            _bound.AddX(lx.GetWidth() - _bound.GetWidth());
            break;
        case HORIZONTAL_CENTER:
        default:
            _bound.AddX((lx.GetWidth() - _bound.GetWidth()) / 2);
            break;
    }
    switch (_align.vertical) {
        case VERTICAL_TOP:
            _bound.AddY(0);
            break;
        case VERTICAL_BOTTOM:
            _bound.AddY(lx.GetHeight() - _bound.GetHeight());
            break;
        case VERTICAL_MIDDLE:
        default:
            _bound.AddY((lx.GetHeight() - _bound.GetHeight()) / 2);
            break;
    }
    return;
}// SFYImageWidget::Relocate //

参照

SFYResponder::SetType | SFYResponder::SetPropertyTransparent | SFYImageWidget::CodeEnum | SFYImageWidget::SetHorizontalAlign | SFYImageWidget::SetVerticalAlign | SFYImageWidget::HorizontalEnum | SFYImageWidget::VerticalEnum | タイプ | 属性

解説

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

内部実装

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

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

解説

この関数は、イメージを描画します。

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

内部実装

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

/*protected */Void SFYImageWidget::DrawImage(SFXGraphicsPtr graphics, SFXGridConstRef grid) const
{
    if (_image != null) {
        graphics->DrawImage(_image, grid);
    }
    return;
}// SFYImageWidget::DrawImage //

参照

SFYImageWidget::HandleRenderRequest

戻り値

水平アライメントの値。

解説

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

参照

SFYImageWidget::SetHorizontalAlign | SFYImageWidget::HorizontalEnum

戻り値

画像。

解説

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

参照

SFYImageWidget::SetImage | SFYImageWidget::GetImageSize

戻り値

イメージの始点。

解説

この関数は、イメージの始点を取得します。

戻り値

イメージの大きさ。

解説

この関数は、イメージの大きさを取得します。

参照

SFYImageWidget::SetImage | SFYImageWidget::GetImage

戻り値

垂直アライメントの値。

解説

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

参照

SFYImageWidget::SetVerticalAlign | SFYImageWidget::VerticalEnum

解説

この関数は、 領域イベント [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 SFYImageWidget::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    if (rectangle->GetWidth() > _bound.GetWidth()) {
        rectangle->SetWidth(_bound.GetWidth());
    }
    if (rectangle->GetHeight() > _bound.GetHeight()) {
        rectangle->SetHeight(_bound.GetHeight());
    }
    return;
}// SFYImageWidget::HandleBoundOptimize //

参照

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

解説

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

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

デフォルトの実装は、仮想領域を実領域に一致させます。

	仮想領域
	SFYImageWidget クラスでは、 画像全体を画面上に表示するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [画像の横幅] ＞ [実領域の横幅] または [仮想領域の縦幅] ≧ [画像の縦幅] ＞ [実領域の縦幅] の関係が成り立つとき、画像全体を画面に表示できません。

	領域イベント[(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 SFYImageWidget::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYImageWidget::HandleBoundReal //

参照

SFYResponder::SetRealBound | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 仮想領域 | 実領域 | ローカル領域

解説

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

レスポンダの最適な領域を計算します。

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

デフォルトの実装は、SFYImageWidget::GetImageSize 関数で取得できる画像サイズ （SFYImageWidget::SetImage 関数で設定された画像サイズ）を返します。

	領域イベント[(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 SFYImageWidget::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->SetSize(_bound.GetSize());
    return;
}// SFYImageWidget::HandleBoundRequest //

参照

SFYResponder::GetSuitableBound | SFYImageWidget::SetImage | SFYImageWidget::GetImageSize | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

デフォルトの実装は、 仮想領域の変更に伴い水平方向と垂直方向のアライメントの設定に従って画像を再配置します。

画像の配置は、 SFYImageWidget::SetHorizontalAlign 関数で水平方向のアライメント、 SFYImageWidget::SetVerticalAlign 関数で垂直方向のアライメントを設定します。 デフォルトの設定では、水平方向、垂直方向ともに中央揃えのアライメントになります。

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

内部実装

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

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

/*private */Void SFYImageWidget::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    _bound.SetOrigin(lx.GetOrigin());
    switch (_align.horizontal) {
        case HORIZONTAL_LEFT:
            _bound.AddX(0);
            break;
        case HORIZONTAL_RIGHT:
            _bound.AddX(lx.GetWidth() - _bound.GetWidth());
            break;
        case HORIZONTAL_CENTER:
        default:
            _bound.AddX((lx.GetWidth() - _bound.GetWidth()) / 2);
            break;
    }
    switch (_align.vertical) {
        case VERTICAL_TOP:
            _bound.AddY(0);
            break;
        case VERTICAL_BOTTOM:
            _bound.AddY(lx.GetHeight() - _bound.GetHeight());
            break;
        case VERTICAL_MIDDLE:
        default:
            _bound.AddY((lx.GetHeight() - _bound.GetHeight()) / 2);
            break;
    }
    return;
}// SFYImageWidget::Relocate //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] | 仮想領域 | 実領域 | ローカル領域

解説

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

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

デフォルトの実装は、 SFYImageWidget::SetImage 関数で設定した画像を描画します。

仮想領域内での画像の配置は、SFYImageWidget::SetHorizontalAlign 関数と SFYImageWidget::SetVerticalAlign 関数で設定します。

	仮想領域
	SFYImageWidget クラスでは、 画像全体を画面上に表示するために、 仮想領域を実領域に合わせて使用することが推奨されます。 たとえば、 [仮想領域の横幅] ≧ [画像の横幅] ＞ [実領域の横幅] または [仮想領域の縦幅] ≧ [画像の縦幅] ＞ [実領域の縦幅] の関係が成り立つとき、画像全体を画面に表示できません。

レスポンダの描画手順

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

内部実装

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

/*protected virtual */Void SFYImageWidget::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawImage(graphics, _bound.GetOrigin());
    return;
}// SFYImageWidget::HandleRenderRequest //

参照

SFYImageWidget::SetImage | SFYImageWidget::DrawImage | SFYImageWidget::SetHorizontalAlign | SFYImageWidget::SetVerticalAlign | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | 仮想領域 | 実領域 | ローカル領域

引数

戻り値

解説

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

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

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

使用例

以下は、イメージウィジェットのインスタンスを生成するためのコードです。

// イメージウィジェットのインスタンスを生成する
SFCError error;
SFYImageWidgetSmp _imagewidget;

if ((_imagewidget = SFYImageWidget::NewInstance(&error)) != null) {
    // ...
}

解説

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

デフォルト値: SFYImageWidget::DEFAULT_HORIZONTAL

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

参照

SFYImageWidget::GetHorizontalAlign | SFYImageWidget::HorizontalEnum

戻り値

解説

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

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

画像サイズが不正なものやアニメーションビットマップなどは利用できません。

参照

SFYImageWidget::GetImage | SFYImageWidget::GetImageSize | SFBImage | BREW API IImage

解説

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

デフォルト値: SFYImageWidget::DEFAULT_VERTICAL

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

参照

SFYImageWidget::GetVerticalAlign | SFYImageWidget::VerticalEnum

参照

SFYResponder::GetType | SFYResponder::SetType

解説

水平方向のアライメントについて：

参照

SFYImageWidget::SetHorizontalAlign | ローカル領域

解説

垂直方向のアライメントについて：

参照

SFYImageWidget::SetVerticalAlign | ローカル領域