継承図

協調図

解説

■ 仕様と使い方

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

SFYContainer クラスは、 フォーカス移動、仮想領域のスクロールとスクロールキーの管理を提供するコンテナの抽象クラスです。

SFYContainer クラスは各種コンテナを実装するための起点（基底クラス）となります （複雑な機能を持ったコンテナは、SFYContainer クラスを継承して実装します）。

たとえば、 SFZContainer、 SFZWindow、 SFZDialog は SFYContainer クラスを継承して実装しています。

コントロールやコンテナが配置されている場合、 SFYContainer::SetScrollDownKey / SFYContainer::SetScrollUpKey / SFYContainer::SetPageDownKey / SFYContainer::SetPageUpKey / SFYContainer::SetSnapDownKey / SFYContainer::SetSnapUpKey 関数で設定するスクロールキーでフォーカスの移動機能を利用できます。

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

■ イベントとハンドラ

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

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

	Tip
	ハンドラを登録する手間を省略できるので、 通常、これらのイベント処理は仮想関数をオーバーライドして記述します。

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

	注釈
	※1. SFYContainer::ScrollUp 関数を実行します。 ※2. SFYContainer::ScrollDown 関数を実行します。 ※3. SFYContainer::PageUp 関数を実行します。 ※4. SFYContainer::PageDown 関数を実行します。 ※5. SFYContainer::SnapUp 関数を実行します。 ※6. SFYContainer::SnapDown 関数を実行します。

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

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;
};

// コンストラクタ
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 パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

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

    return;
}

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

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

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

参照

SFYContainer::SFYContainer | SFYWidget::SFYWidget | SFZContainer | SFZWindow | SFZDialog | SFZMessageDialog | SFZQuestionDialog | SFZTabPage | 仮想領域 | 実領域 | ローカル領域 | SFYContainer::SetScrollDownKey | SFYContainer::SetScrollUpKey | SFYContainer::SetPageDownKey | SFYContainer::SetPageUpKey | SFYContainer::SetSnapDownKey | SFYContainer::SetSnapUpKey | キーイベント[SFEVT_KEY] | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER] | コンテナを表す抽象クラス[SFYContainer]

メンバ

解説

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

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

内部実装

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

/*protected */SFYContainer::SFYContainer(Void) static_throws
{
    static SFXEventRange::AtomRecConst          trange[] = {
        #if TARGET_VERSION_GE(3, 0, 0)
        {       SFEVT_KEY_PRESS,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END},
        #else
        {       SFEVT_KEY_PRESS,         SFEVT_KEY_HELD,          SFP16_BEGIN,            SFP16_END},
        #endif
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_FOCUS,  SFEVT_RESPONDER_FOCUS,  SFP16_FOCUS_FORWARD,  SFP16_FOCUS_FORWARD},
        { SFEVT_RESPONDER_FOCUS,  SFEVT_RESPONDER_FOCUS, SFP16_FOCUS_BACKWARD, SFP16_FOCUS_BACKWARD}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnShield);
        trule[0].reference = this;
        trule[1].spp = XANDLER_FUNCTION(OnKey);
        trule[1].reference = this;
        trule[2].spp = XANDLER_FUNCTION(OnFocusForward);
        trule[2].reference = this;
        trule[3].spp = XANDLER_FUNCTION(OnFocusBackward);
        trule[3].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            _step = DEFAULT_STEP;
            _repeat = false;
            _key.sup = AVK_UP;
            _key.sdown = AVK_DOWN;
            _key.pup = AVK_TXPGUP;
            _key.pdown = AVK_TXPGDOWN;
            _key.nup = AVK_TXHOME;
            _key.ndown = AVK_TXEND;
        }
    }
}// SFYContainer::SFYContainer //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFYContainer, OnShield, invoker, event)
{
    unused(invoker);
    return (event.GetP16() == _key.sup || event.GetP16() == _key.sdown || event.GetP16() == _key.pup || event.GetP16() == _key.pdown || event.GetP16() == _key.nup || event.GetP16() == _key.ndown);
}// XANDLER_IMPLEMENT_BOOLEVENT(SFYContainer, OnShield) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFYContainer, OnKey, invoker, event)
{
    Bool                                        result(false);

    unused(invoker);
    if (event.GetP16() == _key.sup) {
        result = HandleScrollUpKey();
    }
    else if (event.GetP16() == _key.sdown) {
        result = HandleScrollDownKey();
    }
    else if (event.GetP16() == _key.pup) {
        result = HandlePageUpKey();
    }
    else if (event.GetP16() == _key.pdown) {
        result = HandlePageDownKey();
    }
    else if (event.GetP16() == _key.nup) {
        result = HandleSnapUpKey();
    }
    else if (event.GetP16() == _key.ndown) {
        result = HandleSnapDownKey();
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFYContainer, OnKey) //

/*private */XANDLER_IMPLEMENT_VOIDFOCUS(SFYContainer, OnFocusForward, invoker, reason, focus)
{
    unused(invoker);
    unused(reason);
    if (focus) {
        SnapUp();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDFOCUS(SFYContainer, OnFocusForward) //

/*private */XANDLER_IMPLEMENT_VOIDFOCUS(SFYContainer, OnFocusBackward, invoker, reason, focus)
{
    unused(invoker);
    unused(reason);
    if (focus) {
        SnapDown();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDFOCUS(SFYContainer, OnFocusBackward) //

参照

SFYResponder::SetType | SFYContainer::CodeEnum | SFYContainer::SetScrollStep | SFYContainer::DefaultEnum | SFYContainer::SetScrollRepeat | SFYContainer::SetScrollUpKey | SFYContainer::HandleScrollUpKey | SFYContainer::SetScrollDownKey | SFYContainer::HandleScrollDownKey | SFYContainer::SetPageUpKey | SFYContainer::HandlePageUpKey | SFYContainer::SetPageDownKey | SFYContainer::HandlePageDownKey | SFYContainer::SetSnapUpKey | SFYContainer::HandleSnapUpKey | SFYContainer::SetSnapDownKey | SFYContainer::HandleSnapDownKey | SFXEvent | タイプ | イベント | キーイベント[SFEVT_KEY]

解説

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

内部実装

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

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

戻り値

仮想領域を下方向に 1 ページ分スクロールする PageDown キー。

解説

この関数は、仮想領域を下方向に 1 ページ分スクロールする PageDown キーを取得します。

参照

SFYContainer::SetPageDownKey | AVKType

戻り値

仮想領域を上方向に 1 ページ分スクロールする PageUp キー。

解説

この関数は、仮想領域を上方向に 1 ページ分スクロールする PageUp キーを取得します。

参照

SFYContainer::SetPageUpKey | AVKType

戻り値

仮想領域を下方向にスクロールステップ分スクロールする ScrollDown キー。

解説

この関数は、仮想領域を下方向にスクロールステップ分スクロールする ScrollDown キーを取得します。

参照

SFYContainer::SetScrollDownKey | SFYContainer::SetScrollStep | AVKType

戻り値

解説

この関数は、連続スクロールフラグの値を取得します。

	注意
	連続スクロールフラグが true に設定されていると、 最上部または最下部にフォーカスがあるときに、さらに移動させようとすると それぞれ最下部または最上部にジャンプします。

参照

SFYContainer::SetScrollRepeat

戻り値

スクロールステップ。

解説

この関数は、 SFYContainer::SetScrollStep 関数によって設定されたスクロールステップを取得します。[単位 : ピクセル]

参照

SFYContainer::SetScrollStep

戻り値

仮想領域を上方向にスクロールステップ分スクロールする ScrollUp キー。

解説

この関数は、仮想領域を上方向にスクロールステップ分スクロールする ScrollUp キーを取得します。

参照

SFYContainer::SetScrollUpKey | SFYContainer::SetScrollStep | AVKType

戻り値

仮想領域を下端までスクロールする SnapDown キー。

解説

この関数は、仮想領域を下端までスクロールする SnapDown キーを取得します。

参照

SFYContainer::SetSnapDownKey | AVKType

戻り値

仮想領域を上端までスクロールする SnapUp キー。

解説

この関数は、仮想領域を上端までスクロールする SnapUp キーを取得します。

参照

SFYContainer::SetSnapUpKey | AVKType

解説

この関数は、SFYContainer::SetPageDownKey 関数で設定した PageDown キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、 SFYContainer::PageDown 関数を呼び出して、 仮想領域を１ページ分下にスクロールします。

内部実装

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

/*protected virtual */Bool SFYContainer::HandlePageDownKey(Void)
{
    return PageDown();
}// SFYContainer::HandlePageDownKey //

参照

SFYContainer::SetPageDownKey | SFYContainer::PageDown | キーイベント[SFEVT_KEY]

解説

この関数は、SFYContainer::SetPageUpKey 関数で設定した PageUp キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、 SFYContainer::PageUp 関数を呼び出して、 仮想領域を１ページ分上にスクロールします。

内部実装

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

/*protected virtual */Bool SFYContainer::HandlePageUpKey(Void)
{
    return PageUp();
}// SFYContainer::HandlePageUpKey //

参照

SFYContainer::SetPageDownKey | SFYContainer::PageUp | キーイベント[SFEVT_KEY]

解説

この関数は、SFYContainer::SetScrollDownKey 関数で設定した ScrollDown キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFYContainer::ScrollDown 関数を呼び出して、仮想領域を下方向にスクロールします。

内部実装

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

/*protected virtual */Bool SFYContainer::HandleScrollDownKey(Void)
{
    return ScrollDown();
}// SFYContainer::HandleScrollDownKey //

参照

SFYContainer::SetScrollDownKey | SFYContainer::ScrollDown | キーイベント[SFEVT_KEY]

解説

この関数は、SFYContainer::SetScrollUpKey 関数で設定した ScrollUp キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFYContainer::ScrollUp 関数を呼び出して、仮想領域を上方向にスクロールします。

内部実装

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

/*protected virtual */Bool SFYContainer::HandleScrollUpKey(Void)
{
    return ScrollUp();
}// SFYContainer::HandleScrollUpKey //

参照

SFYContainer::SetScrollUpKey | SFYContainer::ScrollUp | キーイベント[SFEVT_KEY]

解説

この関数は、SFYContainer::SetSnapDownKey 関数で設定した SnapDown キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFYContainer::SnapDown 関数を呼び出して、仮想領域の下端までスクロールします。

内部実装

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

/*protected virtual */Bool SFYContainer::HandleSnapDownKey(Void)
{
    return SnapDown();
}// SFYContainer::HandleSnapDownKey //

参照

SFYContainer::SetSnapDownKey | SFYContainer::SnapDown | キーイベント[SFEVT_KEY]

解説

この関数は、SFYContainer::SetSnapUpKey 関数で設定した SnapUp キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、SFYContainer::SnapUp 関数を呼び出して、仮想領域の上端までスクロールします。

内部実装

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

/*protected virtual */Bool SFYContainer::HandleSnapUpKey(Void)
{
    return SnapUp();
}// SFYContainer::HandleSnapUpKey //

参照

SFYContainer::SetSnapUpKey | SFYContainer::SnapUp | キーイベント[SFEVT_KEY]

戻り値

false。

解説

この関数は、仮想領域を下方向に 1 ページ分スクロールします。。

この関数は、SFYContainer::HandlePageDownKey 関数から呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装は、false の戻り値を返す以外に何もしません。

参照

SFYContainer::HandlePageDownKey | SFYContainer::PageUp

戻り値

false。

解説

この関数は、仮想領域を上方向に 1 ページ分スクロールします。

この関数は、SFYContainer::HandlePageUpKey 関数から呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装は、false の戻り値を返す以外に何もしません。

参照

SFYContainer::HandlePageUpKey | SFYContainer::PageDown

戻り値

解説

この関数は、仮想領域を下方向にスクロールします。

この関数は、SFYContainer::HandleScrollDownKey 関数から呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装は、以下の仕様で仮想領域を下方向にスクロールします。

参照

SFYContainer::HandleScrollDownKey | SFYContainer::ScrollUp

戻り値

解説

この関数は、仮想領域を上方向にスクロールします。

この関数は、SFYContainer::HandleScrollUpKey 関数から呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装は、以下の仕様で仮想領域を上方向にスクロールします。

参照

SFYContainer::HandleScrollUpKey | SFYContainer::ScrollDown

解説

この関数は、 仮想領域を下方向に 1 ページ分スクロールする PageDown キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントが発生すると、 SFYContainer::HandlePageDownKey 関数が実行されます。

デフォルト値: AVK_TXPGDOWN

参照

SFYContainer::HandlePageDownKey | SFYContainer::GetPageDownKey | AVKType

解説

この関数は、 仮想領域を上方向に 1 ページ分スクロールする PageUp キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントが発生すると、 SFYContainer::HandlePageUpKey 関数が実行されます。

デフォルト値: AVK_TXPGUP

参照

SFYContainer::HandlePageUpKey | SFYContainer::GetPageUpKey | AVKType

解説

この関数は、 仮想領域を下方向にスクロールステップ分スクロールする ScrollDown キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントが発生すると、 SFYContainer::HandleScrollDownKey 関数が実行されます。

デフォルト値: AVK_DOWN

参照

SFYContainer::HandleScrollDownKey | SFYContainer::GetScrollDownKey | SFYContainer::SetScrollStep | AVKType

解説

この関数は、連続スクロールフラグを設定します。

連続スクロールフラグが true に設定されていると、 最上部または最下部にフォーカスがあるときに、さらに移動させようとすると それぞれ最下部または最上部にジャンプします。

参照

SFYContainer::GetScrollRepeat

解説

この関数は、 SFYContainer::ScrollUp / SFYContainer::ScrollUp 関数でスクロールするステップを設定します。[単位 : ピクセル]

デフォルト値: DEFAULT_STEP ピクセル（20 ピクセル）

参照

SFYContainer::GetScrollStep | SFYContainer::DefaultEnum

解説

この関数は、 仮想領域を上方向にスクロールステップ分スクロールする ScrollUp キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントが発生すると、 SFYContainer::HandleScrollUpKey 関数が実行されます。

デフォルト値: AVK_UP

参照

SFYContainer::HandleScrollUpKey | SFYContainer::GetScrollUpKey | SFYContainer::SetScrollStep | AVKType

解説

この関数は、 仮想領域を下端までスクロールする SnapDown キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントが発生すると、 SFYContainer::HandleSnapDownKey 関数が実行されます。

デフォルト値: AVK_TXEND

参照

SFYContainer::HandleSnapDownKey | SFYContainer::GetSnapDownKey | AVKType

解説

この関数は、 仮想領域を上端までスクロールする SnapUp キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントが発生すると、 SFYContainer::HandleSnapUpKey 関数が実行されます。

デフォルト値: AVK_TXHOME

参照

SFYContainer::HandleSnapUpKey | SFYContainer::GetSnapUpKey | AVKType

戻り値

false。

解説

この関数は、仮想領域を下端までスクロールします。

この関数は、SFYContainer::HandleSnapDownKey 関数から呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装は、false の戻り値を返す以外に何もしません。

参照

SFYContainer::HandleSnapDownKey | SFYContainer::SnapUp

戻り値

false。

解説

この関数は、仮想領域を上端までスクロールします。

この関数は、SFYContainer::HandleSnapUpKey 関数から呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装は、false の戻り値を返す以外に何もしません。

参照

SFYContainer::HandleSnapUpKey | SFYContainer::SnapDown

参照

SFYResponder::GetType | SFYResponder::SetType

参照

SFYContainer::SetScrollStep