SFZListBoxControl

リストボックスを表すコントロールです。

#include <SFZListBoxControl.h.hpp>

class SFZListBoxControl : public SFYBandControl;

SFMTYPEDEFRESPONDER(SFZListBoxControl)

継承図

協調図

解説

SFZListBoxControl は、ユーザーに表示された複数の項目のリストの中からひとつ選択させるためのコントロール用クラスです。

ユーザーがある項目を選択すると、その項目はハイライト表示されて、そのイベントが親レスポンダに送信されます。

リストボックスの最小値は常に０です。

リストボックスの現在値は選択されている項目のインデックスを表します。

リストボックスの最大値は項目数を表します。

SetMinimumValue, SetMaximumValue 関数で最小値、最大値を変更してはいけません。

以下は、リストボックスを生成するためのコードです。

Void UserClass::Main(Void)
{
     SFCError error;

     // ウインドウを生成する
     _window = SFZWindow::NewInstance();
     _window->SetParent(GetThis());
     _window->SetRealBound(GetLocalBound());
     _window->SetVirtualBound(SFXRectangle(_window->GetVirtualBound()).SetHeight(640));
     _window->SetState(true, true, true, true);
     _window->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

     // リストボックスを生成する
     SFZListBoxControlSmp _list = SFZListBoxControl::NewInstance(&error);
     _list->SetRealBound(SFXRectangle(20,50,200,200));
     _list->SetState(true, true, true, true);
     _list->SetParent(_window);

     UInt16 i;
     for (i = 0;  i < 10 ; ++i) {
          _list->Append(SFXAnsiString::Format("List Item %d ", i));
     }
	 
     return;
}

実行結果:

	注意
	リストボックスは、`SFZComboBoxControl` クラスの実装で使用されます。

参照

リストボックスコントロール[SFZListBoxControl] | SFZComboBoxControl | SFZTextMenu

メンバ

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

パブリック関数
`SFCError`	Append( `SFXPathConstRef` path , `UInt16` id ) Append( `SFXWideStringConstRef` text , `AVKType` key , `WChar` keyIcon = 0 ) Append( `SFXWideStringConstRef` item ) Append( `SFXPathConstRef` path , `UInt16` id , `AVKType` key , `WChar` keyIcon = 0 ) リストボックスに項目を追加します。
`Void`	Clear( `Void` ) リストボックスのすべての項目を削除します。
`SFXBevelColorConstRef`	GetBevelColor( `Void` ) 3D のリストボックスを描画するためのベベルカラーを取得します。
`SFXRGBColorConstRef`	GetDefaultItemBackColor( `Void` ) 項目のデフォルトの背景色を取得します。
`SFXRGBColorConstRef`	GetDefaultItemForeColor( `Void` ) 項目のデフォルトの前景色を取得します。
`AVKType`	GetDownKey( `Void` ) DOWN キーを取得します。
`AVKType`	GetEscapeKey( `Void` ) ESCAPE キーを取得します。
`AEEFont`	GetFont( `Void` ) フォントを取得します。
`AVKType`	GetItemAccessKey( `SInt32` index ) 指定された項目のアクセスキーを取得します。
`SFXRGBColorConstRef`	GetItemBackColor( `SInt32` index ) 指定された項目の背景色を取得します。
`SFXRGBColorConstRef`	GetItemForeColor( `SInt32` index ) 指定された項目のテキストを描画する色を取得します。
`SInt16`	GetItemHeight( `Void` ) リストボックスの項目の高さを取得します。
`SFXWideStringConstRef`	GetItemText( `SInt32` index ) 指定された項目のテキストを取得します。
`SInt32`	GetMaximumValue( `Void` ) リストボックスの項目数を取得します。
`AVKType`	GetOperateKey( `Void` ) 操作キーを取得します。
static `SFZBandScrollBarControlSmp`	GetScrollBar( `Void` ) スクロールバーコントロールを取得します。
`UInt32`	GetScrollInterval( `Void` ) スクロールインターバルを取得します。
`SInt16`	GetScrollStep( `Void` ) スクロールステップを取得します。
`SFXRGBColorConstRef`	GetSelBackColor( `Void` ) 現在選択されている項目の背景色を取得します。
`SFXRGBColorConstRef`	GetSelForeColor( `Void` ) 現在選択されている項目の前景色を取得します。
`AVKType`	GetUpKey( `Void` ) UP キーを取得します。
`UInt32`	GetWaitInterval( `Void` ) スクロールに関する待ちインターバルを取得します。
static `SFZListBoxControlSmp`	NewInstance( `SFCErrorPtr` exception = null ) 新しいインスタンスを作成します。
`Void`	Remove( `SInt32` index ) リストボックスから指定した項目を削除します。
`Void`	SetBevelColor( `SFXBevelColorConstRef` param ) 3D のリストボックスを描画するためのベベルカラーを設定します。
`Void`	SetDefaultItemBackColor( `SFXRGBColorConstRef` param ) 項目のデフォルトの背景色を設定します。
`Void`	SetDefaultItemForeColor( `SFXRGBColorConstRef` param ) 項目のデフォルトの前景色を設定します。
`Void`	SetDownKey( `AVKType` param ) DOWN キーを設定します。
`Void`	SetEscapeKey( `AVKType` param ) ESCAPE キーを設定します。
`Void`	SetFont( `AEEFont` value ) フォントを設定します。
`SFCError`	SetItemAccessKey( `SInt32` index , `AVKType` key , `WChar` keyIcon = 0 ) 指定された項目にアクセスキーとその絵文字を設定します。
`SFCError`	SetItemBackColor( `SInt32` index , `SFXRGBColorConstRef` param ) 指定された項目の背景色を設定します。
`Void`	SetItemForeColor( `SInt32` index , `SFXRGBColorConstRef` param ) 指定された項目のテキストを描画する前景色を設定します。
`Void`	SetItemHeight( `SInt16` param ) 項目の高さを設定します。
`SFCError`	SetItemText( `SInt32` index , `SFXPathConstRef` path , `UInt16` id ) SetItemText( `SInt32` index , `SFXWideStringConstRef` item ) 指定された項目にテキストを取得します。
`Void`	SetOperateKey( `AVKType` param ) 操作キーを設定します。
`Void`	SetScrollInterval( `UInt32` param ) スクロールインターバルを設定します。
`Void`	SetScrollStep( `SInt16` param ) スクロールステップを設定します。
`Void`	SetSelBackColor( `SFXRGBColorConstRef` param ) 現在選択されている項目の背景色を設定します。
`Void`	SetSelForeColor( `SFXRGBColorConstRef` param ) 現在選択されている項目の前景色を設定します。
`Void`	SetUpKey( `AVKType` param ) UP キーを設定します。
`Void`	SetWaitInterval( `UInt32` param ) スクロールに関する待ちインターバルを設定します。
`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 から継承) 最前面に位置する子レスポンダを取得します。
`SInt32`	GetCurrentValue( `Void` ) (SFYControl から継承) コントロールの現在値を取得します。
`SFYDistributerPtr`	GetDistributer( `Void` ) (SFYResponder から継承) 配信エンジンを取得します。
`SInt32`	GetFieldValue( `Void` ) (SFYBandControl から継承) コントロールのフィールド値を取得します。
`SFXRectangle`	GetGlobalBound( `Void` ) (SFYResponder から継承) グローバル領域を取得します。
`UInt32`	GetID( `Void` ) (SFYResponder から継承) ID を取得します。
`SFXRectangle`	GetLocalBound( `Void` ) (SFYResponder から継承) ローカル領域を取得します。
`SInt32`	GetMinimumValue( `Void` ) (SFYControl から継承) コントロールの最小値を取得します。
`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 から継承) 最適な余白を取得します。
`SInt32`	GetTopValue( `Void` ) (SFYBandControl から継承) コントロールのトップ値を取得します。
`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`	SetCurrentValue( `SInt32` param ) (SFYControl から継承) コントロールの現在値を設定します。
`Void`	SetDistributer( `SFYDistributerPtr` param ) (SFYResponder から継承) 配信エンジンを設定します。
`Void`	SetFieldValue( `SInt32` param ) (SFYBandControl から継承) コントロールのフィールド値を設定します。
`Void`	SetID( `UInt32` param ) (SFYResponder から継承) ID を設定します。
`Void`	SetMaximumValue( `SInt32` param ) (SFYControl から継承) コントロールの最大値を設定します。
`Void`	SetMinimumValue( `SInt32` param ) (SFYControl から継承) コントロールの最小値を設定します。
`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`	SetTopValue( `SInt32` param ) (SFYBandControl から継承) コントロールのトップ値を設定します。
`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`	HandleBoundVirtual( `Void` ) 仮想領域の変更処理を行います。
`Void`	HandleRenderRequest( `SFXGraphicsPtr` graphics ) リストボックスを描画します。
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`	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 SFZListBoxControl クラスを表す定数です。
DefaultEnum リストボックスで使用される定数です。

SFZListBoxControl::SFZListBoxControl

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

[ protected, explicit ]
SFZListBoxControl(Void);

SFZListBoxControl::~SFZListBoxControl

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

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

SFZListBoxControl::Append

リストボックスに項目を追加します。

[ public ]
SFCError Append(
    SFXPathConstRef path   // リソースファイルのパス
    UInt16 id              // テキスト オブジェクト ID
);

[ public ]
SFCError Append(
    SFXPathConstRef path   // リソースファイルのパス
    UInt16 id              // テキスト オブジェクト ID
    AVKType key            // ダイレクトアクセスキー
    WChar keyIcon = 0      // キーアイコン
);

[ public ]
SFCError Append(
    SFXWideStringConstRef item   // テキスト項目
);

[ public ]
SFCError Append(
    SFXWideStringConstRef text   // テキスト項目
    AVKType key                  // ダイレクトアクセスキー
    WChar keyIcon = 0            // キーアイコン
);

解説

リストボックスに項目を追加します。追加された項目はリストボックスの最後の項目となります。

参照

SFZListBoxControl::Remove | SFZListBoxControl::Clear

SFZListBoxControl::Clear

リストボックスのすべての項目を削除します。

[ public ]
Void Clear(Void);

参照

SFZListBoxControl::Append | SFZListBoxControl::Remove

SFZListBoxControl::GetBevelColor

3D のリストボックスを描画するためのベベルカラーを取得します。

[ public, const ]
SFXBevelColorConstRef GetBevelColor(Void);

戻り値

3D のリストボックスを描画するためのベベルカラー(SFXBevelColor)。

参照

SFZListBoxControl::SetBevelColor | SFXBevelColor

SFZListBoxControl::GetDefaultItemBackColor

項目のデフォルトの背景色を取得します。

[ public, const ]
SFXRGBColorConstRef GetDefaultItemBackColor(Void);

参照

SFZListBoxControl::SetDefaultItemBackColor

SFZListBoxControl::GetDefaultItemForeColor

項目のデフォルトの前景色を取得します。

[ public, const ]
SFXRGBColorConstRef GetDefaultItemForeColor(Void);

参照

SFZListBoxControl::SetDefaultItemForeColor

SFZListBoxControl::GetDownKey

DOWN キーを取得します。

[ public, const ]
AVKType GetDownKey(Void);

戻り値

SFZListBoxControl::SetDownKey 関数によって設定された DOWN キー。

参照

SFZListBoxControl::SetDownKey | SFZListBoxControl::GetUpKey | SFZListBoxControl::SetUpKey

SFZListBoxControl::GetEscapeKey

ESCAPE キーを取得します。

[ public, const ]
AVKType GetEscapeKey(Void);

戻り値

SFZListBoxControl::GetEscapeKey 関数によって設定された ESCAPE キー。

参照

SFZListBoxControl::GetEscapeKey

SFZListBoxControl::GetFont

フォントを取得します。

[ public, const ]
AEEFont GetFont(Void);

戻り値

リストボックスの項目を描画するフォント。

参照

SFZListBoxControl::SetFont

SFZListBoxControl::GetItemAccessKey

指定された項目のアクセスキーを取得します。

[ public, const ]
AVKType GetItemAccessKey(
    SInt32 index   // リスト項目のインデックス
);

戻り値

リスト項目のアクセスキー。アクセスキーが設定されていない場合は AVK_UNDEFINED。

参照

SFZListBoxControl::SetItemAccessKey

SFZListBoxControl::GetItemBackColor

指定された項目の背景色を取得します。

[ public, const ]
SFXRGBColorConstRef GetItemBackColor(
    SInt32 index   // リスト項目のインデックス
);

戻り値

リスト項目の背景色 (SFXRGBColor)。

参照

SFZListBoxControl::SetItemBackColor | SFXRGBColor

SFZListBoxControl::GetItemForeColor

指定された項目のテキストを描画する色を取得します。

[ public, const ]
SFXRGBColorConstRef GetItemForeColor(
    SInt32 index   // 項目のインデックス
);

戻り値

リストボックスの項目のテキストを描画する色(SFXRGBColor)。

参照

SFZListBoxControl::SetItemForeColor | SFXRGBColor

SFZListBoxControl::GetItemHeight

リストボックスの項目の高さを取得します。

[ public, const ]
SInt16 GetItemHeight(Void);

戻り値

リストボックスの項目の高さ。

参照

SFZListBoxControl::SetItemHeight

SFZListBoxControl::GetItemText

指定された項目のテキストを取得します。

[ public ]
SFXWideStringConstRef GetItemText(
    SInt32 index   // 項目のインデックス
);

戻り値

The text of the item.

参照

SFZListBoxControl::SetItemText

SFZListBoxControl::GetMaximumValue

リストボックスの項目数を取得します。

[ public, const ]
SInt32 GetMaximumValue(Void);

戻り値

リストボックスの項目数。

SFZListBoxControl::GetOperateKey

操作キーを取得します。

[ public, const ]
AVKType GetOperateKey(Void);

戻り値

SFZListBoxControl::SetOperateKey 関数によって設定された操作キー。

参照

SFZListBoxControl::SetOperateKey

SFZListBoxControl::GetScrollBar

スクロールバーコントロールを取得します。

[ public, static ]
SFZBandScrollBarControlSmp GetScrollBar(Void);

戻り値

帯コントロール用スクロールバーコントロール。

解説

リストボックスで使用されるスクロールバーコントロールを取得します。

開発者は取得したスクロールバーコントロールを使って、スクロールバーのコンポーネントの色を変更したりできます。

使用例

以下は、リストボックスで使用されるスクロールバーコントロールを取得するためのコードです。

// スクロールバーコントロールを取得する
SFZBandScrollBarControlSmp _scrollbar;

if ((_scrollbar = SFZListBoxControl::GetScrollBar()) != null) {
    _scrollbar->SetTrackColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));
}

参照

SFZBandScrollBarControl

SFZListBoxControl::GetScrollInterval

スクロールインターバルを取得します。

[ public, const ]
UInt32 GetScrollInterval(Void);

戻り値

スクロールインターバル(単位:ミリ秒)。

参照

SFZListBoxControl::SetScrollInterval

SFZListBoxControl::GetScrollStep

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

[ public, const ]
SInt16 GetScrollStep(Void);

戻り値

スクロールステップ(スクロールの移動単位)。

参照

SFZListBoxControl::SetScrollStep

SFZListBoxControl::GetSelBackColor

現在選択されている項目の背景色を取得します。

[ public, const ]
SFXRGBColorConstRef GetSelBackColor(Void);

戻り値

現在選択されている項目を含む矩形の背景色(SFXRGBColor)。

参照

SFZListBoxControl::SetSelBackColor | SFZListBoxControl::GetSelForeColor | SFZListBoxControl::SetSelForeColor | SFXRGBColor

SFZListBoxControl::GetSelForeColor

現在選択されている項目の前景色を取得します。

[ public, const ]
SFXRGBColorConstRef GetSelForeColor(Void);

戻り値

現在選択されている項目のテキストを描画する前景色(SFXRGBColor)。

参照

SFZListBoxControl::SetSelForeColor | SFZListBoxControl::GetSelBackColor | SFZListBoxControl::SetSelBackColor | SFXRGBColor

SFZListBoxControl::GetUpKey

UP キーを取得します。

[ public, const ]
AVKType GetUpKey(Void);

戻り値

SFZListBoxControl::SetUpKey 関数によって設定された UP キー。

参照

SFZListBoxControl::SetUpKey | SFZListBoxControl::GetDownKey | SFZListBoxControl::SetDownKey

SFZListBoxControl::GetWaitInterval

スクロールに関する待ちインターバルを取得します。

[ public, const ]
UInt32 GetWaitInterval(Void);

戻り値

スクロールが開始されるまでの待ちインターバル(ミリ秒単位)。

参照

SFZListBoxControl::SetWaitInterval

SFZListBoxControl::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]

SFZListBoxControl::HandleBoundVirtual

仮想領域の変更処理を行います。

[ protected, virtual ]
Void HandleBoundVirtual(Void);

解説

(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントを受信したときに呼び出される関数です。

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

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

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

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

仮想領域の変更処理

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

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

参照

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

SFZListBoxControl::HandleRenderRequest

リストボックスを描画します。

[ protected, virtual, const ]
Void HandleRenderRequest(
    SFXGraphicsPtr graphics   // グラフィックスオブジェクト
);

解説

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

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

デフォルトの実装は、リストボックスコントロールを描画します。

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

描画処理の方法

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

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

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

描画処理の手順

	描画処理の手順
描画ハンドラは描画イベント(SFEVT_RESPONDER_RENDER)の発生によって起動されます。そして実際の描画は描画ハンドラによって行われます。描画イベント(SFEVT_RESPONDER_RENDER)自体は、 `SFYResponder::Render` 関数によって描画エンジンが起動してから描画エンジンが登録された再描画領域のなかから再描画が必要な領域を含むレスポンダだけに `SFYResponder::InvokeBackward` 関数を使って送信します。なお、`SFYResponder::Render` 関数はイベントループの最後で自動的に呼び出されるか、コールバックなどの処理なかから明示的に呼び出されるかのどちらかです。また、`SFYResponder::Render` 関数の引数を true にして呼び出すと、再描画領域の登録に関係無くレスポンダツリーの自レスポンダ以下の枝部分で実際に携帯電話の画面に描画されるすべてのレスポンダに描画イベントが送信されます。

描画ハンドラは描画イベント(SFEVT_RESPONDER_RENDER)の発生によって起動されます。そして実際の描画は描画ハンドラによって行われます。

描画イベント(SFEVT_RESPONDER_RENDER)自体は、 SFYResponder::Render 関数によって描画エンジンが起動してから描画エンジンが登録された再描画領域のなかから再描画が必要な領域を含むレスポンダだけに SFYResponder::InvokeBackward 関数を使って送信します。

なお、SFYResponder::Render 関数はイベントループの最後で自動的に呼び出されるか、コールバックなどの処理なかから明示的に呼び出されるかのどちらかです。

また、SFYResponder::Render 関数の引数を true にして呼び出すと、再描画領域の登録に関係無くレスポンダツリーの自レスポンダ以下の枝部分で実際に携帯電話の画面に描画されるすべてのレスポンダに描画イベントが送信されます。

参照

SFZListBoxControl::NewInstance

新しいインスタンスを作成します。

[ public, static ]
SFZListBoxControlSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

引数

exception: 関数内部で発生したエラー値を返します。

戻り値

成功したとき : null 以外のポインタ
失敗したとき : null ポインタ

解説

SSFZListBoxControl クラスの新しいインスタンスを作成します。

作成に成功した場合は null 以外のポインタを返し、exception 引数は常に SFERR_NO_ERROR になります。メモリ不足などで作成に失敗した場合は null ポインタを返し、exception 引数にエラー値が返ります。

使用例

以下は、リストボックスのインスタンスを生成するためのコードです。

// リストボックスのインスタンスを生成する
SFCError error;
SFZListBoxControlSmp _listbox;

if ((_listbox = SFZListBoxControl::NewInstance(&error)) != null) {
    	...
}

SFZListBoxControl::Remove

リストボックスから指定した項目を削除します。

[ public ]
Void Remove(
    SInt32 index   // 削除する項目のインデックス
);

解説

リストボックスから指定したインデックスの項目を削除します。

参照

SFZListBoxControl::Append | SFZListBoxControl::Clear

SFZListBoxControl::SetBevelColor

3D のリストボックスを描画するためのベベルカラーを設定します。

[ public ]
Void SetBevelColor(
    SFXBevelColorConstRef param   // 設定するベベルカラー
);

解説

3D のリストボックスを描画するためのベベルカラー(SFXBevelColor)を設定します。

デフォルト値: SFXBevelColor(SFXRGBColor(0xAA, 0xAA, 0xAA, 0x00), SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00), SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00))

参照

SFZListBoxControl::GetBevelColor | SFXBevelColor | SFXRGBColor

SFZListBoxControl::SetDefaultItemBackColor

項目のデフォルトの背景色を設定します。

[ public ]
Void SetDefaultItemBackColor(
    SFXRGBColorConstRef param   // デフォルトの背景色
);

解説

リストボックスコントロールの項目の矩形を塗り潰すデフォルトの背景色(