:github_url: hide .. 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//doc_classes. .. _class_OptionButton: OptionButton ============ **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Button control that provides selectable options when pressed. Properties ---------- +-----------------------+-------------------------------------------------------+ | :ref:`int` | :ref:`selected` | +-----------------------+-------------------------------------------------------+ Methods ------- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_separator` **(** **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected_id` **(** **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` idx **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- +---------------------------------+---------------------+ | :ref:`Texture` | arrow | +---------------------------------+---------------------+ | :ref:`int` | arrow_margin | +---------------------------------+---------------------+ | :ref:`StyleBox` | disabled | +---------------------------------+---------------------+ | :ref:`StyleBox` | focus | +---------------------------------+---------------------+ | :ref:`Font` | font | +---------------------------------+---------------------+ | :ref:`Color` | font_color | +---------------------------------+---------------------+ | :ref:`Color` | font_color_disabled | +---------------------------------+---------------------+ | :ref:`Color` | font_color_hover | +---------------------------------+---------------------+ | :ref:`Color` | font_color_pressed | +---------------------------------+---------------------+ | :ref:`StyleBox` | hover | +---------------------------------+---------------------+ | :ref:`int` | hseparation | +---------------------------------+---------------------+ | :ref:`StyleBox` | normal | +---------------------------------+---------------------+ | :ref:`StyleBox` | pressed | +---------------------------------+---------------------+ Signals ------- .. _class_OptionButton_signal_item_focused: - **item_focused** **(** :ref:`int` ID **)** This signal is emitted when user navigated to an item using ``ui_up`` or ``ui_down`` action. ID of the item selected is passed as argument. ---- .. _class_OptionButton_signal_item_selected: - **item_selected** **(** :ref:`int` ID **)** This signal is emitted when the current item was changed by the user. Index of the item selected is passed as argument. 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. Property Descriptions --------------------- .. _class_OptionButton_property_selected: - :ref:`int` **selected** +----------+----------------+ | *Getter* | get_selected() | +----------+----------------+ Method Descriptions ------------------- .. _class_OptionButton_method_add_icon_item: - void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** 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_method_add_item: - void **add_item** **(** :ref:`String` label, :ref:`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_method_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_method_clear: - void **clear** **(** **)** Clear all the items in the ``OptionButton``. ---- .. _class_OptionButton_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Returns the amount of items in the OptionButton. ---- .. _class_OptionButton_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Returns the icon of the item at index "idx". ---- .. _class_OptionButton_method_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Returns the ID of the item at index ``idx``. ---- .. _class_OptionButton_method_get_item_index: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const Returns the index of the item with the given ``id``. ---- .. _class_OptionButton_method_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const ---- .. _class_OptionButton_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Returns the text of the item at index "idx". ---- .. _class_OptionButton_method_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Returns the :ref:`PopupMenu` contained in this button. ---- .. _class_OptionButton_method_get_selected_id: - :ref:`int` **get_selected_id** **(** **)** const ---- .. _class_OptionButton_method_get_selected_metadata: - :ref:`Variant` **get_selected_metadata** **(** **)** const ---- .. _class_OptionButton_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const ---- .. _class_OptionButton_method_remove_item: - void **remove_item** **(** :ref:`int` idx **)** ---- .. _class_OptionButton_method_select: - void **select** **(** :ref:`int` idx **)** Select an item by index and make it the current item. ---- .. _class_OptionButton_method_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** ---- .. _class_OptionButton_method_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** Set the icon of an item at index "idx". ---- .. _class_OptionButton_method_set_item_id: - void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the ID of an item at index "idx". ---- .. _class_OptionButton_method_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** ---- .. _class_OptionButton_method_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of an item at index "idx".