| github_url: | hide |
|---|
Inherits: :ref:`Popup<class_Popup>` < :ref:`Control<class_Control>` < :ref:`CanvasItem<class_CanvasItem>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`
PopupMenu displays a list of options.
PopupMenu is a :ref:`Control<class_Control>` that displays a list of options. They are popular in toolbars or context menus.
| :ref:`Texture2D<class_Texture2D>` | checked | |
| :ref:`Font<class_Font>` | font | |
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
| :ref:`Color<class_Color>` | font_color_accel | Color( 0.7, 0.7, 0.7, 0.8 ) |
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.4, 0.4, 0.4, 0.8 ) |
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.88, 0.88, 0.88, 1 ) |
| :ref:`StyleBox<class_StyleBox>` | hover | |
| :ref:`int<class_int>` | hseparation | 4 |
| :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:`Texture2D<class_Texture2D>` | radio_checked | |
| :ref:`Texture2D<class_Texture2D>` | radio_unchecked | |
| :ref:`StyleBox<class_StyleBox>` | separator | |
| :ref:`Texture2D<class_Texture2D>` | submenu | |
| :ref:`Texture2D<class_Texture2D>` | unchecked | |
| :ref:`int<class_int>` | vseparation | 4 |
Emitted when user navigated to an item of some id using ui_up or ui_down action.
Emitted when an item of some id is pressed or its accelerator is activated.
Emitted when an item of some index is pressed or its accelerator is activated.
| Default | false |
| Setter | set_allow_search(value) |
| Getter | get_allow_search() |
If true, allows to navigate PopupMenu with letter keys.
| Default | true |
| Setter | set_hide_on_checkable_item_selection(value) |
| Getter | is_hide_on_checkable_item_selection() |
If true, hides the PopupMenu when a checkbox or radio button is selected.
| Default | true |
| Setter | set_hide_on_item_selection(value) |
| Getter | is_hide_on_item_selection() |
If true, hides the PopupMenu when an item is selected.
| Default | false |
| Setter | set_hide_on_state_item_selection(value) |
| Getter | is_hide_on_state_item_selection() |
If true, hides the PopupMenu when a state item is selected.
| Default | 0.3 |
| Setter | set_submenu_popup_delay(value) |
| Getter | 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.
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.
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.
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.
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.
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.
Same as :ref:`add_icon_check_item<class_PopupMenu_method_add_icon_check_item>`, but uses a radio check button.
Same as :ref:`add_icon_check_shortcut<class_PopupMenu_method_add_icon_check_shortcut>`, but uses a radio check button.
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.
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.
Adds a new multistate item with text label.
Contrarily to normal binary items, multistate items can have more than two states, as defined by max_states. Each press or activate of the item will increase the state by one. The default value is defined by default_state.
An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided then the default 0 will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
Adds a new radio check button with text label.
An id can optionally be provided, as well as an accelerator (accel). If no id is provided, one will be created from the index. If no accel is provided then the default 0 will be assigned to it. See :ref:`get_item_accelerator<class_PopupMenu_method_get_item_accelerator>` for more info on accelerators.
Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked<class_PopupMenu_method_set_item_checked>` for more info on how to control it.
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.
Adds a separator between items. Separators also occupy an index.
Adds a :ref:`ShortCut<class_ShortCut>`.
An id can optionally be provided. If no id is provided, one will be created from the index.
Adds an item that will act as a submenu of the parent PopupMenu node when clicked. The submenu argument is the name of the child PopupMenu node that will be shown when the item is clicked.
An id can optionally be provided. If no id is provided, one will be created from the index.
Removes all items from the PopupMenu.
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.
Returns the number of items in the PopupMenu.
Returns the icon of the item at index idx.
Returns the id of the item at index idx. id can be manually assigned, while index can not.
Returns the index of the item containing the specified id. Index is automatically assigned to each item by the engine. Index can not be set manually.
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.
Returns the :ref:`ShortCut<class_ShortCut>` associated with the specified idx item.
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.
Returns the text of the item at index idx.
Returns the tooltip associated with the specified index index idx.
Returns true if the popup will be hidden when the window loses focus or not.
Returns true if the item at index idx is checkable in some way, i.e. if it has a checkbox or radio button.
Note: Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.
Returns true if the item at index idx is checked.
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.
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.
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.
Returns true if the specified item's shortcut is disabled.
Removes the item at index idx from the menu.
Note: The indices of items after the removed item will be shifted by one.
Hides the PopupMenu when the window loses focus.
Sets the accelerator of the item at index idx. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
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.
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.
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.
Sets the checkstate status of the item at index idx.
Enables/disables the item at index idx. When it is disabled, it can't be selected and its action can't be invoked.
Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified idx.
Sets the id of the item at index idx.
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.
Sets the state of an multistate item. See :ref:`add_multistate_item<class_PopupMenu_method_add_multistate_item>` for details.
Sets a :ref:`ShortCut<class_ShortCut>` for the specified item idx.
Disables the :ref:`ShortCut<class_ShortCut>` of the specified index idx.
Sets the submenu of the item at index idx. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.
Sets the text of the item at index idx.
Sets the :ref:`String<class_String>` tooltip of the item at the specified index idx.
Toggles the check state of the item of the specified index idx.
Cycle to the next state of an multistate item. See :ref:`add_multistate_item<class_PopupMenu_method_add_multistate_item>` for details.