PopupMenu¶
Inherits: Popup < Control < CanvasItem < Node < Object
Category: Core
Brief Description¶
PopupMenu displays a list of options.
Properties¶
bool | hide_on_checkable_item_selection |
bool | hide_on_item_selection |
bool | hide_on_state_item_selection |
float | submenu_popup_delay |
Methods¶
Theme Properties¶
Texture | checked |
Font | font |
Color | font_color |
Color | font_color_accel |
Color | font_color_disabled |
Color | font_color_hover |
StyleBox | hover |
int | hseparation |
StyleBox | labeled_separator_left |
StyleBox | labeled_separator_right |
StyleBox | panel |
StyleBox | panel_disabled |
Texture | radio_checked |
Texture | radio_unchecked |
StyleBox | separator |
Texture | submenu |
Texture | unchecked |
int | vseparation |
Signals¶
- id_focused ( int ID )
This event is emitted when user navigated to an item of some id using ui_up
or ui_down
action.
- id_pressed ( int ID )
This event is emitted when an item of some id is pressed or its accelerator is activated.
- index_pressed ( int index )
This event is emitted when an item of some index is pressed or its accelerator is activated.
Description¶
PopupMenu is a Control that displays a list of options. They are popular in toolbars or context menus.
Property Descriptions¶
- 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 PopupMenu when a checkbox or radio button is selected.
- bool hide_on_item_selection
Setter | set_hide_on_item_selection(value) |
Getter | is_hide_on_item_selection() |
If true
, hides the PopupMenu when an item is selected.
- 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 PopupMenu when a state item is selected.
- 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¶
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 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 set_item_checked for more info on how to control it.
Adds a new checkable item and assigns the specified ShortCut to it. Sets the label of the checkbox to the 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 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 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 set_item_checked for more info on how to control it.
Adds a new checkable item and assigns the specified ShortCut and icon texture
to it. Sets the label of the checkbox to the 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 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 get_item_accelerator for more info on accelerators.
Adds a new item and assigns the specified ShortCut and icon texture
to it. Sets the label of the checkbox to the 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 get_item_accelerator for more info on accelerators.
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 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 set_item_checked for more info on how to control it.
Adds a new radio check button and assigns a ShortCut to it. Sets the label of the checkbox to the 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 set_item_checked for more info on how to control it.
- void add_separator ( String label=”” )
Add a separator between items. Separators also occupy an index.
Adds a 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.
- void clear ( )
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.
- int get_item_count ( ) const
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 manualy.
Returns the metadata of the specified item, which might be of any type. You can set it with set_item_metadata, which provides a simple way of assigning context data to items.
Returns the ShortCut associated with the specified idx
item.
Returns the submenu name of the item at index idx
. See 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
.
- bool is_hide_on_window_lose_focus ( ) const
Returns whether the popup will be hidden when the window loses focus or not.
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.
Returns whether 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 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 add_separator for more info on how to add a separator.
Returns whether the shortcut of the specified item idx
is disabled or not.
- void remove_item ( 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.
- void set_hide_on_window_lose_focus ( bool enable )
Hides the PopupMenu when the window loses focus.
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.
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.
Set the checkstate status of the item at index “idx”.
Sets whether the item at index “idx” is disabled or not. When it is disabled it can’t be selected, or its action invoked.
Replaces the Texture icon of the specified idx
.
Set the id of the item at index “idx”.
Sets the metadata of an item, which might be of any type. You can later get it with get_item_metadata, which provides a simple way of assigning context data to items.
Sets a ShortCut for the specified item idx
.
Disables the 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.
Set the text of the item at index “idx”.
Sets the String tooltip of the item at the specified index idx
.
- void toggle_item_checked ( int idx )
Toggles the check state of the item of the specified index idx
.
- void toggle_item_multistate ( int idx )