SFBMenuCtl

IMenuCtl インターフェイスのラッパークラスです。

#include <SFBMenuCtl.hpp>

class SFBMenuCtl : public SFBControl;

typedef SFBMenuCtl&          SFBMenuCtlRef;
typedef SFBMenuCtl*          SFBMenuCtlPtr;
typedef SFBMenuCtl**         SFBMenuCtlHandle;
typedef const SFBMenuCtl     ConstSFBMenuCtl;
typedef const SFBMenuCtl&    ConstSFBMenuCtlRef;
typedef const SFBMenuCtl*    ConstSFBMenuCtlPtr;
typedef const SFBMenuCtl**   ConstSFBMenuCtlHandle;

継承図

参照

BREW API IMenuCtl

バグ情報

メニュープロパティ
ドキュメントエラー	BREW API リファレンス 2.0.1.5

メニュープロパティについては、複数箇所に記述があり、その記述内容に若干の異同があります。「データ構造 (Data Structure)」の AEE メニュープロパティ (AEE Menu Properties) のページに記載されているのが正しい情報です。

IMENUCTL_AddItem, IMENUCTL_AddItemEx
Tips	すべて

リソースファイルから項目テキストを読み込ませる場合、セットできる文字は NULL 終端を含め 128 文字までです。これ以上の文字をセットしようとすると、 EFAILED が返り、項目は追加されません。

メンバ

パブリック関数
public	AddItem	メニューに新しいメニュー項目を追加します。
public	AddItemEx	項目をメニュー、リスト、またはアイコン表示に追加します。
public	AddRef (SFBBase から継承)	インターフェイスの参照カウントをインクリメントします。
public	DeleteAll	メニューコントロールオブジェクトからすべてのメニュー項目を削除します。
public	DeleteItem	メニューコントロールからメニュー項目を削除します。
public	EnableCommand	デバイスユーザーが選択キーを押したことにより生成されたイベントを受け取ったときに、指定されたコマンドをAEEシェルに送信するためにメニューコントロールオブジェクトを使用可能にします。
public	EnumNextSel	この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。
public	EnumSelInit	この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。
public	GetFocus	この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。
public	GetItem	メニュー項目に関連付けられた値を問い合わせます。
public	GetItemCount	メニュー内の項目の数を返します。
public	GetItemData	指定されたメニューコントロールオブジェクトのメニュー項目に関連するデータを取得します。
public	GetItemID	インデックスが指定された項目の項目IDを返します。
public	GetItemTime	メニューコントロールがカレンダーの場合、メニュー項目IDで指定されたメニュー項目の開始時刻と継続時間（開始時刻と終了時刻の間隔）を取得します。
public	GetProperties (SFBControl から継承)	コントロール固有のプロパティまたはフラグを返します。
public	GetRect (SFBControl から継承)	コントロールの矩形を取得します。
public	GetSel	メニューコントロールオブジェクトで現在選択されているメニュー項目識別子を取得します。
public	HandleEvent (SFBControl から継承)	コントロールのイベント処理機能を提供します。この関数はすべてのコントロールで実装する必要があります。
public static	Instance	IMenuCtl インターフェイスのインスタンスを取得します。
public	IsActive (SFBControl から継承)	コントロールのアクティブ状態を返します。
public	MoveItem	指定された方向にメニュー項目の位置を１つ移動します。
public	Redraw (SFBControl から継承)	コントロールの内容を再描画します。
public	Release (SFBBase から継承)	インターフェイスの参照カウントをデクリメントします。
public	Reset (SFBControl から継承)	コントロールの内容をリセットし、アクティブ状態をすぐに解除します。
public	SetActive (SFBControl から継承)	コントロールのアクティブ状態を設定/解除します。
public	SetColors	デフォルトでは、メニュー要素の色を決定するのは、デバイスのメーカーによって定義されているシステムカラーテーブルのエントリです。
public	SetFocus	この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。
public	SetItem	メニュー項目が作成された後で項目の任意のフィールドを設定します。
public	SetItemText	メニュー項目IDで指定された新しいメニュー項目にテキスト名を設定します。
public	SetItemTime	カレンダーメニューコントロールを設定します。
public	SetProperties (SFBControl から継承)	コントロール固有のプロパティまたはフラグを設定します。
public	SetRect (SFBControl から継承)	コントロールの矩形を設定します。
public	SetSel	MP_NO_REDRAWプロパティが設定されていない場合、指定されたメニュー項目をメニューコントロールオブジェクトの現在の選択値に設定し、再描画を要求します。
public	SetSelEx	この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。
public	SetStyle	メニュー項目の表示スタイルを設定します。
public	SetTitle	メニューコントロールオブジェクトのタイトルを設定します。
public	Sort	メニュー内の項目を並べ替えます。
public	SortCustom	ユーザー供給の比較コールバックを使ってメニューをソートします。

SFBMenuCtl::AddItem

メニューに新しいメニュー項目を追加します。

[ public ]
Bool AddItem(
    ConstACharPtr pszResFile   
    UInt16 wResID              
    UInt16 nItemID             
    UInt32 lData               
);

[ public ]
Bool AddItem(
    UInt16 nItemID   
    WCharPtr pText   
    UInt32 lData     
);

[ public ]
Bool AddItem(
    UInt16 nItemID             
    SFUWideStringPtr strText   
    UInt32 lData               
);

[ public ]
Bool AddItem(
    ConstSFUAnsiStringRef strResFile   
    UInt16 wResID                      
    UInt16 nItemID                     
    UInt32 lData                       
);

参照

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

SFBMenuCtl::AddItemEx

項目をメニュー、リスト、またはアイコン表示に追加します。

[ public ]
Bool AddItemEx(
    CtlAddItem * pAddItem    
);

参照

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

SFBMenuCtl::DeleteAll

メニューコントロールオブジェクトからすべてのメニュー項目を削除します。

[ public ]
Bool DeleteAll(Void);

参照

BREW API IMENUCTL_DeleteAll

SFBMenuCtl::DeleteItem

メニューコントロールからメニュー項目を削除します。

[ public ]
Bool DeleteItem(
    UInt16 nItemID   
);

参照

BREW API IMENUCTL_DeleteItem

SFBMenuCtl::EnableCommand

デバイスユーザーが選択キーを押したことにより生成されたイベントを受け取ったときに、指定されたコマンドをAEEシェルに送信するためにメニューコントロールオブジェクトを使用可能にします。

[ public ]
Void EnableCommand(
    Bool bEnable   
);

参照

BREW API IMENUCTL_EnableCommand | SFBControl::HandleEvent

SFBMenuCtl::EnumNextSel

この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。

[ public ]
UInt16 EnumNextSel(Void);

参照

BREW API IMENUCTL_EnumNextSel | SFBMenuCtl::EnumSelInit

SFBMenuCtl::EnumSelInit

この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。

[ public ]
Bool EnumSelInit(Void);

参照

BREW API IMENUCTL_EnumSelInit | SFBMenuCtl::EnumNextSel

SFBMenuCtl::GetFocus

この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。

[ public ]
UInt16 GetFocus(Void);

参照

BREW API IMENUCTL_GetFocus | SFBMenuCtl::SetFocus

SFBMenuCtl::GetItem

メニュー項目に関連付けられた値を問い合わせます。

[ public ]
Bool GetItem(
    UInt16 wID         
    CtlAddItem * pai   
);

参照

BREW API IMENUCTL_GetItem | CtlAddItem | SFBMenuCtl::SetItem

SFBMenuCtl::GetItemCount

メニュー内の項目の数を返します。

[ public ]
SIntN GetItemCount(Void);

参照

BREW API IMENUCTL_GetItemCount | SFBMenuCtl::GetItemID

SFBMenuCtl::GetItemData

指定されたメニューコントロールオブジェクトのメニュー項目に関連するデータを取得します。

[ public ]
Bool GetItemData(
    UInt16 nItemID     
    UInt32Ptr plData   
);

[ public ]
UInt32 GetItemData(
    UInt16 nItemID   
);

参照

BREW API IMENUCTL_GetItemData | SFBMenuCtl::AddItem

SFBMenuCtl::GetItemID

インデックスが指定された項目の項目IDを返します。

[ public ]
UInt16 GetItemID(
    SIntN nIdx   
);

参照

BREW API IMENUCTL_GetItemID

SFBMenuCtl::GetItemTime

メニューコントロールがカレンダーの場合、メニュー項目IDで指定されたメニュー項目の開始時刻と継続時間（開始時刻と終了時刻の間隔）を取得します。

[ public ]
SIntN GetItemTime(
    UInt16 nItemID        
    UInt16 * pwDuration   
);

参照

BREW API IMENUCTL_GetItemTime | SFBMenuCtl::SetItemTime

SFBMenuCtl::GetSel

メニューコントロールオブジェクトで現在選択されているメニュー項目識別子を取得します。

[ public ]
UInt16 GetSel(Void);

参照

BREW API IMENUCTL_GetSel | SFBMenuCtl::SetSel

SFBMenuCtl::Instance

IMenuCtl インターフェイスのインスタンスを取得します。

[ public, static ]
SFUBrewPtr<SFBMenuCtl> Instance(
    AEECLSID cls_id   
);

SFBMenuCtl::MoveItem

指定された方向にメニュー項目の位置を１つ移動します。

[ public ]
Void MoveItem(
    UInt16 nItemID   
    SIntN nDir       
);

参照

BREW API IMENUCTL_MoveItem

SFBMenuCtl::SetColors

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

[ public ]
Void SetColors(
    AEEMenuColors * pc   
);

参照

BREW API IMENUCTL_SetColors | AEEMenuColors

SFBMenuCtl::SetFocus

この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。

[ public ]
Void SetFocus(
    UInt16 wID   
);

参照

BREW API IMENUCTL_SetFocus | SFBMenuCtl::GetFocus

SFBMenuCtl::SetItem

メニュー項目が作成された後で項目の任意のフィールドを設定します。

[ public ]
Bool SetItem(
    UInt16 wID         
    UInt16 wFlags      
    CtlAddItem * pai   
);

参照

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

SFBMenuCtl::SetItemText

メニュー項目IDで指定された新しいメニュー項目にテキスト名を設定します。

[ public ]
Void SetItemText(
    UInt16 nItemID             
    ConstACharPtr pszResFile   
    UInt16 wResID              
    WCharPtr pText             
);

[ public ]
Void SetItemText(
    UInt16 nItemID                     
    ConstSFUAnsiStringRef strResFile   
    UInt16 wResID                      
);

[ public ]
Void SetItemText(
    UInt16 nItemID     
    WCharPtr strText   
);

参照

BREW API IMENUCTL_SetItemText

SFBMenuCtl::SetItemTime

カレンダーメニューコントロールを設定します。

[ public ]
Void SetItemTime(
    UInt16 nItemID     
    UInt16 wMinStart   
    UInt16 wDuration   
);

参照

BREW API IMENUCTL_SetItemTime | SFBMenuCtl::GetItemTime

SFBMenuCtl::SetSel

MP_NO_REDRAWプロパティが設定されていない場合、指定されたメニュー項目をメニューコントロールオブジェクトの現在の選択値に設定し、再描画を要求します。

[ public ]
Void SetSel(
    UInt16 nItemID   
);

参照

BREW API IMENUCTL_SetSel | SFBMenuCtl::GetSel

SFBMenuCtl::SetSelEx

この関数は、マルチ選択メニュー（MP_MULTI_SEL）でのみ使用します。

[ public ]
Void SetSelEx(
    UInt16 wID       
    Bool bSelected   
);

参照

BREW API IMENUCTL_SetSelEx

SFBMenuCtl::SetStyle

メニュー項目の表示スタイルを設定します。

[ public ]
Void SetStyle(
    AEEItemStyle * pNormal   
    AEEItemStyle * pSel      
);

参照

BREW API IMENUCTL_SetStyle | AEEItemStyle

SFBMenuCtl::SetTitle

メニューコントロールオブジェクトのタイトルを設定します。

[ public ]
Bool SetTitle(
    ConstACharPtr pszResFile   
    UInt16 eResID              
);

[ public ]
Bool SetTitle(
    WCharPtr pText   
);

[ public ]
Bool SetTitle(
    ConstSFUAnsiStringRef strResFile   
    UInt16 wResID                      
);

[ public ]
Bool SetTitle(
    SFUWideStringPtr strText   
);

参照

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 fn   
    VoidPtr data            
);

参照

BREW API IMENUCTL_SortCustom | PFNMENUSORTCOMPARE | SFBMenuCtl::Sort