継承図

協調図

解説

■ SFYFrame とは

SFYFrame は、フレームの最上位抽象クラスです。

■ フレームの装着

フレームは、SFYResponder::SetFrame 関数を使用してレスポンダに装着します。

	注意
	このとき、レスポンダに装着したフレームをアタッチメントフレーム、 フレームを装着されたレスポンダをコンテントレスポンダと呼びます。

以下にあるように、 コンテントレスポンダを操作するだけで、 それに付随するアタッチメントフレームの処理も自動的に行われます。

コンテントレスポンダの実領域を設定すれば、 アタッチメントフレームの実領域も自動的に計算されて設定されます。

コンテントレスポンダを最前面に移動すれば、 アタッチメントフレームも自動的に最前面に移動します。

コンテントレスポンダを終了すると、 アタッチメントフレームはコンテントレスポンダから切り離されて見えなくなり、 他のレスポンダに装着可能な通常のフレームに戻ります。

状態と配信エンジンの観点では、 アタッチメントフレームはコンテントレスポンダの子レスポンダとして振舞います。

詳細については、フレームを参照してください。

	警告
	SophiaFramework UNIVERSE 5.1.8 までは、 フレームをレスポンダの親にしてフレームを装着していました。 現在もこの方法を利用できますが、 フレーム処理に関するコード量が増えたり、 フレームを透過的に扱えなかったりするので推奨されません。

■ 余白イベント[SFEVT_RESPONDER_MARGIN]について

SFYFrame を継承する具象フレームでは、 余白イベント[SFEVT_RESPONDER_MARGIN]を受信すると、 フレーム余白領域を計算するハンドラが登録されています。

具体的には、 SFYResponder::GetSuitableMargin 関数は自レスポンダである、 具象フレームに余白イベントを送信します。 具象フレームは、余白イベントを受信すると、 フレーム余白領域を計算する HandleMarginRequest() 仮想関数を呼び出します。

つまり、SFYFrame を継承する具象フレームのフレーム余白領域は、 SFYResponder::GetSuitableMargin 関数を呼び出すことで取得できます。

参照

SFYResponder::SetFrame | SFYResponder::SetRealBound | SFYResponder::ToFront | SFYPlainFrame | SFYFlatFrame | SFYBevelFrame | SFZPlainFrame | SFZFlatFrame | SFZBevelFrame | SFZTitlePlainFrame | SFZTitleFlatFrame | SFZTitleBevelFrame | 余白イベント[SFEVT_RESPONDER_MARGIN] | SFYResponder::GetSuitableBound | SFYResponder::GetSuitableMargin | フレーム | 状態

メンバ

解説

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

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

内部実装

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

/*protected */SFYFrame::SFYFrame(Void) static_throws
{
    static SFXEventRange::AtomRecConst          trange[] = {
        {SFEVT_RESPONDER_MARGIN, SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, SFP16_MARGIN_REQUEST}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnMarginRequest);
        trule[0].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
    }
}// SFYFrame::SFYFrame //

/*private */XANDLER_IMPLEMENT_VOIDMARGIN(SFYFrame, OnMarginRequest, invoker, reason, margin)
{
    unused(invoker);
    unused(reason);
    HandleMarginRequest(margin);
    return;
}// XANDLER_IMPLEMENT_VOIDMARGIN(SFYFrame, OnMarginRequest) //

参照

SFYResponder::SetType | SFYFrame::CodeEnum | SFYFrame::HandleMarginRequest | SFXEvent | タイプ | 余白イベント[SFEVT_RESPONDER_MARGIN]

解説

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

内部実装

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

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

解説

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

参照

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

解説

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

フレーム余白領域を計算する場合は、この関数をオーバーライドします。 自レスポンダの外枠やタイトルは、このフレーム余白領域に描画されます。

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

	余白イベント[(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) イベント]
	SFYResponder::GetSuitableMargin 関数は、 余白イベント [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, margin)] をレスポンダに送信します。 SFYFrame クラスを継承するレスポンダが余白イベントを受信すると、 SFYFrame::SFYFrame コンストラクタで最初に登録した余白イベント専用ハンドラの処理により、 SFYFrame::HandleMarginRequest 仮想関数が呼び出されます。 ※ 余白イベントの P32 パラメータ margin には SFXMargin::ZeroInstance() が初期設定されています。

	(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) イベント受信時の余白領域計算
	SFYFrame::HandleMarginRequest 仮想関数をオーバーライドする以外に、 余白イベント専用ハンドラを定義・実装し レスポンダに登録して行うことも可能です。 フレーム余白領域の計算は、最初に SFYFrame::HandleMarginRequest 仮想関数を実行し、 次に余白イベント専用ハンドラを登録した順に実行して行われます。 余白イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYFrame::HandleMarginRequest 仮想関数をオーバーライドして処理を記述します。

内部実装

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

/*protected virtual */Void SFYFrame::HandleMarginRequest(SFXMarginPtr /*margin*/) const
{
    return;
}// SFYFrame::HandleMarginRequest //

参照

SFYResponder::GetSuitableMargin | SFXMargin | SFXEvent | 余白イベント[SFEVT_RESPONDER_MARGIN] | 余白イベント専用ハンドラ[XANDLER_DECLARE_VOIDMARGIN]

参照

SFYResponder::GetType | SFYResponder::SetType