SFYMenu

メニューの抽象クラスです。

#include <SFYMenu.h.hpp>

class SFYMenu : public SFYWidget;

SFMTYPEDEFCLASS(SFYMenu)

継承図

協調図

解説

メニューは、ルート内に配置されるように設計されたレスポンダです。

すべてのメニューは SFYMenu クラスを継承し、一定時間経過後に自動的にメニューを閉じる機能とデフォルトのキー操作機能を提供します。

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

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

SFYMenu クラスは、各種メニューを実装するための起点となります。

このクラスは、一定時間経過後に自動的にメニューを閉じる機能と操作キーの管理を実装し、いくつかの仮想関数のデフォルトの動作も実装します。

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

仮想関数名	デフォルトの動作	オーバーライト
`SFYMenu::HandleOperateKey`	イベントを送信※１	任意
`SFYMenu::HandleEscapeKey`	イベントを送信※２	任意
`SFYMenu::HandleSelectUpKey`	－	任意
`SFYMenu::HandleSelectDownKey`	－	任意
`SFYMenu::HandleSelectLeftKey`	－	任意
`SFYMenu::HandleSelectRightKey`	－	任意
`SFYWidget::HandleBoundRequest`	－	推奨
`SFYWidget::HandleBoundOptimize`	－	推奨
`SFYMenu::HandleBoundReal`	仮想領域を調整※３	任意
`SFYWidget::HandleBoundVirtual`	－	任意
`SFYWidget::HandleBoundGlobal`	－	任意
`SFYWidget::HandleRenderRequest`	－	必須

	注釈
※１．InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_CANCEL, 0), false) を実行します。 ※２．InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0), false) を実行します。 ※３．SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize())) を実行します。

注釈

※１．InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_CANCEL, 0), false) を実行します。

※２．InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0), false) を実行します。

※３．SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize())) を実行します。

参照

メニュー（基礎編） | SFYResponder::SetParent | SFYResponder::SetState | SFYResponder::SetRealBound

メンバ

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

パブリック関数
`Void`	CancelTimer( `Void` ) メニューのタイマーをキャンセルします。
`AVKType`	GetEscapeKey( `Void` ) ESCAPE キーを取得します。
`AVKType`	GetOperateKey( `Void` ) 操作キーを取得します。
`AVKType`	GetSelectDownKey( `Void` ) DOWN キーを取得します。
`AVKType`	GetSelectLeftKey( `Void` ) LEFT キーを取得します。
`AVKType`	GetSelectRightKey( `Void` ) RIGHT キーを取得します。
`AVKType`	GetSelectUpKey( `Void` ) UP キーを取得します。
`Void`	RewindTimer( `Void` ) メニューが自動的に閉じるまでの時間を再設定します。
`Void`	ScheduleTimer( `UInt32` param ) 指定した時間が経過すればメニューが自動的に閉じるようにスケジュールします。
`Void`	SetEscapeKey( `AVKType` param ) ESCAPE キーを設定します。
`Void`	SetOperateKey( `AVKType` param ) 操作キーを設定します。
`Void`	SetSelectDownKey( `AVKType` param ) DOWN キーを設定します。
`Void`	SetSelectLeftKey( `AVKType` param ) LEFT キーを設定します。
`Void`	SetSelectRightKey( `AVKType` param ) RIGHT キーを設定します。
`Void`	SetSelectUpKey( `AVKType` param ) UP キーを設定します。
`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 から継承) 現在保持している例外を取得します。

プロテクト関数
`Void`	HandleBoundReal( `Void` ) 実領域が変化した時の処理です。
`Void`	HandleEscapeKey( `Void` ) ESCAPE キーが押されたときに実行される処理です。
`Void`	HandleOperateKey( `Void` ) 操作キーが押されたときに実行される処理です。
`Void`	HandleSelectDownKey( `Void` ) DOWN キーが押されたときに実行される処理です。
`Void`	HandleSelectLeftKey( `Void` ) LEFT キーが押されたときに実行される処理です。
`Void`	HandleSelectRightKey( `Void` ) RIGHT キーが押されたときに実行される処理です。
`Void`	HandleSelectUpKey( `Void` ) UP キーが押されたときに実行される処理です。
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`	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 SFYMenu クラスを表す定数です。

SFYMenu::SFYMenu

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

[ protected, explicit ]
SFYMenu(Void);

SFYMenu::~SFYMenu

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

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

SFYMenu::CancelTimer

メニューのタイマーをキャンセルします。

[ public ]
Void CancelTimer(Void);

解説

一定時間経過しても自動的にメニューが閉じないようにします。

参照

SFYMenu::ScheduleTimer | SFYMenu::RewindTimer

SFYMenu::GetEscapeKey

ESCAPE キーを取得します。

[ public, const ]
AVKType GetEscapeKey(Void);

戻り値

メニューの ESCAPE キー。

参照

SFYMenu::SetEscapeKey

SFYMenu::GetOperateKey

操作キーを取得します。

[ public, const ]
AVKType GetOperateKey(Void);

戻り値

メニューの操作キー。

参照

SFYMenu::SetOperateKey

SFYMenu::GetSelectDownKey

DOWN キーを取得します。

[ public, const ]
AVKType GetSelectDownKey(Void);

戻り値

メニューの DOWN キー。

参照

SFYMenu::SetSelectDownKey

SFYMenu::GetSelectLeftKey

LEFT キーを取得します。

[ public, const ]
AVKType GetSelectLeftKey(Void);

戻り値

メニューの LEFT キー。

参照

SFYMenu::SetSelectLeftKey

SFYMenu::GetSelectRightKey

RIGHT キーを取得します。

[ public, const ]
AVKType GetSelectRightKey(Void);

戻り値

メニューの RIGHT キー。

参照

SFYMenu::SetSelectRightKey

SFYMenu::GetSelectUpKey

UP キーを取得します。

[ public, const ]
AVKType GetSelectUpKey(Void);

戻り値

メニューの UP キー。

参照

SFYMenu::SetSelectUpKey

SFYMenu::HandleBoundReal

実領域が変化した時の処理です。

[ protected, virtual ]
Void HandleBoundReal(Void);

解説

この関数は、「SFEVT_RESPONDER_BOUND/SFP16_BOUND_REAL」イベントを受信したときに呼び出されます。

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

デフォルトの実装は、仮想領域を実領域に一致させます。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベントの送信
	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベントは `SFYResponder::SetRealBound` 関数を呼び出したときなどに発生します。

	実領域の変更処理
この仮想関数をオーバーライドする以外に、領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装しレスポンダに登録して行うことも可能です。実領域の変更処理は、最初に仮想関数を実行し、次に領域イベント専用ハンドラを登録した順に実行して行われます。領域イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして実領域の変更処理を行います。

実領域の変更処理

この仮想関数をオーバーライドする以外に、領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装しレスポンダに登録して行うことも可能です。

実領域の変更処理は、最初に仮想関数を実行し、次に領域イベント専用ハンドラを登録した順に実行して行われます。

領域イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして実領域の変更処理を行います。

参照

SFYResponder::SetRealBound | 領域イベント(SFEVT_RESPONDER_BOUND) | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]

SFYMenu::HandleEscapeKey

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

[ protected, virtual ]
Void HandleEscapeKey(Void);

解説

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

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

デフォルトの実装では、SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0) イベントを送信します。

参照

SFYMenu::SetEscapeKey

SFYMenu::HandleOperateKey

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

[ protected, virtual ]
Void HandleOperateKey(Void);

解説

この関数は、SFYMenu::SetOperateKey 関数によって設定された操作キーのイベントを受信したときに呼び出されます。

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

デフォルトの実装では、SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_CANCEL, 0) イベントを送信します。

参照

SFYMenu::SetOperateKey

SFYMenu::HandleSelectDownKey

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

[ protected, virtual ]
Void HandleSelectDownKey(Void);

解説

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

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

デフォルトの実装では、何も処理しません。

参照

SFYMenu::SetSelectDownKey

SFYMenu::HandleSelectLeftKey

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

[ protected, virtual ]
Void HandleSelectLeftKey(Void);

解説

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

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

デフォルトの実装では、何も処理しません。

参照

SFYMenu::SetSelectLeftKey

SFYMenu::HandleSelectRightKey

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

[ protected, virtual ]
Void HandleSelectRightKey(Void);

解説

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

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

デフォルトの実装では、何も処理しません。

参照

SFYMenu::SetSelectRightKey

SFYMenu::HandleSelectUpKey

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

[ protected, virtual ]
Void HandleSelectUpKey(Void);

解説

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

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

デフォルトの実装では、何も処理しません。

参照

SFYMenu::SetSelectUpKey

SFYMenu::RewindTimer

メニューが自動的に閉じるまでの時間を再設定します。

[ public ]
Void RewindTimer(Void);

解説

メニューが自動的に閉じるまでの時間を、前回 SFYMenu::ScheduleTimer 関数によって設定された時間に再設定します。

参照

SFYMenu::ScheduleTimer | SFYMenu::CancelTimer

SFYMenu::ScheduleTimer

指定した時間が経過すればメニューが自動的に閉じるようにスケジュールします。

[ public ]
Void ScheduleTimer(
    UInt32 param   // 設定する時間
);

解説

引数で指定した時間(単位：ミリ秒)が経過したときにメニューが自動的に閉じるようにスケジュールします。

参照

SFYMenu::CancelTimer | SFYMenu::RewindTimer

SFYMenu::SetEscapeKey

ESCAPE キーを設定します。

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

解説

メニューの ESCAPE キーを設定します。

デフォルト値: AVK_CLR

参照

SFYMenu::GetEscapeKey

SFYMenu::SetOperateKey

操作キーを設定します。

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

解説

メニューの操作キーを設定します。

デフォルト値: AVK_SELECT

参照

SFYMenu::GetOperateKey

SFYMenu::SetSelectDownKey

DOWN キーを設定します。

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

解説

メニューの DOWN キーを設定します。

デフォルト値: AVK_DOWN

参照

SFYMenu::GetSelectDownKey

SFYMenu::SetSelectLeftKey

LEFT キーを設定します。

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

解説

メニューの LEFT キーを設定します。

デフォルト値: AVK_LEFT

参照

SFYMenu::GetSelectLeftKey

SFYMenu::SetSelectRightKey

RIGHT キーを設定します。

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

解説

メニューの RIGHT キーを設定します。

デフォルト値: AVK_RIGHT

参照

SFYMenu::GetSelectRightKey

SFYMenu::SetSelectUpKey

UP キーを設定します。

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

解説

メニューの UP キーを設定します。

デフォルト値: AVK_UP

参照

SFYMenu::GetSelectUpKey

SFYMenu::CodeEnum

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

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

参照

SFYResponder::GetType | SFYResponder::SetType