ComboBox
コンボボックス (ComboBox) 要素は、ウィンドウスタイルのコンボボックスコントロールを提供します。このウィンドウ要素は、他のいくつかのウィンドウコンポーネントの自動化された組み合わせです。
Summary
| ComboBox | コンボボックス (ComboBox) 要素は、ウィンドウスタイルのコンボボックスコントロールを提供します。このウィンドウ要素は、他のいくつかのウィンドウコンポーネントの自動化された組み合わせです。 |
| 実装の詳細 | コンボボックスはウィンドウ要素の集合体です。基本的なウィンドウコンポーネントを組み合わせて、自動的にコンボボックスの動作をするようにします。 |
| XML定義 | |
| XMLタグ | |
| 任意属性 | |
| selectedbutton | メインドロップダウンボタンのボタン定義の名前。 |
| menuitembutton | メニューボタンのボタン定義の名前。 |
| menubackground | ドロップダウンメニューのウィンドウ定義の名前。 |
| scrollbar | 水平スクロールバー定義の名前。 |
| maxvisibleitems | 画面内に一度に表示できる項目数の最大値。 |
| 要素 | |
| MenuButtonOffset | メニューボタンのオフセットを指定できます。 |
| ウィンドウ コールバック | |
| コールバック | |
| OnSelChanged | 選択されたメニューアイテムが変更された時に呼び出されます。 |
| 関数 | |
| 関数 | |
| ComboBoxAddMenuItem() | メニューリストに新たな項目を追加します。 |
| ComboBoxClearMenuItems() | 現在そのメニューに含まれる全項目を消去します。 |
| ComboBoxSetSelectedMenuItem() | 現在選択されているメニュー項目を設定します。 |
| ComboBoxGetSelectedMenuItem() | 現在選択されているメニュー項目のインデックスを返します。 |
| ComboBoxGetSelectedText() | 現在選択されているメニュー項目のテキストを返します。 |
| ComboBoxSetDisabledFlag() | コンボボックスを無効な状態に設定します。 |
| ComboBoxGetDisabledFlag() | コンボボックスが現在無効になっているかどうかを返します。 |
| ComboBoxIsMenuOpen() | コンボボックスが現在開いているかどうかを調べて値を返します。 |
| ComboBoxExternalOpenMenu() | OpenMenu() wrapper, ExternalOpenMenu()用のLua-exposedな関数です。 |
実装の詳細
コンボボックスはウィンドウ要素の集合体です。基本的なウィンドウコンポーネントを組み合わせて、自動的にコンボボックスの動作をするようにします。
コンポーネント
コンボボックスは以下のコンポーネントによって構成されます。
- ドロップダウンボタン用の Button 定義。
- ドロップダウンの背景に使う FullResizeImage 。
- メニューリスト内の各項目用の Button 定義。
XML定義
Summary
| XMLタグ | |
| 任意属性 | |
| selectedbutton | メインドロップダウンボタンのボタン定義の名前。 |
| menuitembutton | メニューボタンのボタン定義の名前。 |
| menubackground | ドロップダウンメニューのウィンドウ定義の名前。 |
| scrollbar | 水平スクロールバー定義の名前。 |
| maxvisibleitems | 画面内に一度に表示できる項目数の最大値。 |
| 要素 | |
| MenuButtonOffset | メニューボタンのオフセットを指定できます。 |
selectedbutton
メインドロップダウンボタンのボタン定義の名前。
このボタン定義を使用する際には、選択されたメニュー項目を表示するためのテキストコンポーネントと、項目一覧を表示するための矢印を一緒に指定することをお勧めします。
データ型
| string | 有効な Button の名前。 |
デフォルト値
- ””
menuitembutton
メニューボタンのボタン定義の名前。
ボタン定義の名前はドロップダウンリスト中の各メニュー項目に使用されます。また、このボタン定義はテキストコンポーネントを持っている必要があります。
データ型
| string | 有効な Button の名前。 |
デフォルト値
- ””
menubackground
ドロップダウンメニューのウィンドウ定義の名前。
背景は、メニューに追加された要素の数に合うように自動的にサイズが決定されます。このウインドウは子ウィンドウを持つことができますが、正しくリサイズするにはアンカーを設定してください。
データ型
| string | 有効な Window の名前。 |
デフォルト値
- ””
scrollbar
水平スクロールバー定義の名前。
コンボボックスが一度に表示しきれないほど多くの項目を含んでいる場合に使用されます。
データ型
| string | 有効な HorizontalScrollbar の名前。 |
デフォルト値
- ””
ウィンドウ コールバック
Summary
| コールバック | |
| OnSelChanged | 選択されたメニューアイテムが変更された時に呼び出されます。 |
関数
Summary
| 関数 | |
| ComboBoxAddMenuItem() | メニューリストに新たな項目を追加します。 |
| ComboBoxClearMenuItems() | 現在そのメニューに含まれる全項目を消去します。 |
| ComboBoxSetSelectedMenuItem() | 現在選択されているメニュー項目を設定します。 |
| ComboBoxGetSelectedMenuItem() | 現在選択されているメニュー項目のインデックスを返します。 |
| ComboBoxGetSelectedText() | 現在選択されているメニュー項目のテキストを返します。 |
| ComboBoxSetDisabledFlag() | コンボボックスを無効な状態に設定します。 |
| ComboBoxGetDisabledFlag() | コンボボックスが現在無効になっているかどうかを返します。 |
| ComboBoxIsMenuOpen() | コンボボックスが現在開いているかどうかを調べて値を返します。 |
| ComboBoxExternalOpenMenu() | OpenMenu() wrapper, ExternalOpenMenu()用のLua-exposedな関数です。 |
ComboBoxAddMenuItem()
メニューリストに新たな項目を追加します。
最初の項目がindex 1となり、2番目の項目はindex 2、と続きます。
パラメータ
| comboBoxName | (string) コンボボックスの名前。 |
| menuItemText | (wstring) メニュー項目のテキスト。 |
戻り値
| nil | 戻り値無し。 |
例
ComboBoxAddMenuItem("CareerWindowOrderCombo", L"Apprentice")
ComboBoxAddMenuItem("CareerWindowOrderCombo", L"Journeyman")
ComboBoxAddMenuItem("CareerWindowOrderCombo", L"Expert")
ComboBoxAddMenuItem("CareerWindowOrderCombo", L"Master")ComboBoxSetSelectedMenuItem()
現在選択されているメニュー項目を設定します。
パラメータ
| comboBoxName | (string) コンボボックスの名前。 |
| menuItemIndex | (integer) 選択されているメニュー項目のインデックス番号。1から現在のメニュー項目数の間の数でなければなりません。 |
戻り値
| nil | 戻り値無し。 |
メモ
- 選択された項目を設定すると、OnSelChangedイベントハンドラが起動されます。イベントハンドラが戻る前に ComboBoxSetSelectedMenuItem() を呼び出そうとすることがないように注意してください。
例
ComboBoxSetSelectedMenuItem( "CareerWindowOrderCombo", 1 )
ComboBoxSetDisabledFlag()
コンボボックスを無効な状態に設定します。
無効化すると選択されたボタンは「無効化」状態を表示し、そのドロップダウンメニューは機能しなくなります。
パラメータ
| comboBoxName | (string) コンボボックスの名前。 |
| isDisabled | (boolean) コンボボックスを無効化するか否か？ |
戻り値
| nil | 戻り値無し。 |
メモ
- コンボボックスを無効化にセットすると、コンボボックスメニューのみが無効化されます。コンボボックスと結びついた <OnLButtonUP> イベントがある場合、そのイベントのプロセスは続行されます。
例
ComboBoxSetDisabledFlag("GroupOptionsWindowLootModeCombo", GameData.Player.isGroupLeader == false )