| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the OptionButton.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_OptionButton:
- OptionButton
- ============
- **Inherits:** :ref:`Button<class_button>` **<** :ref:`BaseButton<class_basebutton>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Button control that provides selectable options when pressed.
- Member Functions
- ----------------
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_icon_item<class_OptionButton_add_icon_item>` **(** :ref:`Texture<class_texture>` texture, :ref:`String<class_string>` label, :ref:`int<class_int>` id **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_item<class_OptionButton_add_item>` **(** :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1 **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_separator<class_OptionButton_add_separator>` **(** **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear<class_OptionButton_clear>` **(** **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_item_count<class_OptionButton_get_item_count>` **(** **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Texture<class_texture>` | :ref:`get_item_icon<class_OptionButton_get_item_icon>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_item_id<class_OptionButton_get_item_id>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_variant>` | :ref:`get_item_metadata<class_OptionButton_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_item_text<class_OptionButton_get_item_text>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_selected<class_OptionButton_get_selected>` **(** **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_selected_id<class_OptionButton_get_selected_id>` **(** **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_variant>` | :ref:`get_selected_metadata<class_OptionButton_get_selected_metadata>` **(** **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_OptionButton_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_item<class_OptionButton_remove_item>` **(** :ref:`int<class_int>` idx **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`select<class_OptionButton_select>` **(** :ref:`int<class_int>` idx **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_item_disabled<class_OptionButton_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_item_icon<class_OptionButton_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` texture **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_item_id<class_OptionButton_set_item_id>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_item_metadata<class_OptionButton_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` metadata **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_item_text<class_OptionButton_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` text **)** |
- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- - **item_selected** **(** :ref:`int<class_int>` ID **)**
- This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
- Member Variables
- ----------------
- - :ref:`Array<class_array>` **items**
- - :ref:`int<class_int>` **selected**
- Description
- -----------
- OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text.
- Member Function Description
- ---------------------------
- .. _class_OptionButton_add_icon_item:
- - void **add_icon_item** **(** :ref:`Texture<class_texture>` texture, :ref:`String<class_string>` label, :ref:`int<class_int>` id **)**
- Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.
- .. _class_OptionButton_add_item:
- - void **add_item** **(** :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1 **)**
- Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.
- .. _class_OptionButton_add_separator:
- - void **add_separator** **(** **)**
- Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end.
- .. _class_OptionButton_clear:
- - void **clear** **(** **)**
- Clear all the items in the :ref:`OptionButton<class_optionbutton>`.
- .. _class_OptionButton_get_item_count:
- - :ref:`int<class_int>` **get_item_count** **(** **)** const
- Return the amount of items in the OptionButton.
- .. _class_OptionButton_get_item_icon:
- - :ref:`Texture<class_texture>` **get_item_icon** **(** :ref:`int<class_int>` idx **)** const
- Return the icon of the item at index "idx".
- .. _class_OptionButton_get_item_id:
- - :ref:`int<class_int>` **get_item_id** **(** :ref:`int<class_int>` idx **)** const
- Return the ID of the item at index "idx".
- .. _class_OptionButton_get_item_metadata:
- - :ref:`Variant<class_variant>` **get_item_metadata** **(** :ref:`int<class_int>` idx **)** const
- .. _class_OptionButton_get_item_text:
- - :ref:`String<class_string>` **get_item_text** **(** :ref:`int<class_int>` idx **)** const
- Return the text of the item at index "idx".
- .. _class_OptionButton_get_selected:
- - :ref:`int<class_int>` **get_selected** **(** **)** const
- Return the current item index
- .. _class_OptionButton_get_selected_id:
- - :ref:`int<class_int>` **get_selected_id** **(** **)** const
- .. _class_OptionButton_get_selected_metadata:
- - :ref:`Variant<class_variant>` **get_selected_metadata** **(** **)** const
- .. _class_OptionButton_is_item_disabled:
- - :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** const
- .. _class_OptionButton_remove_item:
- - void **remove_item** **(** :ref:`int<class_int>` idx **)**
- .. _class_OptionButton_select:
- - void **select** **(** :ref:`int<class_int>` idx **)**
- Select an item by index and make it the current item.
- .. _class_OptionButton_set_item_disabled:
- - void **set_item_disabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**
- .. _class_OptionButton_set_item_icon:
- - void **set_item_icon** **(** :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` texture **)**
- Set the icon of an item at index "idx".
- .. _class_OptionButton_set_item_id:
- - void **set_item_id** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)**
- Set the ID of an item at index "idx".
- .. _class_OptionButton_set_item_metadata:
- - void **set_item_metadata** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` metadata **)**
- .. _class_OptionButton_set_item_text:
- - void **set_item_text** **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` text **)**
- Set the text of an item at index "idx".
|
