SFYContainer

コンテナの抽象クラスです。

#include <SFYContainer.h.hpp>

class SFYContainer : public SFYWidget;

SFMTYPEDEFCLASS(SFYContainer)

継承図

協調図

解説

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

すべてのコンテナは SFYContainer クラスを継承し、実領域よりも大きな仮想領域のスクロール機能とフォーカスの移動機能を提供します。

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

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

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

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

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

クラス名	解説
`SFYContainer`	コンテナを表す抽象クラスです。

	重要
	すべてのコンテナにおいて、`SFYResponder::SetParent` 関数、`SFYResponder::SetState` 関数、`SFYResponder::SetRealBound` 関数の呼び出しは必須です。その他の関数は必要に応じて呼び出すことも省略することもできます。

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

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

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

仮想関数名	デフォルトの動作	オーバーライト
`SFYContainer::HandleScrollUpKey`	仮想領域を上方向にスクロール※１	任意
`SFYContainer::HandleScrollDownKey`	仮想領域を下方向にスクロール※２	任意
`SFYContainer::HandlePageUpKey`	仮想領域を上方向に１ページ分スクロール※３	任意
`SFYContainer::HandlePageDownKey`	仮想領域を下方向に１ページ分スクロール※４	任意
`SFYContainer::HandleSnapUpKey`	仮想領域を上端までスクロール※５	任意
`SFYContainer::HandleSnapDownKey`	仮想領域を下端までスクロール※６	任意
`SFYWidget::HandleBoundRequest`	－	推奨
`SFYWidget::HandleBoundOptimize`	－	推奨
`SFYWidget::HandleBoundReal`	－	任意
`SFYWidget::HandleBoundVirtual`	－	任意
`SFYWidget::HandleBoundGlobal`	－	任意
`SFYWidget::HandleRenderRequest`	－	任意

注釈

	注釈
※１．`SFYContainer::ScrollUp` 関数を実行します。 ※２．`SFYContainer::ScrollDown` 関数を実行します。 ※３．`SFYContainer::PageUp` 関数を実行します。 ※４．`SFYContainer::PageDown` 関数を実行します。 ※５．`SFYContainer::SnapUp` 関数を実行します。 ※６．`SFYContainer::SnapDown` 関数を実行します。

※１．SFYContainer::ScrollUp 関数を実行します。

※２．SFYContainer::ScrollDown 関数を実行します。

※３．SFYContainer::PageUp 関数を実行します。

※４．SFYContainer::PageDown 関数を実行します。

※５．SFYContainer::SnapUp 関数を実行します。

※６．SFYContainer::SnapDown 関数を実行します。

参照

メンバ

コンストラクタ/デストラクタ
SFYContainer( `Void` ) SFYContainer クラスのコンストラクタです。
~SFYContainer( `Void` ) SFYContainer クラスのデストラクタです。

パブリック関数
`AVKType`	GetPageDownKey( `Void` ) 仮想領域を下方向に１ページ分スクロールするキーを取得します。
`AVKType`	GetPageUpKey( `Void` ) 仮想領域を上方向に１ページ分スクロールするキーを取得します。
`AVKType`	GetScrollDownKey( `Void` ) 仮想領域を下方向にスクロールするキーを取得します。
`Bool`	GetScrollRepeat( `Void` ) 連続スクロールフラグを取得します。
`SInt16`	GetScrollStep( `Void` ) スクロールステップを取得します。
`AVKType`	GetScrollUpKey( `Void` ) 仮想領域を上方向にスクロールするキーを取得します。
`AVKType`	GetSnapDownKey( `Void` ) 仮想領域を下端までスクロールするキーを取得します。
`AVKType`	GetSnapUpKey( `Void` ) 仮想領域を上端までスクロールするキーを取得します。
`Bool`	PageDown( `Void` ) 仮想領域を下方向に１ページ分スクロールします。
`Bool`	PageUp( `Void` ) 仮想領域を上方向に１ページ分スクロールします。
`Bool`	ScrollDown( `Void` ) 仮想領域を下方向にスクロールします。
`Bool`	ScrollUp( `Void` ) 仮想領域を上方向にスクロールします。
`Void`	SetPageDownKey( `AVKType` param ) 仮想領域を下方向に１ページ分スクロールするキーを設定します。
`Void`	SetPageUpKey( `AVKType` param ) 仮想領域を上方向に１ページ分スクロールするキーを設定します。
`Void`	SetScrollDownKey( `AVKType` param ) 仮想領域を下方向にスクロールするキーを設定します。
`Void`	SetScrollRepeat( `Bool` param ) 連続スクロールフラグの設定をします。
`Void`	SetScrollStep( `SInt16` param ) スクロールステップを設定します。
`Void`	SetScrollUpKey( `AVKType` param ) 仮想領域を上方向にスクロールするキーを設定します。
`Void`	SetSnapDownKey( `AVKType` param ) 仮想領域を下端までスクロールするキーを設定します。
`Void`	SetSnapUpKey( `AVKType` param ) 仮想領域を上端までスクロールするキーを設定します。
`Bool`	SnapDown( `Void` ) 仮想領域を下端までスクロールします。
`Bool`	SnapUp( `Void` ) 仮想領域を上端までスクロールします。
`Void`	ClearHandler( `Void` ) (SFYResponder から継承) ハンドラの登録をすべて解除します。
`Void`	ClearTracer( `Void` ) (SFYResponder から継承) トレーサの登録をすべて解除します。
`SFCError`	Distribute( `SFXEventConstRef` event , `BoolPtr` result = null ) (SFYResponder から継承) 配信エンジンを起動してイベントを配信します。
`SFXRGBColorConstRef`	GetBackgroundColor( `Void` ) (SFYWidget から継承) 背景の色を取得します。
`SFYResponderSmp`	GetChildBack( `Void` ) (SFYResponder から継承) GetChildBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildBack( `UInt32` id ) (SFYResponder から継承) GetChildBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 最背面に位置する子レスポンダを取得します。
`SFYResponderSmp`	GetChildBackward( `SInt32` index ) (SFYResponder から継承) GetChildBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildBackward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) GetChildBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 背面から数えて指定された順番に位置する子レスポンダを取得します。
`SInt32`	GetChildCount( `Void` ) (SFYResponder から継承) GetChildCount( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildCount( `UInt32` id ) (SFYResponder から継承) GetChildCount( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 子レスポンダの数を取得します。
`SFYResponderSmp`	GetChildForward( `SInt32` index ) (SFYResponder から継承) GetChildForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildForward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) GetChildForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 前面から数えて指定された順番に位置する子レスポンダを取得します。
`SFYResponderSmp`	GetChildFront( `Void` ) (SFYResponder から継承) GetChildFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetChildFront( `UInt32` id ) (SFYResponder から継承) GetChildFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 最前面に位置する子レスポンダを取得します。
`SFYDistributerPtr`	GetDistributer( `Void` ) (SFYResponder から継承) 配信エンジンを取得します。
`SFXRectangle`	GetGlobalBound( `Void` ) (SFYResponder から継承) グローバル領域を取得します。
`UInt32`	GetID( `Void` ) (SFYResponder から継承) ID を取得します。
`SFXRectangle`	GetLocalBound( `Void` ) (SFYResponder から継承) ローカル領域を取得します。
`SInt32`	GetNthBackward( `Void` ) (SFYResponder から継承) GetNthBackward( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetNthBackward( `UInt32` id ) (SFYResponder から継承) GetNthBackward( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが背面から数えて何番目に位置するかを取得します。
`SInt32`	GetNthForward( `Void` ) (SFYResponder から継承) GetNthForward( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) GetNthForward( `UInt32` id ) (SFYResponder から継承) GetNthForward( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが前面から数えて何番目に位置するかを取得します。
`SFYResponderSmp`	GetParent( `Void` ) (SFYResponder から継承) 親レスポンダを取得します。
`Bool`	GetPropertyTransparent( `Void` ) (SFYResponder から継承) 透過属性を取得します。
`SFXRectangleConstRef`	GetRealBound( `Void` ) (SFYResponder から継承) 実領域を取得します。
`VoidPtr`	GetReference( `Void` ) (SFYResponder から継承) リファレンス値を取得します。
`SFYRendererPtr`	GetRenderer( `Void` ) (SFYResponder から継承) 描画エンジンを取得します。
`SFYResponderSmp`	GetRoot( `Void` ) (SFYResponder から継承) ルートレスポンダを取得します。
`Bool`	GetStateActive( `Bool` inherit = false ) (SFYResponder から継承) 活性状態を取得します。
`Bool`	GetStateEnable( `Bool` inherit = false ) (SFYResponder から継承) 操作可能状態を取得します。
`Bool`	GetStateFocus( `Bool` inherit = false ) (SFYResponder から継承) フォーカス状態を取得します。
`Bool`	GetStateVisible( `Bool` inherit = false ) (SFYResponder から継承) 可視状態を取得します。
`SFXRectangle`	GetSuitableBound( `Void` ) (SFYResponder から継承) GetSuitableBound( `SFXRectangleConstRef` param ) (SFYResponder から継承) 最適な大きさを取得します。
`SFXMargin`	GetSuitableMargin( `Void` ) (SFYResponder から継承) 最適な余白を取得します。
`SFCType`	GetType( `Void` ) (SFYResponder から継承) タイプを取得します。
`SFXRectangleConstRef`	GetVirtualBound( `Void` ) (SFYResponder から継承) 仮想領域を取得します。
`Void`	Initialize( `Void` ) (SFYResponder から継承) レスポンダを初期化します。
`Void`	Invalidate( `Void` ) (SFYResponder から継承) Invalidate( `SFXRectangleConstRef` param ) (SFYResponder から継承) 再描画領域を登録します。
`Void`	InvokeBackward( `SFXEventConstRef` event , `Bool` overload , `BoolPtr` result = null ) (SFYResponder から継承) レスポンダにイベントを送信します。ハンドラ関数はハンドラリストに登録された順序で呼び出されます。
`Void`	InvokeForward( `SFXEventConstRef` event , `Bool` overload , `BoolPtr` result = null ) (SFYResponder から継承) レスポンダにイベントを送信します。ハンドラ関数はハンドラリストに登録された逆順で呼び出されます。
`Bool`	IsBack( `Void` ) (SFYResponder から継承) IsBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsBack( `UInt32` id ) (SFYResponder から継承) IsBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが最背面に位置するかどうかを判定します。
`Bool`	IsFront( `Void` ) (SFYResponder から継承) IsFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsFront( `UInt32` id ) (SFYResponder から継承) IsFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが最前面に位置するかどうかを判定します。
`Bool`	IsNthBackward( `SInt32` index ) (SFYResponder から継承) IsNthBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsNthBackward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) IsNthBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
`Bool`	IsNthForward( `SInt32` index ) (SFYResponder から継承) IsNthForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) IsNthForward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) IsNthForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
`Bool`	IsRoot( `Void` ) (SFYResponder から継承) 自レスポンダがルートレスポンダかどうかを判定します。
`SFCError`	RegisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::RuleRecConstRef` rule ) (SFYResponder から継承) RegisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::HandlerSPPConstPtr` spp , `VoidPtrConstPtr` reference , `SInt32` length ) (SFYResponder から継承) RegisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::RuleRecConstPtr` rule , `SInt32` length ) (SFYResponder から継承) RegisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::HandlerSPP` spp , `VoidPtr` reference ) (SFYResponder から継承) ハンドラを登録します。
`SFCError`	RegisterTracer( `SFXEventRangeConstRef` range , `SFYTracer::RuleRecConstRef` rule ) (SFYResponder から継承) RegisterTracer( `SFXEventRangeConstPtr` range , `SFYTracer::OrderEnumConstPtr` order , `SFYTracer::StateEnumConstPtr` state , `BoolConstPtr` overload , `SInt32` length ) (SFYResponder から継承) RegisterTracer( `SFXEventRangeConstPtr` range , `SFYTracer::RuleRecConstPtr` rule , `SInt32` length ) (SFYResponder から継承) RegisterTracer( `SFXEventRangeConstRef` range , `SFYTracer::OrderEnum` order , `SFYTracer::StateEnum` state , `Bool` overload ) (SFYResponder から継承) トレーサを登録します。
`SFCError`	Render( `Bool` force = false ) (SFYResponder から継承) 描画エンジンを起動して再描画します。
`Void`	SetBackgroundColor( `SFXRGBColorConstRef` param ) (SFYWidget から継承) 背景の色を設定します。
`Void`	SetDistributer( `SFYDistributerPtr` param ) (SFYResponder から継承) 配信エンジンを設定します。
`Void`	SetID( `UInt32` param ) (SFYResponder から継承) ID を設定します。
`SFCError`	SetParent( `SFYResponderSmpConstRef` param ) (SFYResponder から継承) 親レスポンダを設定します。
`Void`	SetProperty( `Bool` transparent ) (SFYResponder から継承) 属性をまとめて設定します。
`Void`	SetPropertyTransparent( `Bool` param ) (SFYResponder から継承) 透過属性を設定します。
`Void`	SetRealBound( `SFXRectangleConstRef` param ) (SFYResponder から継承) 実領域を設定します。
`Void`	SetReference( `VoidPtr` param ) (SFYResponder から継承) リファレンス値を設定します。
`Void`	SetRenderer( `SFYRendererPtr` param ) (SFYResponder から継承) 描画エンジンを設定します。
`Void`	SetState( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 状態をまとめて設定します。
`Void`	SetStateActive( `Bool` param ) (SFYResponder から継承) 活性状態を設定します。
`Void`	SetStateEnable( `Bool` param ) (SFYResponder から継承) 操作可能状態を設定します。
`Void`	SetStateFocus( `Bool` param ) (SFYResponder から継承) フォーカス状態を設定します。
`Void`	SetStateVisible( `Bool` param ) (SFYResponder から継承) 可視状態を設定します。
`Void`	SetVirtualBound( `SFXRectangleConstRef` param ) (SFYResponder から継承) 仮想領域を設定します。
`Void`	Terminate( `Void` ) (SFYResponder から継承) レスポンダの終了処理をします。
`Void`	ToBack( `Void` ) (SFYResponder から継承) ToBack( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToBack( `UInt32` id ) (SFYResponder から継承) ToBack( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを姉妹レスポンダのなかで最背面に移動します。
`Void`	ToFront( `Void` ) (SFYResponder から継承) ToFront( `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToFront( `UInt32` id ) (SFYResponder から継承) ToFront( `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを姉妹レスポンダのなかで最前面に移動します。
`Void`	ToNthBackward( `SInt32` index ) (SFYResponder から継承) ToNthBackward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToNthBackward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) ToNthBackward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを背面から数えて指定された順番に移動します。
`Void`	ToNthForward( `SInt32` index ) (SFYResponder から継承) ToNthForward( `SInt32` index , `UInt32` id , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) ToNthForward( `SInt32` index , `UInt32` id ) (SFYResponder から継承) ToNthForward( `SInt32` index , `Bool` visible , `Bool` active , `Bool` enable , `Bool` focus ) (SFYResponder から継承) 自レスポンダを前面から数えて指定された順番に移動します。
`Void`	UnregisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::RuleRecConstRef` rule ) (SFYResponder から継承) UnregisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::HandlerSPPConstPtr` spp , `VoidPtrConstPtr` reference , `SInt32` length ) (SFYResponder から継承) UnregisterHandler( `SFXEventRangeConstPtr` range , `SFYHandler::RuleRecConstPtr` rule , `SInt32` length ) (SFYResponder から継承) UnregisterHandler( `SFXEventRangeConstRef` range , `SFYHandler::HandlerSPP` spp , `VoidPtr` reference ) (SFYResponder から継承) ハンドラの登録を解除します。
`Void`	UnregisterTracer( `SFXEventRangeConstRef` range ) (SFYResponder から継承) UnregisterTracer( `SFXEventRangeConstPtr` range , `SInt32` length ) (SFYResponder から継承) トレーサの登録を解除します。
`T const &`	static_catch( `Void` ) (static_exception から継承) 現在保持している例外を取得します。

プロテクト関数
`Bool`	HandlePageDownKey( `Void` ) PageDown キーが押されたときに実行される処理です。
`Bool`	HandlePageUpKey( `Void` ) PageUp キーが押されたときに実行される処理です。
`Bool`	HandleScrollDownKey( `Void` ) ScrollDown キーが押されたときに実行される処理です。
`Bool`	HandleScrollUpKey( `Void` ) ScrollUp キーが押されたときに実行される処理です。
`Bool`	HandleSnapDownKey( `Void` ) SnapDown キーが押されたときに実行される処理です。
`Bool`	HandleSnapUpKey( `Void` ) SnapUp キーが押されたときに実行される処理です。
static `SFYResponderSmp`	Factory( `SFYResponderPtr` responder , `SFCErrorPtr` exception = null ) (SFYResponder から継承) NewInstance 関数の実装を補助します。
`SFYResponderSmp`	GetThis( `Void` ) (SFYResponder から継承) スマートポインタで保持された this を取得します。
`Void`	HandleBoundGlobal( `SFXRectangleConstRef` rectangle ) (SFYWidget から継承) グローバル領域の変更処理を行います。
`Void`	HandleBoundOptimize( `SFXRectanglePtr` rectangle ) (SFYWidget から継承) 指定した矩形に収まる範囲内で最適なサイズを計算します。
`Void`	HandleBoundReal( `Void` ) (SFYWidget から継承) 実領域の変更処理を行います。
`Void`	HandleBoundRequest( `SFXRectanglePtr` rectangle ) (SFYWidget から継承) 最適な矩形を計算します。
`Void`	HandleBoundVirtual( `Void` ) (SFYWidget から継承) 仮想領域の変更処理を行います。
`Void`	HandleRenderRequest( `SFXGraphicsPtr` graphics ) (SFYWidget から継承) レスポンダを描画します。
`Void`	SetType( `SFCType` param ) (SFYResponder から継承) タイプを設定します。
`Void`	static_throw( `static_exception< T > const &` param ) (static_exception から継承) static_throw( `T const &` param ) (static_exception から継承) 例外を設定します。
`Bool`	static_try( `Void` ) (static_exception から継承) 例外が保持されているかどうかを確かめます。

型
CodeEnum SFYContainer クラスを表す定数です。
DefaultEnum デフォルトのスクロールステップを表す定数です。

SFYContainer::SFYContainer

SFYContainer クラスのコンストラクタです。

[ protected, explicit ]
SFYContainer(Void);

SFYContainer::~SFYContainer

SFYContainer クラスのデストラクタです。

[ protected, virtual ]
virtual ~SFYContainer(Void);

SFYContainer::GetPageDownKey

仮想領域を下方向に１ページ分スクロールするキーを取得します。

[ public, const ]
AVKType GetPageDownKey(Void);

戻り値

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

参照

SFYContainer::SetPageDownKey

SFYContainer::GetPageUpKey

仮想領域を上方向に１ページ分スクロールするキーを取得します。

[ public, const ]
AVKType GetPageUpKey(Void);

戻り値

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

参照

SFYContainer::SetPageUpKey

SFYContainer::GetScrollDownKey

仮想領域を下方向にスクロールするキーを取得します。

[ public, const ]
AVKType GetScrollDownKey(Void);

戻り値

仮想領域を下方向にスクロールするキー。

参照

SFYContainer::SetScrollDownKey

SFYContainer::GetScrollRepeat

連続スクロールフラグを取得します。

[ public, const ]
Bool GetScrollRepeat(Void);

戻り値

連続スクロールに設定されているとき : true
そうでないとき : false

解説

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

参照

SFYContainer::SetScrollRepeat

SFYContainer::GetScrollStep

スクロールステップを取得します。

[ public, const ]
SInt16 GetScrollStep(Void);

戻り値

SFYContainer::SetScrollStep 関数によって設定されたスクロールステップ。

参照

SFYContainer::SetScrollStep

SFYContainer::GetScrollUpKey

仮想領域を上方向にスクロールするキーを取得します。

[ public, const ]
AVKType GetScrollUpKey(Void);

戻り値

仮想領域を上方向にスクロールするキー。

参照

SFYContainer::SetScrollUpKey

SFYContainer::GetSnapDownKey

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

[ public, const ]
AVKType GetSnapDownKey(Void);

戻り値

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

参照

SFYContainer::SetSnapDownKey

SFYContainer::GetSnapUpKey

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

[ public, const ]
AVKType GetSnapUpKey(Void);

戻り値

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

参照

SFYContainer::SetSnapUpKey

SFYContainer::HandlePageDownKey

PageDown キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandlePageDownKey(Void);

解説

この関数は、SFYContainer::SetPageDownKey 関数によって設定された PageDown キーを受信したときに呼び出されます。

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

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

参照

SFYContainer::SetPageDownKey | SFYContainer::PageDown

SFYContainer::HandlePageUpKey

PageUp キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandlePageUpKey(Void);

解説

この関数は、SFYContainer::SetPageUpKey 関数によって設定された PageUp キーを受信したときに呼び出されます。

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

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

参照

SFYContainer::SetPageDownKey | SFYContainer::PageUp

SFYContainer::HandleScrollDownKey

ScrollDown キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleScrollDownKey(Void);

解説

この関数は、SFYContainer::SetScrollDownKey 関数によって設定された ScrollDown キーを受信したときに呼び出されます。

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

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

参照

SFYContainer::SetScrollDownKey | SFYContainer::ScrollDown

SFYContainer::HandleScrollUpKey

ScrollUp キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleScrollUpKey(Void);

解説

この関数は、SFYContainer::SetScrollUpKey 関数によって設定された ScrollUp キーを受信したときに呼び出されます。

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

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

参照

SFYContainer::SetScrollUpKey | SFYContainer::ScrollUp

SFYContainer::HandleSnapDownKey

SnapDown キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleSnapDownKey(Void);

解説

この関数は、SFYContainer::SetSnapDownKey 関数によって設定された SnapDown キーを受信したときに呼び出されます。

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

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

参照

SFYContainer::SetSnapDownKey | SFYContainer::SnapDown

SFYContainer::HandleSnapUpKey

SnapUp キーが押されたときに実行される処理です。

[ protected, virtual ]
Bool HandleSnapUpKey(Void);

解説

この関数は、SFYContainer::SetSnapUpKey 関数によって設定された SnapUp キーを受信したときに呼び出されます。

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

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

参照

SFYContainer::SetSnapUpKey | SFYContainer::SnapUp

SFYContainer::PageDown

仮想領域を下方向に１ページ分スクロールします。

[ public ]
Bool PageDown(Void);

戻り値

false。

解説

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

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

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

参照

SFYContainer::HandlePageDownKey | SFYContainer::PageUp

SFYContainer::PageUp

仮想領域を上方向に１ページ分スクロールします。

[ public ]
Bool PageUp(Void);

戻り値

false。

解説

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

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

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

参照

SFYContainer::HandlePageUpKey | SFYContainer::PageDown

SFYContainer::ScrollDown

仮想領域を下方向にスクロールします。

[ public ]
Bool ScrollDown(Void);

戻り値

成功したとき : true
失敗したとき : false

解説

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

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

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

	下方向のスクロールについて
フォーカスされているレスポンダがありフォーカスを次のレスポンダに移動できる場合は、フォーカスを移動します。フォーカスを移動した結果、フォーカスが画面外にはみ出る場合は、画面を下方向にスクロールします。フォーカスを最後のレスポンダまで移動しこれ以上移動できない場合は、画面を下方向にスクロールします。フォーカスされているレスポンダが無い場合は、フォーカス可能な最初のレスポンダがフォーカスされ画面をスクロールします。フォーカス可能なレスポンダが１つも無い場合は、画面を下方向にスクロールします。

下方向のスクロールについて

フォーカスされているレスポンダがありフォーカスを次のレスポンダに移動できる場合は、フォーカスを移動します。

フォーカスを移動した結果、フォーカスが画面外にはみ出る場合は、画面を下方向にスクロールします。

フォーカスを最後のレスポンダまで移動しこれ以上移動できない場合は、画面を下方向にスクロールします。

フォーカスされているレスポンダが無い場合は、フォーカス可能な最初のレスポンダがフォーカスされ画面をスクロールします。

フォーカス可能なレスポンダが１つも無い場合は、画面を下方向にスクロールします。

参照

SFYContainer::HandleScrollDownKey | SFYContainer::ScrollUp

SFYContainer::ScrollUp

仮想領域を上方向にスクロールします。

[ public ]
Bool ScrollUp(Void);

戻り値

成功したとき : true
失敗したとき : false

解説

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

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

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

	上方向のスクロールについて
フォーカスされているレスポンダがありフォーカスを前のレスポンダに移動できる場合は、フォーカスを移動します。フォーカスを移動した結果、フォーカスが画面外にはみ出る場合は、画面を上方向にスクロールします。フォーカスを最初のレスポンダまで移動しこれ以上移動できない場合は、画面を上方向にスクロールします。フォーカスされているレスポンダが無い場合は、フォーカス可能な最後のレスポンダがフォーカスされ画面をスクロールします。フォーカス可能なレスポンダが１つも無い場合は、画面を上方向にスクロールします。

上方向のスクロールについて

フォーカスされているレスポンダがありフォーカスを前のレスポンダに移動できる場合は、フォーカスを移動します。

フォーカスを移動した結果、フォーカスが画面外にはみ出る場合は、画面を上方向にスクロールします。

フォーカスを最初のレスポンダまで移動しこれ以上移動できない場合は、画面を上方向にスクロールします。

フォーカスされているレスポンダが無い場合は、フォーカス可能な最後のレスポンダがフォーカスされ画面をスクロールします。

フォーカス可能なレスポンダが１つも無い場合は、画面を上方向にスクロールします。

参照

SFYContainer::HandleScrollUpKey | SFYContainer::ScrollDown

SFYContainer::SetPageDownKey

仮想領域を下方向に１ページ分スクロールするキーを設定します。

[ public ]
Void SetPageDownKey(
    AVKType param   // 設定するキー
);

解説

仮想領域を下方向に１ページ分スクロールするキーを設定します。

デフォルト値: AVK_TXPGDOWN

参照

SFYContainer::GetPageDownKey

SFYContainer::SetPageUpKey

仮想領域を上方向に１ページ分スクロールするキーを設定します。

[ public ]
Void SetPageUpKey(
    AVKType param   // 設定するキー
);

解説

仮想領域を上方向に１ページ分スクロールするキーを設定します。

デフォルト値: AVK_TXPGUP

参照

SFYContainer::GetPageUpKey

SFYContainer::SetScrollDownKey

仮想領域を下方向にスクロールするキーを設定します。

[ public ]
Void SetScrollDownKey(
    AVKType param   // 設定するキー
);

解説

仮想領域を下方向にスクロールするキーを設定します。

デフォルト値: AVK_DOWN

参照

SFYContainer::GetScrollDownKey

SFYContainer::SetScrollRepeat

連続スクロールフラグの設定をします。

[ public ]
Void SetScrollRepeat(
    Bool param   // 設定する値
);

解説

参照

SFYContainer::GetScrollRepeat

SFYContainer::SetScrollStep

スクロールステップを設定します。

[ public ]
Void SetScrollStep(
    SInt16 param   // 設定するスクロール ステップ
);

解説

SFYContainer::ScrollUp 関数と SFYContainer::ScrollUp 関数でスクロールするステップを設定します。

デフォルト値: DEFAULT_STEP(20)

参照

SFYContainer::GetScrollStep

SFYContainer::SetScrollUpKey

仮想領域を上方向にスクロールするキーを設定します。

[ public ]
Void SetScrollUpKey(
    AVKType param   // 設定するキー
);

解説

仮想領域を上方向にスクロールするキーを設定します。

デフォルト値: AVK_UP

参照

SFYContainer::GetScrollUpKey

SFYContainer::SetSnapDownKey

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

[ public ]
Void SetSnapDownKey(
    AVKType param   // 設定するキー
);

解説

仮想領域の下端までスクロールするキーを設定します。

デフォルト値: AVK_TXEND

参照

SFYContainer::GetSnapDownKey

SFYContainer::SetSnapUpKey

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

[ public ]
Void SetSnapUpKey(
    AVKType param   // 設定するキー
);

解説

仮想領域の上端までスクロールするキーを設定します。

デフォルト値: AVK_TXHOME

参照

SFYContainer::GetSnapUpKey

SFYContainer::SnapDown

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

[ public ]
Bool SnapDown(Void);

戻り値

false。

解説

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

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

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

参照

SFYContainer::HandleSnapDownKey | SFYContainer::SnapUp

SFYContainer::SnapUp

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

[ public ]
Bool SnapUp(Void);

戻り値

false。

解説

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

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

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

参照

SFYContainer::HandleSnapUpKey | SFYContainer::SnapDown

SFYContainer::CodeEnum

SFYContainer クラスを表す定数です。

enum CodeEnum {
    CODE_TYPE = four_char_code('.', 'n', 't', 'n')
};
SFMTYPEDEFTYPE(CodeEnum)

参照

SFYResponder::GetType | SFYResponder::SetType

SFYContainer::DefaultEnum

デフォルトのスクロールステップを表す定数です。

enum DefaultEnum {
    DEFAULT_STEP  = 20  //  デフォルトのスクロール ステップ
};
SFMTYPEDEFTYPE(DefaultEnum)