class_popupmenu.rst 100 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PopupMenu.xml.
  6. .. _class_PopupMenu:
  7. PopupMenu
  8. =========
  9. **Inherits:** :ref:`Popup<class_Popup>` **<** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A modal window used to display a list of options.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **PopupMenu** is a modal window used to display a list of options. Useful for toolbars and context menus.
  15. The size of a **PopupMenu** can be limited by using :ref:`Window.max_size<class_Window_property_max_size>`. If the height of the list of items is larger than the maximum height of the **PopupMenu**, a :ref:`ScrollContainer<class_ScrollContainer>` within the popup will allow the user to scroll the contents. If no maximum size is set, or if it is set to ``0``, the **PopupMenu** height will be limited by its parent rect.
  16. All ``set_*`` methods allow negative item indices, i.e. ``-1`` to access the last item, ``-2`` to select the second-to-last item, and so on.
  17. \ **Incremental search:** Like :ref:`ItemList<class_ItemList>` and :ref:`Tree<class_Tree>`, **PopupMenu** supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing :ref:`ProjectSettings.gui/timers/incremental_search_max_interval_msec<class_ProjectSettings_property_gui/timers/incremental_search_max_interval_msec>`.
  18. \ **Note:** The ID values used for items are limited to 32 bits, not full 64 bits of :ref:`int<class_int>`. This has a range of ``-2^32`` to ``2^32 - 1``, i.e. ``-2147483648`` to ``2147483647``.
  19. .. rst-class:: classref-reftable-group
  20. Properties
  21. ----------
  22. .. table::
  23. :widths: auto
  24. +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
  25. | :ref:`bool<class_bool>` | :ref:`allow_search<class_PopupMenu_property_allow_search>` | ``true`` |
  26. +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
  27. | :ref:`bool<class_bool>` | :ref:`hide_on_checkable_item_selection<class_PopupMenu_property_hide_on_checkable_item_selection>` | ``true`` |
  28. +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
  29. | :ref:`bool<class_bool>` | :ref:`hide_on_item_selection<class_PopupMenu_property_hide_on_item_selection>` | ``true`` |
  30. +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
  31. | :ref:`bool<class_bool>` | :ref:`hide_on_state_item_selection<class_PopupMenu_property_hide_on_state_item_selection>` | ``false`` |
  32. +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
  33. | :ref:`int<class_int>` | :ref:`item_count<class_PopupMenu_property_item_count>` | ``0`` |
  34. +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
  35. | :ref:`float<class_float>` | :ref:`submenu_popup_delay<class_PopupMenu_property_submenu_popup_delay>` | ``0.3`` |
  36. +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
  37. .. rst-class:: classref-reftable-group
  38. Methods
  39. -------
  40. .. table::
  41. :widths: auto
  42. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`add_check_item<class_PopupMenu_method_add_check_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)** |
  44. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`add_check_shortcut<class_PopupMenu_method_add_check_shortcut>` **(** :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)** |
  46. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`add_icon_check_item<class_PopupMenu_method_add_icon_check_item>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)** |
  48. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`add_icon_check_shortcut<class_PopupMenu_method_add_icon_check_shortcut>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)** |
  50. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`add_icon_item<class_PopupMenu_method_add_icon_item>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)** |
  52. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`add_icon_radio_check_item<class_PopupMenu_method_add_icon_radio_check_item>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)** |
  54. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`add_icon_radio_check_shortcut<class_PopupMenu_method_add_icon_radio_check_shortcut>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)** |
  56. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`add_icon_shortcut<class_PopupMenu_method_add_icon_shortcut>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false, :ref:`bool<class_bool>` allow_echo=false **)** |
  58. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`add_item<class_PopupMenu_method_add_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)** |
  60. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`add_multistate_item<class_PopupMenu_method_add_multistate_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state=0, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)** |
  62. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`add_radio_check_item<class_PopupMenu_method_add_radio_check_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)** |
  64. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`add_radio_check_shortcut<class_PopupMenu_method_add_radio_check_shortcut>` **(** :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)** |
  66. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`add_separator<class_PopupMenu_method_add_separator>` **(** :ref:`String<class_String>` label="", :ref:`int<class_int>` id=-1 **)** |
  68. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`add_shortcut<class_PopupMenu_method_add_shortcut>` **(** :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false, :ref:`bool<class_bool>` allow_echo=false **)** |
  70. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`add_submenu_item<class_PopupMenu_method_add_submenu_item>` **(** :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` id=-1 **)** |
  72. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`clear<class_PopupMenu_method_clear>` **(** **)** |
  74. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`int<class_int>` | :ref:`get_focused_item<class_PopupMenu_method_get_focused_item>` **(** **)** |const| |
  76. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`Key<enum_@GlobalScope_Key>` | :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` **(** :ref:`int<class_int>` index **)** |const| |
  78. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`Texture2D<class_Texture2D>` | :ref:`get_item_icon<class_PopupMenu_method_get_item_icon>` **(** :ref:`int<class_int>` index **)** |const| |
  80. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`int<class_int>` | :ref:`get_item_icon_max_width<class_PopupMenu_method_get_item_icon_max_width>` **(** :ref:`int<class_int>` index **)** |const| |
  82. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`Color<class_Color>` | :ref:`get_item_icon_modulate<class_PopupMenu_method_get_item_icon_modulate>` **(** :ref:`int<class_int>` index **)** |const| |
  84. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`int<class_int>` | :ref:`get_item_id<class_PopupMenu_method_get_item_id>` **(** :ref:`int<class_int>` index **)** |const| |
  86. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`int<class_int>` | :ref:`get_item_indent<class_PopupMenu_method_get_item_indent>` **(** :ref:`int<class_int>` index **)** |const| |
  88. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`int<class_int>` | :ref:`get_item_index<class_PopupMenu_method_get_item_index>` **(** :ref:`int<class_int>` id **)** |const| |
  90. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`String<class_String>` | :ref:`get_item_language<class_PopupMenu_method_get_item_language>` **(** :ref:`int<class_int>` index **)** |const| |
  92. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`Variant<class_Variant>` | :ref:`get_item_metadata<class_PopupMenu_method_get_item_metadata>` **(** :ref:`int<class_int>` index **)** |const| |
  94. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`Shortcut<class_Shortcut>` | :ref:`get_item_shortcut<class_PopupMenu_method_get_item_shortcut>` **(** :ref:`int<class_int>` index **)** |const| |
  96. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`String<class_String>` | :ref:`get_item_submenu<class_PopupMenu_method_get_item_submenu>` **(** :ref:`int<class_int>` index **)** |const| |
  98. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`String<class_String>` | :ref:`get_item_text<class_PopupMenu_method_get_item_text>` **(** :ref:`int<class_int>` index **)** |const| |
  100. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`get_item_text_direction<class_PopupMenu_method_get_item_text_direction>` **(** :ref:`int<class_int>` index **)** |const| |
  102. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`String<class_String>` | :ref:`get_item_tooltip<class_PopupMenu_method_get_item_tooltip>` **(** :ref:`int<class_int>` index **)** |const| |
  104. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`bool<class_bool>` | :ref:`is_item_checkable<class_PopupMenu_method_is_item_checkable>` **(** :ref:`int<class_int>` index **)** |const| |
  106. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`bool<class_bool>` | :ref:`is_item_checked<class_PopupMenu_method_is_item_checked>` **(** :ref:`int<class_int>` index **)** |const| |
  108. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_PopupMenu_method_is_item_disabled>` **(** :ref:`int<class_int>` index **)** |const| |
  110. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`bool<class_bool>` | :ref:`is_item_radio_checkable<class_PopupMenu_method_is_item_radio_checkable>` **(** :ref:`int<class_int>` index **)** |const| |
  112. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`bool<class_bool>` | :ref:`is_item_separator<class_PopupMenu_method_is_item_separator>` **(** :ref:`int<class_int>` index **)** |const| |
  114. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`bool<class_bool>` | :ref:`is_item_shortcut_disabled<class_PopupMenu_method_is_item_shortcut_disabled>` **(** :ref:`int<class_int>` index **)** |const| |
  116. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | void | :ref:`remove_item<class_PopupMenu_method_remove_item>` **(** :ref:`int<class_int>` index **)** |
  118. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | void | :ref:`scroll_to_item<class_PopupMenu_method_scroll_to_item>` **(** :ref:`int<class_int>` index **)** |
  120. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | void | :ref:`set_focused_item<class_PopupMenu_method_set_focused_item>` **(** :ref:`int<class_int>` index **)** |
  122. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | void | :ref:`set_item_accelerator<class_PopupMenu_method_set_item_accelerator>` **(** :ref:`int<class_int>` index, :ref:`Key<enum_@GlobalScope_Key>` accel **)** |
  124. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | void | :ref:`set_item_as_checkable<class_PopupMenu_method_set_item_as_checkable>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)** |
  126. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | void | :ref:`set_item_as_radio_checkable<class_PopupMenu_method_set_item_as_radio_checkable>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)** |
  128. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | void | :ref:`set_item_as_separator<class_PopupMenu_method_set_item_as_separator>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)** |
  130. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | void | :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` checked **)** |
  132. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`set_item_disabled<class_PopupMenu_method_set_item_disabled>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` disabled **)** |
  134. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`set_item_icon<class_PopupMenu_method_set_item_icon>` **(** :ref:`int<class_int>` index, :ref:`Texture2D<class_Texture2D>` icon **)** |
  136. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | void | :ref:`set_item_icon_max_width<class_PopupMenu_method_set_item_icon_max_width>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` width **)** |
  138. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`set_item_icon_modulate<class_PopupMenu_method_set_item_icon_modulate>` **(** :ref:`int<class_int>` index, :ref:`Color<class_Color>` modulate **)** |
  140. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`set_item_id<class_PopupMenu_method_set_item_id>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` id **)** |
  142. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | void | :ref:`set_item_indent<class_PopupMenu_method_set_item_indent>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` indent **)** |
  144. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`set_item_language<class_PopupMenu_method_set_item_language>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` language **)** |
  146. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | void | :ref:`set_item_metadata<class_PopupMenu_method_set_item_metadata>` **(** :ref:`int<class_int>` index, :ref:`Variant<class_Variant>` metadata **)** |
  148. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | void | :ref:`set_item_multistate<class_PopupMenu_method_set_item_multistate>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` state **)** |
  150. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | void | :ref:`set_item_shortcut<class_PopupMenu_method_set_item_shortcut>` **(** :ref:`int<class_int>` index, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`bool<class_bool>` global=false **)** |
  152. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | void | :ref:`set_item_shortcut_disabled<class_PopupMenu_method_set_item_shortcut_disabled>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` disabled **)** |
  154. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`set_item_submenu<class_PopupMenu_method_set_item_submenu>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` submenu **)** |
  156. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`set_item_text<class_PopupMenu_method_set_item_text>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` text **)** |
  158. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`set_item_text_direction<class_PopupMenu_method_set_item_text_direction>` **(** :ref:`int<class_int>` index, :ref:`TextDirection<enum_Control_TextDirection>` direction **)** |
  160. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | void | :ref:`set_item_tooltip<class_PopupMenu_method_set_item_tooltip>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` tooltip **)** |
  162. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | void | :ref:`toggle_item_checked<class_PopupMenu_method_toggle_item_checked>` **(** :ref:`int<class_int>` index **)** |
  164. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | void | :ref:`toggle_item_multistate<class_PopupMenu_method_toggle_item_multistate>` **(** :ref:`int<class_int>` index **)** |
  166. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. .. rst-class:: classref-reftable-group
  168. Theme Properties
  169. ----------------
  170. .. table::
  171. :widths: auto
  172. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  173. | :ref:`Color<class_Color>` | :ref:`font_accelerator_color<class_PopupMenu_theme_color_font_accelerator_color>` | ``Color(0.7, 0.7, 0.7, 0.8)`` |
  174. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  175. | :ref:`Color<class_Color>` | :ref:`font_color<class_PopupMenu_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
  176. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  177. | :ref:`Color<class_Color>` | :ref:`font_disabled_color<class_PopupMenu_theme_color_font_disabled_color>` | ``Color(0.4, 0.4, 0.4, 0.8)`` |
  178. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  179. | :ref:`Color<class_Color>` | :ref:`font_hover_color<class_PopupMenu_theme_color_font_hover_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
  180. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  181. | :ref:`Color<class_Color>` | :ref:`font_outline_color<class_PopupMenu_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
  182. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  183. | :ref:`Color<class_Color>` | :ref:`font_separator_color<class_PopupMenu_theme_color_font_separator_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
  184. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  185. | :ref:`Color<class_Color>` | :ref:`font_separator_outline_color<class_PopupMenu_theme_color_font_separator_outline_color>` | ``Color(1, 1, 1, 1)`` |
  186. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  187. | :ref:`int<class_int>` | :ref:`h_separation<class_PopupMenu_theme_constant_h_separation>` | ``4`` |
  188. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  189. | :ref:`int<class_int>` | :ref:`icon_max_width<class_PopupMenu_theme_constant_icon_max_width>` | ``0`` |
  190. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  191. | :ref:`int<class_int>` | :ref:`indent<class_PopupMenu_theme_constant_indent>` | ``10`` |
  192. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  193. | :ref:`int<class_int>` | :ref:`item_end_padding<class_PopupMenu_theme_constant_item_end_padding>` | ``2`` |
  194. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  195. | :ref:`int<class_int>` | :ref:`item_start_padding<class_PopupMenu_theme_constant_item_start_padding>` | ``2`` |
  196. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  197. | :ref:`int<class_int>` | :ref:`outline_size<class_PopupMenu_theme_constant_outline_size>` | ``0`` |
  198. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  199. | :ref:`int<class_int>` | :ref:`separator_outline_size<class_PopupMenu_theme_constant_separator_outline_size>` | ``0`` |
  200. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  201. | :ref:`int<class_int>` | :ref:`v_separation<class_PopupMenu_theme_constant_v_separation>` | ``4`` |
  202. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  203. | :ref:`Font<class_Font>` | :ref:`font<class_PopupMenu_theme_font_font>` | |
  204. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  205. | :ref:`Font<class_Font>` | :ref:`font_separator<class_PopupMenu_theme_font_font_separator>` | |
  206. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  207. | :ref:`int<class_int>` | :ref:`font_separator_size<class_PopupMenu_theme_font_size_font_separator_size>` | |
  208. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  209. | :ref:`int<class_int>` | :ref:`font_size<class_PopupMenu_theme_font_size_font_size>` | |
  210. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  211. | :ref:`Texture2D<class_Texture2D>` | :ref:`checked<class_PopupMenu_theme_icon_checked>` | |
  212. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  213. | :ref:`Texture2D<class_Texture2D>` | :ref:`checked_disabled<class_PopupMenu_theme_icon_checked_disabled>` | |
  214. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  215. | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_checked<class_PopupMenu_theme_icon_radio_checked>` | |
  216. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  217. | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_checked_disabled<class_PopupMenu_theme_icon_radio_checked_disabled>` | |
  218. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  219. | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_unchecked<class_PopupMenu_theme_icon_radio_unchecked>` | |
  220. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  221. | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_unchecked_disabled<class_PopupMenu_theme_icon_radio_unchecked_disabled>` | |
  222. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  223. | :ref:`Texture2D<class_Texture2D>` | :ref:`submenu<class_PopupMenu_theme_icon_submenu>` | |
  224. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  225. | :ref:`Texture2D<class_Texture2D>` | :ref:`submenu_mirrored<class_PopupMenu_theme_icon_submenu_mirrored>` | |
  226. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  227. | :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked<class_PopupMenu_theme_icon_unchecked>` | |
  228. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  229. | :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_disabled<class_PopupMenu_theme_icon_unchecked_disabled>` | |
  230. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  231. | :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_PopupMenu_theme_style_hover>` | |
  232. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  233. | :ref:`StyleBox<class_StyleBox>` | :ref:`labeled_separator_left<class_PopupMenu_theme_style_labeled_separator_left>` | |
  234. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  235. | :ref:`StyleBox<class_StyleBox>` | :ref:`labeled_separator_right<class_PopupMenu_theme_style_labeled_separator_right>` | |
  236. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  237. | :ref:`StyleBox<class_StyleBox>` | :ref:`panel<class_PopupMenu_theme_style_panel>` | |
  238. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  239. | :ref:`StyleBox<class_StyleBox>` | :ref:`panel_disabled<class_PopupMenu_theme_style_panel_disabled>` | |
  240. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  241. | :ref:`StyleBox<class_StyleBox>` | :ref:`separator<class_PopupMenu_theme_style_separator>` | |
  242. +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
  243. .. rst-class:: classref-section-separator
  244. ----
  245. .. rst-class:: classref-descriptions-group
  246. Signals
  247. -------
  248. .. _class_PopupMenu_signal_id_focused:
  249. .. rst-class:: classref-signal
  250. **id_focused** **(** :ref:`int<class_int>` id **)**
  251. Emitted when the user navigated to an item of some ``id`` using the :ref:`ProjectSettings.input/ui_up<class_ProjectSettings_property_input/ui_up>` or :ref:`ProjectSettings.input/ui_down<class_ProjectSettings_property_input/ui_down>` input action.
  252. .. rst-class:: classref-item-separator
  253. ----
  254. .. _class_PopupMenu_signal_id_pressed:
  255. .. rst-class:: classref-signal
  256. **id_pressed** **(** :ref:`int<class_int>` id **)**
  257. Emitted when an item of some ``id`` is pressed or its accelerator is activated.
  258. \ **Note:** If ``id`` is negative (either explicitly or due to overflow), this will return the corresponding index instead.
  259. .. rst-class:: classref-item-separator
  260. ----
  261. .. _class_PopupMenu_signal_index_pressed:
  262. .. rst-class:: classref-signal
  263. **index_pressed** **(** :ref:`int<class_int>` index **)**
  264. Emitted when an item of some ``index`` is pressed or its accelerator is activated.
  265. .. rst-class:: classref-item-separator
  266. ----
  267. .. _class_PopupMenu_signal_menu_changed:
  268. .. rst-class:: classref-signal
  269. **menu_changed** **(** **)**
  270. Emitted when any item is added, modified or removed.
  271. .. rst-class:: classref-section-separator
  272. ----
  273. .. rst-class:: classref-descriptions-group
  274. Property Descriptions
  275. ---------------------
  276. .. _class_PopupMenu_property_allow_search:
  277. .. rst-class:: classref-property
  278. :ref:`bool<class_bool>` **allow_search** = ``true``
  279. .. rst-class:: classref-property-setget
  280. - void **set_allow_search** **(** :ref:`bool<class_bool>` value **)**
  281. - :ref:`bool<class_bool>` **get_allow_search** **(** **)**
  282. If ``true``, allows navigating **PopupMenu** with letter keys.
  283. .. rst-class:: classref-item-separator
  284. ----
  285. .. _class_PopupMenu_property_hide_on_checkable_item_selection:
  286. .. rst-class:: classref-property
  287. :ref:`bool<class_bool>` **hide_on_checkable_item_selection** = ``true``
  288. .. rst-class:: classref-property-setget
  289. - void **set_hide_on_checkable_item_selection** **(** :ref:`bool<class_bool>` value **)**
  290. - :ref:`bool<class_bool>` **is_hide_on_checkable_item_selection** **(** **)**
  291. If ``true``, hides the **PopupMenu** when a checkbox or radio button is selected.
  292. .. rst-class:: classref-item-separator
  293. ----
  294. .. _class_PopupMenu_property_hide_on_item_selection:
  295. .. rst-class:: classref-property
  296. :ref:`bool<class_bool>` **hide_on_item_selection** = ``true``
  297. .. rst-class:: classref-property-setget
  298. - void **set_hide_on_item_selection** **(** :ref:`bool<class_bool>` value **)**
  299. - :ref:`bool<class_bool>` **is_hide_on_item_selection** **(** **)**
  300. If ``true``, hides the **PopupMenu** when an item is selected.
  301. .. rst-class:: classref-item-separator
  302. ----
  303. .. _class_PopupMenu_property_hide_on_state_item_selection:
  304. .. rst-class:: classref-property
  305. :ref:`bool<class_bool>` **hide_on_state_item_selection** = ``false``
  306. .. rst-class:: classref-property-setget
  307. - void **set_hide_on_state_item_selection** **(** :ref:`bool<class_bool>` value **)**
  308. - :ref:`bool<class_bool>` **is_hide_on_state_item_selection** **(** **)**
  309. If ``true``, hides the **PopupMenu** when a state item is selected.
  310. .. rst-class:: classref-item-separator
  311. ----
  312. .. _class_PopupMenu_property_item_count:
  313. .. rst-class:: classref-property
  314. :ref:`int<class_int>` **item_count** = ``0``
  315. .. rst-class:: classref-property-setget
  316. - void **set_item_count** **(** :ref:`int<class_int>` value **)**
  317. - :ref:`int<class_int>` **get_item_count** **(** **)**
  318. The number of items currently in the list.
  319. .. rst-class:: classref-item-separator
  320. ----
  321. .. _class_PopupMenu_property_submenu_popup_delay:
  322. .. rst-class:: classref-property
  323. :ref:`float<class_float>` **submenu_popup_delay** = ``0.3``
  324. .. rst-class:: classref-property-setget
  325. - void **set_submenu_popup_delay** **(** :ref:`float<class_float>` value **)**
  326. - :ref:`float<class_float>` **get_submenu_popup_delay** **(** **)**
  327. Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item.
  328. .. rst-class:: classref-section-separator
  329. ----
  330. .. rst-class:: classref-descriptions-group
  331. Method Descriptions
  332. -------------------
  333. .. _class_PopupMenu_method_add_check_item:
  334. .. rst-class:: classref-method
  335. void **add_check_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**
  336. Adds a new checkable item with text ``label``.
  337. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided, then the default value of 0 (corresponding to :ref:`@GlobalScope.KEY_NONE<class_@GlobalScope_constant_KEY_NONE>`) will be assigned to the item (which means it won't have any accelerator). See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
  338. \ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.
  339. .. rst-class:: classref-item-separator
  340. ----
  341. .. _class_PopupMenu_method_add_check_shortcut:
  342. .. rst-class:: classref-method
  343. void **add_check_shortcut** **(** :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**
  344. Adds a new checkable item and assigns the specified :ref:`Shortcut<class_Shortcut>` to it. Sets the label of the checkbox to the :ref:`Shortcut<class_Shortcut>`'s name.
  345. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.
  346. \ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.
  347. .. rst-class:: classref-item-separator
  348. ----
  349. .. _class_PopupMenu_method_add_icon_check_item:
  350. .. rst-class:: classref-method
  351. void **add_icon_check_item** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**
  352. Adds a new checkable item with text ``label`` and icon ``texture``.
  353. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided, then the default value of 0 (corresponding to :ref:`@GlobalScope.KEY_NONE<class_@GlobalScope_constant_KEY_NONE>`) will be assigned to the item (which means it won't have any accelerator). See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
  354. \ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.
  355. .. rst-class:: classref-item-separator
  356. ----
  357. .. _class_PopupMenu_method_add_icon_check_shortcut:
  358. .. rst-class:: classref-method
  359. void **add_icon_check_shortcut** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**
  360. Adds a new checkable item and assigns the specified :ref:`Shortcut<class_Shortcut>` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`Shortcut<class_Shortcut>`'s name.
  361. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.
  362. \ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.
  363. .. rst-class:: classref-item-separator
  364. ----
  365. .. _class_PopupMenu_method_add_icon_item:
  366. .. rst-class:: classref-method
  367. void **add_icon_item** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**
  368. Adds a new item with text ``label`` and icon ``texture``.
  369. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided, then the default value of 0 (corresponding to :ref:`@GlobalScope.KEY_NONE<class_@GlobalScope_constant_KEY_NONE>`) will be assigned to the item (which means it won't have any accelerator). See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
  370. .. rst-class:: classref-item-separator
  371. ----
  372. .. _class_PopupMenu_method_add_icon_radio_check_item:
  373. .. rst-class:: classref-method
  374. void **add_icon_radio_check_item** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**
  375. Same as :ref:`add_icon_check_item<class_PopupMenu_method_add_icon_check_item>`, but uses a radio check button.
  376. .. rst-class:: classref-item-separator
  377. ----
  378. .. _class_PopupMenu_method_add_icon_radio_check_shortcut:
  379. .. rst-class:: classref-method
  380. void **add_icon_radio_check_shortcut** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**
  381. Same as :ref:`add_icon_check_shortcut<class_PopupMenu_method_add_icon_check_shortcut>`, but uses a radio check button.
  382. .. rst-class:: classref-item-separator
  383. ----
  384. .. _class_PopupMenu_method_add_icon_shortcut:
  385. .. rst-class:: classref-method
  386. void **add_icon_shortcut** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false, :ref:`bool<class_bool>` allow_echo=false **)**
  387. Adds a new item and assigns the specified :ref:`Shortcut<class_Shortcut>` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`Shortcut<class_Shortcut>`'s name.
  388. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.
  389. If ``allow_echo`` is ``true``, the shortcut can be activated with echo events.
  390. .. rst-class:: classref-item-separator
  391. ----
  392. .. _class_PopupMenu_method_add_item:
  393. .. rst-class:: classref-method
  394. void **add_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**
  395. Adds a new item with text ``label``.
  396. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided, then the default value of 0 (corresponding to :ref:`@GlobalScope.KEY_NONE<class_@GlobalScope_constant_KEY_NONE>`) will be assigned to the item (which means it won't have any accelerator). See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
  397. \ **Note:** The provided ``id`` is used only in :ref:`id_pressed<class_PopupMenu_signal_id_pressed>` and :ref:`id_focused<class_PopupMenu_signal_id_focused>` signals. It's not related to the ``index`` arguments in e.g. :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>`.
  398. .. rst-class:: classref-item-separator
  399. ----
  400. .. _class_PopupMenu_method_add_multistate_item:
  401. .. rst-class:: classref-method
  402. void **add_multistate_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state=0, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**
  403. Adds a new multistate item with text ``label``.
  404. Contrarily to normal binary items, multistate items can have more than two states, as defined by ``max_states``. Each press or activate of the item will increase the state by one. The default value is defined by ``default_state``.
  405. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided, then the default value of 0 (corresponding to :ref:`@GlobalScope.KEY_NONE<class_@GlobalScope_constant_KEY_NONE>`) will be assigned to the item (which means it won't have any accelerator). See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
  406. .. rst-class:: classref-item-separator
  407. ----
  408. .. _class_PopupMenu_method_add_radio_check_item:
  409. .. rst-class:: classref-method
  410. void **add_radio_check_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**
  411. Adds a new radio check button with text ``label``.
  412. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided, then the default value of 0 (corresponding to :ref:`@GlobalScope.KEY_NONE<class_@GlobalScope_constant_KEY_NONE>`) will be assigned to the item (which means it won't have any accelerator). See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
  413. \ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.
  414. .. rst-class:: classref-item-separator
  415. ----
  416. .. _class_PopupMenu_method_add_radio_check_shortcut:
  417. .. rst-class:: classref-method
  418. void **add_radio_check_shortcut** **(** :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**
  419. Adds a new radio check button and assigns a :ref:`Shortcut<class_Shortcut>` to it. Sets the label of the checkbox to the :ref:`Shortcut<class_Shortcut>`'s name.
  420. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.
  421. \ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.
  422. .. rst-class:: classref-item-separator
  423. ----
  424. .. _class_PopupMenu_method_add_separator:
  425. .. rst-class:: classref-method
  426. void **add_separator** **(** :ref:`String<class_String>` label="", :ref:`int<class_int>` id=-1 **)**
  427. Adds a separator between items. Separators also occupy an index, which you can set by using the ``id`` parameter.
  428. A ``label`` can optionally be provided, which will appear at the center of the separator.
  429. .. rst-class:: classref-item-separator
  430. ----
  431. .. _class_PopupMenu_method_add_shortcut:
  432. .. rst-class:: classref-method
  433. void **add_shortcut** **(** :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false, :ref:`bool<class_bool>` allow_echo=false **)**
  434. Adds a :ref:`Shortcut<class_Shortcut>`.
  435. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.
  436. If ``allow_echo`` is ``true``, the shortcut can be activated with echo events.
  437. .. rst-class:: classref-item-separator
  438. ----
  439. .. _class_PopupMenu_method_add_submenu_item:
  440. .. rst-class:: classref-method
  441. void **add_submenu_item** **(** :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` id=-1 **)**
  442. Adds an item that will act as a submenu of the parent **PopupMenu** node when clicked. The ``submenu`` argument is the name of the child **PopupMenu** node that will be shown when the item is clicked.
  443. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.
  444. .. rst-class:: classref-item-separator
  445. ----
  446. .. _class_PopupMenu_method_clear:
  447. .. rst-class:: classref-method
  448. void **clear** **(** **)**
  449. Removes all items from the **PopupMenu**.
  450. .. rst-class:: classref-item-separator
  451. ----
  452. .. _class_PopupMenu_method_get_focused_item:
  453. .. rst-class:: classref-method
  454. :ref:`int<class_int>` **get_focused_item** **(** **)** |const|
  455. Returns the index of the currently focused item. Returns ``-1`` if no item is focused.
  456. .. rst-class:: classref-item-separator
  457. ----
  458. .. _class_PopupMenu_method_get_item_accelerator:
  459. .. rst-class:: classref-method
  460. :ref:`Key<enum_@GlobalScope_Key>` **get_item_accelerator** **(** :ref:`int<class_int>` index **)** |const|
  461. Returns the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The return value is an integer which is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). If no accelerator is defined for the specified ``index``, :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` returns ``0`` (corresponding to :ref:`@GlobalScope.KEY_NONE<class_@GlobalScope_constant_KEY_NONE>`).
  462. .. rst-class:: classref-item-separator
  463. ----
  464. .. _class_PopupMenu_method_get_item_icon:
  465. .. rst-class:: classref-method
  466. :ref:`Texture2D<class_Texture2D>` **get_item_icon** **(** :ref:`int<class_int>` index **)** |const|
  467. Returns the icon of the item at the given ``index``.
  468. .. rst-class:: classref-item-separator
  469. ----
  470. .. _class_PopupMenu_method_get_item_icon_max_width:
  471. .. rst-class:: classref-method
  472. :ref:`int<class_int>` **get_item_icon_max_width** **(** :ref:`int<class_int>` index **)** |const|
  473. Returns the maximum allowed width of the icon for the item at the given ``index``.
  474. .. rst-class:: classref-item-separator
  475. ----
  476. .. _class_PopupMenu_method_get_item_icon_modulate:
  477. .. rst-class:: classref-method
  478. :ref:`Color<class_Color>` **get_item_icon_modulate** **(** :ref:`int<class_int>` index **)** |const|
  479. Returns a :ref:`Color<class_Color>` modulating the item's icon at the given ``index``.
  480. .. rst-class:: classref-item-separator
  481. ----
  482. .. _class_PopupMenu_method_get_item_id:
  483. .. rst-class:: classref-method
  484. :ref:`int<class_int>` **get_item_id** **(** :ref:`int<class_int>` index **)** |const|
  485. Returns the ID of the item at the given ``index``. ``id`` can be manually assigned, while index can not.
  486. .. rst-class:: classref-item-separator
  487. ----
  488. .. _class_PopupMenu_method_get_item_indent:
  489. .. rst-class:: classref-method
  490. :ref:`int<class_int>` **get_item_indent** **(** :ref:`int<class_int>` index **)** |const|
  491. Returns the horizontal offset of the item at the given ``index``.
  492. .. rst-class:: classref-item-separator
  493. ----
  494. .. _class_PopupMenu_method_get_item_index:
  495. .. rst-class:: classref-method
  496. :ref:`int<class_int>` **get_item_index** **(** :ref:`int<class_int>` id **)** |const|
  497. Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine and can not be set manually.
  498. .. rst-class:: classref-item-separator
  499. ----
  500. .. _class_PopupMenu_method_get_item_language:
  501. .. rst-class:: classref-method
  502. :ref:`String<class_String>` **get_item_language** **(** :ref:`int<class_int>` index **)** |const|
  503. Returns item's text language code.
  504. .. rst-class:: classref-item-separator
  505. ----
  506. .. _class_PopupMenu_method_get_item_metadata:
  507. .. rst-class:: classref-method
  508. :ref:`Variant<class_Variant>` **get_item_metadata** **(** :ref:`int<class_int>` index **)** |const|
  509. Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`set_item_metadata<class_PopupMenu_method_set_item_metadata>`, which provides a simple way of assigning context data to items.
  510. .. rst-class:: classref-item-separator
  511. ----
  512. .. _class_PopupMenu_method_get_item_shortcut:
  513. .. rst-class:: classref-method
  514. :ref:`Shortcut<class_Shortcut>` **get_item_shortcut** **(** :ref:`int<class_int>` index **)** |const|
  515. Returns the :ref:`Shortcut<class_Shortcut>` associated with the item at the given ``index``.
  516. .. rst-class:: classref-item-separator
  517. ----
  518. .. _class_PopupMenu_method_get_item_submenu:
  519. .. rst-class:: classref-method
  520. :ref:`String<class_String>` **get_item_submenu** **(** :ref:`int<class_int>` index **)** |const|
  521. Returns the submenu name of the item at the given ``index``. See :ref:`add_submenu_item<class_PopupMenu_method_add_submenu_item>` for more info on how to add a submenu.
  522. .. rst-class:: classref-item-separator
  523. ----
  524. .. _class_PopupMenu_method_get_item_text:
  525. .. rst-class:: classref-method
  526. :ref:`String<class_String>` **get_item_text** **(** :ref:`int<class_int>` index **)** |const|
  527. Returns the text of the item at the given ``index``.
  528. .. rst-class:: classref-item-separator
  529. ----
  530. .. _class_PopupMenu_method_get_item_text_direction:
  531. .. rst-class:: classref-method
  532. :ref:`TextDirection<enum_Control_TextDirection>` **get_item_text_direction** **(** :ref:`int<class_int>` index **)** |const|
  533. Returns item's text base writing direction.
  534. .. rst-class:: classref-item-separator
  535. ----
  536. .. _class_PopupMenu_method_get_item_tooltip:
  537. .. rst-class:: classref-method
  538. :ref:`String<class_String>` **get_item_tooltip** **(** :ref:`int<class_int>` index **)** |const|
  539. Returns the tooltip associated with the item at the given ``index``.
  540. .. rst-class:: classref-item-separator
  541. ----
  542. .. _class_PopupMenu_method_is_item_checkable:
  543. .. rst-class:: classref-method
  544. :ref:`bool<class_bool>` **is_item_checkable** **(** :ref:`int<class_int>` index **)** |const|
  545. Returns ``true`` if the item at the given ``index`` is checkable in some way, i.e. if it has a checkbox or radio button.
  546. \ **Note:** Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.
  547. .. rst-class:: classref-item-separator
  548. ----
  549. .. _class_PopupMenu_method_is_item_checked:
  550. .. rst-class:: classref-method
  551. :ref:`bool<class_bool>` **is_item_checked** **(** :ref:`int<class_int>` index **)** |const|
  552. Returns ``true`` if the item at the given ``index`` is checked.
  553. .. rst-class:: classref-item-separator
  554. ----
  555. .. _class_PopupMenu_method_is_item_disabled:
  556. .. rst-class:: classref-method
  557. :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` index **)** |const|
  558. Returns ``true`` if the item at the given ``index`` is disabled. When it is disabled it can't be selected, or its action invoked.
  559. See :ref:`set_item_disabled<class_PopupMenu_method_set_item_disabled>` for more info on how to disable an item.
  560. .. rst-class:: classref-item-separator
  561. ----
  562. .. _class_PopupMenu_method_is_item_radio_checkable:
  563. .. rst-class:: classref-method
  564. :ref:`bool<class_bool>` **is_item_radio_checkable** **(** :ref:`int<class_int>` index **)** |const|
  565. Returns ``true`` if the item at the given ``index`` has radio button-style checkability.
  566. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
  567. .. rst-class:: classref-item-separator
  568. ----
  569. .. _class_PopupMenu_method_is_item_separator:
  570. .. rst-class:: classref-method
  571. :ref:`bool<class_bool>` **is_item_separator** **(** :ref:`int<class_int>` index **)** |const|
  572. Returns ``true`` if the item is a separator. If it is, it will be displayed as a line. See :ref:`add_separator<class_PopupMenu_method_add_separator>` for more info on how to add a separator.
  573. .. rst-class:: classref-item-separator
  574. ----
  575. .. _class_PopupMenu_method_is_item_shortcut_disabled:
  576. .. rst-class:: classref-method
  577. :ref:`bool<class_bool>` **is_item_shortcut_disabled** **(** :ref:`int<class_int>` index **)** |const|
  578. Returns ``true`` if the specified item's shortcut is disabled.
  579. .. rst-class:: classref-item-separator
  580. ----
  581. .. _class_PopupMenu_method_remove_item:
  582. .. rst-class:: classref-method
  583. void **remove_item** **(** :ref:`int<class_int>` index **)**
  584. Removes the item at the given ``index`` from the menu.
  585. \ **Note:** The indices of items after the removed item will be shifted by one.
  586. .. rst-class:: classref-item-separator
  587. ----
  588. .. _class_PopupMenu_method_scroll_to_item:
  589. .. rst-class:: classref-method
  590. void **scroll_to_item** **(** :ref:`int<class_int>` index **)**
  591. Moves the scroll view to make the item at the given ``index`` visible.
  592. .. rst-class:: classref-item-separator
  593. ----
  594. .. _class_PopupMenu_method_set_focused_item:
  595. .. rst-class:: classref-method
  596. void **set_focused_item** **(** :ref:`int<class_int>` index **)**
  597. Sets the currently focused item as the given ``index``.
  598. Passing ``-1`` as the index makes so that no item is focused.
  599. .. rst-class:: classref-item-separator
  600. ----
  601. .. _class_PopupMenu_method_set_item_accelerator:
  602. .. rst-class:: classref-method
  603. void **set_item_accelerator** **(** :ref:`int<class_int>` index, :ref:`Key<enum_@GlobalScope_Key>` accel **)**
  604. Sets the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. ``accel`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  605. .. rst-class:: classref-item-separator
  606. ----
  607. .. _class_PopupMenu_method_set_item_as_checkable:
  608. .. rst-class:: classref-method
  609. void **set_item_as_checkable** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)**
  610. Sets whether the item at the given ``index`` has a checkbox. If ``false``, sets the type of the item to plain text.
  611. \ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
  612. .. rst-class:: classref-item-separator
  613. ----
  614. .. _class_PopupMenu_method_set_item_as_radio_checkable:
  615. .. rst-class:: classref-method
  616. void **set_item_as_radio_checkable** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)**
  617. Sets the type of the item at the given ``index`` to radio button. If ``false``, sets the type of the item to plain text.
  618. .. rst-class:: classref-item-separator
  619. ----
  620. .. _class_PopupMenu_method_set_item_as_separator:
  621. .. rst-class:: classref-method
  622. void **set_item_as_separator** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)**
  623. Mark the item at the given ``index`` as a separator, which means that it would be displayed as a line. If ``false``, sets the type of the item to plain text.
  624. .. rst-class:: classref-item-separator
  625. ----
  626. .. _class_PopupMenu_method_set_item_checked:
  627. .. rst-class:: classref-method
  628. void **set_item_checked** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` checked **)**
  629. Sets the checkstate status of the item at the given ``index``.
  630. .. rst-class:: classref-item-separator
  631. ----
  632. .. _class_PopupMenu_method_set_item_disabled:
  633. .. rst-class:: classref-method
  634. void **set_item_disabled** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` disabled **)**
  635. Enables/disables the item at the given ``index``. When it is disabled, it can't be selected and its action can't be invoked.
  636. .. rst-class:: classref-item-separator
  637. ----
  638. .. _class_PopupMenu_method_set_item_icon:
  639. .. rst-class:: classref-method
  640. void **set_item_icon** **(** :ref:`int<class_int>` index, :ref:`Texture2D<class_Texture2D>` icon **)**
  641. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the item at the given ``index``.
  642. .. rst-class:: classref-item-separator
  643. ----
  644. .. _class_PopupMenu_method_set_item_icon_max_width:
  645. .. rst-class:: classref-method
  646. void **set_item_icon_max_width** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` width **)**
  647. Sets the maximum allowed width of the icon for the item at the given ``index``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width<class_PopupMenu_theme_constant_icon_max_width>`. The height is adjusted according to the icon's ratio.
  648. .. rst-class:: classref-item-separator
  649. ----
  650. .. _class_PopupMenu_method_set_item_icon_modulate:
  651. .. rst-class:: classref-method
  652. void **set_item_icon_modulate** **(** :ref:`int<class_int>` index, :ref:`Color<class_Color>` modulate **)**
  653. Sets a modulating :ref:`Color<class_Color>` of the item's icon at the given ``index``.
  654. .. rst-class:: classref-item-separator
  655. ----
  656. .. _class_PopupMenu_method_set_item_id:
  657. .. rst-class:: classref-method
  658. void **set_item_id** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` id **)**
  659. Sets the ``id`` of the item at the given ``index``.
  660. The ``id`` is used in :ref:`id_pressed<class_PopupMenu_signal_id_pressed>` and :ref:`id_focused<class_PopupMenu_signal_id_focused>` signals.
  661. .. rst-class:: classref-item-separator
  662. ----
  663. .. _class_PopupMenu_method_set_item_indent:
  664. .. rst-class:: classref-method
  665. void **set_item_indent** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` indent **)**
  666. Sets the horizontal offset of the item at the given ``index``.
  667. .. rst-class:: classref-item-separator
  668. ----
  669. .. _class_PopupMenu_method_set_item_language:
  670. .. rst-class:: classref-method
  671. void **set_item_language** **(** :ref:`int<class_int>` index, :ref:`String<class_String>` language **)**
  672. Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
  673. .. rst-class:: classref-item-separator
  674. ----
  675. .. _class_PopupMenu_method_set_item_metadata:
  676. .. rst-class:: classref-method
  677. void **set_item_metadata** **(** :ref:`int<class_int>` index, :ref:`Variant<class_Variant>` metadata **)**
  678. Sets the metadata of an item, which may be of any type. You can later get it with :ref:`get_item_metadata<class_PopupMenu_method_get_item_metadata>`, which provides a simple way of assigning context data to items.
  679. .. rst-class:: classref-item-separator
  680. ----
  681. .. _class_PopupMenu_method_set_item_multistate:
  682. .. rst-class:: classref-method
  683. void **set_item_multistate** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` state **)**
  684. Sets the state of a multistate item. See :ref:`add_multistate_item<class_PopupMenu_method_add_multistate_item>` for details.
  685. .. rst-class:: classref-item-separator
  686. ----
  687. .. _class_PopupMenu_method_set_item_shortcut:
  688. .. rst-class:: classref-method
  689. void **set_item_shortcut** **(** :ref:`int<class_int>` index, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`bool<class_bool>` global=false **)**
  690. Sets a :ref:`Shortcut<class_Shortcut>` for the item at the given ``index``.
  691. .. rst-class:: classref-item-separator
  692. ----
  693. .. _class_PopupMenu_method_set_item_shortcut_disabled:
  694. .. rst-class:: classref-method
  695. void **set_item_shortcut_disabled** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` disabled **)**
  696. Disables the :ref:`Shortcut<class_Shortcut>` of the item at the given ``index``.
  697. .. rst-class:: classref-item-separator
  698. ----
  699. .. _class_PopupMenu_method_set_item_submenu:
  700. .. rst-class:: classref-method
  701. void **set_item_submenu** **(** :ref:`int<class_int>` index, :ref:`String<class_String>` submenu **)**
  702. Sets the submenu of the item at the given ``index``. The submenu is the name of a child **PopupMenu** node that would be shown when the item is clicked.
  703. .. rst-class:: classref-item-separator
  704. ----
  705. .. _class_PopupMenu_method_set_item_text:
  706. .. rst-class:: classref-method
  707. void **set_item_text** **(** :ref:`int<class_int>` index, :ref:`String<class_String>` text **)**
  708. Sets the text of the item at the given ``index``.
  709. .. rst-class:: classref-item-separator
  710. ----
  711. .. _class_PopupMenu_method_set_item_text_direction:
  712. .. rst-class:: classref-method
  713. void **set_item_text_direction** **(** :ref:`int<class_int>` index, :ref:`TextDirection<enum_Control_TextDirection>` direction **)**
  714. Sets item's text base writing direction.
  715. .. rst-class:: classref-item-separator
  716. ----
  717. .. _class_PopupMenu_method_set_item_tooltip:
  718. .. rst-class:: classref-method
  719. void **set_item_tooltip** **(** :ref:`int<class_int>` index, :ref:`String<class_String>` tooltip **)**
  720. Sets the :ref:`String<class_String>` tooltip of the item at the given ``index``.
  721. .. rst-class:: classref-item-separator
  722. ----
  723. .. _class_PopupMenu_method_toggle_item_checked:
  724. .. rst-class:: classref-method
  725. void **toggle_item_checked** **(** :ref:`int<class_int>` index **)**
  726. Toggles the check state of the item at the given ``index``.
  727. .. rst-class:: classref-item-separator
  728. ----
  729. .. _class_PopupMenu_method_toggle_item_multistate:
  730. .. rst-class:: classref-method
  731. void **toggle_item_multistate** **(** :ref:`int<class_int>` index **)**
  732. Cycle to the next state of a multistate item. See :ref:`add_multistate_item<class_PopupMenu_method_add_multistate_item>` for details.
  733. .. rst-class:: classref-section-separator
  734. ----
  735. .. rst-class:: classref-descriptions-group
  736. Theme Property Descriptions
  737. ---------------------------
  738. .. _class_PopupMenu_theme_color_font_accelerator_color:
  739. .. rst-class:: classref-themeproperty
  740. :ref:`Color<class_Color>` **font_accelerator_color** = ``Color(0.7, 0.7, 0.7, 0.8)``
  741. The text :ref:`Color<class_Color>` used for shortcuts and accelerators that show next to the menu item name when defined. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
  742. .. rst-class:: classref-item-separator
  743. ----
  744. .. _class_PopupMenu_theme_color_font_color:
  745. .. rst-class:: classref-themeproperty
  746. :ref:`Color<class_Color>` **font_color** = ``Color(0.875, 0.875, 0.875, 1)``
  747. The default text :ref:`Color<class_Color>` for menu items' names.
  748. .. rst-class:: classref-item-separator
  749. ----
  750. .. _class_PopupMenu_theme_color_font_disabled_color:
  751. .. rst-class:: classref-themeproperty
  752. :ref:`Color<class_Color>` **font_disabled_color** = ``Color(0.4, 0.4, 0.4, 0.8)``
  753. :ref:`Color<class_Color>` used for disabled menu items' text.
  754. .. rst-class:: classref-item-separator
  755. ----
  756. .. _class_PopupMenu_theme_color_font_hover_color:
  757. .. rst-class:: classref-themeproperty
  758. :ref:`Color<class_Color>` **font_hover_color** = ``Color(0.875, 0.875, 0.875, 1)``
  759. :ref:`Color<class_Color>` used for the hovered text.
  760. .. rst-class:: classref-item-separator
  761. ----
  762. .. _class_PopupMenu_theme_color_font_outline_color:
  763. .. rst-class:: classref-themeproperty
  764. :ref:`Color<class_Color>` **font_outline_color** = ``Color(1, 1, 1, 1)``
  765. The tint of text outline of the menu item.
  766. .. rst-class:: classref-item-separator
  767. ----
  768. .. _class_PopupMenu_theme_color_font_separator_color:
  769. .. rst-class:: classref-themeproperty
  770. :ref:`Color<class_Color>` **font_separator_color** = ``Color(0.875, 0.875, 0.875, 1)``
  771. :ref:`Color<class_Color>` used for labeled separators' text. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.
  772. .. rst-class:: classref-item-separator
  773. ----
  774. .. _class_PopupMenu_theme_color_font_separator_outline_color:
  775. .. rst-class:: classref-themeproperty
  776. :ref:`Color<class_Color>` **font_separator_outline_color** = ``Color(1, 1, 1, 1)``
  777. The tint of text outline of the labeled separator.
  778. .. rst-class:: classref-item-separator
  779. ----
  780. .. _class_PopupMenu_theme_constant_h_separation:
  781. .. rst-class:: classref-themeproperty
  782. :ref:`int<class_int>` **h_separation** = ``4``
  783. The horizontal space between the item's elements.
  784. .. rst-class:: classref-item-separator
  785. ----
  786. .. _class_PopupMenu_theme_constant_icon_max_width:
  787. .. rst-class:: classref-themeproperty
  788. :ref:`int<class_int>` **icon_max_width** = ``0``
  789. The maximum allowed width of the item's icon. This limit is applied on top of the default size of the icon, but before the value set with :ref:`set_item_icon_max_width<class_PopupMenu_method_set_item_icon_max_width>`. The height is adjusted according to the icon's ratio.
  790. .. rst-class:: classref-item-separator
  791. ----
  792. .. _class_PopupMenu_theme_constant_indent:
  793. .. rst-class:: classref-themeproperty
  794. :ref:`int<class_int>` **indent** = ``10``
  795. Width of the single indentation level.
  796. .. rst-class:: classref-item-separator
  797. ----
  798. .. _class_PopupMenu_theme_constant_item_end_padding:
  799. .. rst-class:: classref-themeproperty
  800. :ref:`int<class_int>` **item_end_padding** = ``2``
  801. Horizontal padding to the right of the items (or left, in RTL layout).
  802. .. rst-class:: classref-item-separator
  803. ----
  804. .. _class_PopupMenu_theme_constant_item_start_padding:
  805. .. rst-class:: classref-themeproperty
  806. :ref:`int<class_int>` **item_start_padding** = ``2``
  807. Horizontal padding to the left of the items (or right, in RTL layout).
  808. .. rst-class:: classref-item-separator
  809. ----
  810. .. _class_PopupMenu_theme_constant_outline_size:
  811. .. rst-class:: classref-themeproperty
  812. :ref:`int<class_int>` **outline_size** = ``0``
  813. The size of the item text outline.
  814. \ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` enabled, its :ref:`FontFile.msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` must be set to at least *twice* the value of :ref:`outline_size<class_PopupMenu_theme_constant_outline_size>` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
  815. .. rst-class:: classref-item-separator
  816. ----
  817. .. _class_PopupMenu_theme_constant_separator_outline_size:
  818. .. rst-class:: classref-themeproperty
  819. :ref:`int<class_int>` **separator_outline_size** = ``0``
  820. The size of the labeled separator text outline.
  821. .. rst-class:: classref-item-separator
  822. ----
  823. .. _class_PopupMenu_theme_constant_v_separation:
  824. .. rst-class:: classref-themeproperty
  825. :ref:`int<class_int>` **v_separation** = ``4``
  826. The vertical space between each menu item.
  827. .. rst-class:: classref-item-separator
  828. ----
  829. .. _class_PopupMenu_theme_font_font:
  830. .. rst-class:: classref-themeproperty
  831. :ref:`Font<class_Font>` **font**
  832. :ref:`Font<class_Font>` used for the menu items.
  833. .. rst-class:: classref-item-separator
  834. ----
  835. .. _class_PopupMenu_theme_font_font_separator:
  836. .. rst-class:: classref-themeproperty
  837. :ref:`Font<class_Font>` **font_separator**
  838. :ref:`Font<class_Font>` used for the labeled separator.
  839. .. rst-class:: classref-item-separator
  840. ----
  841. .. _class_PopupMenu_theme_font_size_font_separator_size:
  842. .. rst-class:: classref-themeproperty
  843. :ref:`int<class_int>` **font_separator_size**
  844. Font size of the labeled separator.
  845. .. rst-class:: classref-item-separator
  846. ----
  847. .. _class_PopupMenu_theme_font_size_font_size:
  848. .. rst-class:: classref-themeproperty
  849. :ref:`int<class_int>` **font_size**
  850. Font size of the menu items.
  851. .. rst-class:: classref-item-separator
  852. ----
  853. .. _class_PopupMenu_theme_icon_checked:
  854. .. rst-class:: classref-themeproperty
  855. :ref:`Texture2D<class_Texture2D>` **checked**
  856. :ref:`Texture2D<class_Texture2D>` icon for the checked checkbox items.
  857. .. rst-class:: classref-item-separator
  858. ----
  859. .. _class_PopupMenu_theme_icon_checked_disabled:
  860. .. rst-class:: classref-themeproperty
  861. :ref:`Texture2D<class_Texture2D>` **checked_disabled**
  862. :ref:`Texture2D<class_Texture2D>` icon for the checked checkbox items when they are disabled.
  863. .. rst-class:: classref-item-separator
  864. ----
  865. .. _class_PopupMenu_theme_icon_radio_checked:
  866. .. rst-class:: classref-themeproperty
  867. :ref:`Texture2D<class_Texture2D>` **radio_checked**
  868. :ref:`Texture2D<class_Texture2D>` icon for the checked radio button items.
  869. .. rst-class:: classref-item-separator
  870. ----
  871. .. _class_PopupMenu_theme_icon_radio_checked_disabled:
  872. .. rst-class:: classref-themeproperty
  873. :ref:`Texture2D<class_Texture2D>` **radio_checked_disabled**
  874. :ref:`Texture2D<class_Texture2D>` icon for the checked radio button items when they are disabled.
  875. .. rst-class:: classref-item-separator
  876. ----
  877. .. _class_PopupMenu_theme_icon_radio_unchecked:
  878. .. rst-class:: classref-themeproperty
  879. :ref:`Texture2D<class_Texture2D>` **radio_unchecked**
  880. :ref:`Texture2D<class_Texture2D>` icon for the unchecked radio button items.
  881. .. rst-class:: classref-item-separator
  882. ----
  883. .. _class_PopupMenu_theme_icon_radio_unchecked_disabled:
  884. .. rst-class:: classref-themeproperty
  885. :ref:`Texture2D<class_Texture2D>` **radio_unchecked_disabled**
  886. :ref:`Texture2D<class_Texture2D>` icon for the unchecked radio button items when they are disabled.
  887. .. rst-class:: classref-item-separator
  888. ----
  889. .. _class_PopupMenu_theme_icon_submenu:
  890. .. rst-class:: classref-themeproperty
  891. :ref:`Texture2D<class_Texture2D>` **submenu**
  892. :ref:`Texture2D<class_Texture2D>` icon for the submenu arrow (for left-to-right layouts).
  893. .. rst-class:: classref-item-separator
  894. ----
  895. .. _class_PopupMenu_theme_icon_submenu_mirrored:
  896. .. rst-class:: classref-themeproperty
  897. :ref:`Texture2D<class_Texture2D>` **submenu_mirrored**
  898. :ref:`Texture2D<class_Texture2D>` icon for the submenu arrow (for right-to-left layouts).
  899. .. rst-class:: classref-item-separator
  900. ----
  901. .. _class_PopupMenu_theme_icon_unchecked:
  902. .. rst-class:: classref-themeproperty
  903. :ref:`Texture2D<class_Texture2D>` **unchecked**
  904. :ref:`Texture2D<class_Texture2D>` icon for the unchecked checkbox items.
  905. .. rst-class:: classref-item-separator
  906. ----
  907. .. _class_PopupMenu_theme_icon_unchecked_disabled:
  908. .. rst-class:: classref-themeproperty
  909. :ref:`Texture2D<class_Texture2D>` **unchecked_disabled**
  910. :ref:`Texture2D<class_Texture2D>` icon for the unchecked checkbox items when they are disabled.
  911. .. rst-class:: classref-item-separator
  912. ----
  913. .. _class_PopupMenu_theme_style_hover:
  914. .. rst-class:: classref-themeproperty
  915. :ref:`StyleBox<class_StyleBox>` **hover**
  916. :ref:`StyleBox<class_StyleBox>` displayed when the **PopupMenu** item is hovered.
  917. .. rst-class:: classref-item-separator
  918. ----
  919. .. _class_PopupMenu_theme_style_labeled_separator_left:
  920. .. rst-class:: classref-themeproperty
  921. :ref:`StyleBox<class_StyleBox>` **labeled_separator_left**
  922. :ref:`StyleBox<class_StyleBox>` for the left side of labeled separator. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.
  923. .. rst-class:: classref-item-separator
  924. ----
  925. .. _class_PopupMenu_theme_style_labeled_separator_right:
  926. .. rst-class:: classref-themeproperty
  927. :ref:`StyleBox<class_StyleBox>` **labeled_separator_right**
  928. :ref:`StyleBox<class_StyleBox>` for the right side of labeled separator. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.
  929. .. rst-class:: classref-item-separator
  930. ----
  931. .. _class_PopupMenu_theme_style_panel:
  932. .. rst-class:: classref-themeproperty
  933. :ref:`StyleBox<class_StyleBox>` **panel**
  934. Default :ref:`StyleBox<class_StyleBox>` of the **PopupMenu** items.
  935. .. rst-class:: classref-item-separator
  936. ----
  937. .. _class_PopupMenu_theme_style_panel_disabled:
  938. .. rst-class:: classref-themeproperty
  939. :ref:`StyleBox<class_StyleBox>` **panel_disabled**
  940. :ref:`StyleBox<class_StyleBox>` used when the **PopupMenu** item is disabled.
  941. .. rst-class:: classref-item-separator
  942. ----
  943. .. _class_PopupMenu_theme_style_separator:
  944. .. rst-class:: classref-themeproperty
  945. :ref:`StyleBox<class_StyleBox>` **separator**
  946. :ref:`StyleBox<class_StyleBox>` used for the separators. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.
  947. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  948. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  949. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  950. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  951. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  952. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  953. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`