例 9.4. レスポンダツリーの作成

SFCError USRApplication::MakeTree(Void)
{
    SFZRootSmp root;
    SFZDialogSmp dialog;
    SFZTextButtonControlSmp button;
    SFZWindowSmp window;
    SFZTextLabelControlSmp label;
    SFCError error(SFERR_NO_ERROR);

    // SFYApplication クラスが内部に保持するルートを取得する
    if ((root = GetThis() != null) { 

        // ダイアログを生成する
        if ((dialog = SFZDialog::NewInstance(&error)) != null) {

            // ダイアログの親レスポンダをルートに設定する
            if ((error = dialog->SetParent(root)) == SFERR_NO_ERROR) {

                // テキストボタンコントロールを生成する
                if ((button = SFZTextButtonControl::NewInstance(&error)) != null) {

                    // テキストボタンコントロールの親レスポンダをダイアログに設定する
                    if ((error = button->SetParent(dialog)) == SFERR_NO_ERROR) {

                        // ...（省略）...
                    }
                }
            }
        }

        if (error == SFERR_NO_ERROR) {

            // ウィンドウを生成する
            if ((window = SFZWindow::NewInstance(&error)) != null) {

                // ウィンドウの親レスポンダをルートに設定する
                if ((error = window->SetParent(root)) == SFERR_NO_ERROR) {

                    // テキストラベルコントロールを生成する
                    if ((label = SFZTextLabelControl::NewInstance(&error)) != null) {

                        // テキストラベルコントロールの親レスポンダをウィンドウに設定する
                        if ((error = label->SetParent(window)) == SFERR_NO_ERROR) {

                            // ...（省略）...
                        }
                    }
                }
            }
        }
    }

    return error;
}

	注意
	SFYApplication クラスは、 内部にルート （SFZRoot）を保持しています。

例 9.5. ルートへの配信エンジンと描画エンジンの設定

SFCError USRApplication::MakeRoot(Void)
{
    SFYDistributer _distributer;  // 配信エンジン
    SFYRenderer _renderer;        // 描画エンジン
    SFZRootSmp _root;             // ルート
    SFCError error(SFERR_NO_ERROR);

    // ********************************************************************************
    // 以下の処理は SFYApplication クラスのコンストラクタ内で実装済みです。            
    // 一般のアプリ開発では、実装する必要はありません。                                
    // ********************************************************************************

    // 配信エンジンを初期化する
    error = _distributer.Initialize();
    if (error == SFERR_NO_ERROR) {

        // 描画エンジンを初期化する
        // ※デバイス画面領域（携帯電話の画面領域）がレスポンダ空間となる
        error = _renderer.Initialize();
        if (error == SFERR_NO_ERROR) {

            // ルートを生成する
            if ((_root = SFZRoot::NewInstance(&error)) != null) {

                // ルートに配信エンジンを設定する
                _root->SetDistributer(&distributer);

                // ルートに描画エンジンを設定する
                _root->SetRenderer(&renderer);

                // ルートの実領域を設定する
                // ※1. 親レスポンダが存在しないルートはレスポンダ空間内に実領域を設定する
                // ※2. _root->GetSuitableBound() はレスポンダ空間（＝デバイス画面領域）を返す
                // ※3. ルートの実領域はデバイス画面領域に設定される
                _root->SetRealBound(_root->GetSuitableBound());

                // ルートの状態を「可視＋活性＋操作可能＋フォーカス」にまとめて設定する
                _root->SetState(true, true, true, true);
            }
        }
    }

    return error;
}

	Tip
	SFYApplication クラスは、 内部にルート（SFZRoot）を保持しています。 SFYApplication::SFYApplication コンストラクタの処理により、 このルートには配信エンジンと描画エンジンが関連付けられます。 通常、このルートをアプリの GUI を構成する レスポンダツリーのルートレスポンダとして使用するので、 上記コードを実装する必要はありません。

参照: SFZRoot | SFYDistributer | SFYRenderer | SFYResponder::SetDistributer | SFYResponder::SetRenderer

例 9.6. 親レスポンダの設定

SFCError USRResponder::SetButtonParent(Void)
{
    SFZWindowSmp window;
    SFZTextButtonControlSmp button;
    SFCError error(SFERR_NO_ERROR);

    // ...（省略）...

    // button の親レスポンダを window に設定する
    if ((error = button->SetParent(window)) == SFERR_NO_ERROR) {

        // ...（省略）...
    }

    return error;
}

例 9.7. 親レスポンダのクリア

SFCError USRResponder::ClearButtonParent(Void)
{
    SFZTextButtonControlSmp button;
    SFCError error(SFERR_NO_ERROR);

    // ...（省略）...

    // SFYResponderSmp::EmptyInstance() を指定して親レスポンダをクリアする
    if ((error = button->SetParent(SFYResponderSmp::EmptyInstance())) == SFERR_NO_ERROR) {

        // ...（省略）...
    }

    return error;
}

	Tip
	親レスポンダをクリアするには、レスポンダの SFYResponder::SetParent 関数の引数に SFYResponderSmp::EmptyInstance() を指定します。 この操作によりレスポンダはレスポンダツリーから分離されます。

例 9.8. 子レスポンダの検索

SFYResponderSmp USRResponder::SearchChild(SInt32 index) const
{
    // 可視の子レスポンダの中で前面から index 番目の子レスポンダを検索する
    // この他にもいくつかの検索方法が利用可能
    return GetChildForward(index, true, false, false, false);
}

参照: SFYResponder::GetChildBack | SFYResponder::GetChildFront | SFYResponder::GetChildBackward | SFYResponder::GetChildForward | SFYResponder::GetChildCount

例 9.9. 姉妹レスポンダの検索

SFYResponderSmp USRResponder::SearchNextSister(Void) const
{
    SFYResponderSmp parent;
    SFYResponderSmp result;

    // 自レスポンダと同じ親レスポンダを持つすべての姉妹レスポンダの中で
    // 自レスポンダの次の姉妹レスポンダを検索する
    if ((parent = GetParent()) != null) {

        if ((index = GetNthBackward(false, false, false, false)) > 0) {

            result = parent->GetChildBackward(index - 1, false, false, false, false);
        }
    }

    return result;
}

参照: SFYResponder::GetChildBackward | SFYResponder::GetChildBack | SFYResponder::GetNthBackward | SFYResponder::ToNthBackward | SFYResponder::IsNthBackward | SFYResponder::ToBack | SFYResponder::IsBack | SFYResponder::GetChildForward | SFYResponder::GetChildFront | SFYResponder::GetNthForward | SFYResponder::ToNthForward | SFYResponder::IsNthForward | SFYResponder::ToFront | SFYResponder::IsFront

例 9.10. 最適な領域を取得してから実領域を設定する方法

Void USRResponder::SetButtonBound(Void)
{
    SFZTextButtonControlSmp button;

    // ...（省略）...

    // テキストボタンコントロールのテキストを設定する
    button->SetText("Text Button");

    // テキストボタンコントロールの最適な領域を取得してから実領域を設定する
    button->SetRealBound(button->GetSuitableBound().SetOrigin(10, 10));

    // ...（省略）...

    return;
}

	Tip
	SFYResponder::GetSuitableBound 関数を利用すれば、 テキストボタンコントロールに設定されたテキスト、フォントなどの情報から最適な領域を取得できます。 この関数で得られる領域の始点はデフォルトで (0, 0) なので、 必要に応じて SFXRectangle::SetOrigin / SFXRectangle::Offset 関数などを利用して最適な場所に配置します。

例 9.11. ローカル領域の描画

XANDLER_IMPLEMENT_VOIDRENDER(USRResponder, OnRenderRequest, invoker, reason, graphics)
{
    // ローカル領域全体を白色で塗り潰す
    graphics->FillRectangle(GetLocalBound(), SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00));

    return;
}

例 9.12. レスポンダ領域をスクロールして表示する方法

Void USRResponder::ScrollVirtualBound(Void)
{
    // 現在の仮想領域を取得し、原点の Y 座標を 10 ピクセル分減算することにより
    // 仮想領域を 10 ピクセル分上にスクロールする
    SetVirtualBound(SFXRectangle(GetVirtualBound()).SubY(10));

    return;
}

例 9.13. 透過属性の設定

Void USRResponder::SetTransparent(Void)
{

    // USRResponder の透過属性を true に設定する
    SetPropertyTransparent(true);

    return;
}

例 9.14. 状態の設定

Void USRResponder::SetState(Void)
{
    // 可視、活性、操作可能、フォーカスの各状態のフラグを true に設定し、
    // このレスポンダのフォーカス状態を ON にする
    SetState(true, true, true, true);
    // ※ 親レスポンダのフォーカス状態は ON であると仮定

    // 可視状態のフラグを false に設定する（このレスポンダを不可視状態 OFF にする）
    SetStateVisible(false);
    // ※ このとき、活性状態と操作可能状態のフラグ値は true のままだが、
    //    フォーカス状態フラグ値は自動的に true から false に変更されることに注意！
    //    そして、もし存在すれば、1 つだけ背面にある操作可能な姉妹レスポンダ（存在しない場合は、1 つだけ前面にある操作可能な姉妹レスポンダ）の
    //    フォーカス状態フラグが false から true に変更される（その姉妹レスポンダにフォーカスが移動する）

    // 可視状態のフラグを true に設定すると、操作可能状態 ON になるが、
    // フォーカス状態フラグ値は false のままなので、フォーカス状態は OFF
    SetStateVisible(true);

    // フォーカス状態を ON にするには、フォーカス状態フラグを true に設定する必要がある
    SetStateFocus(true);

    return;
}

例 9.15. トレーサへの配信規則の登録

SFCError USRResponder::MakeTracer(Void)
{

    // AVK_SOFT1 から AVK_SOFT4 までのキーイベントについて
    // 『処理順序：前面から背面、配信条件：有効状態 ON、重複条件：なし』
    // という配信規則をトレーサに登録する
    return RegisterTracer(
        SFXEventRange(SFEVT_KEY, SFEVT_KEY, AVK_SOFT1, AVK_SOFT4),
        SFYTracer::ORDER_FORWARD, SFYTracer::STATE_ALL, false
    );
}

例 9.16. ハンドラの登録

SFCError error;

1 つのハンドラを登録する
error = RegisterHandler(SFXEventRange(SFEVT_KEY, SFEVT_KEY, SFP16_BEGIN, SFP16_END), 
                        XANDLER_INTERNAL(OnKey)
        );


複数のハンドラをまとめて登録する
static SFXEventRange::AtomRecConst range[] = {
    {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
    {       SFEVT_KEY_PRESS,        SFEVT_KEY_PRESS,          SFP16_BEGIN,            SFP16_END},
    {     SFEVT_KEY_RELEASE,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END}
};
SFYHandler::RuleRec rule[lengthof(range)];

rule[0].spp = XANDLER_FUNCTION(OnKey);
rule[0].reference = this;
rule[1].spp = XANDLER_FUNCTION(OnKeyPress);
rule[1].reference = this;
rule[2].spp = XANDLER_FUNCTION(OnKeyRelease);
rule[2].reference = this;

error = RegisterHandler(atomic_cast(range), rule, lengthof(range));

例 9.17. タイプの設定

USRResponder::USRResponder(Void) static_throws
{
    if (static_try()) {

        // タイプは必ずこの場所で設定する
        // このようにすると親クラスのコンストラクタ内でエラーが発生した場合は
        // 親クラスのタイプが保持され、自クラスのコンストラクタ内でエラーが
        // 発生した場合は自クラスのタイプが設定されるようになる
        // 外部からこのクラスを利用する場合にエラーの発生個所を特定しやすくなる
        SetType(four_char_code('U', 'R', 'S', 'P'));

        // その他の初期化処理を記述する

        // ...（省略）...
    }
}

例 9.18. タイプの利用

Void USRResponder::PrintType(SFYResponderSmpConstRef param) const
{
    switch (param->GetType()) {

        case SFZWindow::CODE_TYPE:

            TRACE("It is a SFZWindow class.");
            break;

        case SFZDialog::CODE_TYPE:

            TRACE("It is a SFZDialog class.");
            break;

        case SFZTextButtonControl::CODE_TYPE:

            TRACE("It is a SFZTextButtonControl class.");
            break;

        default:

            TRACE("It is an unknown class.");
            break;
    }

    return;
}

例 9.19. ID の設定

SFCError USRResponder::MakeButton(Void)
{
    SFZTextButtonControlSmp button;
    SFCError error(SFERR_NO_ERROR);

    if ((button = SFZTextButtonControl::NewInstance(&error)) != null) {

        if ((error = button->SetParent(GetThis())) == SFERR_NO_ERROR) {

            // テキストボタンコントロールの ID を 100 に設定する
            button->SetID(100);

            // ...（省略）...
        }
    }

    return error;
}

例 9.20. ID を用いた検索

SFZTextButtonControlSmp USRResponder::GetButton(Void) const
{
    // ID を利用すればクラス変数を用いてレスポンダを管理しなくてもよい

    // ID が 100 であるテキストボタンコントロールを取得する
    return static_pointer_cast<SFZTextButtonControl>(GetChildFront(100));
}

例 9.21. テキストボタンコントロールへの識別番号の設定とその参照

SFZTextButtonControlSmp _button;
SInt32 i;

// 10 個のテキストボタンコントロールを作成し番号(リファレンス値)を設定する
for (i = 0; i < 10; ++i) {

    // テキストボタンコントロールを作成する
    if ((_button = SFZTextButtonControl::NewInstance(&error)) != null) {

        // テキストボタンコントロールの親 GetThis() に設定する
        error = _button->SetParent(GetThis());
        if (error == SFERR_NO_ERROR) {

            // テキストボタンコントロール識別用番号を設定する
            _button->SetReference(reinterpret_cast<VoidPtr>(i));
        }
    }
}

// ...（省略）...

// テキストボタンコントロール識別用番号を取得する
SInt32 number = reinterpret_cast<SInt32>(_button->GetReference());