継承図

協調図

解説

■ 仕様と使い方

ルート（SFZRoot）は、 ルートレスポンダ用に設計されたレスポンダです。

レスポンダツリーにイベントを配信したり、 レスポンダツリーを描画するには、そのルートレスポンダに初期化された配信エンジン （SFYDistributer）と描画エンジン （SFYRenderer）を関連付ける必要があります。

SFYApplication クラスは、内部にデフォルトでルート（SFZRoot）を保持します。

このルートは、 SFYApplication::SFYApplication コンストラクタの処理により、 初期化された配信エンジンと描画エンジンが関連付けられています。 一般の SFY アプリ開発では、 このルートを GUI として使用するレスポンダツリーのルートレスポンダとして使用します

	注意
	1 つのアプリケーションクラスが複数個のルートを保持することも可能ですが、 通常、SFYApplication クラスが内部で保持するデフォルトのルートだけで十分です。 デフォルトのルートを使用する場合は、 配信エンジンと描画エンジンの初期化やルートレスポンダへの関連付けは不要になります。

具象ルートはアプリ開発ですぐに使うことができる部品です。

	重要
	すべての具象ルートにおいて、 SFYResponder::SetDistributer 関数、 SFYResponder::SetRenderer 関数、 SFYResponder::SetState 関数、 SFYResponder::SetRealBound 関数の呼び出しは必須です。 その他の関数の呼び出しは省略可能です。

SFZRoot は、 ウィンドウ、 ダイアログや メニューを配置するための汎用的なルートとして機能します。

SFY アプリの開発では、 GUI として使用するレスポンダツリーのルートレスポンダとして SFYApplication クラスが内部で保持する、 デフォルトのルート（SFZRoot）を利用するので、 新たに別のルートを作成する必要はありません。

	注意
	SFC アプリの開発で SFY レスポンダを利用する場合や、 2 つ以上のレスポンダツリーを使用する場合は、 ルートを作成する必要がありますが、このようなケースはほとんどありません。

図 425. 動作例

参照

レスポンダツリー | ルート（基礎編） | ウィンドウ（基礎編） | ダイアログ（基礎編） | メニュー（基礎編） | フレーム | SFYApplication

メンバ

解説

このレスポンダのタイプを "root" に設定します。

内部実装

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

/*protected */SFZRoot::SFZRoot(Void) static_throws
{
    if (static_try()) {
        SetType(CODE_TYPE);
    }
}// SFZRoot::SFZRoot //

参照

SFYResponder::SetType | SFZRoot::CodeEnum | タイプ

解説

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

内部実装

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

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

解説

この関数は、 領域イベント [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 SFZRoot::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    SFYRendererPtr    renderer;
    SFYResponderSmp   parent;

    if ((parent = GetParent()) != null) {
        rectangle->SetSize(parent->GetVirtualBound().GetSize());
    }
    else if ((renderer = GetRenderer()) != null) {
        rectangle->SetSize(renderer->GetGlobalBound().GetSize());
    }
    else {
        rectangle->SetSize(SFXGraphics::GetDeviceSize());
    }
    return;
}// SFZRoot::HandleBoundRequest //

参照

SFYRenderer::Initialize | 親レスポンダ | 仮想領域 | 描画エンジン | レスポンダ空間 | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

引数

戻り値

解説

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

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

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

使用例

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

// ルートのインスタンスを生成する
SFZRootSmp _root;
SFCError error;

if ((_root = SFZRoot::NewInstance(&error)) != null) {
    // ...
}

参照

SFYResponder::GetType | SFYResponder::SetType