PopupMenu

Inherits: Popup < Window < Viewport < Node < Object

There is currently no description for this class. Please help us by contributing one!

Properties

bool	allow_search	`true`
bool	hide_on_checkable_item_selection	`true`
bool	hide_on_item_selection	`true`
bool	hide_on_state_item_selection	`false`
int	item_count	`0`
bool	prefer_native_menu	`false`
float	submenu_popup_delay	`0.3`
SystemMenus	system_menu_id	`0`

Methods

bool	activate_item_by_event ( InputEvent event, bool for_global_only=false )
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, bool allow_echo=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, bool allow_echo=false )
void	add_submenu_item ( String label, String submenu, int id=-1 )
void	add_submenu_node_item ( String label, PopupMenu submenu, int id=-1 )
void	clear ( bool free_submenus=false )
int	get_focused_item ( ) const
Key	get_item_accelerator ( int index ) const
Texture2D	get_item_icon ( int index ) const
int	get_item_icon_max_width ( int index ) const
Color	get_item_icon_modulate ( int index ) const
int	get_item_id ( int index ) const
int	get_item_indent ( int index ) const
int	get_item_index ( int id ) const
String	get_item_language ( int index ) const
Variant	get_item_metadata ( int index ) const
int	get_item_multistate ( int index ) const
int	get_item_multistate_max ( int index ) const
Shortcut	get_item_shortcut ( int index ) const
String	get_item_submenu ( int index ) const
PopupMenu	get_item_submenu_node ( int index ) const
String	get_item_text ( int index ) const
TextDirection	get_item_text_direction ( int index ) const
String	get_item_tooltip ( int index ) const
bool	is_item_checkable ( int index ) const
bool	is_item_checked ( int index ) const
bool	is_item_disabled ( int index ) const
bool	is_item_radio_checkable ( int index ) const
bool	is_item_separator ( int index ) const
bool	is_item_shortcut_disabled ( int index ) const
bool	is_native_menu ( ) const
bool	is_system_menu ( ) const
void	remove_item ( int index )
void	scroll_to_item ( int index )
void	set_focused_item ( int index )
void	set_item_accelerator ( int index, Key accel )
void	set_item_as_checkable ( int index, bool enable )
void	set_item_as_radio_checkable ( int index, bool enable )
void	set_item_as_separator ( int index, bool enable )
void	set_item_checked ( int index, bool checked )
void	set_item_disabled ( int index, bool disabled )
void	set_item_icon ( int index, Texture2D icon )
void	set_item_icon_max_width ( int index, int width )
void	set_item_icon_modulate ( int index, Color modulate )
void	set_item_id ( int index, int id )
void	set_item_indent ( int index, int indent )
void	set_item_language ( int index, String language )
void	set_item_metadata ( int index, Variant metadata )
void	set_item_multistate ( int index, int state )
void	set_item_multistate_max ( int index, int max_states )
void	set_item_shortcut ( int index, Shortcut shortcut, bool global=false )
void	set_item_shortcut_disabled ( int index, bool disabled )
void	set_item_submenu ( int index, String submenu )
void	set_item_submenu_node ( int index, PopupMenu submenu )
void	set_item_text ( int index, String text )
void	set_item_text_direction ( int index, TextDirection direction )
void	set_item_tooltip ( int index, String tooltip )
void	toggle_item_checked ( int index )
void	toggle_item_multistate ( int index )

Theme Properties

Color	font_accelerator_color	`Color(0.7, 0.7, 0.7, 0.8)`
Color	font_color	`Color(0.875, 0.875, 0.875, 1)`
Color	font_disabled_color	`Color(0.4, 0.4, 0.4, 0.8)`
Color	font_hover_color	`Color(0.875, 0.875, 0.875, 1)`
Color	font_outline_color	`Color(0, 0, 0, 1)`
Color	font_separator_color	`Color(0.875, 0.875, 0.875, 1)`
Color	font_separator_outline_color	`Color(0, 0, 0, 1)`
int	h_separation	`4`
int	icon_max_width	`0`
int	indent	`10`
int	item_end_padding	`2`
int	item_start_padding	`2`
int	outline_size	`0`
int	separator_outline_size	`0`
int	v_separation	`4`
Font	font
Font	font_separator
int	font_separator_size
int	font_size
Texture2D	checked
Texture2D	checked_disabled
Texture2D	radio_checked
Texture2D	radio_checked_disabled
Texture2D	radio_unchecked
Texture2D	radio_unchecked_disabled
Texture2D	submenu
Texture2D	submenu_mirrored
Texture2D	unchecked
Texture2D	unchecked_disabled
StyleBox	hover
StyleBox	labeled_separator_left
StyleBox	labeled_separator_right
StyleBox	panel
StyleBox	separator

Signals

id_focused ( int id )

There is currently no description for this signal. Please help us by contributing one!

id_pressed ( int id )

There is currently no description for this signal. Please help us by contributing one!

index_pressed ( int index )

There is currently no description for this signal. Please help us by contributing one!

Property Descriptions

bool allow_search = true

void set_allow_search ( bool value )
bool get_allow_search ( )

There is currently no description for this property. Please help us by contributing one!

bool hide_on_checkable_item_selection = true

void set_hide_on_checkable_item_selection ( bool value )
bool is_hide_on_checkable_item_selection ( )

There is currently no description for this property. Please help us by contributing one!

bool hide_on_item_selection = true

void set_hide_on_item_selection ( bool value )
bool is_hide_on_item_selection ( )

There is currently no description for this property. Please help us by contributing one!

bool hide_on_state_item_selection = false

void set_hide_on_state_item_selection ( bool value )
bool is_hide_on_state_item_selection ( )

There is currently no description for this property. Please help us by contributing one!

int item_count = 0

void set_item_count ( int value )
int get_item_count ( )

There is currently no description for this property. Please help us by contributing one!

bool prefer_native_menu = false

void set_prefer_native_menu ( bool value )
bool is_prefer_native_menu ( )

There is currently no description for this property. Please help us by contributing one!

float submenu_popup_delay = 0.3

void set_submenu_popup_delay ( float value )
float get_submenu_popup_delay ( )

There is currently no description for this property. Please help us by contributing one!

SystemMenus system_menu_id = 0

void set_system_menu ( SystemMenus value )
SystemMenus get_system_menu ( )

There is currently no description for this property. Please help us by contributing one!