Startsida Utforska Hjälp
Logga in
Godot
/
godot-docs
spegling av https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Filer Ärenden 0 Wiki
Gren: 3.3
Grenar Taggar
godot-docs
/
classes
/
class_optionbutton.rst

class_optionbutton.rst 19 KB
Permalänk Historik Rå

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the OptionButton.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_OptionButton:
    8. 

  8. 

  9. OptionButton
    10. 

  10. ============
    11. 

  11. 

  12. **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>`
    13. 

  13. 

  14. Button control that provides selectable options when pressed.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. 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.
    20. 

  20. 

  21. See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
    22. 

  22. 

  23. Properties
    24. 

  24. ----------
    25. 

  25. 

  26. +-----------------------------------------------+-------------------------------------------------------+------------------------------+
    27. 

  27. | :ref:`ActionMode<enum_BaseButton_ActionMode>` | action_mode                                           | ``0`` *(parent override)*    |
    28. 

  28. +-----------------------------------------------+-------------------------------------------------------+------------------------------+
    29. 

  29. | :ref:`TextAlign<enum_Button_TextAlign>`       | align                                                 | ``0`` *(parent override)*    |
    30. 

  30. +-----------------------------------------------+-------------------------------------------------------+------------------------------+
    31. 

  31. | :ref:`int<class_int>`                         | :ref:`selected<class_OptionButton_property_selected>` | ``-1``                       |
    32. 

  32. +-----------------------------------------------+-------------------------------------------------------+------------------------------+
    33. 

  33. | :ref:`bool<class_bool>`                       | toggle_mode                                           | ``true`` *(parent override)* |
    34. 

  34. +-----------------------------------------------+-------------------------------------------------------+------------------------------+
    35. 

  35. 

  36. Methods
    37. 

  37. -------
    38. 

  38. 

  39. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                              | :ref:`add_icon_item<class_OptionButton_method_add_icon_item>` **(** :ref:`Texture<class_Texture>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1 **)** |
    41. 

  41. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                              | :ref:`add_item<class_OptionButton_method_add_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1 **)**                                                  |
    43. 

  43. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                              | :ref:`add_separator<class_OptionButton_method_add_separator>` **(** **)**                                                                                                       |
    45. 

  45. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                              | :ref:`clear<class_OptionButton_method_clear>` **(** **)**                                                                                                                       |
    47. 

  47. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`             | :ref:`get_item_count<class_OptionButton_method_get_item_count>` **(** **)** |const|                                                                                             |
    49. 

  49. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`Texture<class_Texture>`     | :ref:`get_item_icon<class_OptionButton_method_get_item_icon>` **(** :ref:`int<class_int>` idx **)** |const|                                                                     |
    51. 

  51. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`int<class_int>`             | :ref:`get_item_id<class_OptionButton_method_get_item_id>` **(** :ref:`int<class_int>` idx **)** |const|                                                                         |
    53. 

  53. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`int<class_int>`             | :ref:`get_item_index<class_OptionButton_method_get_item_index>` **(** :ref:`int<class_int>` id **)** |const|                                                                    |
    55. 

  55. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`Variant<class_Variant>`     | :ref:`get_item_metadata<class_OptionButton_method_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** |const|                                                             |
    57. 

  57. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`String<class_String>`       | :ref:`get_item_text<class_OptionButton_method_get_item_text>` **(** :ref:`int<class_int>` idx **)** |const|                                                                     |
    59. 

  59. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_popup<class_OptionButton_method_get_popup>` **(** **)** |const|                                                                                                       |
    61. 

  61. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`int<class_int>`             | :ref:`get_selected_id<class_OptionButton_method_get_selected_id>` **(** **)** |const|                                                                                           |
    63. 

  63. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | :ref:`Variant<class_Variant>`     | :ref:`get_selected_metadata<class_OptionButton_method_get_selected_metadata>` **(** **)** |const|                                                                               |
    65. 

  65. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`bool<class_bool>`           | :ref:`is_item_disabled<class_OptionButton_method_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** |const|                                                               |
    67. 

  67. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | void                              | :ref:`remove_item<class_OptionButton_method_remove_item>` **(** :ref:`int<class_int>` idx **)**                                                                                 |
    69. 

  69. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | void                              | :ref:`select<class_OptionButton_method_select>` **(** :ref:`int<class_int>` idx **)**                                                                                           |
    71. 

  71. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | void                              | :ref:`set_item_disabled<class_OptionButton_method_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**                                   |
    73. 

  73. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | void                              | :ref:`set_item_icon<class_OptionButton_method_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` texture **)**                                      |
    75. 

  75. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | void                              | :ref:`set_item_id<class_OptionButton_method_set_item_id>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)**                                                       |
    77. 

  77. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | void                              | :ref:`set_item_metadata<class_OptionButton_method_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**                             |
    79. 

  79. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | void                              | :ref:`set_item_text<class_OptionButton_method_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**                                           |
    81. 

  81. +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. 

  83. Theme Properties
    84. 

  84. ----------------
    85. 

  85. 

  86. +---------------------------------+---------------------+------------------------------+
    87. 

  87. | :ref:`Texture<class_Texture>`   | arrow               |                              |
    88. 

  88. +---------------------------------+---------------------+------------------------------+
    89. 

  89. | :ref:`int<class_int>`           | arrow_margin        | 2                            |
    90. 

  90. +---------------------------------+---------------------+------------------------------+
    91. 

  91. | :ref:`StyleBox<class_StyleBox>` | disabled            |                              |
    92. 

  92. +---------------------------------+---------------------+------------------------------+
    93. 

  93. | :ref:`StyleBox<class_StyleBox>` | focus               |                              |
    94. 

  94. +---------------------------------+---------------------+------------------------------+
    95. 

  95. | :ref:`Font<class_Font>`         | font                |                              |
    96. 

  96. +---------------------------------+---------------------+------------------------------+
    97. 

  97. | :ref:`Color<class_Color>`       | font_color          | Color( 0.88, 0.88, 0.88, 1 ) |
    98. 

  98. +---------------------------------+---------------------+------------------------------+
    99. 

  99. | :ref:`Color<class_Color>`       | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 )  |
    100. 

  100. +---------------------------------+---------------------+------------------------------+
    101. 

  101. | :ref:`Color<class_Color>`       | font_color_hover    | Color( 0.94, 0.94, 0.94, 1 ) |
    102. 

  102. +---------------------------------+---------------------+------------------------------+
    103. 

  103. | :ref:`Color<class_Color>`       | font_color_pressed  | Color( 1, 1, 1, 1 )          |
    104. 

  104. +---------------------------------+---------------------+------------------------------+
    105. 

  105. | :ref:`StyleBox<class_StyleBox>` | hover               |                              |
    106. 

  106. +---------------------------------+---------------------+------------------------------+
    107. 

  107. | :ref:`int<class_int>`           | hseparation         | 2                            |
    108. 

  108. +---------------------------------+---------------------+------------------------------+
    109. 

  109. | :ref:`StyleBox<class_StyleBox>` | normal              |                              |
    110. 

  110. +---------------------------------+---------------------+------------------------------+
    111. 

  111. | :ref:`StyleBox<class_StyleBox>` | pressed             |                              |
    112. 

  112. +---------------------------------+---------------------+------------------------------+
    113. 

  113. 

  114. Signals
    115. 

  115. -------
    116. 

  116. 

  117. .. _class_OptionButton_signal_item_focused:
    118. 

  118. 

  119. - **item_focused** **(** :ref:`int<class_int>` index **)**
    120. 

  120. 

  121. Emitted when the user navigates to an item using the ``ui_up`` or ``ui_down`` actions. The index of the item selected is passed as argument.
    122. 

  122. 

  123. ----
    124. 

  124. 

  125. .. _class_OptionButton_signal_item_selected:
    126. 

  126. 

  127. - **item_selected** **(** :ref:`int<class_int>` index **)**
    128. 

  128. 

  129. Emitted when the current item has been changed by the user. The index of the item selected is passed as argument.
    130. 

  130. 

  131. Property Descriptions
    132. 

  132. ---------------------
    133. 

  133. 

  134. .. _class_OptionButton_property_selected:
    135. 

  135. 

  136. - :ref:`int<class_int>` **selected**
    137. 

  137. 

  138. +-----------+----------------+
    139. 

  139. | *Default* | ``-1``         |
    140. 

  140. +-----------+----------------+
    141. 

  141. | *Getter*  | get_selected() |
    142. 

  142. +-----------+----------------+
    143. 

  143. 

  144. The index of the currently selected item, or ``-1`` if no item is selected.
    145. 

  145. 

  146. Method Descriptions
    147. 

  147. -------------------
    148. 

  148. 

  149. .. _class_OptionButton_method_add_icon_item:
    150. 

  150. 

  151. - void **add_icon_item** **(** :ref:`Texture<class_Texture>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1 **)**
    152. 

  152. 

  153. Adds an item, with a ``texture`` icon, text ``label`` and (optionally) ``id``. If no ``id`` is passed, the item index will be used as the item's ID. New items are appended at the end.
    154. 

  154. 

  155. ----
    156. 

  156. 

  157. .. _class_OptionButton_method_add_item:
    158. 

  158. 

  159. - void **add_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1 **)**
    160. 

  160. 

  161. Adds an item, with text ``label`` and (optionally) ``id``. If no ``id`` is passed, the item index will be used as the item's ID. New items are appended at the end.
    162. 

  162. 

  163. ----
    164. 

  164. 

  165. .. _class_OptionButton_method_add_separator:
    166. 

  166. 

  167. - void **add_separator** **(** **)**
    168. 

  168. 

  169. Adds a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end.
    170. 

  170. 

  171. ----
    172. 

  172. 

  173. .. _class_OptionButton_method_clear:
    174. 

  174. 

  175. - void **clear** **(** **)**
    176. 

  176. 

  177. Clears all the items in the ``OptionButton``.
    178. 

  178. 

  179. ----
    180. 

  180. 

  181. .. _class_OptionButton_method_get_item_count:
    182. 

  182. 

  183. - :ref:`int<class_int>` **get_item_count** **(** **)** |const|
    184. 

  184. 

  185. Returns the amount of items in the OptionButton, including separators.
    186. 

  186. 

  187. ----
    188. 

  188. 

  189. .. _class_OptionButton_method_get_item_icon:
    190. 

  190. 

  191. - :ref:`Texture<class_Texture>` **get_item_icon** **(** :ref:`int<class_int>` idx **)** |const|
    192. 

  192. 

  193. Returns the icon of the item at index ``idx``.
    194. 

  194. 

  195. ----
    196. 

  196. 

  197. .. _class_OptionButton_method_get_item_id:
    198. 

  198. 

  199. - :ref:`int<class_int>` **get_item_id** **(** :ref:`int<class_int>` idx **)** |const|
    200. 

  200. 

  201. Returns the ID of the item at index ``idx``.
    202. 

  202. 

  203. ----
    204. 

  204. 

  205. .. _class_OptionButton_method_get_item_index:
    206. 

  206. 

  207. - :ref:`int<class_int>` **get_item_index** **(** :ref:`int<class_int>` id **)** |const|
    208. 

  208. 

  209. Returns the index of the item with the given ``id``.
    210. 

  210. 

  211. ----
    212. 

  212. 

  213. .. _class_OptionButton_method_get_item_metadata:
    214. 

  214. 

  215. - :ref:`Variant<class_Variant>` **get_item_metadata** **(** :ref:`int<class_int>` idx **)** |const|
    216. 

  216. 

  217. Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID.
    218. 

  218. 

  219. ----
    220. 

  220. 

  221. .. _class_OptionButton_method_get_item_text:
    222. 

  222. 

  223. - :ref:`String<class_String>` **get_item_text** **(** :ref:`int<class_int>` idx **)** |const|
    224. 

  224. 

  225. Returns the text of the item at index ``idx``.
    226. 

  226. 

  227. ----
    228. 

  228. 

  229. .. _class_OptionButton_method_get_popup:
    230. 

  230. 

  231. - :ref:`PopupMenu<class_PopupMenu>` **get_popup** **(** **)** |const|
    232. 

  232. 

  233. Returns the :ref:`PopupMenu<class_PopupMenu>` contained in this button.
    234. 

  234. 

  235. ----
    236. 

  236. 

  237. .. _class_OptionButton_method_get_selected_id:
    238. 

  238. 

  239. - :ref:`int<class_int>` **get_selected_id** **(** **)** |const|
    240. 

  240. 

  241. Returns the ID of the selected item, or ``0`` if no item is selected.
    242. 

  242. 

  243. ----
    244. 

  244. 

  245. .. _class_OptionButton_method_get_selected_metadata:
    246. 

  246. 

  247. - :ref:`Variant<class_Variant>` **get_selected_metadata** **(** **)** |const|
    248. 

  248. 

  249. Gets the metadata of the selected item. Metadata for items can be set using :ref:`set_item_metadata<class_OptionButton_method_set_item_metadata>`.
    250. 

  250. 

  251. ----
    252. 

  252. 

  253. .. _class_OptionButton_method_is_item_disabled:
    254. 

  254. 

  255. - :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** |const|
    256. 

  256. 

  257. Returns ``true`` if the item at index ``idx`` is disabled.
    258. 

  258. 

  259. ----
    260. 

  260. 

  261. .. _class_OptionButton_method_remove_item:
    262. 

  262. 

  263. - void **remove_item** **(** :ref:`int<class_int>` idx **)**
    264. 

  264. 

  265. Removes the item at index ``idx``.
    266. 

  266. 

  267. ----
    268. 

  268. 

  269. .. _class_OptionButton_method_select:
    270. 

  270. 

  271. - void **select** **(** :ref:`int<class_int>` idx **)**
    272. 

  272. 

  273. Selects an item by index and makes it the current item. This will work even if the item is disabled.
    274. 

  274. 

  275. ----
    276. 

  276. 

  277. .. _class_OptionButton_method_set_item_disabled:
    278. 

  278. 

  279. - void **set_item_disabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**
    280. 

  280. 

  281. Sets whether the item at index ``idx`` is disabled.
    282. 

  282. 

  283. Disabled items are drawn differently in the dropdown and are not selectable by the user. If the current selected item is set as disabled, it will remain selected.
    284. 

  284. 

  285. ----
    286. 

  286. 

  287. .. _class_OptionButton_method_set_item_icon:
    288. 

  288. 

  289. - void **set_item_icon** **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` texture **)**
    290. 

  290. 

  291. Sets the icon of the item at index ``idx``.
    292. 

  292. 

  293. ----
    294. 

  294. 

  295. .. _class_OptionButton_method_set_item_id:
    296. 

  296. 

  297. - void **set_item_id** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)**
    298. 

  298. 

  299. Sets the ID of the item at index ``idx``.
    300. 

  300. 

  301. ----
    302. 

  302. 

  303. .. _class_OptionButton_method_set_item_metadata:
    304. 

  304. 

  305. - void **set_item_metadata** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**
    306. 

  306. 

  307. Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID.
    308. 

  308. 

  309. ----
    310. 

  310. 

  311. .. _class_OptionButton_method_set_item_text:
    312. 

  312. 

  313. - void **set_item_text** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**
    314. 

  314. 

  315. Sets the text of the item at index ``idx``.
    316. 

  316. 

  317. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    318. 

  318. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    319. 

  319. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    320.