SFZComboBoxControl

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

#include <SFZComboBoxControl.h.hpp>

class SFZComboBoxControl : public SFYBoxControl;

SFMTYPEDEFRESPONDER(SFZComboBoxControl)

継承図

協調図

解説

コンボボックスは、ボタンコントロールを持つリストボックスとして構成されます。

コンボボックスのリストボックス部分は常に表示する方式と、ドロップダウン矢印のボタンが押されたときだけ表示する方式が可能です。

コンボボックスの最小値は常に０です。

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

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

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));

     // コンボボックスを生成する
     SFZComboBoxControlSmp _comb = SFZComboBoxControl::NewInstance(&error);
     _comb->SetRealBound(SFXRectangle(20, 50, 200, 25));
     _comb->SetState(true, true, true, true);
     _comb->SetParent(_window);
     _comb->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

     // append items to the list box of the combo box
     UInt16 i;
     for (i = 0;  i < 5 ; ++i) {
          _comb->Append(SFXAnsiString::Format("List Item %d ", i));
	 }
     return;
}

実行結果:

参照

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

メンバ

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

パブリック関数
`SFCError`	Append( `SFXPathConstRef` path , `UInt16` id ) Append( `SFXWideStringConstRef` item , `AVKType` key , `WChar` keyIcon = 0 ) Append( `SFXWideStringConstRef` item ) Append( `SFXPathConstRef` path , `UInt16` id , `AVKType` key , `WChar` keyIcon = 0 ) コンボボックスのリストボックスに項目を追加します。
`Void`	Clear( `Void` ) コンボボックスコントロールのリストボックスのすべての項目を削除します。
`SFXRGBColorConstRef`	GetArrowColor( `Void` ) コンボボックスの矢印の色を取得します。
`AEEFont`	GetFont( `Void` ) タイトルのフォントを取得します。
`HorizontalEnum`	GetHorizontalAlign( `Void` ) タイトルの水平アラインメントの値を取得します。
`AVKType`	GetItemAccessKey( `SInt32` index ) 指定された項目のアクセスキーを取得します。
`SFXWideString`	GetItemText( `SInt32` index ) 指定された項目のテキストを取得します。
static `SFZListBoxControlSmp`	GetListBox( `Void` ) リストボックスコントロールを取得します。
`AEEFont`	GetListFont( `Void` ) リストボックス項目のフォントを取得します。
`SInt32`	GetMaximumValue( `Void` ) コンボボックスのリストボックス内の項目数を取得します。
`DirectionEnum`	GetScrollDirection( `Void` ) タイトルのスクロール移動方向を取得します。
`UInt32`	GetScrollInterval( `Void` ) タイトルのスクロール移動時間を取得します。
`SInt16`	GetScrollStep( `Void` ) タイトルのスクロール移動量を取得します。
`SFXRGBColorConstRef`	GetTitleColor( `Void` ) コンボボックスのタイトルの色を取得します。
`VerticalEnum`	GetVerticalAlign( `Void` ) タイトルの垂直アラインメントの値を取得します。
`UInt32`	GetWaitInterval( `Void` ) タイトルのスクロール開始までの待ち時間を取得します。
static `SFZComboBoxControlSmp`	NewInstance( `SFCErrorPtr` exception = null ) 新しいインスタンスを作成します。
`Void`	Remove( `SInt32` index ) コンボボックスコントロールのリストボックスから指定した項目を削除します。
`Void`	SetArrowColor( `SFXRGBColorConstRef` param ) コンボボックスの矢印の色を設定します。
`Void`	SetFont( `AEEFont` param ) タイトルのフォントを設定します。
`Void`	SetHorizontalAlign( `HorizontalEnum` param ) タイトルの水平アラインメントを設定します。
`SFCError`	SetItemAccessKey( `SInt32` index , `AVKType` key , `WChar` keyIcon = 0 ) 指定された項目にアクセスキーとその絵文字を設定します。
`SFCError`	SetItemText( `SInt32` index , `SFXPathConstRef` path , `UInt16` id ) SetItemText( `SInt32` index , `SFXWideStringConstRef` item ) 指定された項目にテキストを設定します。
`Void`	SetListFont( `AEEFont` param ) リストボックス項目のフォントを設定します。
`Void`	SetScrollDirection( `DirectionEnum` param ) タイトルのスクロール移動方向を設定します。
`Void`	SetScrollInterval( `UInt32` param ) タイトルのスクロール移動時間を設定します。
`Void`	SetScrollStep( `SInt16` param ) タイトルのスクロール移動量を設定します。
`Void`	SetTitleColor( `SFXRGBColorConstRef` param ) コンボボックスのタイトルテキストの色を設定します。
`Void`	SetVerticalAlign( `VerticalEnum` param ) タイトルの垂直アラインメントを設定します。
`Void`	SetWaitInterval( `UInt32` param ) タイトルのスクロール開始までの待ち時間を設定します。
`Void`	StartScroll( `Void` ) スクロールを開始します。
`Void`	StopScroll( `Void` ) スクロールを停止します。
`Void`	ClearHandler( `Void` ) (SFYResponder から継承) ハンドラの登録をすべて解除します。
`Void`	ClearTracer( `Void` ) (SFYResponder から継承) トレーサの登録をすべて解除します。
`SFCError`	Distribute( `SFXEventConstRef` event , `BoolPtr` result = null ) (SFYResponder から継承) 配信エンジンを起動してイベントを配信します。
`SFXRGBColorConstRef`	GetBackgroundColor( `Void` ) (SFYWidget から継承) 背景の色を取得します。
`SFXBevelColorConstRef`	GetBevelColor( `Void` ) (SFYBoxControl から継承) 3D のボックスコントロールを描画するためのベベルカラーを取得します。
`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 から継承) 配信エンジンを取得します。
`SFXRGBColorConstRef`	GetFocusColor( `Void` ) (SFYBoxControl から継承) フォーカス状態にあるときの枠線の色を取得します。
`SFXRGBColorConstRef`	GetFrameColor( `Void` ) (SFYBoxControl から継承) 外側の枠線の色を取得します。
`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 から継承) 自レスポンダが前面から数えて何番目に位置するかを取得します。
`AVKType`	GetOperateKey( `Void` ) (SFYBoxControl から継承) 操作キーを取得します。
`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`	SetBevelColor( `SFXBevelColorConstRef` param ) (SFYBoxControl から継承) 3D のボックスコントロールを描画するためのベベルカラーを設定します。
`Void`	SetCurrentValue( `SInt32` param ) (SFYControl から継承) コントロールの現在値を設定します。
`Void`	SetDistributer( `SFYDistributerPtr` param ) (SFYResponder から継承) 配信エンジンを設定します。
`Void`	SetFocusColor( `SFXRGBColorConstRef` param ) (SFYBoxControl から継承) フォーカス状態にあるときの枠線の色を設定します。
`Void`	SetFrameColor( `SFXRGBColorConstRef` param ) (SFYBoxControl から継承) 外側の枠線の色を設定します。
`Void`	SetID( `UInt32` param ) (SFYResponder から継承) ID を設定します。
`Void`	SetMaximumValue( `SInt32` param ) (SFYControl から継承) コントロールの最大値を設定します。
`Void`	SetMinimumValue( `SInt32` param ) (SFYControl から継承) コントロールの最小値を設定します。
`Void`	SetOperateKey( `AVKType` param ) (SFYBoxControl から継承) 操作キーを設定します。
`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`	DrawTab( `SFXGraphicsPtr` graphics , `SFXRectangleConstRef` rectangle ) コンボボックスの矢印を描画します。
`SFYSingleTextWidgetSmpConstRef`	GetTextWidget( `Void` ) タイトルに使用されているテキストウィジェットを取得します。
`Void`	HandleBoundReal( `Void` ) 実領域が変化した時の処理を行います。
`Void`	HandleBoundVirtual( `Void` ) 仮想領域の変更処理を行います。
`Void`	HandleOperateKeyRelease( `Void` ) キー解放イベントを処理します。
`Void`	HandleRenderRequest( `SFXGraphicsPtr` graphics ) コンボボックスを描画します。
`Void`	DrawBox( `SFXGraphicsPtr` graphics , `SFXRectangleConstRef` rectangle ) (SFYBoxControl から継承) ボックスコントロールを描画します。
static `SFYResponderSmp`	Factory( `SFYResponderPtr` responder , `SFCErrorPtr` exception = null ) (SFYResponder から継承) NewInstance 関数の実装を補助します。
static `SFXMarginConstRef`	GetBoxMargin( `Void` ) (SFYBoxControl から継承) ボックスコントロールのマージンの値を取得します。
`SFYResponderSmp`	GetThis( `Void` ) (SFYResponder から継承) スマートポインタで保持された this を取得します。
`Void`	HandleBoundGlobal( `SFXRectangleConstRef` rectangle ) (SFYWidget から継承) グローバル領域の変更処理を行います。
`Void`	HandleBoundOptimize( `SFXRectanglePtr` rectangle ) (SFYWidget から継承) 指定した矩形に収まる範囲内で最適なサイズを計算します。
`Void`	HandleBoundRequest( `SFXRectanglePtr` rectangle ) (SFYWidget から継承) 最適な矩形を計算します。
`Void`	HandleOperateKey( `Void` ) (SFYBoxControl から継承) 操作キーが押されたときに実行される処理です。
`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 SFZComboBoxControl クラスを表す定数です。
DefaultEnum 各種パラメータのデフォルト値を表します。
DirectionEnum タイトルのスクロール移動方向を表します。
HorizontalEnum タイトルの水平方向のアラインメントを表す定数です。
VerticalEnum タイトルの垂直方向のアラインメントを表す定数です。

SFZComboBoxControl::SFZComboBoxControl

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

[ protected, explicit ]
SFZComboBoxControl(Void);

SFZComboBoxControl::~SFZComboBoxControl

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

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

SFZComboBoxControl::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 item   // テキスト項目
    AVKType key                  // ダイレクトアクセスキー
    WChar keyIcon = 0            // キーアイコン
);

解説

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

参照

SFZComboBoxControl::Remove | SFZComboBoxControl::Clear

SFZComboBoxControl::Clear

コンボボックスコントロールのリストボックスのすべての項目を削除します。

[ public ]
Void Clear(Void);

解説

コンボボックスコントロールのリストボックスのすべての項目を削除します。

参照

SFZComboBoxControl::Append | SFZComboBoxControl::Remove

SFZComboBoxControl::DrawTab

コンボボックスの矢印を描画します。

[ protected, const ]
Void DrawTab(
    SFXGraphicsPtr graphics          // グラフィックスオブジェクト
    SFXRectangleConstRef rectangle   // コンボボックスの矢印を描画する矩形領域
);

解説

引数で指定した矩形領域にコンボボックスの矢印を描画します。

コンボボックスの矢印の大きさと位置を変更できます。

参照

SFZComboBoxControl::HandleRenderRequest |

SFZComboBoxControl::GetArrowColor

コンボボックスの矢印の色を取得します。

[ public, const ]
SFXRGBColorConstRef GetArrowColor(Void);

戻り値

コンボボックスボタンの矢印を描画する色 (SFXRGBColor)。

参照

SFZComboBoxControl::SetArrowColor | SFXRGBColor

SFZComboBoxControl::GetFont

タイトルのフォントを取得します。

[ public, const ]
AEEFont GetFont(Void);

戻り値

コンボボックスのタイトルのフォント。

参照

SFZComboBoxControl::SetFont

SFZComboBoxControl::GetHorizontalAlign

タイトルの水平アラインメントの値を取得します。

[ public, const ]
HorizontalEnum GetHorizontalAlign(Void);

戻り値

タイトルの水平アラインメントの値。

参照

SFZComboBoxControl::SetHorizontalAlign | SFZComboBoxControl::HorizontalEnum

SFZComboBoxControl::GetItemAccessKey

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

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

戻り値

コンボボックスの項目のアクセスキー。アクセスキーが設定されていない場合は AVK_UNDEFINED。

参照

SFZComboBoxControl::SetItemAccessKey

SFZComboBoxControl::GetItemText

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

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

戻り値

コンボボックスのリストボックスの項目のテキスト。

参照

SFZComboBoxControl::SetItemText

SFZComboBoxControl::GetListBox

リストボックスコントロールを取得します。

[ public, static ]
SFZListBoxControlSmp GetListBox(Void);

戻り値

コンボボックスコントロールを実装するリストボックスコントロール。

解説

コンボボックスコントロールを実装するリストボックスコントロールを取得します。

開発者は取得したリストボックスコントロールを使って、コンボボックスの実装に使っているリストボックスの項目の背景色や前景色を変更したりできます。

使用例

以下は、コンボボックスコントロールを実装するリストボックスコントロールを取得するためのコードです。

// リストボックスコントロールを取得する
SFZListBoxControlSmp _listbox;

if ((_listbox = SFZComboBoxControl::GetListBox()) != null) {
    _listbox->SetItemBackColor(0, SFXRGBColor(0xED, 0xED, 0x14, 0x00));
}

参照

SFZListBoxControl

SFZComboBoxControl::GetListFont

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

[ public, const ]
AEEFont GetListFont(Void);

戻り値

リストボックス項目のテキストのフォント。

参照

SFZComboBoxControl::SetListFont

SFZComboBoxControl::GetMaximumValue

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

[ public, const ]
SInt32 GetMaximumValue(Void);

戻り値

コンボボックスのリストボックス内の項目数。

参照

SFYControl::SetMaximumValue

SFZComboBoxControl::GetScrollDirection

タイトルのスクロール移動方向を取得します。

[ public, const ]
DirectionEnum GetScrollDirection(Void);

参照

SFZComboBoxControl::SetScrollDirection

SFZComboBoxControl::GetScrollInterval

タイトルのスクロール移動時間を取得します。

[ public, const ]
UInt32 GetScrollInterval(Void);

参照

SFZComboBoxControl::SetScrollInterval

SFZComboBoxControl::GetScrollStep

タイトルのスクロール移動量を取得します。

[ public, const ]
SInt16 GetScrollStep(Void);

参照

SFZComboBoxControl::SetScrollStep

SFZComboBoxControl::GetTextWidget

タイトルに使用されているテキストウィジェットを取得します。

[ protected, const ]
SFYSingleTextWidgetSmpConstRef GetTextWidget(Void);

戻り値

コンボボックスのタイトル部分で使用されているテキストウィジェット(SFYSingleTextWidget)。

参照

SFYSingleTextWidget

SFZComboBoxControl::GetTitleColor

コンボボックスのタイトルの色を取得します。

[ public, const ]
SFXRGBColorConstRef GetTitleColor(Void);

戻り値

コンボボックスのタイトルテキストを描画する色 (SFXRGBColor)。

参照

SFZComboBoxControl::SetTitleColor | SFXRGBColor

SFZComboBoxControl::GetVerticalAlign

タイトルの垂直アラインメントの値を取得します。

[ public, const ]
VerticalEnum GetVerticalAlign(Void);

戻り値

タイトルの垂直アラインメントの値。

参照

SFZComboBoxControl::SetVerticalAlign | SFZComboBoxControl::VerticalEnum

SFZComboBoxControl::GetWaitInterval

タイトルのスクロール開始までの待ち時間を取得します。

[ public, const ]
UInt32 GetWaitInterval(Void);

参照

SFZComboBoxControl::SetWaitInterval

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

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

SFZComboBoxControl::HandleOperateKeyRelease

キー解放イベントを処理します。

[ protected, virtual ]
Void HandleOperateKeyRelease(Void);

解説

SFEVT_KEY_RELEASE イベントのキーが SFYButtonControl::SetOperateKey 関数で設定した操作キーと一致するときに呼び出される関数です。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、コンボボックスコントロールが内部に保持するリストボックスコントロールを表示します。

参照

SFYButtonControl::SetOperateKey

SFZComboBoxControl::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 にして呼び出すと、再描画領域の登録に関係無くレスポンダツリーの自レスポンダ以下の枝部分で実際に携帯電話の画面に描画されるすべてのレスポンダに描画イベントが送信されます。

参照

SFZComboBoxControl::NewInstance

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

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

引数

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

戻り値

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

解説

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

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

使用例

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

// コンボボックスのインスタンスを生成する
SFCError error;
SFZComboBoxControlSmp _combo;

if ((_combo = SFZComboBoxControl::NewInstance(&error)) != null) {
    	...
}

SFZComboBoxControl::Remove

コンボボックスコントロールのリストボックスから指定した項目を削除します。

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

解説

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

参照

SFZComboBoxControl::Append | SFZComboBoxControl::Clear

SFZComboBoxControl::SetArrowColor

コンボボックスの矢印の色を設定します。

[ public ]
Void SetArrowColor(
    SFXRGBColorConstRef param   // 設定する色
);

解説

コンボボックスボタンの矢印を描画する色 (SFXRGBColor)を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

参照

SFZComboBoxControl::SetArrowColor | SFXRGBColor

SFZComboBoxControl::SetFont

タイトルのフォントを設定します。

[ public ]
Void SetFont(
    AEEFont param   // 設定するフォント
);

解説

コンボボックスのタイトルのフォントを設定します。

デフォルト値: AEE_FONT_NORMAL

参照

SFZComboBoxControl::GetFont

SFZComboBoxControl::SetHorizontalAlign

タイトルの水平アラインメントを設定します。

[ public ]
Void SetHorizontalAlign(
    HorizontalEnum param   // 設定する値
);

解説

タイトルの水平アラインメントを設定します。

デフォルト値: SFYSingleTextWidget::DEFAULT_HORIZONTAL(中央揃え)

参照

SFZComboBoxControl::GetHorizontalAlign | SFZComboBoxControl::HorizontalEnum

SFZComboBoxControl::SetItemAccessKey

指定された項目にアクセスキーとその絵文字を設定します。

[ public ]
SFCError SetItemAccessKey(
    SInt32 index        // 項目のインデックス
    AVKType key         // アクセスキー
    WChar keyIcon = 0   // アクセスキーの絵文字
);

解説

コンボボックスの項目のアクセスキーとその絵文字を設定します。

使用例

コンボボックスの項目のアクセスキーとその絵文字を設定するコードです。

// コンボボックスの最初の項目に、アクセスキーとして AVK_1、その絵文字として 0xFBF6 を設定する
_combobox->SetItemAccessKey(0, AVK_1, 0xFBF6);

参照

SFZComboBoxControl::GetItemAccessKey

SFZComboBoxControl::SetItemText

指定された項目にテキストを設定します。

[ public ]
SFCError SetItemText(
    SInt32 index           // 項目のインデックス