前のページ次のページ上に戻るホーム BREW C++ ライブラリ & GUI フレームワーク & XML ミドルウェア : SophiaFramework UNIVERSE 5.0

9.8. コンテナ(基礎編)

コンテナは、コントロール内及び他のコンテナ(コンテナ・ウィンドウ・ダイアログ)内に配置されるように設計されたレスポンダです。

すべてのコンテナは SFYContainer クラスを継承します。

実領域よりも大きな仮想領域が設定されている場合、自動的なスクロール機能とフォーカスの移動機能を提供します。

具象コンテナはアプレット開発ですぐに使うことができる部品であり、 抽象コンテナはカスタマイズされたユーザー定義コンテナを作成するための起点となります。

[Caution] 注意
ウィンドウやダイアログはコンテナの一種ですが、これらのクラスはルート内に配置される点が他のコンテナと異なります。

表 9.8. 具象コンテナの種類

クラス名 解説
SFZContainer コントロールやコンテナなどを配置する汎用コンテナです。
SFZWindow コントロールやコンテナなどを配置する汎用ウィンドウです。
SFZDialog コントロールやコンテナなどを配置する汎用ダイアログです。
SFZTabPage SFZTabControlに追加できる具象コンテナです。

表 9.9. 抽象コンテナの種類

クラス名 解説
SFYContainer コンテナを表す抽象クラスです。
SFZWindow ウィンドウを表す抽象クラスです。
SFZDialog ダイアログを表す抽象クラスです。
[Important] 重要

すべてのコンテナにおいて、SFYResponder::SetParent 関数、SFYResponder::SetState 関数、SFYResponder::SetRealBound 関数の呼び出しは必須です。

その他の関数は必要に応じて呼び出します。省略することも可能です。

9.8.1. コントロールやコンテナなどを配置する汎用コンテナ [SFZContainer]

図 9.28. 動作例

動作例

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

コントロールやコンテナが配置されている場合、上下キーでフォーカスの移動機能を利用できます。

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

例 9.40. 宣言

SFMTYPEDEFRESPONDER(USRWindow)
class USRWindow : public SFZWindow {
    SFMSEALRESPONDER(USRWindow)
    SFMRESPONDERINSTANTIATEFOUR(USRWindow, SFZWindow, SFYContainer, SFYWidget, SFYResponder)
private:
    SFZContainerSmp _container;

    ...
private:
    SFCError Make(Void);
};

例 9.41. 実装

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

    if ((_container = SFZContainer::NewInstance(&error)) != null) {

        // コンテナの親レスポンダを USRWindow に設定する
        error = _container->SetParent(GetThis());
        if (error == SFERR_NO_ERROR) {

            // コンテナの背景色を薄赤色に設定する
            // 背景色の描画は SFYWidget クラスが自動的に行ってくれる
            _container->SetBackgroundColor(SFXRGBColor(0xFF, 0xCC, 0xCC, 0x00));

            // コンテナの実領域を設定する
            _container->SetRealBound(_container->GetSuitableBound(GetLocalBound().Deflate(10, 10)));

            // コンテナの状態を「可視+活性+操作可能+フォーカス」にまとめて設定する
            _container->SetState(true, true, true, true);
        }
    }
    return error;
}

9.8.2. コンテナを表す抽象クラス[SFYContainer]

SFYContainer クラスは、 各種コンテナを実装するための起点となります。

このクラスは、フォーカスの移動機能や仮想領域のスクロール機能と操作キーの管理を実装し、いくつかの仮想関数のデフォルトの動作も実装します。

表 9.10. 仮想関数名とデフォルトの動作

仮想関数名 デフォルトの動作 オーバーライド
SFYContainer::HandleScrollUpKey 仮想領域を上方向にスクロール※1 任意
SFYContainer::HandleScrollDownKey 仮想領域を下方向にスクロール※2 任意
SFYContainer::HandlePageUpKey 仮想領域を上方向に1ページ分スクロール※3 任意
SFYContainer::HandlePageDownKey 仮想領域を下方向に1ページ分スクロール※4 任意
SFYContainer::HandleSnapUpKey 仮想領域を上端までスクロール※5 任意
SFYContainer::HandleSnapDownKey 仮想領域を下端までスクロール※6 任意
SFYWidget::HandleBoundRequest 推奨
SFYWidget::HandleBoundOptimize 推奨
SFYWidget::HandleBoundReal 任意
SFYWidget::HandleBoundVirtual 任意
SFYWidget::HandleBoundGlobal 任意
SFYWidget::HandleRenderRequest 任意
[Note] 注釈

※1.ScrollUp() を実行します。

※2.ScrollDown() を実行します。

※3.PageUp() を実行します。

※4.PageDown() を実行します。

※5.SnapUp() を実行します。

※6.SnapDown() を実行します。

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

例 9.42. 宣言

SFMTYPEDEFRESPONDER(USRContainer)
class USRContainer : public SFYContainer {
    SFMSEALRESPONDER(USRContainer)
    SFMRESPONDERINSTANTIATETHREE(USRContainer, SFYContainer, SFYWidget, SFYResponder)
public:

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

public:
    static USRContainerSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit USRContainer(Void) static_throws;
    virtual ~USRContainer(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.43. 実装

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

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

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

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

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

Void USRContainer::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    // コンテナに最適な大きさを計算して rectangle パラメータに設定する
    // 原点は変更せず、サイズだけを設定することを推奨

    return;
}

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

    return;
}

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

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

Void USRContainer::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    // コンテナを描画する
    return;
}