PopupMenu

Inherits: Popup < Window < Viewport < Node < Object

PopupMenu displays a list of options.

Description

PopupMenu is a Control that displays a list of options. They are popular in toolbars or context menus.

The size of a PopupMenu can be limited by using Window.max_size. If the height of the list of items is larger than the maximum height of the PopupMenu, a 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.

Methods

void

add_check_item ( String label, int id=-1, Key accel=0 )

void

add_check_shortcut ( Shortcut shortcut, int id=-1, bool global=false )

void

add_icon_check_item ( Texture2D texture, String label, int id=-1, Key accel=0 )

void

add_icon_check_shortcut ( Texture2D texture, Shortcut shortcut, int id=-1, bool global=false )

void

add_icon_item ( Texture2D texture, String label, int id=-1, Key accel=0 )

void

add_icon_radio_check_item ( Texture2D texture, String label, int id=-1, Key accel=0 )

void

add_icon_radio_check_shortcut ( Texture2D texture, Shortcut shortcut, int id=-1, bool global=false )

void

add_icon_shortcut ( Texture2D texture, Shortcut shortcut, int id=-1, bool global=false )

void

add_item ( String label, int id=-1, Key accel=0 )

void

add_multistate_item ( String label, int max_states, int default_state=0, int id=-1, Key accel=0 )

void

add_radio_check_item ( String label, int id=-1, Key accel=0 )

void

add_radio_check_shortcut ( Shortcut shortcut, int id=-1, bool global=false )

void

add_separator ( String label="", int id=-1 )

void

add_shortcut ( Shortcut shortcut, int id=-1, bool global=false )

void

add_submenu_item ( String label, String submenu, int id=-1 )

void

clear ( )

void

clear_item_opentype_features ( int idx )

int

get_current_index ( ) const

Key

get_item_accelerator ( int idx ) const

Texture2D

get_item_icon ( int idx ) const

int

get_item_id ( int idx ) const

int

get_item_index ( int id ) const

String

get_item_language ( int idx ) const

Variant

get_item_metadata ( int idx ) const

int

get_item_opentype_feature ( int idx, String tag ) const

Shortcut

get_item_shortcut ( int idx ) const

String

get_item_submenu ( int idx ) const

String

get_item_text ( int idx ) const

TextDirection

get_item_text_direction ( int idx ) const

String

get_item_tooltip ( int idx ) const

bool

is_item_checkable ( int idx ) const

bool

is_item_checked ( int idx ) const

bool

is_item_disabled ( int idx ) const

bool

is_item_radio_checkable ( int idx ) const

bool

is_item_separator ( int idx ) const

bool

is_item_shortcut_disabled ( int idx ) const

void

remove_item ( int idx )

void

set_item_accelerator ( int idx, Key accel )

void

set_item_as_checkable ( int idx, bool enable )

void

set_item_as_radio_checkable ( int idx, bool enable )

void

set_item_as_separator ( int idx, bool enable )

void

set_item_checked ( int idx, bool checked )

void

set_item_disabled ( int idx, bool disabled )

void

set_item_icon ( int idx, Texture2D icon )

void

set_item_id ( int idx, int id )

void

set_item_language ( int idx, String language )

void

set_item_metadata ( int idx, Variant metadata )

void

set_item_multistate ( int idx, int state )

void

set_item_opentype_feature ( int idx, String tag, int value )

void

set_item_shortcut ( int idx, Shortcut shortcut, bool global=false )

void

set_item_shortcut_disabled ( int idx, bool disabled )

void

set_item_submenu ( int idx, String submenu )

void

set_item_text ( int idx, String text )

void

set_item_text_direction ( int idx, TextDirection direction )

void

set_item_tooltip ( int idx, String tooltip )

void

toggle_item_checked ( int idx )

void

toggle_item_multistate ( int idx )

Signals

  • id_focused ( int id )

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


  • id_pressed ( int id )

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


  • index_pressed ( int index )

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

Property Descriptions

Default

true

Setter

set_allow_search(value)

Getter

get_allow_search()

If true, allows navigating PopupMenu with letter keys.


  • bool hide_on_checkable_item_selection

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.


  • bool hide_on_item_selection

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.


  • bool hide_on_state_item_selection

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.


  • int items_count

Default

0

Setter

set_item_count(value)

Getter

get_item_count()

The number of items currently in the list.


  • float submenu_popup_delay

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.

Method Descriptions

  • void add_check_item ( String label, int id=-1, 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 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.


  • void add_check_shortcut ( Shortcut shortcut, int id=-1, bool global=false )

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.


Same as add_icon_check_item, but uses a radio check button.


Same as add_icon_check_shortcut, but uses a radio check button.


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.


  • void add_multistate_item ( String label, int max_states, int default_state=0, int id=-1, 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 0 will be assigned to it. See get_item_accelerator for more info on accelerators.


  • void add_radio_check_item ( String label, int id=-1, 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 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.


  • void add_radio_check_shortcut ( Shortcut shortcut, int id=-1, bool global=false )

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="", 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.


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.


  • void clear_item_opentype_features ( int idx )

Removes all OpenType features form the item's text.


  • int get_current_index ( ) const

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


  • Key get_item_accelerator ( 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.


Returns the icon of the item at index idx.


  • int get_item_id ( int idx ) const

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


  • int get_item_index ( int id ) const

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


Returns item's text language code.


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.


  • int get_item_opentype_feature ( int idx, String tag ) const

Returns OpenType feature tag of the item's text.


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 item's text base writing direction.


Returns the tooltip associated with the specified index index idx.


  • bool is_item_checkable ( int idx ) const

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

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


  • bool is_item_checked ( int idx ) const

Returns true if the item at index idx is checked.


  • bool is_item_disabled ( 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 set_item_disabled for more info on how to disable an item.


  • bool is_item_radio_checkable ( 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.


  • bool is_item_separator ( int idx ) const

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.


  • bool is_item_shortcut_disabled ( int idx ) const

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


  • void remove_item ( int idx )

Removes the item at index idx from the menu.

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


  • void set_item_accelerator ( int idx, Key accel )

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


  • void set_item_as_checkable ( int idx, 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.


  • void set_item_as_radio_checkable ( int idx, 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.


  • void set_item_as_separator ( int idx, 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.


  • void set_item_checked ( int idx, bool checked )

Sets the checkstate status of the item at index idx.


  • void set_item_disabled ( int idx, bool disabled )

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


Replaces the Texture2D icon of the specified idx.


  • void set_item_id ( int idx, int id )

Sets the id of the item at index idx.


  • void set_item_language ( int idx, 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.


  • void set_item_metadata ( int idx, Variant metadata )

Sets the metadata of an item, which may be of any type. You can later get it with get_item_metadata, which provides a simple way of assigning context data to items.


  • void set_item_multistate ( int idx, int state )

Sets the state of a multistate item. See add_multistate_item for details.


  • void set_item_opentype_feature ( int idx, String tag, int value )

Sets OpenType feature tag for the item's text. More info: OpenType feature tags.


Sets a Shortcut for the specified item idx.


  • void set_item_shortcut_disabled ( int idx, bool disabled )

Disables the Shortcut of the specified index idx.


  • void set_item_submenu ( int idx, String submenu )

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


  • void set_item_text ( int idx, String text )

Sets the text of the item at index idx.


Sets item's text base writing direction.


  • void set_item_tooltip ( int idx, String tooltip )

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 )

Cycle to the next state of a multistate item. See add_multistate_item for details.

Theme Property Descriptions

Texture2D icon for the checked checkbox items.


Font used for the menu items.


  • Color font_accelerator_color

Default

Color(0.7, 0.7, 0.7, 0.8)

The text Color used for shortcuts and accelerators that show next to the menu item name when defined. See get_item_accelerator for more info on accelerators.


Default

Color(0.88, 0.88, 0.88, 1)

The default text Color for menu items' names.


  • Color font_disabled_color

Default

Color(0.4, 0.4, 0.4, 0.8)

Color used for disabled menu items' text.


Default

Color(0.88, 0.88, 0.88, 1)

Color used for the hovered text.


  • Color font_outline_color

Default

Color(1, 1, 1, 1)

The tint of text outline of the menu item.


  • Color font_separator_color

Default

Color(0.88, 0.88, 0.88, 1)

Color used for labeled separators' text. See add_separator.


  • int font_size

Font size of the menu items.


StyleBox displayed when the PopupMenu item is hovered.


  • int hseparation

Default

4

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


  • int item_end_padding

Default

2


  • int item_start_padding

Default

2


StyleBox for the left side of labeled separator. See add_separator.


StyleBox for the right side of labeled separator. See add_separator.


  • int outline_size

Default

0

The size of the item text outline.


Default StyleBox of the PopupMenu items.


StyleBox used when the PopupMenu item is disabled.


Texture2D icon for the checked radio button items.


Texture2D icon for the unchecked radio button items.


StyleBox used for the separators. See add_separator.


Texture2D icon for the submenu arrow (for left-to-right layouts).


Texture2D icon for the submenu arrow (for right-to-left layouts).


Texture2D icon for the unchecked checkbox items.


  • int vseparation

Default

4

The vertical space between each menu item.