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/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PopupMenu.xml.

.. _class_PopupMenu:

PopupMenu
=========

**Inherits:** :ref:`Popup<class_Popup>` **<** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

A modal window used to display a list of options.

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

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

**PopupMenu** is a modal window used to display a list of options. Useful for toolbars and context menus.

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.

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.

\ **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>`                                         | ``true``  |
   +---------------------------+----------------------------------------------------------------------------------------------------+-----------+
   | :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:`int<class_int>`     | :ref:`item_count<class_PopupMenu_property_item_count>`                                             | ``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

   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                          | :ref:`activate_item_by_event<class_PopupMenu_method_activate_item_by_event>` **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`bool<class_bool>` for_global_only=false **)**                                                                                               |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` accel=0 **)**                                         |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                               |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                     |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                             |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                   |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)** |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                                                          |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**           |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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, :ref:`bool<class_bool>` allow_echo=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:`bool<class_bool>` free_submenus=false **)**                                                                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                            | :ref:`get_focused_item<class_PopupMenu_method_get_focused_item>` **(** **)** |const|                                                                                                                                                                                            |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Key<enum_@GlobalScope_Key>`                | :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                        |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Texture2D<class_Texture2D>`                | :ref:`get_item_icon<class_PopupMenu_method_get_item_icon>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                      |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                            | :ref:`get_item_icon_max_width<class_PopupMenu_method_get_item_icon_max_width>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                        | :ref:`get_item_icon_modulate<class_PopupMenu_method_get_item_icon_modulate>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                    |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                            | :ref:`get_item_id<class_PopupMenu_method_get_item_id>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                          |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                            | :ref:`get_item_indent<class_PopupMenu_method_get_item_indent>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                            | :ref:`get_item_index<class_PopupMenu_method_get_item_index>` **(** :ref:`int<class_int>` id **)** |const|                                                                                                                                                                       |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                      | :ref:`get_item_language<class_PopupMenu_method_get_item_language>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                    | :ref:`get_item_metadata<class_PopupMenu_method_get_item_metadata>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Shortcut<class_Shortcut>`                  | :ref:`get_item_shortcut<class_PopupMenu_method_get_item_shortcut>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                      | :ref:`get_item_submenu<class_PopupMenu_method_get_item_submenu>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                      | :ref:`get_item_text<class_PopupMenu_method_get_item_text>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                      |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`get_item_text_direction<class_PopupMenu_method_get_item_text_direction>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                      | :ref:`get_item_tooltip<class_PopupMenu_method_get_item_tooltip>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                          | :ref:`is_item_checkable<class_PopupMenu_method_is_item_checkable>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                          | :ref:`is_item_checked<class_PopupMenu_method_is_item_checked>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                          | :ref:`is_item_disabled<class_PopupMenu_method_is_item_disabled>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                          | :ref:`is_item_radio_checkable<class_PopupMenu_method_is_item_radio_checkable>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                          | :ref:`is_item_separator<class_PopupMenu_method_is_item_separator>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                          | :ref:`is_item_shortcut_disabled<class_PopupMenu_method_is_item_shortcut_disabled>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`remove_item<class_PopupMenu_method_remove_item>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`scroll_to_item<class_PopupMenu_method_scroll_to_item>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                                            |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_focused_item<class_PopupMenu_method_set_focused_item>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                                        |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_accelerator<class_PopupMenu_method_set_item_accelerator>` **(** :ref:`int<class_int>` index, :ref:`Key<enum_@GlobalScope_Key>` accel **)**                                                                                                                       |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_as_checkable<class_PopupMenu_method_set_item_as_checkable>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)**                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_as_separator<class_PopupMenu_method_set_item_as_separator>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` enable **)**                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` checked **)**                                                                                                                                       |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_disabled<class_PopupMenu_method_set_item_disabled>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` disabled **)**                                                                                                                                    |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_icon<class_PopupMenu_method_set_item_icon>` **(** :ref:`int<class_int>` index, :ref:`Texture2D<class_Texture2D>` icon **)**                                                                                                                                      |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                                                                             |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_icon_modulate<class_PopupMenu_method_set_item_icon_modulate>` **(** :ref:`int<class_int>` index, :ref:`Color<class_Color>` modulate **)**                                                                                                                        |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_id<class_PopupMenu_method_set_item_id>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` id **)**                                                                                                                                                        |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_indent<class_PopupMenu_method_set_item_indent>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` indent **)**                                                                                                                                            |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_language<class_PopupMenu_method_set_item_language>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` language **)**                                                                                                                                |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_metadata<class_PopupMenu_method_set_item_metadata>` **(** :ref:`int<class_int>` index, :ref:`Variant<class_Variant>` metadata **)**                                                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_multistate<class_PopupMenu_method_set_item_multistate>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` state **)**                                                                                                                                     |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)**                                                                                      |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_shortcut_disabled<class_PopupMenu_method_set_item_shortcut_disabled>` **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` disabled **)**                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_submenu<class_PopupMenu_method_set_item_submenu>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` submenu **)**                                                                                                                                   |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_text<class_PopupMenu_method_set_item_text>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` text **)**                                                                                                                                            |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_text_direction<class_PopupMenu_method_set_item_text_direction>` **(** :ref:`int<class_int>` index, :ref:`TextDirection<enum_Control_TextDirection>` direction **)**                                                                                              |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`set_item_tooltip<class_PopupMenu_method_set_item_tooltip>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` tooltip **)**                                                                                                                                   |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`toggle_item_checked<class_PopupMenu_method_toggle_item_checked>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                                  |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                             | :ref:`toggle_item_multistate<class_PopupMenu_method_toggle_item_multistate>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                            |
   +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

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

.. table::
   :widths: auto

   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`font_accelerator_color<class_PopupMenu_theme_color_font_accelerator_color>`             | ``Color(0.7, 0.7, 0.7, 0.8)``     |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`font_color<class_PopupMenu_theme_color_font_color>`                                     | ``Color(0.875, 0.875, 0.875, 1)`` |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`font_disabled_color<class_PopupMenu_theme_color_font_disabled_color>`                   | ``Color(0.4, 0.4, 0.4, 0.8)``     |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`font_hover_color<class_PopupMenu_theme_color_font_hover_color>`                         | ``Color(0.875, 0.875, 0.875, 1)`` |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`font_outline_color<class_PopupMenu_theme_color_font_outline_color>`                     | ``Color(1, 1, 1, 1)``             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`font_separator_color<class_PopupMenu_theme_color_font_separator_color>`                 | ``Color(0.875, 0.875, 0.875, 1)`` |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`font_separator_outline_color<class_PopupMenu_theme_color_font_separator_outline_color>` | ``Color(1, 1, 1, 1)``             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`h_separation<class_PopupMenu_theme_constant_h_separation>`                              | ``4``                             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`icon_max_width<class_PopupMenu_theme_constant_icon_max_width>`                          | ``0``                             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`indent<class_PopupMenu_theme_constant_indent>`                                          | ``10``                            |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`item_end_padding<class_PopupMenu_theme_constant_item_end_padding>`                      | ``2``                             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`item_start_padding<class_PopupMenu_theme_constant_item_start_padding>`                  | ``2``                             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`outline_size<class_PopupMenu_theme_constant_outline_size>`                              | ``0``                             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`separator_outline_size<class_PopupMenu_theme_constant_separator_outline_size>`          | ``0``                             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`v_separation<class_PopupMenu_theme_constant_v_separation>`                              | ``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:`int<class_int>`             | :ref:`font_separator_size<class_PopupMenu_theme_font_size_font_separator_size>`               |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`font_size<class_PopupMenu_theme_font_size_font_size>`                                   |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`checked<class_PopupMenu_theme_icon_checked>`                                            |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`checked_disabled<class_PopupMenu_theme_icon_checked_disabled>`                          |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_checked<class_PopupMenu_theme_icon_radio_checked>`                                |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_checked_disabled<class_PopupMenu_theme_icon_radio_checked_disabled>`              |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_unchecked<class_PopupMenu_theme_icon_radio_unchecked>`                            |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`radio_unchecked_disabled<class_PopupMenu_theme_icon_radio_unchecked_disabled>`          |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`submenu<class_PopupMenu_theme_icon_submenu>`                                            |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`submenu_mirrored<class_PopupMenu_theme_icon_submenu_mirrored>`                          |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked<class_PopupMenu_theme_icon_unchecked>`                                        |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_disabled<class_PopupMenu_theme_icon_unchecked_disabled>`                      |                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+
   | :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:`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 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.

.. 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-item-separator

----

.. _class_PopupMenu_signal_menu_changed:

.. rst-class:: classref-signal

**menu_changed** **(** **)**

Emitted when any item is added, modified or removed.

.. 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** = ``true``

.. 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_item_count:

.. rst-class:: classref-property

:ref:`int<class_int>` **item_count** = ``0``

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

- void **set_item_count** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_item_count** **(** **)**

The number of items currently in the list.

.. 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_activate_item_by_event:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **activate_item_by_event** **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`bool<class_bool>` for_global_only=false **)**

Checks the provided ``event`` against the **PopupMenu**'s shortcuts and accelerators, and activates the first item with matching events. If ``for_global_only`` is ``true``, only shortcuts and accelerators with ``global`` set to ``true`` will be called.

Returns ``true`` if an item was successfully activated.

\ **Note:** Certain :ref:`Control<class_Control>`\ s, such as :ref:`MenuButton<class_MenuButton>`, will call this method automatically.

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

----

.. _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:`Key<enum_@GlobalScope_Key>` 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 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.

\ **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:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` 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 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.

\ **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:`Texture2D<class_Texture2D>` 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:`Texture2D<class_Texture2D>` texture, :ref:`String<class_String>` label, :ref:`int<class_int>` id=-1, :ref:`Key<enum_@GlobalScope_Key>` 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 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.

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

----

.. _class_PopupMenu_method_add_icon_radio_check_item:

.. rst-class:: classref-method

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 **)**

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:`Texture2D<class_Texture2D>` 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:`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 **)**

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.

If ``allow_echo`` is ``true``, the shortcut can be activated with echo events.

.. 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:`Key<enum_@GlobalScope_Key>` 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 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.

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

.. 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:`Key<enum_@GlobalScope_Key>` 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 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.

.. 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:`Key<enum_@GlobalScope_Key>` 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 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.

\ **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, :ref:`bool<class_bool>` allow_echo=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.

If ``allow_echo`` is ``true``, the shortcut can be activated with echo events.

.. 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 must be the name of an existing **PopupMenu** that has been added as a child to this node. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ``ui_select`` or ``ui_right`` input actions.

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** **(** :ref:`bool<class_bool>` free_submenus=false **)**

Removes all items from the **PopupMenu**. If ``free_submenus`` is ``true``, the submenu nodes are automatically freed.

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

----

.. _class_PopupMenu_method_get_focused_item:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_focused_item** **(** **)** |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:`Key<enum_@GlobalScope_Key>` **get_item_accelerator** **(** :ref:`int<class_int>` index **)** |const|

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

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

----

.. _class_PopupMenu_method_get_item_icon:

.. rst-class:: classref-method

:ref:`Texture2D<class_Texture2D>` **get_item_icon** **(** :ref:`int<class_int>` index **)** |const|

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

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

----

.. _class_PopupMenu_method_get_item_icon_max_width:

.. rst-class:: classref-method

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

Returns the maximum allowed width of the icon for the item at the given ``index``.

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

----

.. _class_PopupMenu_method_get_item_icon_modulate:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_item_icon_modulate** **(** :ref:`int<class_int>` index **)** |const|

Returns a :ref:`Color<class_Color>` modulating the item's icon at the given ``index``.

.. 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>` index **)** |const|

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

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

----

.. _class_PopupMenu_method_get_item_indent:

.. rst-class:: classref-method

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

Returns the horizontal offset of the item at the given ``index``.

.. 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 and can not be set manually.

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

----

.. _class_PopupMenu_method_get_item_language:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_item_language** **(** :ref:`int<class_int>` index **)** |const|

Returns item's text language code.

.. 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>` index **)** |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>` index **)** |const|

Returns the :ref:`Shortcut<class_Shortcut>` associated with the item at the given ``index``.

.. 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>` index **)** |const|

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.

.. 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>` index **)** |const|

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

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

----

.. _class_PopupMenu_method_get_item_text_direction:

.. rst-class:: classref-method

:ref:`TextDirection<enum_Control_TextDirection>` **get_item_text_direction** **(** :ref:`int<class_int>` index **)** |const|

Returns item's text base writing direction.

.. 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>` index **)** |const|

Returns the tooltip associated with the item at the given ``index``.

.. 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>` index **)** |const|

Returns ``true`` if the item at the given ``index`` 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>` index **)** |const|

Returns ``true`` if the item at the given ``index`` 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>` index **)** |const|

Returns ``true`` if the item at the given ``index`` 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>` index **)** |const|

Returns ``true`` if the item at the given ``index`` 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>` index **)** |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>` index **)** |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>` index **)**

Removes the item at the given ``index`` 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_scroll_to_item:

.. rst-class:: classref-method

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

Moves the scroll view to make the item at the given ``index`` visible.

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

----

.. _class_PopupMenu_method_set_focused_item:

.. rst-class:: classref-method

void **set_focused_item** **(** :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_item_accelerator:

.. rst-class:: classref-method

void **set_item_accelerator** **(** :ref:`int<class_int>` index, :ref:`Key<enum_@GlobalScope_Key>` accel **)**

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

.. 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>` index, :ref:`bool<class_bool>` enable **)**

Sets whether the item at the given ``index`` 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>` index, :ref:`bool<class_bool>` enable **)**

Sets the type of the item at the given ``index`` 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>` index, :ref:`bool<class_bool>` enable **)**

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.

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

----

.. _class_PopupMenu_method_set_item_checked:

.. rst-class:: classref-method

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

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

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

----

.. _class_PopupMenu_method_set_item_disabled:

.. rst-class:: classref-method

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

Enables/disables the item at the given ``index``. 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>` index, :ref:`Texture2D<class_Texture2D>` icon **)**

Replaces the :ref:`Texture2D<class_Texture2D>` icon of the item at the given ``index``.

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

----

.. _class_PopupMenu_method_set_item_icon_max_width:

.. rst-class:: classref-method

void **set_item_icon_max_width** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` width **)**

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.

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

----

.. _class_PopupMenu_method_set_item_icon_modulate:

.. rst-class:: classref-method

void **set_item_icon_modulate** **(** :ref:`int<class_int>` index, :ref:`Color<class_Color>` modulate **)**

Sets a modulating :ref:`Color<class_Color>` of the item's icon at the given ``index``.

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

----

.. _class_PopupMenu_method_set_item_id:

.. rst-class:: classref-method

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

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

The ``id`` is used in :ref:`id_pressed<class_PopupMenu_signal_id_pressed>` and :ref:`id_focused<class_PopupMenu_signal_id_focused>` signals.

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

----

.. _class_PopupMenu_method_set_item_indent:

.. rst-class:: classref-method

void **set_item_indent** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` indent **)**

Sets the horizontal offset of the item at the given ``index``.

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

----

.. _class_PopupMenu_method_set_item_language:

.. rst-class:: classref-method

void **set_item_language** **(** :ref:`int<class_int>` index, :ref:`String<class_String>` language **)**

Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

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

----

.. _class_PopupMenu_method_set_item_metadata:

.. rst-class:: classref-method

void **set_item_metadata** **(** :ref:`int<class_int>` index, :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>` index, :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>` index, :ref:`Shortcut<class_Shortcut>` shortcut, :ref:`bool<class_bool>` global=false **)**

Sets a :ref:`Shortcut<class_Shortcut>` for the item at the given ``index``.

.. 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>` index, :ref:`bool<class_bool>` disabled **)**

Disables the :ref:`Shortcut<class_Shortcut>` of the item at the given ``index``.

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

----

.. _class_PopupMenu_method_set_item_submenu:

.. rst-class:: classref-method

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

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.

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

----

.. _class_PopupMenu_method_set_item_text:

.. rst-class:: classref-method

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

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

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

----

.. _class_PopupMenu_method_set_item_text_direction:

.. rst-class:: classref-method

void **set_item_text_direction** **(** :ref:`int<class_int>` index, :ref:`TextDirection<enum_Control_TextDirection>` direction **)**

Sets item's text base writing direction.

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

----

.. _class_PopupMenu_method_set_item_tooltip:

.. rst-class:: classref-method

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

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

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

----

.. _class_PopupMenu_method_toggle_item_checked:

.. rst-class:: classref-method

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

Toggles the check state of the item at the given ``index``.

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

----

.. _class_PopupMenu_method_toggle_item_multistate:

.. rst-class:: classref-method

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

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_accelerator_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_accelerator_color** = ``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:

.. rst-class:: classref-themeproperty

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

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

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

----

.. _class_PopupMenu_theme_color_font_disabled_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_disabled_color** = ``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_hover_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_hover_color** = ``Color(0.875, 0.875, 0.875, 1)``

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

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

----

.. _class_PopupMenu_theme_color_font_outline_color:

.. rst-class:: classref-themeproperty

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

The tint of text outline of the menu item.

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

----

.. _class_PopupMenu_theme_color_font_separator_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_separator_color** = ``Color(0.875, 0.875, 0.875, 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_color_font_separator_outline_color:

.. rst-class:: classref-themeproperty

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

The tint of text outline of the labeled separator.

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

----

.. _class_PopupMenu_theme_constant_h_separation:

.. rst-class:: classref-themeproperty

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

The horizontal space between the item's elements.

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

----

.. _class_PopupMenu_theme_constant_icon_max_width:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **icon_max_width** = ``0``

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.

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

----

.. _class_PopupMenu_theme_constant_indent:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **indent** = ``10``

Width of the single indentation level.

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

----

.. _class_PopupMenu_theme_constant_item_end_padding:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **item_end_padding** = ``2``

Horizontal padding to the right of the items (or left, in RTL layout).

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

----

.. _class_PopupMenu_theme_constant_item_start_padding:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **item_start_padding** = ``2``

Horizontal padding to the left of the items (or right, in RTL layout).

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

----

.. _class_PopupMenu_theme_constant_outline_size:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **outline_size** = ``0``

The size of the item text outline.

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

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

----

.. _class_PopupMenu_theme_constant_separator_outline_size:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **separator_outline_size** = ``0``

The size of the labeled separator text outline.

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

----

.. _class_PopupMenu_theme_constant_v_separation:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **v_separation** = ``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_font_size_font_separator_size:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **font_separator_size**

Font size of the labeled separator.

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

----

.. _class_PopupMenu_theme_font_size_font_size:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **font_size**

Font size of the menu items.

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

----

.. _class_PopupMenu_theme_icon_checked:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **checked**

:ref:`Texture2D<class_Texture2D>` icon for the checked checkbox items.

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

----

.. _class_PopupMenu_theme_icon_checked_disabled:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **checked_disabled**

:ref:`Texture2D<class_Texture2D>` icon for the checked checkbox items when they are disabled.

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

----

.. _class_PopupMenu_theme_icon_radio_checked:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **radio_checked**

:ref:`Texture2D<class_Texture2D>` icon for the checked radio button items.

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

----

.. _class_PopupMenu_theme_icon_radio_checked_disabled:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **radio_checked_disabled**

:ref:`Texture2D<class_Texture2D>` icon for the checked radio button items when they are disabled.

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

----

.. _class_PopupMenu_theme_icon_radio_unchecked:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **radio_unchecked**

:ref:`Texture2D<class_Texture2D>` icon for the unchecked radio button items.

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

----

.. _class_PopupMenu_theme_icon_radio_unchecked_disabled:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **radio_unchecked_disabled**

:ref:`Texture2D<class_Texture2D>` icon for the unchecked radio button items when they are disabled.

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

----

.. _class_PopupMenu_theme_icon_submenu:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **submenu**

:ref:`Texture2D<class_Texture2D>` icon for the submenu arrow (for left-to-right layouts).

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

----

.. _class_PopupMenu_theme_icon_submenu_mirrored:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **submenu_mirrored**

:ref:`Texture2D<class_Texture2D>` icon for the submenu arrow (for right-to-left layouts).

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

----

.. _class_PopupMenu_theme_icon_unchecked:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **unchecked**

:ref:`Texture2D<class_Texture2D>` icon for the unchecked checkbox items.

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

----

.. _class_PopupMenu_theme_icon_unchecked_disabled:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **unchecked_disabled**

:ref:`Texture2D<class_Texture2D>` icon for the unchecked checkbox items when they are disabled.

.. 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_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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`