前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3

9.13. ウィンドウ(基礎編)

ウィンドウは、 ルート[SFZRoot]内に配置されるように設計されたレスポンダです。

すべてのウィンドウは SFZWindow クラスを継承します。

SFZWindow は、 実領域よりも大きい 仮想領域を上下にスクロールしたり、 ウィンドウ内のレスポンダ間でフォーカスを移動させる機能を提供します。 このとき、スクロールはフォーカス移動と連動して行われます。

コントロールを利用するすべてのアプリは、コントロールを配置するためのコンテナとしてウィンドウを利用します。

[Tip] Tip
通常、コントロールを利用するしないにかかわらず、 ユーザーインターフェースの処理はアプリケーションクラスではなくウィンドウに記述します。

具象ウィンドウはアプリ開発ですぐに使うことができる部品であり、 抽象ウィンドウはカスタマイズされたユーザー定義ウィンドウを作成するための起点(基底クラス)となります。

表 9.11. 具象ウィンドウの種類

クラス名 解説
SFZWindow コントロールやコンテナなどを配置する汎用ウィンドウです。
[Important] 重要

すべての具象ウィンドウにおいて、 SFYResponder::SetParent 関数、 SFYResponder::SetState 関数、 SFYResponder::SetRealBound 関数の呼び出しは必須です。

その他の関数の呼び出しは省略可能です。

SFYResponder::SetFrame 関数を呼び出してフレームをウィンドウに装着する場合、 フレームの SFYResponder::SetRealBound 関数を呼び出すと、 ウィンドウの実領域がフレーム余白領域に合わせて自動的に設定されるので、SFYResponder::SetRealBound 関数の呼び出しは省略されます。

表 9.12. 抽象ウィンドウの種類

クラス名 解説
SFZWindow ウィンドウを表す抽象クラスです。

9.13.1. コントロールやコンテナなどを配置する汎用ウィンドウ[SFZWindow]

SFZWindow は、 各種コントロールやコンテナを配置するための汎用的なウィンドウとして機能します。

ウィンドウ内にコントロールやコンテナが配置されている場合、 SFYContainer::SetScrollDownKey / SFYContainer::SetScrollUpKey / SFYContainer::SetPageDownKey / SFYContainer::SetPageUpKey / SFYContainer::SetSnapDownKey / SFYContainer::SetSnapUpKey 関数で設定するスクロールキーを使用してウィンドウ内のレスポンダ間でフォーカスを移動できます。

仮想領域実領域よりも大きい場合は、 フォーカス移動と連動した、仮想領域の上下方向へのスクロール機能も利用できます。

図 9.32. 動作例

動作例

例 9.58. 宣言

SFMTYPEDEFCLASS(USRApplication)
class USRApplication: public SFYApplication {
    SFMSEALCOPY(USRApplication)
private:
    SFZWindowSmp _window;

    // ...(省略)...
private:
    SFCError Make(Void);
};

例 9.59. 実装

SFCError USRApplication::Make(Void)
{
    SFCError error(SFERR_NO_ERROR);

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

        // ウィンドウの親レスポンダを USRApplication に設定する
        error = _window->SetParent(GetThis());
        if (error == SFERR_NO_ERROR) {

            // ウィンドウの背景色を薄緑色に設定する
            // ※ウィンドウの背景は SFYWidget::OnRenderRequest ハンドラによって描画される
            _window->SetBackgroundColor(SFXRGBColor(0xCC, 0xFF, 0xCC, 0x00));

            // ウィンドウの実領域を設定する
            // ※ルートのローカル領域を (10, 10) だけ Deflate した領域に設定する
            _window->SetRealBound(GetLocalBound().Deflate(10, 10));

            // ウィンドウの状態を「可視+活性+操作可能+フォーカス」にまとめて設定する
            _window->SetState(true, true, true, true);

            // ウィンドウを最前面に移動する
            _window->ToFront();
        }
    }

    return error;
}

図 9.33. 枠とタイトルの付いたウィンドウ[SFZWindow]


枠とタイトルの付いたウィンドウ[SFZWindow]

ウィンドウ[SFZWindow]に枠線やタイトルを付けるためのサンプルコードは SFZWindow を参照してください。

9.13.2. ウィンドウを表す抽象クラスとしての汎用ウィンドウ[SFZWindow]

SFZWindow は、 各種ウィンドウを実装するための起点(基底クラス)となります。

SFZWindow は、 実領域よりも大きい 仮想領域を上下にスクロールしたり、 ウィンドウ内のレスポンダ間でフォーカスを移動させる機能を提供します。 このとき、スクロールはフォーカス移動と連動して行われます。

ウィンドウ内にコントロールやコンテナが配置されている場合、 SFYContainer::SetScrollDownKey / SFYContainer::SetScrollUpKey / SFYContainer::SetPageDownKey / SFYContainer::SetPageUpKey / SFYContainer::SetSnapDownKey / SFYContainer::SetSnapUpKey 関数で設定するスクロールキーを使用してウィンドウ内のレスポンダ間でフォーカスを移動できます。

SFZWindow を継承するレスポンダでは、 SFYContainer::SFYContainer / SFYWidget::SFYWidget コンストラクタで登録されたハンドラの処理により、 下記のイベントを受信すると、対応する下記の仮想関数(ハンドラ)が最初に呼び出されます。 その後、開発者がレスポンダに登録したハンドラが呼び出されることになります。

[Note] 注意

ハンドラの詳細については、 SFYContainer::SFYContainer / SFYWidget::SFYWidget コンストラクタの解説を参照してください。

表 9.13. イベント、仮想関数(ハンドラ)とデフォルト動作

イベント 仮想関数(ハンドラ) デフォルトの動作 オーバーライド
SFYContainer::SetScrollUpKey で設定された ScrollUp キーの SFEVT_KEY イベント SFYContainer::HandleScrollUpKey 仮想領域を上方向にスクロールする※1 任意
SFYContainer::SetScrollDownKey で設定された ScrollDown キーの SFEVT_KEY イベント SFYContainer::HandleScrollDownKey 仮想領域を下方向にスクロールする※2 任意
SFYContainer::SetPageUpKey で設定された PageUp キーの SFEVT_KEY イベント SFYContainer::HandlePageUpKey 仮想領域を上方向に 1 ページ分スクロールする※3 任意
SFYContainer::SetPageDownKey で設定された PageDown キーの SFEVT_KEY イベント SFYContainer::HandlePageDownKey 仮想領域を下方向に 1 ページ分スクロールする※4 任意
SFYContainer::SetSnapUpKey で設定された SnapUp キーの SFEVT_KEY イベント SFYContainer::HandleSnapUpKey 仮想領域を上端までスクロールする※5 任意
SFYContainer::SetSnapDownKey で設定された SnapDown キーの SFEVT_KEY イベント SFYContainer::HandleSnapDownKey 仮想領域を下端までスクロールする※6 任意
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント SFYWidget::HandleBoundRequest 推奨
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント SFYWidget::HandleBoundOptimize 推奨
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベント SFYWidget::HandleBoundReal 任意
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント SFYWidget::HandleBoundVirtual 任意
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) イベント SFYWidget::HandleBoundGlobal 非推奨[廃止予定]
(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) イベント SFYWidget::HandleRenderRequest 任意

※デフォルトの動作にある "−" は何も実装していないことを表す。

[Note] 注釈

※1.SFYContainer::ScrollUp 関数を実行します。

※2.SFYContainer::ScrollDown 関数を実行します。

※3.SFYContainer::PageUp 関数を実行します。

※4.SFYContainer::PageDown 関数を実行します。

※5.SFYContainer::SnapUp 関数を実行します。

※6.SFYContainer::SnapDown 関数を実行します。

ユーザー定義ウィンドウを作成するときに最低限必要なコードを示します。

例 9.60. 宣言

SFMTYPEDEFRESPONDER(USRWindow)
class USRWindow: public SFZWindow {
    SFMSEALRESPONDER(USRWindow)
    SFMRESPONDERINSTANTIATEFOUR(USRWindow, SFZWindow, SFYContainer, SFYWidget, SFYResponder)
public:

    // レスポンダのタイプを定義する
    // 小文字と記号のみからなるタイプは予約されているので使えない
    enum CodeEnum {
        CODE_TYPE = four_char_code('U', 'W', 'N', 'D')
    };
    SFMTYPEDEFTYPE(CodeEnum)

public:
    static USRWindowSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit USRWindow(Void) static_throws;
    virtual ~USRWindow(Void);

    // 親クラスで定義されている仮想関数のうち、実装が推奨される仮想関数
    virtual Void HandleBoundRequest(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundOptimize(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundReal(Void);
    virtual Void HandleBoundVirtual(Void);
    virtual Void HandleRenderRequest(SFXGraphicsPtr graphics) const;
};

例 9.61. 実装

// コンストラクタ
USRWindow::USRWindow(Void) static_throws
{
    if (static_try()) {

        // レスポンダのタイプを設定する
        SetType(CODE_TYPE);

        // 初期化処理を記述する
    }
}

// デストラクタ
USRWindow::~USRWindow(Void)
{
    // 終了処理を記述する
}

// スマートポインタで管理されるインスタンスを生成する関数
USRWindowSmp USRWindow::NewInstance(SFCErrorPtr exception)
{
    return static_pointer_cast<USRWindow>(Factory(::new USRWindow, exception));
}

Void USRWindow::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    // ウィンドウに最適な大きさを計算して rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRWindow::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    // ウィンドウに最適な大きさを rectangle パラメータ内の大きさに
    // 収まるように計算し、rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRWindow::HandleBoundReal(Void)
{
    // 実領域が変更された場合に再計算が必要なものがあれば、ここに記述する

    return;
}

Void USRWindow::HandleBoundVirtual(Void)
{
    // 仮想領域が変更された場合に再計算が必要なものがあれば、ここに記述する

    return;
}

Void USRWindow::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    // ウィンドウを描画する

    return;
}