前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFBMenuCtl
IMenuCtl インターフェースのラッパークラスです。
#include <SFBMenuCtl.h.hpp>
class SFBMenuCtl : public SFBControl;
SFMTYPEDEFWRAPPER(SFBMenuCtl)

継承図

SFBMenuCtl クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0

参照

BREW API IMenuCtl

メンバ

パブリック関数
Bool AddItem( ACharConstPtr resFile , UInt16 resID , UInt16 itemID , UInt32 data )
メニューに新しい項目を追加します。
Bool AddItem( UInt16 itemID , WCharPtr text , UInt32 data )
メニューに新しい項目を追加します。
Bool AddItem( SFXAnsiStringConstRef resFile , UInt16 resID , UInt16 itemID , UInt32 data )
メニューに新しい項目を追加します。
Bool AddItem( UInt16 itemID , SFXWideStringPtr text , UInt32 data )
メニューに新しい項目を追加します。
Bool AddItemEx( CtlAddItem* item )
項目を、メニュー、リスト、またはアイコン表示に追加します。
Bool AddOwnerDrawItem( UInt16 itemID , UInt32 itemData )
オーナー描画メニュー項目をメニューに追加します。
Bool DeleteAll( Void )
メニュー コントロール オブジェクトからすべてのメニュー項目を削除します。
Bool DeleteItem( UInt16 itemID )
メニュー コントロールからメニュー項目を削除します。
Void EnableCommand( Bool enable )
デバイスユーザーが選択キーを押したことにより生成されたイベントを受け取ったときに、指定したコマンドをAEEシェルに送信するためにメニュー コントロール オブジェクトを使用可能にします。
UInt16 EnumNextSel( Void )
次の選択項目の ID を取得します。
Bool EnumSelInit( Void )
選択可能なメニュー項目の列挙を初期化します。
Void GetColors( AEEMenuColors* colors )
メニュー要素の色を取得します。
UInt16 GetFocus( Void )
ユーザー入力フォーカスの設定されたメニュー項目の項目 ID を取得します。
Bool GetItem( UInt16 itemID , CtlAddItem* item )
メニュー項目に関連付けられた値を取得します。
SInt32 GetItemCount( Void )
メニュー内の項目数を取得します。
Bool GetItemData( UInt16 itemID , UInt32Ptr data )
指定したメニュー コントロール オブジェクトのメニュー項目に関連するデータを取得します。
UInt16 GetItemID( SInt32 index )
インデックスが指定された項目の項目 ID を取得します。
Void GetItemRect( UInt16 index , SFXRectanglePtr rect , UInt16 index )
メニュー コントロールの項目の描画に使用された矩形を取得します。
SInt32 GetItemTime( UInt16 itemID , UInt16Ptr duration )
メニュー コントロールがカレンダーの場合、メニュー項目 ID で指定されたメニュー項目の開始時刻と継続時間( 開始時刻と終了時刻の間隔 )を取得します。
UInt16 GetSel( Void )
メニュー コントロール オブジェクトで、現在選択されているメニュー項目識別子を取得します。
Void GetStyle( AEEItemStyle* normal , AEEItemStyle* selected )
メニュー項目の表示スタイルを取得します。
Void MoveItem( UInt16 itemID , SInt32 direction )
指定した方向にメニュー項目の位置を1つ移動します。
static
SFBMenuCtlSmp
NewInstance( SFCErrorPtr exception = null )
SFBMenuCtl インスタンスを生成します。
static
SFBMenuCtlSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
SFBMenuCtl インスタンスを生成します。
Void SetColors( AEEMenuColors* colors )
メニュー要素の色を設定します。
Void SetFocus( UInt16 itemID )
指定されたメニュー項目にフォーカスを設定します。
Bool SetItem( UInt16 itemID , UInt16 flags , CtlAddItem* item )
メニュー項目が作成された後で項目の任意のフィールドを設定します。
Void SetItemText( UInt16 itemID , ACharConstPtr resFile , UInt16 resID )
メニュー項目 ID で指定した新しいメニュー項目にテキスト名を設定します。
Void SetItemText( UInt16 itemID , WCharPtr text )
メニュー項目 ID で指定した新しいメニュー項目にテキスト名を設定します。
Void SetItemText( UInt16 itemID , SFXAnsiStringConstRef resFile , UInt16 resID )
メニュー項目 ID で指定した新しいメニュー項目にテキスト名を設定します。
Void SetItemText( UInt16 itemID , SFXWideStringPtr text )
メニュー項目 ID で指定した新しいメニュー項目にテキスト名を設定します。
Void SetItemTime( UInt16 itemID , UInt16 minStart , UInt16 duration )
カレンダー メニュー コントロールを設定します。
Void SetOwnerDrawCB( PFNOWNERDRAWCB notify , VoidPtr context , UInt16 flags )
オーナー描画メニューのコールバック関数を設定します。
SInt32 SetOwnerDrawCB( PFNOWNERDRAWCB notify , SFXBufferPtr context , UInt16 flags )
オーナー描画メニューのコールバック関数を設定します。
Void SetSel( UInt16 itemID )
MP_NO_REDRAW プロパティが設定されていない場合、指定したメニュー項目をメニュー コントロール オブジェクトの現在の選択値に設定し、再描画を要求します。
Void SetSelEx( UInt16 itemID , Bool selected )
selected パラメータの値に応じて、項目を選択/未選択に設定します。
Void SetStyle( AEEItemStyle* normal , AEEItemStyle* selected )
メニュー項目の表示スタイルを設定します。
Bool SetTitle( ACharConstPtr resFile , UInt16 resID )
メニュー コントロール オブジェクトのタイトルを設定します。
Bool SetTitle( WCharPtr text )
メニュー コントロール オブジェクトのタイトルを設定します。
Bool SetTitle( SFXAnsiStringConstRef resFile , UInt16 resID )
メニュー コントロール オブジェクトのタイトルを設定します。
Bool SetTitle( SFXWideStringPtr text )
メニュー コントロール オブジェクトのタイトルを設定します。
Void Sort( AEEMenuSortType type )
メニュー内の項目を並べ替えます。
Void SortCustom( PFNMENUSORTCOMPARE notify , VoidPtr data )
ユーザー供給の比較コールバックを使用してメニューをソートします。
UInt32 GetProperties( Void ) (SFBControl から継承)
コントロール固有のプロパティまたはフラグを取得します。
Void GetRect( SFXRectanglePtr rect ) (SFBControl から継承)
コントロールの矩形を取得します。
SFXRectangle GetRect( Void ) (SFBControl から継承)
コントロールの矩形を取得します。
Bool HandleEvent( AEEEvent event , UInt16 wParam , UInt32 dwParam ) (SFBControl から継承)
コントロールのイベント処理機能を提供します。 この関数はすべてのコントロールで実装する必要があります。
Bool HandleEvent( SFXEventConstRef event ) (SFBControl から継承)
コントロールのイベント処理機能を提供します。 この関数はすべてのコントロールで実装する必要があります。
Bool IsActive( Void ) (SFBControl から継承)
コントロールがアクティブであるかを判定します。
Bool Redraw( Void ) (SFBControl から継承)
コントロールの内容を再描画します。
Void Reset( Void ) (SFBControl から継承)
コントロールの内容をリセットし、アクティブ状態をすぐに解除します。
Void SetActive( Bool active = true ) (SFBControl から継承)
コントロールのアクティブ状態を設定します。
Void SetProperties( UInt32 properties ) (SFBControl から継承)
コントロール固有のプロパティまたはフラグを設定します。
Void SetRect( SFXRectangleConstRef rect ) (SFBControl から継承)
コントロールの矩形を設定します。
プロテクト関数
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBMenuCtl::AddItem
メニューに新しい項目を追加します。
[ public ]
Bool AddItem(
    ACharConstPtr resFile   // リソースファイル名を含む null 終結文字列
    UInt16 resID            // テキスト文字列のリソースを識別するリソース識別子
    UInt16 itemID           // メニュー項目を一意に識別する項目識別子
    UInt32 data             // メニュー項目に関連付ける項目データ
);
[ public ]
Bool AddItem(
    UInt16 itemID   // メニュー項目を一意に識別する項目識別子
    WCharPtr text   // メニュー項目名を含む null 終結文字列
    UInt32 data     // メニュー項目に関連付ける項目データ
);
[ public ]
Bool AddItem(
    SFXAnsiStringConstRef resFile   // リソースファイル名
    UInt16 resID                    // テキスト文字列のリソースを識別するリソース識別子
    UInt16 itemID                   // メニュー項目を一意に識別する項目識別子
    UInt32 data                     // メニュー項目に関連付ける項目データ
);
[ public ]
Bool AddItem(
    UInt16 itemID           // メニュー項目を一意に識別する項目識別子
    SFXWideStringPtr text   // メニュー項目名
    UInt32 data             // メニュー項目に関連付ける項目データ
);

戻り値

  • 追加に成功したとき: true
  • 失敗したとき: false

参照

BREW API IMENUCTL_AddItem | SFBMenuCtl::DeleteItem | SFBControl::Redraw | SFBControl::SetActive


SFBMenuCtl::AddItemEx
項目を、メニュー、リスト、またはアイコン表示に追加します。
[ public ]
Bool AddItemEx(
    CtlAddItem* item   // CtlAddItem 構造体へのポインタ
);

戻り値

  • 追加に成功したとき: true
  • 失敗したとき: false

参照

BREW API IMENUCTL_AddItemEx | SFBControl::Redraw | SFBMenuCtl::AddItem


SFBMenuCtl::AddOwnerDrawItem
オーナー描画メニュー項目をメニューに追加します。
[ public ]
Bool AddOwnerDrawItem(
    UInt16 itemID     // メニュー項目を一意に識別する項目識別子
    UInt32 itemData   // メニュー項目に関連付ける項目データ
);

戻り値

  • 追加に成功したとき: true
  • 失敗したとき: false

バージョン

この関数は、BREW 3.0 から使用可能です

参照

BREW API IMENUCTL_AddOwnerDrawItem | SFBMenuCtl::DeleteItem | SFBControl::Redraw | SFBControl::SetActive


SFBMenuCtl::DeleteAll
メニュー コントロール オブジェクトからすべてのメニュー項目を削除します。
[ public ]
Bool DeleteAll(Void);

戻り値

  • メニュー項目を削除したとき: true
  • 失敗したとき: false

参照

BREW API IMENUCTL_DeleteAll


SFBMenuCtl::DeleteItem
メニュー コントロールからメニュー項目を削除します。
[ public ]
Bool DeleteItem(
    UInt16 itemID   // メニュー項目をメニューに追加したときに使用したメニュー項目識別子
);

参照

BREW API IMENUCTL_DeleteItem


SFBMenuCtl::EnableCommand
デバイスユーザーが選択キーを押したことにより生成されたイベントを受け取ったときに、指定したコマンドをAEEシェルに送信するためにメニュー コントロール オブジェクトを使用可能にします。
[ public ]
Void EnableCommand(
    Bool enable   // 送信可能 / 送信不可を示すブールフラグ
);

参照

BREW API IMENUCTL_EnableCommand | SFBControl::HandleEvent


SFBMenuCtl::EnumNextSel
次の選択項目の ID を取得します。
[ public ]
UInt16 EnumNextSel(Void);

解説

マルチ選択メニュー( MP_MULTI_SEL )だけで使います。

参照

BREW API IMENUCTL_EnumNextSel | SFBMenuCtl::EnumSelInit


SFBMenuCtl::EnumSelInit
選択可能なメニュー項目の列挙を初期化します。
[ public ]
Bool EnumSelInit(Void);

戻り値

  • 初期化に成功したとき: true
  • 失敗したとき: false

解説

マルチ選択メニュー( MP_MULTI_SEL )だけで使います。

参照

BREW API IMENUCTL_EnumSelInit | SFBMenuCtl::EnumNextSel


SFBMenuCtl::GetColors
メニュー要素の色を取得します。
[ public ]
Void GetColors(
    AEEMenuColors* colors   // 色の値
);

バージョン

この関数は、BREW 3.0 から使用可能です

参照

BREW API IMENUCTL_GetColors


SFBMenuCtl::GetFocus
ユーザー入力フォーカスの設定されたメニュー項目の項目 ID を取得します。
[ public ]
UInt16 GetFocus(Void);

解説

マルチ選択メニュー( MP_MULTI_SEL )だけで使います。

参照

BREW API IMENUCTL_GetFocus | SFBMenuCtl::SetFocus


SFBMenuCtl::GetItem
メニュー項目に関連付けられた値を取得します。
[ public ]
Bool GetItem(
    UInt16 itemID      // メニュー項目 ID
    CtlAddItem* item   // 項目情報の構造体
);

戻り値

  • 取得に成功したとき: true
  • 失敗したとき: false

参照

BREW API IMENUCTL_GetItem | CtlAddItem | SFBMenuCtl::SetItem


SFBMenuCtl::GetItemCount
メニュー内の項目数を取得します。
[ public ]
SInt32 GetItemCount(Void);

参照

BREW API IMENUCTL_GetItemCount | SFBMenuCtl::GetItemID


SFBMenuCtl::GetItemData
指定したメニュー コントロール オブジェクトのメニュー項目に関連するデータを取得します。
[ public ]
Bool GetItemData(
    UInt16 itemID    // このメニュー項目をメニューに追加したときに使用したメニュー項目識別子
    UInt32Ptr data   // 項目データを格納するプレース ホルダー
);

戻り値

  • 取得に成功したとき: true
  • 失敗したとき: false

参照

BREW API IMENUCTL_GetItemData | SFBMenuCtl::AddItem


SFBMenuCtl::GetItemID
インデックスが指定された項目の項目 ID を取得します。
[ public ]
UInt16 GetItemID(
    SInt32 index   // 項目のインデックス
);

参照

BREW API IMENUCTL_GetItemID


SFBMenuCtl::GetItemRect
メニュー コントロールの項目の描画に使用された矩形を取得します。
[ public, public ]
Void GetItemRect(
    UInt16 index           // 項目インデックス
    SFXRectanglePtr rect   // 項目矩形
    UInt16 index           // 項目インデックス
);

バージョン

この関数は、BREW 3.0 から使用可能です

参照

BREW API IMENUCTL_GetItemRect


SFBMenuCtl::GetItemTime
メニュー コントロールがカレンダーの場合、メニュー項目 ID で指定されたメニュー項目の開始時刻と継続時間( 開始時刻と終了時刻の間隔 )を取得します。
[ public ]
SInt32 GetItemTime(
    UInt16 itemID        // メニュー項目識別子
    UInt16Ptr duration   // 継続時間( 分 )
);

参照

BREW API IMENUCTL_GetItemTime | SFBMenuCtl::SetItemTime


SFBMenuCtl::GetSel
メニュー コントロール オブジェクトで、現在選択されているメニュー項目識別子を取得します。
[ public ]
UInt16 GetSel(Void);

参照

BREW API IMENUCTL_GetSel | SFBMenuCtl::SetSel


SFBMenuCtl::GetStyle
メニュー項目の表示スタイルを取得します。
[ public ]
Void GetStyle(
    AEEItemStyle* normal     //  通常のメニュー項目のスタイル
    AEEItemStyle* selected   // 選択されたメニュー項目のスタイル
);

バージョン

この関数は、BREW 3.0 から使用可能です

参照

BREW API IMENUCTL_GetStyle


SFBMenuCtl::MoveItem
指定した方向にメニュー項目の位置を1つ移動します。
[ public ]
Void MoveItem(
    UInt16 itemID      // メニュー項目識別子
    SInt32 direction   // 方向  -1 : 上へ / 1: 下へ
);

参照

BREW API IMENUCTL_MoveItem


SFBMenuCtl::NewInstance
SFBMenuCtl インスタンスを生成します。
[ public, static ]
SFBMenuCtlSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);
[ public, static ]
SFBMenuCtlSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // エラー値
);

SFBMenuCtl::SetColors
メニュー要素の色を設定します。
[ public ]
Void SetColors(
    AEEMenuColors* colors   // 色を変更する項目を示すビットマスクと、色の値の両方が含まれる構造体へのポインタ
);

解説

デフォルトでは、メニュー要素の色を決定するのは、デバイスのメーカーによって定義されているシステムカラーテーブルのエントリです。

次のようなエントリがあります。

  • CLR_SYS_ITEM : 未選択項目の背景色
  • CLR_SYS_ITEM_TEXT : 未選択項目と矢印のテキスト色
  • CLR_SYS_ITEM_SEL : 選択項目の背景色
  • CLR_SYS_ITEM_SEL_TEXT : 選択項目のテキスト色
  • CLR_USER_FRAME : シンプルフレームの色
  • CLR_SYS_SCROLLBAR : スクロールバーフレームの色
  • CLR_SYS_SCROLLBAR_FILL : スクロールバーの塗り潰し色
  • CLR_SYS_TITLE : タイトルテキストの背景
  • CLR_SYS_TITLE_TEXT : タイトルテキストの色

参照

BREW API IMENUCTL_SetColors | AEEMenuColors


SFBMenuCtl::SetFocus
指定されたメニュー項目にフォーカスを設定します。
[ public ]
Void SetFocus(
    UInt16 itemID   // 設定する項目の ID
);

解説

マルチ選択メニュー( MP_MULTI_SEL )だけで使います。

参照

BREW API IMENUCTL_SetFocus | SFBMenuCtl::GetFocus


SFBMenuCtl::SetItem
メニュー項目が作成された後で項目の任意のフィールドを設定します。
[ public ]
Bool SetItem(
    UInt16 itemID      // メニュー項目 ID
    UInt16 flags       // CtlAddItem 構造体の有効フィールドのマスク
    CtlAddItem* item   // 項目情報の構造体
);

戻り値

  • 設定に成功したとき: true
  • 失敗したとき: false

参照

BREW API IMENUCTL_SetItem | CtlAddItem | SFBMenuCtl::GetItem | SFBControl::Redraw


SFBMenuCtl::SetItemText
メニュー項目 ID で指定した新しいメニュー項目にテキスト名を設定します。
[ public ]
Void SetItemText(
    UInt16 itemID           // メニュー項目識別子
    ACharConstPtr resFile   // リソースファイル名を含む null 終結文字列
    UInt16 resID            // リソース ID
);
[ public ]
Void SetItemText(
    UInt16 itemID   // メニュー項目識別子
    WCharPtr text   // 文字列形式の新しいメニュー項目テキスト
);
[ public ]
Void SetItemText(
    UInt16 itemID                   // メニュー項目識別子
    SFXAnsiStringConstRef resFile   // リソースファイル名
    UInt16 resID                    // リソース ID
);
[ public ]
Void SetItemText(
    UInt16 itemID           // メニュー項目識別子
    SFXWideStringPtr text   // 新しいメニュー項目テキスト
);

参照

BREW API IMENUCTL_SetItemText


SFBMenuCtl::SetItemTime
カレンダー メニュー コントロールを設定します。
[ public ]
Void SetItemTime(
    UInt16 itemID     // メニュー項目識別子
    UInt16 minStart   // 開始時刻( 分 )
    UInt16 duration   // 継続時間( 分 )
);

参照

BREW API IMENUCTL_SetItemTime | SFBMenuCtl::GetItemTime


SFBMenuCtl::SetOwnerDrawCB
オーナー描画メニューのコールバック関数を設定します。
[ public ]
Void SetOwnerDrawCB(
    PFNOWNERDRAWCB notify   // コールバック関数
    VoidPtr context         // コンテキストポインタ
    UInt16 flags            // オーナー描画フラグ
                            // ODF_TITLE_OD: タイトルがオーナー描画であることを示す 
                            // ODF_SB_OD: スクロールバーがオーナー描画であることを示す 
                            // ODF_ITEM_OD: メニューにオーナー描画項目が許可されることを示す 
                            // ODF_MEASURE_ONCE: すべての項目が同じ高さと幅であることを示す
);
[ public ]
SInt32 SetOwnerDrawCB(
    PFNOWNERDRAWCB notify   // コールバック関数
    SFXBufferPtr context    //バッファへのポインタ
    UInt16 flags            // オーナー描画フラグ
                            // ODF_TITLE_OD: タイトルがオーナー描画であることを示す 
                            // ODF_SB_OD: スクロールバーがオーナー描画であることを示す 
                            // ODF_ITEM_OD: メニューにオーナー描画項目が許可されることを示す 
                            // ODF_MEASURE_ONCE: すべての項目が同じ高さと幅であることを示す
);

バージョン

この関数は、BREW 3.0 から使用可能です

参照

BREW API IMENUCTL_SetOwnerDrawCB | SFBMenuCtl::GetItemTime


SFBMenuCtl::SetSel
MP_NO_REDRAW プロパティが設定されていない場合、指定したメニュー項目をメニュー コントロール オブジェクトの現在の選択値に設定し、再描画を要求します。
[ public ]
Void SetSel(
    UInt16 itemID   // メニュー項目識別子
                    // メニュー項目をメニューに追加したときに使用した識別子を指定する
);

参照

BREW API IMENUCTL_SetSel | SFBMenuCtl::GetSel


SFBMenuCtl::SetSelEx
selected パラメータの値に応じて、項目を選択/未選択に設定します。
[ public ]
Void SetSelEx(
    UInt16 itemID   // 設定する項目の ID
    Bool selected   // 項目を選択 / 選択解除する
);

解説

マルチ選択メニュー( MP_MULTI_SEL )だけで使います。

参照

BREW API IMENUCTL_SetSelEx


SFBMenuCtl::SetStyle
メニュー項目の表示スタイルを設定します。
[ public ]
Void SetStyle(
    AEEItemStyle* normal     // 通常のメニュー項目のスタイル
    AEEItemStyle* selected   // 選択されたメニュー項目のスタイル
);

参照

BREW API IMENUCTL_SetStyle | AEEItemStyle


SFBMenuCtl::SetTitle
メニュー コントロール オブジェクトのタイトルを設定します。
[ public ]
Bool SetTitle(
    ACharConstPtr resFile   // リソースファイル名を含む null 終結文字列
    UInt16 resID            // リソース識別子
);
[ public ]
Bool SetTitle(
    WCharPtr text   // メニュータイトルに使用する null 終結文字列
);
[ public ]
Bool SetTitle(
    SFXAnsiStringConstRef resFile   // リソースファイル名
    UInt16 resID                    // リソース識別子
);
[ public ]
Bool SetTitle(
    SFXWideStringPtr text   // メニュータイトルに使用する文字列
);

戻り値

  • 設定に成功したとき: true
  • 失敗したとき: false

参照

BREW API IMENUCTL_SetTitle SFBControl::Redraw


SFBMenuCtl::Sort
メニュー内の項目を並べ替えます。
[ public ]
Void Sort(
    AEEMenuSortType type   // ソートタイプ
);

参照

BREW API IMENUCTL_Sort | AEEMenuSortType | SFBMenuCtl::SortCustom


SFBMenuCtl::SortCustom
ユーザー供給の比較コールバックを使用してメニューをソートします。
[ public ]
Void SortCustom(
    PFNMENUSORTCOMPARE notify   // ユーザーのソート比較コールバック
    VoidPtr data                // 比較関数に渡されるユーザー コンテキストデータへのポインタ
);

参照

BREW API IMENUCTL_SortCustom | PFNMENUSORTCOMPARE | SFBMenuCtl::Sort