PopupMenu

Inherits: Popup < Control < CanvasItem < Node < Object

Category: Core

Brief Description

PopupMenu displays a list of options.

Member Functions

void	add_check_item ( String label, int id=-1, int accel=0 )
void	add_icon_check_item ( Object texture, String label, int id=-1, int accel=0 )
void	add_icon_item ( Object texture, String label, int id=-1, int accel=0 )
void	add_item ( String label, int id=-1, int accel=0 )
void	add_separator ( )
void	add_submenu_item ( String label, String submenu, int id=-1 )
void	clear ( )
int	get_item_ID ( int idx ) const
int	get_item_accelerator ( int idx ) const
int	get_item_count ( ) const
Object	get_item_icon ( int idx ) const
int	get_item_index ( int id ) const
void	get_item_metadata ( int idx ) const
String	get_item_submenu ( int idx ) const
String	get_item_text ( 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_separator ( int idx ) const
void	remove_item ( int idx )
void	set_item_ID ( int idx, int id )
void	set_item_accelerator ( int idx, int accel )
void	set_item_as_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, Object icon )
void	set_item_metadata ( int idx, var metadata )
void	set_item_submenu ( int idx, String submenu )
void	set_item_text ( int idx, String text )

Signals

• item_pressed ( int ID )

Description

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

Member Function Description

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

Add a new checkable item with text “label”. An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don’t have any built-in checking behavior and must be checked/unchecked manually.

• void add_icon_check_item ( Object texture, String label, int id=-1, int accel=0 )

Add a new checkable item with text “label” and icon “texture”. An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don’t have any built-in checking behavior and must be checked/unchecked manually.

• void add_icon_item ( Object texture, String label, int id=-1, int accel=0 )

Add a new item with text “label” and icon “texture”. An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.

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

Add a new item with text “label”. An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.

• void add_separator ( )

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

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

Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn’t provided, one will be created from the index.

• void clear ( )

Clear the popup menu, in effect removing all items.

• int get_item_ID ( int idx ) const

Return the id of the item at index “idx”.

• int get_item_accelerator ( int idx ) const

Return 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

Return the amount of items.

• Object get_item_icon ( int idx ) const

Return the icon of the item at index “idx”.

• int get_item_index ( int id ) const

Find and return the index of the item containing a given id.

• void get_item_metadata ( int idx ) const

Return the metadata of an 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.

• String get_item_submenu ( int idx ) const

Return the submenu name of the item at index “idx”.

• String get_item_text ( int idx ) const

Return the text of the item at index “idx”.

• bool is_item_checkable ( int idx ) const

Return whether the item at index “idx” has a checkbox. Note that checkable items just display a checkmark, but don’t have any built-in checking behavior and must be checked/unchecked manually.

• bool is_item_checked ( int idx ) const

Return the checkstate status of the item at index “idx”.

• bool is_item_disabled ( int idx ) const

Return whether the item at index “idx” is disabled. When it is disabled it can’t be selected, or its action invoked.

• bool is_item_separator ( int idx ) const

Return whether the item is a seperator. If it is, it would be displayed as a line.

• 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_item_ID ( int idx, int id )

Set the id of the item at index “idx”.

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

• void set_item_as_checkable ( int idx, bool enable )

Set whether the item at index “idx” has a checkbox. Note that 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_separator ( int idx, bool enable )

Mark the item at index “idx” as a seperator, which means that it would be displayed as a mere line.

• void set_item_checked ( int idx, bool checked )

Set the checkstate status of the item at index “idx”.

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

• void set_item_icon ( int idx, Object icon )

Set the icon of the item at index “idx”.

• void set_item_metadata ( int idx, var metadata )

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.

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

Set the text of the item at index “idx”.