godot-docs/classes/class_popupmenu.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PopupMenu.xml.

.. _class_PopupMenu:

PopupMenu
=========

**Inherits:** :ref:`Popup<class_Popup>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

PopupMenu displays a list of options.

.. rst-class:: classref-introduction-group

Description
-----------

**PopupMenu** is a :ref:`Control<class_Control>` that displays a list of options. They are popular in toolbars or context menus.

\ **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>`.

\ **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``.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`allow_search<class_PopupMenu_property_allow_search>`                                         | ``false``                                                           |
   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
   | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode                                                                                         | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`hide_on_checkable_item_selection<class_PopupMenu_property_hide_on_checkable_item_selection>` | ``true``                                                            |
   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`hide_on_item_selection<class_PopupMenu_property_hide_on_item_selection>`                     | ``true``                                                            |
   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`hide_on_state_item_selection<class_PopupMenu_property_hide_on_state_item_selection>`         | ``false``                                                           |
   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
   | :ref:`float<class_float>`                | :ref:`max_height<class_PopupMenu_property_max_height>`                                             | ``0.0``                                                             |
   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
   | :ref:`float<class_float>`                | :ref:`submenu_popup_delay<class_PopupMenu_property_submenu_popup_delay>`                           | ``0.3``                                                             |
   +------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_check_item<class_PopupMenu_method_add_check_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**                                                                                    |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_icon_check_item<class_PopupMenu_method_add_icon_check_item>` **(** :ref:`Texture<class_Texture>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**                                   |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_icon_check_shortcut<class_PopupMenu_method_add_icon_check_shortcut>` **(** :ref:`Texture<class_Texture>` texture, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**             |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_icon_item<class_PopupMenu_method_add_icon_item>` **(** :ref:`Texture<class_Texture>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**                                               |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_icon_radio_check_item<class_PopupMenu_method_add_icon_radio_check_item>` **(** :ref:`Texture<class_Texture>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**                       |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_icon_radio_check_shortcut<class_PopupMenu_method_add_icon_radio_check_shortcut>` **(** :ref:`Texture<class_Texture>` texture, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)** |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_icon_shortcut<class_PopupMenu_method_add_icon_shortcut>` **(** :ref:`Texture<class_Texture>` texture, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**                         |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_item<class_PopupMenu_method_add_item>` **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**                                                                                                |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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:`int<class_int>` accel=0 **)** |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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:`int<class_int>` accel=0 **)**                                                                        |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                  |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`add_separator<class_PopupMenu_method_add_separator>` **(** :ref:`String<class_String>` label="", :ref:`int<class_int>` id=-1 **)**                                                                                                                  |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`clear<class_PopupMenu_method_clear>` **(** **)**                                                                                                                                                                                                    |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`           | :ref:`get_current_index<class_PopupMenu_method_get_current_index>` **(** **)** |const|                                                                                                                                                                    |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`           | :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                    |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`           | :ref:`get_item_count<class_PopupMenu_method_get_item_count>` **(** **)** |const|                                                                                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`get_item_icon<class_PopupMenu_method_get_item_icon>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                  |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`           | :ref:`get_item_id<class_PopupMenu_method_get_item_id>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                      |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`           | :ref:`get_item_index<class_PopupMenu_method_get_item_index>` **(** :ref:`int<class_int>` id **)** |const|                                                                                                                                                 |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`   | :ref:`get_item_metadata<class_PopupMenu_method_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`ShortCut<class_ShortCut>` | :ref:`get_item_shortcut<class_PopupMenu_method_get_item_shortcut>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`     | :ref:`get_item_submenu<class_PopupMenu_method_get_item_submenu>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                            |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`     | :ref:`get_item_text<class_PopupMenu_method_get_item_text>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                  |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`     | :ref:`get_item_tooltip<class_PopupMenu_method_get_item_tooltip>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                            |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`         | :ref:`is_hide_on_window_lose_focus<class_PopupMenu_method_is_hide_on_window_lose_focus>` **(** **)** |const|                                                                                                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`         | :ref:`is_item_checkable<class_PopupMenu_method_is_item_checkable>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`         | :ref:`is_item_checked<class_PopupMenu_method_is_item_checked>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`         | :ref:`is_item_disabled<class_PopupMenu_method_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                            |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`         | :ref:`is_item_radio_checkable<class_PopupMenu_method_is_item_radio_checkable>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`         | :ref:`is_item_separator<class_PopupMenu_method_is_item_separator>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`         | :ref:`is_item_shortcut_disabled<class_PopupMenu_method_is_item_shortcut_disabled>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`remove_item<class_PopupMenu_method_remove_item>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_current_index<class_PopupMenu_method_set_current_index>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_hide_on_window_lose_focus<class_PopupMenu_method_set_hide_on_window_lose_focus>` **(** :ref:`bool<class_bool>` enable **)**                                                                                                                     |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_accelerator<class_PopupMenu_method_set_item_accelerator>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` accel **)**                                                                                                               |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_as_checkable<class_PopupMenu_method_set_item_as_checkable>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_as_radio_checkable<class_PopupMenu_method_set_item_as_radio_checkable>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**                                                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_as_separator<class_PopupMenu_method_set_item_as_separator>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checked **)**                                                                                                                   |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_disabled<class_PopupMenu_method_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**                                                                                                                |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_icon<class_PopupMenu_method_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` icon **)**                                                                                                                      |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_id<class_PopupMenu_method_set_item_id>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)**                                                                                                                                    |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_metadata<class_PopupMenu_method_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**                                                                                                          |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_multistate<class_PopupMenu_method_set_item_multistate>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` state **)**                                                                                                                 |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_shortcut<class_PopupMenu_method_set_item_shortcut>` **(** :ref:`int<class_int>` idx, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`bool<class_bool>` global=false **)**                                                                  |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_shortcut_disabled<class_PopupMenu_method_set_item_shortcut_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**                                                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_submenu<class_PopupMenu_method_set_item_submenu>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` submenu **)**                                                                                                               |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_text<class_PopupMenu_method_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**                                                                                                                        |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`set_item_tooltip<class_PopupMenu_method_set_item_tooltip>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**                                                                                                               |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`toggle_item_checked<class_PopupMenu_method_toggle_item_checked>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                              |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                            | :ref:`toggle_item_multistate<class_PopupMenu_method_toggle_item_multistate>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                        |
   +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Theme Properties
----------------

.. table::
   :widths: auto

   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color<class_PopupMenu_theme_color_font_color>`                           | ``Color( 0.88, 0.88, 0.88, 1 )`` |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_accel<class_PopupMenu_theme_color_font_color_accel>`               | ``Color( 0.7, 0.7, 0.7, 0.8 )``  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_disabled<class_PopupMenu_theme_color_font_color_disabled>`         | ``Color( 0.4, 0.4, 0.4, 0.8 )``  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_hover<class_PopupMenu_theme_color_font_color_hover>`               | ``Color( 0.88, 0.88, 0.88, 1 )`` |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_separator<class_PopupMenu_theme_color_font_color_separator>`       | ``Color( 0.88, 0.88, 0.88, 1 )`` |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`int<class_int>`           | :ref:`hseparation<class_PopupMenu_theme_constant_hseparation>`                      | ``4``                            |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`int<class_int>`           | :ref:`vseparation<class_PopupMenu_theme_constant_vseparation>`                      | ``4``                            |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Font<class_Font>`         | :ref:`font<class_PopupMenu_theme_font_font>`                                        |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Font<class_Font>`         | :ref:`font_separator<class_PopupMenu_theme_font_font_separator>`                    |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`checked<class_PopupMenu_theme_icon_checked>`                                  |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`radio_checked<class_PopupMenu_theme_icon_radio_checked>`                      |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`radio_unchecked<class_PopupMenu_theme_icon_radio_unchecked>`                  |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`submenu<class_PopupMenu_theme_icon_submenu>`                                  |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`unchecked<class_PopupMenu_theme_icon_unchecked>`                              |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_PopupMenu_theme_style_hover>`                                     |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`labeled_separator_left<class_PopupMenu_theme_style_labeled_separator_left>`   |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`labeled_separator_right<class_PopupMenu_theme_style_labeled_separator_right>` |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`panel<class_PopupMenu_theme_style_panel>`                                     |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`panel_disabled<class_PopupMenu_theme_style_panel_disabled>`                   |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`separator<class_PopupMenu_theme_style_separator>`                             |                                  |
   +---------------------------------+-------------------------------------------------------------------------------------+----------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_PopupMenu_signal_id_focused:

.. rst-class:: classref-signal

**id_focused** **(** :ref:`int<class_int>` id **)**

Emitted when user navigated to an item of some ``id`` using ``ui_up`` or ``ui_down`` action.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_signal_id_pressed:

.. rst-class:: classref-signal

**id_pressed** **(** :ref:`int<class_int>` id **)**

Emitted when an item of some ``id`` is pressed or its accelerator is activated.

\ **Note:** If ``id`` is negative (either explicitly or due to overflow), this will return the corresponding index instead.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_signal_index_pressed:

.. rst-class:: classref-signal

**index_pressed** **(** :ref:`int<class_int>` index **)**

Emitted when an item of some ``index`` is pressed or its accelerator is activated.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_PopupMenu_property_allow_search:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **allow_search** = ``false``

.. rst-class:: classref-property-setget

- void **set_allow_search** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_allow_search** **(** **)**

If ``true``, allows navigating **PopupMenu** with letter keys.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_property_hide_on_checkable_item_selection:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **hide_on_checkable_item_selection** = ``true``

.. rst-class:: classref-property-setget

- void **set_hide_on_checkable_item_selection** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_hide_on_checkable_item_selection** **(** **)**

If ``true``, hides the **PopupMenu** when a checkbox or radio button is selected.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_property_hide_on_item_selection:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **hide_on_item_selection** = ``true``

.. rst-class:: classref-property-setget

- void **set_hide_on_item_selection** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_hide_on_item_selection** **(** **)**

If ``true``, hides the **PopupMenu** when an item is selected.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_property_hide_on_state_item_selection:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **hide_on_state_item_selection** = ``false``

.. rst-class:: classref-property-setget

- void **set_hide_on_state_item_selection** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_hide_on_state_item_selection** **(** **)**

If ``true``, hides the **PopupMenu** when a state item is selected.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_property_max_height:

.. rst-class:: classref-property

:ref:`float<class_float>` **max_height** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_max_height** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_max_height** **(** **)**

If non-zero, the ``PopupMenu`` will be resized vertically to that maximum value, showing a scrollbar if the content doesn't fit.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_property_submenu_popup_delay:

.. rst-class:: classref-property

:ref:`float<class_float>` **submenu_popup_delay** = ``0.3``

.. rst-class:: classref-property-setget

- void **set_submenu_popup_delay** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_submenu_popup_delay** **(** **)**

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.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_PopupMenu_method_add_check_item:

.. rst-class:: classref-method

void **add_check_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**

Adds a new checkable item with text ``label``.

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 ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

\ **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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_check_shortcut:

.. rst-class:: classref-method

void **add_check_shortcut** **(** :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**

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.

An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.

\ **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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_icon_check_item:

.. rst-class:: classref-method

void **add_icon_check_item** **(** :ref:`Texture<class_Texture>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**

Adds a new checkable item with text ``label`` and icon ``texture``.

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 ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

\ **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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_icon_check_shortcut:

.. rst-class:: classref-method

void **add_icon_check_shortcut** **(** :ref:`Texture<class_Texture>` texture, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**

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.

An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.

\ **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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_icon_item:

.. rst-class:: classref-method

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

Adds a new item with text ``label`` and icon ``texture``.

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 ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_icon_radio_check_item:

.. rst-class:: classref-method

void **add_icon_radio_check_item** **(** :ref:`Texture<class_Texture>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**

Same as :ref:`add_icon_check_item<class_PopupMenu_method_add_icon_check_item>`, but uses a radio check button.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_icon_radio_check_shortcut:

.. rst-class:: classref-method

void **add_icon_radio_check_shortcut** **(** :ref:`Texture<class_Texture>` texture, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**

Same as :ref:`add_icon_check_shortcut<class_PopupMenu_method_add_icon_check_shortcut>`, but uses a radio check button.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_icon_shortcut:

.. rst-class:: classref-method

void **add_icon_shortcut** **(** :ref:`Texture<class_Texture>` texture, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**

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.

An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_item:

.. rst-class:: classref-method

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

Adds a new item with text ``label``.

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 ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_multistate_item:

.. rst-class:: classref-method

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:`int<class_int>` accel=0 **)**

Adds a new multistate item with text ``label``.

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``.

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 ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_radio_check_item:

.. rst-class:: classref-method

void **add_radio_check_item** **(** :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`int<class_int>` accel=0 **)**

Adds a new radio check button with text ``label``.

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 ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

\ **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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_radio_check_shortcut:

.. rst-class:: classref-method

void **add_radio_check_shortcut** **(** :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**

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.

An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.

\ **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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_separator:

.. rst-class:: classref-method

void **add_separator** **(** :ref:`String<class_String>` label="", :ref:`int<class_int>` id=-1 **)**

Adds a separator between items. Separators also occupy an index, which you can set by using the ``id`` parameter.

A ``label`` can optionally be provided, which will appear at the center of the separator.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_shortcut:

.. rst-class:: classref-method

void **add_shortcut** **(** :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`int<class_int>` id=-1, :ref:`bool<class_bool>` global=false **)**

Adds a :ref:`ShortCut<class_ShortCut>`.

An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_add_submenu_item:

.. rst-class:: classref-method

void **add_submenu_item** **(** :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` id=-1 **)**

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.

An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_clear:

.. rst-class:: classref-method

void **clear** **(** **)**

Removes all items from the **PopupMenu**.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_current_index:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_current_index** **(** **)** |const|

Returns the index of the currently focused item. Returns ``-1`` if no item is focused.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_accelerator:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_item_accelerator** **(** :ref:`int<class_int>` idx **)** |const|

Returns the accelerator of the item at index ``idx``. Accelerators are special combinations of keys that activate the item, no matter which control is focused.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_item_count** **(** **)** |const|

Returns the number of items in the **PopupMenu**.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_icon:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_item_id** **(** :ref:`int<class_int>` idx **)** |const|

Returns the id of the item at index ``idx``. ``id`` can be manually assigned, while index can not.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_index:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_item_index** **(** :ref:`int<class_int>` id **)** |const|

Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine. Index can not be set manually.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_metadata:

.. rst-class:: classref-method

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

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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_shortcut:

.. rst-class:: classref-method

:ref:`ShortCut<class_ShortCut>` **get_item_shortcut** **(** :ref:`int<class_int>` idx **)** |const|

Returns the :ref:`ShortCut<class_ShortCut>` associated with the specified ``idx`` item.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_submenu:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_item_submenu** **(** :ref:`int<class_int>` idx **)** |const|

Returns the submenu name of the item at index ``idx``. See :ref:`add_submenu_item<class_PopupMenu_method_add_submenu_item>` for more info on how to add a submenu.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_text:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_get_item_tooltip:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_item_tooltip** **(** :ref:`int<class_int>` idx **)** |const|

Returns the tooltip associated with the specified index ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_is_hide_on_window_lose_focus:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_hide_on_window_lose_focus** **(** **)** |const|

Returns ``true`` if the popup will be hidden when the window loses focus or not.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_is_item_checkable:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_item_checkable** **(** :ref:`int<class_int>` idx **)** |const|

Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.

\ **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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_is_item_checked:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_item_checked** **(** :ref:`int<class_int>` idx **)** |const|

Returns ``true`` if the item at index ``idx`` is checked.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_is_item_disabled:

.. rst-class:: classref-method

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

Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.

See :ref:`set_item_disabled<class_PopupMenu_method_set_item_disabled>` for more info on how to disable an item.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_is_item_radio_checkable:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_item_radio_checkable** **(** :ref:`int<class_int>` idx **)** |const|

Returns ``true`` if the item at index ``idx`` has radio button-style checkability.

\ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_is_item_separator:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_item_separator** **(** :ref:`int<class_int>` idx **)** |const|

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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_is_item_shortcut_disabled:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_item_shortcut_disabled** **(** :ref:`int<class_int>` idx **)** |const|

Returns ``true`` if the specified item's shortcut is disabled.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_remove_item:

.. rst-class:: classref-method

void **remove_item** **(** :ref:`int<class_int>` idx **)**

Removes the item at index ``idx`` from the menu.

\ **Note:** The indices of items after the removed item will be shifted by one.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_current_index:

.. rst-class:: classref-method

void **set_current_index** **(** :ref:`int<class_int>` index **)**

Sets the currently focused item as the given ``index``.

Passing ``-1`` as the index makes so that no item is focused.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_hide_on_window_lose_focus:

.. rst-class:: classref-method

void **set_hide_on_window_lose_focus** **(** :ref:`bool<class_bool>` enable **)**

Hides the **PopupMenu** when the window loses focus.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_accelerator:

.. rst-class:: classref-method

void **set_item_accelerator** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` accel **)**

Sets the accelerator of the item at index ``idx``. Accelerators are special combinations of keys that activate the item, no matter which control is focused.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_as_checkable:

.. rst-class:: classref-method

void **set_item_as_checkable** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**

Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.

\ **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_as_radio_checkable:

.. rst-class:: classref-method

void **set_item_as_radio_checkable** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**

Sets the type of the item at the specified index ``idx`` to radio button. If ``false``, sets the type of the item to plain text.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_as_separator:

.. rst-class:: classref-method

void **set_item_as_separator** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**

Mark the item at index ``idx`` as a separator, which means that it would be displayed as a line. If ``false``, sets the type of the item to plain text.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_checked:

.. rst-class:: classref-method

void **set_item_checked** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checked **)**

Sets the checkstate status of the item at index ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_disabled:

.. rst-class:: classref-method

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

Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_icon:

.. rst-class:: classref-method

void **set_item_icon** **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` icon **)**

Replaces the :ref:`Texture<class_Texture>` icon of the specified ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_id:

.. rst-class:: classref-method

void **set_item_id** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)**

Sets the ``id`` of the item at index ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_metadata:

.. rst-class:: classref-method

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

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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_multistate:

.. rst-class:: classref-method

void **set_item_multistate** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` state **)**

Sets the state of a multistate item. See :ref:`add_multistate_item<class_PopupMenu_method_add_multistate_item>` for details.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_shortcut:

.. rst-class:: classref-method

void **set_item_shortcut** **(** :ref:`int<class_int>` idx, :ref:`ShortCut<class_ShortCut>` shortcut, :ref:`bool<class_bool>` global=false **)**

Sets a :ref:`ShortCut<class_ShortCut>` for the specified item ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_shortcut_disabled:

.. rst-class:: classref-method

void **set_item_shortcut_disabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**

Disables the :ref:`ShortCut<class_ShortCut>` of the specified index ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_submenu:

.. rst-class:: classref-method

void **set_item_submenu** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` submenu **)**

Sets the submenu of the item at index ``idx``. The submenu is the name of a child **PopupMenu** node that would be shown when the item is clicked.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_text:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_set_item_tooltip:

.. rst-class:: classref-method

void **set_item_tooltip** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**

Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_toggle_item_checked:

.. rst-class:: classref-method

void **toggle_item_checked** **(** :ref:`int<class_int>` idx **)**

Toggles the check state of the item of the specified index ``idx``.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_method_toggle_item_multistate:

.. rst-class:: classref-method

void **toggle_item_multistate** **(** :ref:`int<class_int>` idx **)**

Cycle to the next state of a multistate item. See :ref:`add_multistate_item<class_PopupMenu_method_add_multistate_item>` for details.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Theme Property Descriptions
---------------------------

.. _class_PopupMenu_theme_color_font_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )``

The default text :ref:`Color<class_Color>` for menu items' names.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_color_font_color_accel:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_accel** = ``Color( 0.7, 0.7, 0.7, 0.8 )``

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.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_color_font_color_disabled:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_disabled** = ``Color( 0.4, 0.4, 0.4, 0.8 )``

:ref:`Color<class_Color>` used for disabled menu items' text.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_color_font_color_hover:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_hover** = ``Color( 0.88, 0.88, 0.88, 1 )``

:ref:`Color<class_Color>` used for the hovered text.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_color_font_color_separator:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_separator** = ``Color( 0.88, 0.88, 0.88, 1 )``

:ref:`Color<class_Color>` used for labeled separators' text. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_constant_hseparation:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **hseparation** = ``4``

The horizontal space between the item's name and the shortcut text/submenu arrow.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_constant_vseparation:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **vseparation** = ``4``

The vertical space between each menu item.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_font_font:

.. rst-class:: classref-themeproperty

:ref:`Font<class_Font>` **font**

:ref:`Font<class_Font>` used for the menu items.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_font_font_separator:

.. rst-class:: classref-themeproperty

:ref:`Font<class_Font>` **font_separator**

:ref:`Font<class_Font>` used for the labeled separator.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_icon_checked:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **checked**

:ref:`Texture<class_Texture>` icon for the checked checkbox items.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_icon_radio_checked:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **radio_checked**

:ref:`Texture<class_Texture>` icon for the checked radio button items.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_icon_radio_unchecked:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **radio_unchecked**

:ref:`Texture<class_Texture>` icon for the unchecked radio button items.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_icon_submenu:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **submenu**

:ref:`Texture<class_Texture>` icon for the submenu arrow.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_icon_unchecked:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **unchecked**

:ref:`Texture<class_Texture>` icon for the unchecked checkbox items.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_style_hover:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **hover**

:ref:`StyleBox<class_StyleBox>` displayed when the **PopupMenu** item is hovered.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_style_labeled_separator_left:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **labeled_separator_left**

:ref:`StyleBox<class_StyleBox>` for the left side of labeled separator. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_style_labeled_separator_right:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **labeled_separator_right**

:ref:`StyleBox<class_StyleBox>` for the right side of labeled separator. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_style_panel:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **panel**

Default :ref:`StyleBox<class_StyleBox>` of the **PopupMenu** items.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_style_panel_disabled:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **panel_disabled**

:ref:`StyleBox<class_StyleBox>` used when the **PopupMenu** item is disabled.

.. rst-class:: classref-item-separator

----

.. _class_PopupMenu_theme_style_separator:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **separator**

:ref:`StyleBox<class_StyleBox>` used for the separators. See :ref:`add_separator<class_PopupMenu_method_add_separator>`.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`