OptionButton¶
继承¶
Button
简要描述¶
按下按钮时提供可选选项的按钮控件。
描述¶
OptionButton是一种按钮类型，在按下该按钮时会提供一个可选择的项目列表。
成员¶
| 类型 | 属性名 | 默认值 |
|---|---|---|
| int | action_mode | 0 |
| int | align | 0 |
| int | selected | -1 |
| bool | toggle_mode | true |
方法¶
| 返回值类型 | 方法名称 |
|---|---|
| void | add_icon_item(texture: Texture, label: String, id: int = -1) |
| void | add_item(label: String, id: int = -1) |
| void | add_separator() |
| void | clear() |
| int | get_item_count() const |
| Texture | get_item_icon(idx: int) const |
| int | get_item_id(idx: int) const |
| int | get_item_index(id: int) const |
| Variant | get_item_metadata(idx: int) const |
| String | get_item_text(idx: int) const |
| PopupMenu | get_popup() const |
| int | get_selected_id() const |
| Variant | get_selected_metadata() const |
| bool | is_item_disabled(idx: int) const |
| void | remove_item(idx: int) |
| void | select(idx: int) |
| void | set_item_disabled(idx: int, disabled: bool) |
| void | set_item_icon(idx: int, texture: Texture) |
| void | set_item_id(idx: int, id: int) |
| void | set_item_metadata(idx: int, metadata: Variant) |
| void | set_item_text(idx: int, text: String) |
信号¶
- item_focused
当用户使用ui_up或ui_down操作导航到项目时发出。
- item_selected
当用户更改了当前项目时发出。
常量¶
成员说明¶
- int action_mode
| Default | 0 |
|---|---|
| setter | set_action_mode(value) |
| getter | get_action_mode |
- int align
| Default | 0 |
|---|---|
| setter | set_text_align(value) |
| getter | get_text_align |
- int selected
| Default | -1 |
|---|---|
| setter | _select_int(value) |
| getter | get_selected |
- bool toggle_mode
| Default | true |
|---|---|
| setter | set_toggle_mode(value) |
| getter | is_toggle_mode |
方法说明¶
- add_icon_item add_icon_item(texture: Texture, label: String, id: int = -1)
添加一个带有texture的图标，文本label和（可选）id的项目。
- add_item add_item(label: String, id: int = -1)
添加一个带有文本label和（可选）id的项目。
- add_separator add_separator()
在项目列表中添加一个分隔符。
- clear clear()
清除OptionButton中的所有项目。
- get_item_count get_item_count() const
返回OptionButton中的项目数量，包括分隔符。
- get_item_icon get_item_icon(idx: int) const
返回索引为idx的项目的图标。
- get_item_id get_item_id(idx: int) const
返回索引为idx的项目的ID。
- get_item_index get_item_index(id: int) const
返回具有给定id的项目的索引。
- get_item_metadata get_item_metadata(idx: int) const
检索项目的元数据。
- get_item_text get_item_text(idx: int) const
返回索引为idx的项目的文本。
- get_popup get_popup() const
返回此按钮中包含的PopupMenu。
- get_selected_id get_selected_id() const
返回所选项目的ID；如果未选择任何项目，则返回0。
- get_selected_metadata get_selected_metadata() const
获取所选项目的元数据。
- is_item_disabled is_item_disabled(idx: int) const
如果索引idx处的项目被禁用，则返回true。
- remove_item remove_item(idx: int)
移除索引为idx的项目。
- select select(idx: int)
通过索引选择一个项目并将其作为当前项目。
- set_item_disabled set_item_disabled(idx: int, disabled: bool)
设置是否禁用索引为idx的项目。
禁用项在下拉菜单中的绘制方式有所不同，用户无法选择。 如果当前选择的项目被设置为禁用，它将保持选中状态。
- set_item_icon set_item_icon(idx: int, texture: Texture)
在索引idx处设置项目的图标。
- set_item_id set_item_id(idx: int, id: int)
在索引idx处设置项目的ID。
- set_item_metadata set_item_metadata(idx: int, metadata: Variant)
设置项目的元数据。
- set_item_text set_item_text(idx: int, text: String)
在索引idx处设置项目的文本。