前のページ次のページ上に戻るホーム SophiaFramework 2.1
SFRMenu
メニューを表すレスポンダです。
#include <SFRMenu.hpp>
class SFRMenu : public SFRResponder;
typedef SFRMenu&          SFRMenuRef;
typedef SFRMenu*          SFRMenuPtr;
typedef SFRMenu**         SFRMenuHandle;
typedef const SFRMenu     ConstSFRMenu;
typedef const SFRMenu&    ConstSFRMenuRef;
typedef const SFRMenu*    ConstSFRMenuPtr;
typedef const SFRMenu**   ConstSFRMenuHandle;

継承図

SFRMenu クラスの継承図

協調図

SFRMenu クラスの協調図

解説

レスポンダの一種で、主にメニュー レベルの処理に特化 したクラスです。メニューはアプリケーションに貼り付けて使用することが できます。

メンバ

コンストラクタ/デストラクタ
protected
SFRMenu SFRMenu クラスのコンストラクタです。
public
~SFRMenu SFRMenu クラスのデストラクタです。
パブリック関数
public
FocusNext (SFRResponder から継承) フォーカスを一つ次に進めます。
public
FocusPrevious (SFRResponder から継承) フォーカスを一つ前に戻します。
public
GetAttribute (SFRResponder から継承) アトリビュートを取得します。
public
GetBack (SFRResponder から継承) 子階層のレスポンダのうち検索条件に一致するレスポンダを 後ろから検索します。
public
GetBaseBound (SFRResponder から継承) ベース領域を親レスポンダのコンテント座標で取得します。
public
GetBaseWorld (SFRResponder から継承) ベース領域を取得します。
public
GetContentBound (SFRResponder から継承) コンテント領域をベース領域の座標で取得します。
public
GetContentWorld (SFRResponder から継承) コンテント領域を取得します。
public
GetDirector 親のポインタを取得します。
public
GetFocus (SFRResponder から継承) 子階層のレスポンダでフォーカスの当たっているものを取得します。
public
GetFront (SFRResponder から継承) 子階層のレスポンダのうち検索条件に一致するレスポンダを前から検索します。
public
GetLeft (SFRResponder から継承) グループ化されているレスポンダのうち 自分より前にあるレスポンダで検索条件に一致するレスポンダを検索します。
public
GetMoveInterval (SFRResponder から継承) UpHandler, DownHandler, LeftHandler, RightHandler に よりレスポンダが移動されるときの移動量を取得します。
public
GetMoveMargin (SFRResponder から継承) UpHandler, DownHandler, LeftHandler, RightHandler, Move 関数に よりレスポンダが移動されるときに画面の端からどこまで 移動できるかを示すマージンを取得します。
public
GetNext (SFRResponder から継承) 自分より後にあるレスポンダで検索条件に一致するレスポンダを 検索します。
public
GetNth (SFRResponder から継承) 子階層のレスポンダのうち検索項目に一致するレスポンダで 前から数えてN番目にあるレスポンダを検索します。
public
GetNthBackward (SFRResponder から継承) 子階層のレスポンダのうち検索条件に一致するレスポンダで 後ろから数えてN番目にあるレスポンダを検索します。
public
GetPrevious (SFRResponder から継承) 自分より前にあるレスポンダで検索条件に一致するレスポンダを 検索します。
public
GetReference (SFRResponder から継承) ユーザが自由に設定できるリファレンス値を取得します。
public
GetRight (SFRResponder から継承) グループ化されているレスポンダのうち 自分より後にあるレスポンダで検索条件に一致するレスポンダを検索します。
public
GetScrollInterval (SFRResponder から継承) NorthHandler, SouthHandler, WestHandler, EastHandler によりレスポンダの仮想領域がスクロールされるときのスクロール量を取得します。
public
GetStatusEnable (SFRResponder から継承) 応答可能/不可能を取得します。
public
GetStatusFocus (SFRResponder から継承) フォーカス/非フォーカスを取得します。
public
GetStatusTarget (SFRResponder から継承) ターゲット/非ターゲットを取得します。
public
GetStatusVisible (SFRResponder から継承) 可視/不可視を取得します。
public
GetTranslate (SFRResponder から継承) コンテント領域から見た仮想領域の原点座標を取得します。
public
GetTravelMargin (SFRResponder から継承) フォーカスされたレスポンダを自動的に可視領域内に 移動させるときのマージンを取得します。
public
GetType (SFRResponder から継承) タイプを取得します。
public
GetVirtualBound (SFRResponder から継承) 仮想領域をコンテント領域の座標で取得します。
public
GetVirtualWorld (SFRResponder から継承) 仮想領域を取得します。
public
Group (SFRResponder から継承) 他のオブジェクトとグループ化します。
public
GroupMove (SFRResponder から継承) グループ化されているレスポンダすべてを移動します。
public
GroupScroll (SFRResponder から継承) グループ化されているレスポンダすべての仮想領域をスクロールします。
public
GroupSelect (SFRResponder から継承) グループ化されているレスポンダすべてを最前面に移動させます。
public
GroupStatusEnable (SFRResponder から継承) グループ化されているレスポンダすべてに対して、応答可能/不可能を設定します。
public
GroupStatusVisible (SFRResponder から継承) グループ化されているレスポンダすべてに対して、可視/不可視を設定します。
public
InvalidateBase (SFRResponder から継承) ベース領域内のアップデート領域を登録します。
public
InvalidateContent (SFRResponder から継承) コンテント領域内のアップデート領域を登録します。
public
InvalidateVirtual (SFRResponder から継承) 仮想領域内のアップデート領域を登録します。
public
Invoke (SFRResponder から継承) イベントを送信します。
public
static
MenuEntry MenuHandler の静的メンバ関数版です。
public
MenuHandler メニューのデフォルトハンドラです。 メニューを閉じる動作をします。
public
Move (SFRResponder から継承) レスポンダを移動します。
public
RegisterHandler (SFRHandler から継承) ハンドラを登録します。
public
RegisterTracer (SFRTracer から継承) トレーサを登録します。
public
Scroll (SFRResponder から継承) 仮想領域をスクロールします。
public
SetBaseBound (SFRResponder から継承) ベース領域を親の相対座標で設定します。
public
SetContentBound (SFRResponder から継承) コンテント領域をベース領域の相対座標で設定します。
public
SetMoveInterval (SFRResponder から継承) UpHandler, DownHandler, LeftHandler, RightHandler によりレスポンダが移動されるときの移動量を設定します。
public
SetMoveMargin (SFRResponder から継承) UpHandler, DownHandler, LeftHandler, RightHandler, Move 関数によりレスポンダが移動されるときに画面の端から何処まで 移動できるかのマージンを設定します。
public
SetReference (SFRResponder から継承) ユーザが自由に設定できるリファレンス値を設定します。
public
SetScrollInterval (SFRResponder から継承) NorthHandler, SouthHandler, WestHandler, EastHandler によりレスポンダの仮想領域がスクロールされるときのスクロール量を設定します。
public
SetStatusEnable (SFRResponder から継承) 応答可能/不可能を設定します。
public
SetStatusFocus (SFRResponder から継承) フォーカス/非フォーカスを設定します。
public
SetStatusTarget (SFRResponder から継承) ターゲット/非ターゲットを設定します。
public
SetStatusVisible (SFRResponder から継承) 可視/不可視を設定します。
public
SetTranslate (SFRResponder から継承) コンテント領域から見た仮想領域の原点を設定します。
public
SetTravelMargin (SFRResponder から継承) フォーカスされたレスポンダを自動的に可視領域内に 移動させるときのマージンを設定します。
public
SetVirtualBound (SFRResponder から継承) 仮想領域をコンテント領域の相対座標で設定します。
public
Ungroup (SFRResponder から継承) グループ化を解除します。
public
UnregisterHandler (SFRHandler から継承) 登録されているハンドラを削除します。
public
UnregisterTracer (SFRTracer から継承) 登録されているトレーサを削除します。
プロテクト関数
protected
ClearHandler (SFRResponder から継承) クリアキーが押されたときのハンドラです。
protected
DownHandler (SFRResponder から継承) 数字の8キーが押されたときのハンドラです。
protected
EastHandler (SFRResponder から継承) 数字の6キーが押されたときのハンドラです。
protected
static
EscapeEntry EscapeHandler の静的メンバ関数版です。
protected
EscapeHandler クリアキーによりメニューがエスケープされたときに呼び出される ハンドラです。SREVT_MENU と SRP16_ESCAPE の組み合わせのイベントを送信します。
protected
GetAppearanceTransparent (SFRResponder から継承) APPEARANCE_TRANSPARENT フラグが設定されているかどうかを取得します。
protected
GetPropertyClosable (SFRResponder から継承) PROPERTY_CLOSABLE フラグが設定されているかどうかを取得します。
protected
GetPropertyDirect (SFRResponder から継承) PROPERTY_DIRECT フラグが設定されているかどうかを取得します。
protected
GetPropertyMovable (SFRResponder から継承) PROPERTY_MOVABLE フラグが設定されているかどうかを取得します。
protected
GetPropertyScrollable (SFRResponder から継承) PROPERTY_SCROLLABLE フラグが設定されているかどうかを取得します。
protected
GetPropertySelect (SFRResponder から継承) PROPERTY_SELECT フラグが設定されているかどうかを取得します。
protected
GetPropertyTravel (SFRResponder から継承) PROPERTY_TRAVEL フラグが設定されているかどうかを取得します。
protected
LeftHandler (SFRResponder から継承) 数字の4キーが押されたときのハンドラです。
protected
Limit _limit メンバ変数の値を設定/取得します。
protected
NextHandler (SFRResponder から継承) 下矢印キーが押されたときのハンドラです。 フォーカスを一つ後に移動します。
protected
NorthHandler (SFRResponder から継承) 数字の2キーが押されたときのハンドラです。
protected
PreviousHandler (SFRResponder から継承) 上矢印キーが押されたときのハンドラです。 フォーカスを一つ前に移動します。
protected
RegisterManipulateHandler (SFRResponder から継承) SelectHandler, ClearHandler, NextHandler, PreviousHandler を それぞれ AVK_SELECT, AVK_CLR, AVK_DOWN, AVK_UP に登録します。
protected
RegisterMoveHandler (SFRResponder から継承) UpHandler, DownHandler, LeftHandler, RightHandler を それぞれ AVK_2, AVK_8, AVK_4, AVK_6 に登録します。
protected
RegisterScrollHandler (SFRResponder から継承) NorthHandler, SouthHandler, WestHandler, EastHandler を それぞれ AVK_2, AVK_8, AVK_4, AVK_6 に登録します。
protected
RightHandler (SFRResponder から継承) 数字の6キーが押されたときのハンドラです。
protected
Select _select メンバ変数の値を設定/取得します。
protected
static
SelectEntry SelectHandler の静的メンバ関数版です。
protected
SelectHandler セレクトキーによりメニューが選択されたときに呼び出される ハンドラです。SREVT_MENU と選択項目のインデックスの組み合わせの イベントを送信します。
protected
SouthHandler (SFRResponder から継承) 数字の8キーが押されたときのハンドラです。
protected
UnregisterManipulateHandler (SFRResponder から継承) AVK_SELECT, AVK_CLR, AVK_DOWN, AVK_UP に登録されているハンドラを 削除します。
protected
UnregisterMoveHandler (SFRResponder から継承) AVK_2, AVK_8, AVK_4, AVK_6 に登録されているハンドラを 削除します。
protected
UnregisterScrollHandler (SFRResponder から継承) AVK_2, AVK_8, AVK_4, AVK_6 に登録されているハンドラを 削除します。
protected
UpHandler (SFRResponder から継承) 数字の2キーが押されたときのハンドラです。
protected
WestHandler (SFRResponder から継承) 数字の4キーが押されたときのハンドラです。
BehaviorEnum (SFRResponder から継承) レスポンダの振る舞いを表します。
HandlerEnum (SFRHandler から継承) ハンドラの呼び出されるタイミングを表します。
StatusEnum メニューのデフォルトステータスを表します。
TracerEnum (SFRTracer から継承) トレース順序を表します。

SFRMenu::SFRMenu
SFRMenu クラスのコンストラクタです。
[ protected ]
SFRMenu(
    SFRApplicationPtr parent             // 親となるレスポンダのポインタ
    ConstSFURectRef rect                 // 親の座標上での位置
    ConstSFUMarginRef margin             // ベース領域とコンテント領域のマージン
    StatusType status = STATUS_MENU      // ステータス
    SFCType attribute = ATTRIBUTE_MENU   // アトリビュート
);

SFRMenu::~SFRMenu
SFRMenu クラスのデストラクタです。
[ public, virtual ]
~SFRMenu(Void);

SFRMenu::EscapeEntry
EscapeHandler の静的メンバ関数版です。
[ protected, static ]
Bool EscapeEntry(
    ConstSFUEventRef event   // イベント
    VoidPtr this             // オブジェクトのポインタ
);

SFRMenu::EscapeHandler
クリアキーによりメニューがエスケープされたときに呼び出される ハンドラです。SREVT_MENU と SRP16_ESCAPE の組み合わせのイベントを送信します。
[ protected ]
Void EscapeHandler(Void);

SFRMenu::GetDirector
親のポインタを取得します。
[ public, const ]
SFRApplicationPtr GetDirector(Void);

SFRMenu::Limit
_limit メンバ変数の値を設定/取得します。
[ protected ]
Void Limit(
    SInt16 prm   // 設定する値
);
[ protected, const ]
SInt16 Limit(Void);

SFRMenu::MenuEntry
MenuHandler の静的メンバ関数版です。
[ public, static ]
Bool MenuEntry(
    ConstSFUEventRef event   // イベント
    VoidPtr this             // オブジェクトのポインタ
);

SFRMenu::MenuHandler
メニューのデフォルトハンドラです。 メニューを閉じる動作をします。
[ public ]
Void MenuHandler(Void);

SFRMenu::Select
_select メンバ変数の値を設定/取得します。
[ protected ]
Void Select(
    SInt16 prm   // 設定する値
);
[ protected, const ]
SInt16 Select(Void);

SFRMenu::SelectEntry
SelectHandler の静的メンバ関数版です。
[ protected, static ]
Bool SelectEntry(
    ConstSFUEventRef event   // イベント
    VoidPtr this             // オブジェクトのポインタ
);

SFRMenu::SelectHandler
セレクトキーによりメニューが選択されたときに呼び出される ハンドラです。SREVT_MENU と選択項目のインデックスの組み合わせの イベントを送信します。
[ protected ]
Void SelectHandler(Void);

SFRMenu::StatusEnum
メニューのデフォルトステータスを表します。
public:
   enum {
       STATUS_MENU = STATUS_VISIBLE | STATUS_ENABLE | STATUS_FOCUS
   };

解説

STATUS_MENU = STATUS_VISIBLE | STATUS_ENABLE | STATUS_FOCUS となっています。

使用例

デフォルトのステータスから特定のステータスを設定したり 解除したりする場合は以下のように使用します。

STATUS_MENU | STATUS_TRANSPARENT // 透過モードを設定
STATUS_MENU & ~STATUS_ENABLE // 応答不可能に設定
STATUS_MENU & ~(STATUS_ENABLE | STATUS_VISIBLE) | (STATUS_TRANSPARENT | STATUS_MOVABLE)
// 応答可能と可視の設定を解除し透過モードと移動可能を設定