OptionButton¶
Inherits: Button < BaseButton < Control < CanvasItem < Node < Object
A button that brings up a dropdown with selectable options when pressed.
Description¶
OptionButton is a type of button that brings up a dropdown with selectable items when pressed. The item selected becomes the "current" item and is displayed as the button text.
See also BaseButton which contains common properties and methods associated with this node.
Note: The ID values used for items are limited to 32 bits, not full 64 bits of int. This has a range of -2^32
to 2^32 - 1
, i.e. -2147483648
to 2147483647
.
Note: The Button.text and Button.icon properties are set automatically based on the selected item. They shouldn't be changed manually.
Properties¶
action_mode |
|
|
alignment |
|
|
|
||
|
||
|
||
|
||
toggle_mode |
|
Methods¶
void |
add_icon_item ( Texture2D texture, String label, int id=-1 ) |
void |
|
void |
add_separator ( String text="" ) |
void |
clear ( ) |
get_item_icon ( int idx ) const |
|
get_item_id ( int idx ) const |
|
get_item_index ( int id ) const |
|
get_item_metadata ( int idx ) const |
|
get_item_text ( int idx ) const |
|
get_item_tooltip ( int idx ) const |
|
get_popup ( ) const |
|
get_selectable_item ( bool from_last=false ) const |
|
get_selected_id ( ) const |
|
get_selected_metadata ( ) const |
|
has_selectable_items ( ) const |
|
is_item_disabled ( int idx ) const |
|
is_item_separator ( int idx ) const |
|
void |
remove_item ( int idx ) |
void |
|
void |
set_disable_shortcuts ( bool disabled ) |
void |
set_item_disabled ( int idx, bool disabled ) |
void |
set_item_icon ( int idx, Texture2D texture ) |
void |
set_item_id ( int idx, |