godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
f629e839e5c5df88ddee330639be78e9931978df
godot-docs/classes/class_optionbutton.rst
Rémi Verschelde f629e839e5 Sync classref with 2.1 source, goodbye 2.0!
2016-08-10 21:33:38 +02:00

183 lines
12 KiB
ReStructuredText
Raw Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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_ID<class_OptionButton_get_item_ID>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :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 |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :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_ID<class_OptionButton_set_item_ID>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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_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 **)**
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_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_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_metadata:
- void **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:
- void **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_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_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_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".
Reference in New Issue View Git Blame Copy Permalink