godot-docs/classes/class_popupmenu.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PopupMenu.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_PopupMenu:

PopupMenu
=========

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

**Category:** Core

Brief Description
-----------------

PopupMenu displays a list of options.

Properties
----------

+---------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`hide_on_checkable_item_selection<class_PopupMenu_property_hide_on_checkable_item_selection>` |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`hide_on_item_selection<class_PopupMenu_property_hide_on_item_selection>`                     |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`hide_on_state_item_selection<class_PopupMenu_property_hide_on_state_item_selection>`         |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`submenu_popup_delay<class_PopupMenu_property_submenu_popup_delay>`                           |
+---------------------------+----------------------------------------------------------------------------------------------------+

Methods
-------

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

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

+---------------------------------+-------------------------+
| :ref:`Texture<class_Texture>`   | checked                 |
+---------------------------------+-------------------------+
| :ref:`Font<class_Font>`         | font                    |
+---------------------------------+-------------------------+
| :ref:`Color<class_Color>`       | font_color              |
+---------------------------------+-------------------------+
| :ref:`Color<class_Color>`       | font_color_accel        |
+---------------------------------+-------------------------+
| :ref:`Color<class_Color>`       | font_color_disabled     |
+---------------------------------+-------------------------+
| :ref:`Color<class_Color>`       | font_color_hover        |
+---------------------------------+-------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover                   |
+---------------------------------+-------------------------+
| :ref:`int<class_int>`           | hseparation             |
+---------------------------------+-------------------------+
| :ref:`StyleBox<class_StyleBox>` | labeled_separator_left  |
+---------------------------------+-------------------------+
| :ref:`StyleBox<class_StyleBox>` | labeled_separator_right |
+---------------------------------+-------------------------+
| :ref:`StyleBox<class_StyleBox>` | panel                   |
+---------------------------------+-------------------------+
| :ref:`StyleBox<class_StyleBox>` | panel_disabled          |
+---------------------------------+-------------------------+
| :ref:`Texture<class_Texture>`   | radio_checked           |
+---------------------------------+-------------------------+
| :ref:`Texture<class_Texture>`   | radio_unchecked         |
+---------------------------------+-------------------------+
| :ref:`StyleBox<class_StyleBox>` | separator               |
+---------------------------------+-------------------------+
| :ref:`Texture<class_Texture>`   | submenu                 |
+---------------------------------+-------------------------+
| :ref:`Texture<class_Texture>`   | unchecked               |
+---------------------------------+-------------------------+
| :ref:`int<class_int>`           | vseparation             |
+---------------------------------+-------------------------+

Signals
-------

.. _class_PopupMenu_signal_id_focused:

- **id_focused** **(** :ref:`int<class_int>` ID **)**

This event is emitted when user navigated to an item of some id using ``ui_up`` or ``ui_down`` action.

----

.. _class_PopupMenu_signal_id_pressed:

- **id_pressed** **(** :ref:`int<class_int>` ID **)**

This event is emitted when an item of some id is pressed or its accelerator is activated.

----

.. _class_PopupMenu_signal_index_pressed:

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

This event is emitted when an item of some index is pressed or its accelerator is activated.

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

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

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

.. _class_PopupMenu_property_hide_on_checkable_item_selection:

- :ref:`bool<class_bool>` **hide_on_checkable_item_selection**

+----------+---------------------------------------------+
| *Setter* | set_hide_on_checkable_item_selection(value) |
+----------+---------------------------------------------+
| *Getter* | is_hide_on_checkable_item_selection()       |
+----------+---------------------------------------------+

If ``true``, hides the :ref:`PopupMenu<class_PopupMenu>` when a checkbox or radio button is selected.

----

.. _class_PopupMenu_property_hide_on_item_selection:

- :ref:`bool<class_bool>` **hide_on_item_selection**

+----------+-----------------------------------+
| *Setter* | set_hide_on_item_selection(value) |
+----------+-----------------------------------+
| *Getter* | is_hide_on_item_selection()       |
+----------+-----------------------------------+

If ``true``, hides the :ref:`PopupMenu<class_PopupMenu>` when an item is selected.

----

.. _class_PopupMenu_property_hide_on_state_item_selection:

- :ref:`bool<class_bool>` **hide_on_state_item_selection**

+----------+-----------------------------------------+
| *Setter* | set_hide_on_state_item_selection(value) |
+----------+-----------------------------------------+
| *Getter* | is_hide_on_state_item_selection()       |
+----------+-----------------------------------------+

If ``true``, hides the :ref:`PopupMenu<class_PopupMenu>` when a state item is selected.

----

.. _class_PopupMenu_property_submenu_popup_delay:

- :ref:`float<class_float>` **submenu_popup_delay**

+----------+--------------------------------+
| *Setter* | set_submenu_popup_delay(value) |
+----------+--------------------------------+
| *Getter* | get_submenu_popup_delay()      |
+----------+--------------------------------+

Sets the delay time 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. Default value: ``0.3`` seconds.

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

.. _class_PopupMenu_method_add_check_item:

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

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

An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided then the default ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

**Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.

----

.. _class_PopupMenu_method_add_check_shortcut:

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

----

.. _class_PopupMenu_method_add_icon_check_item:

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

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

An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided then the default ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

**Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.

----

.. _class_PopupMenu_method_add_icon_check_shortcut:

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

Adds a new checkable item and assigns the specified :ref:`ShortCut<class_ShortCut>` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`ShortCut<class_ShortCut>`'s name.

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

**Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.

----

.. _class_PopupMenu_method_add_icon_item:

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

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

An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided then the default ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

----

.. _class_PopupMenu_method_add_icon_shortcut:

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

Adds a new item and assigns the specified :ref:`ShortCut<class_ShortCut>` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`ShortCut<class_ShortCut>`'s name.

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

----

.. _class_PopupMenu_method_add_item:

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

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

An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided then the default ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

----

.. _class_PopupMenu_method_add_radio_check_item:

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

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

An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided then the default ``0`` will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.

**Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.

----

.. _class_PopupMenu_method_add_radio_check_shortcut:

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

----

.. _class_PopupMenu_method_add_separator:

- void **add_separator** **(** :ref:`String<class_String>` label="" **)**

Add a separator between items. Separators also occupy an index.

----

.. _class_PopupMenu_method_add_shortcut:

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

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

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

----

.. _class_PopupMenu_method_add_submenu_item:

- 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 :ref:`PopupMenu<class_PopupMenu>` node when clicked. The ``submenu`` argument is the name of the child :ref:`PopupMenu<class_PopupMenu>` node that will be shown when the item is clicked.

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

----

.. _class_PopupMenu_method_clear:

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

Removes all items from the :ref:`PopupMenu<class_PopupMenu>`.

----

.. _class_PopupMenu_method_get_item_accelerator:

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

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

----

.. _class_PopupMenu_method_get_item_count:

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

Returns the number of items in the :ref:`PopupMenu<class_PopupMenu>`.

----

.. _class_PopupMenu_method_get_item_icon:

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

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

----

.. _class_PopupMenu_method_get_item_id:

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

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

----

.. _class_PopupMenu_method_get_item_index:

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

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

----

.. _class_PopupMenu_method_get_item_metadata:

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

Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`set_item_metadata<class_PopupMenu_method_set_item_metadata>`, which provides a simple way of assigning context data to items.

----

.. _class_PopupMenu_method_get_item_shortcut:

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

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

----

.. _class_PopupMenu_method_get_item_submenu:

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

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

----

.. _class_PopupMenu_method_get_item_text:

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

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

----

.. _class_PopupMenu_method_get_item_tooltip:

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

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

----

.. _class_PopupMenu_method_is_hide_on_window_lose_focus:

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

Returns whether the popup will be hidden when the window loses focus or not.

----

.. _class_PopupMenu_method_is_item_checkable:

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

Returns whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.

----

.. _class_PopupMenu_method_is_item_checked:

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

Returns whether the item at index "idx" is checked.

----

.. _class_PopupMenu_method_is_item_disabled:

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

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

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

----

.. _class_PopupMenu_method_is_item_radio_checkable:

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

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

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

----

.. _class_PopupMenu_method_is_item_separator:

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

Returns ``true`` if the item is a separator. If it is, it will be displayed as a line. See :ref:`add_separator<class_PopupMenu_method_add_separator>` for more info on how to add a separator.

----

.. _class_PopupMenu_method_is_item_shortcut_disabled:

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

Returns whether the shortcut of the specified item ``idx`` is disabled or not.

----

.. _class_PopupMenu_method_remove_item:

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

Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one.

----

.. _class_PopupMenu_method_set_hide_on_window_lose_focus:

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

Hides the :ref:`PopupMenu<class_PopupMenu>` when the window loses focus.

----

.. _class_PopupMenu_method_set_item_accelerator:

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

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

----

.. _class_PopupMenu_method_set_item_as_checkable:

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

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

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

----

.. _class_PopupMenu_method_set_item_as_radio_checkable:

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

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

----

.. _class_PopupMenu_method_set_item_as_separator:

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

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

----

.. _class_PopupMenu_method_set_item_checked:

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

Set the checkstate status of the item at index "idx".

----

.. _class_PopupMenu_method_set_item_disabled:

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

Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked.

----

.. _class_PopupMenu_method_set_item_icon:

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

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

----

.. _class_PopupMenu_method_set_item_id:

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

Set the id of the item at index "idx".

----

.. _class_PopupMenu_method_set_item_metadata:

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

Sets the metadata of an item, which might 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.

----

.. _class_PopupMenu_method_set_item_multistate:

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

----

.. _class_PopupMenu_method_set_item_shortcut:

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

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

----

.. _class_PopupMenu_method_set_item_shortcut_disabled:

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

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

----

.. _class_PopupMenu_method_set_item_submenu:

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

Sets the submenu of the item at index ``idx``. The submenu is the name of a child :ref:`PopupMenu<class_PopupMenu>` node that would be shown when the item is clicked.

----

.. _class_PopupMenu_method_set_item_text:

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

Set the text of the item at index "idx".

----

.. _class_PopupMenu_method_set_item_tooltip:

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

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

----

.. _class_PopupMenu_method_toggle_item_checked:

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

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

----

.. _class_PopupMenu_method_toggle_item_multistate:

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