Up to date
This page is up to date for Godot 4.2.
If you still find outdated information, please open an issue.
PopupMenu¶
Inherits: Popup < Window < Viewport < Node < Object
A modal window used to display a list of options.
Description¶
PopupMenu is a modal window used to display a list of options. Useful for toolbars and 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.
All set_* methods allow negative item indices, i.e. -1 to access the last item, -2 to select the second-to-last item, and so on.
Incremental search: Like ItemList and Tree, PopupMenu supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing ProjectSettings.gui/timers/incremental_search_max_interval_msec.
Note: The ID values used for items are limited to 32 bits, not full 64 bits of int. This has a range of -2^32 to 2^32 - 1, i.e. -2147483648 to 2147483647.
Properties¶
|
||
|
||
|
||
|
||
|
||
|
Methods¶
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 |
|
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 |
|
get_focused_item ( ) const |
|
get_item_accelerator ( int index ) const |
|
get_item_icon ( int index ) const |
|
get_item_icon_max_width ( int index ) const |
|
get_item_icon_modulate ( int index ) const |
|
get_item_id ( int index ) const |
|
get_item_indent ( int index ) const |
|
get_item_index ( int id ) const |
|
get_item_language ( int index ) const |
|
get_item_metadata ( int index ) const |
|
get_item_shortcut ( int index ) const |
|
get_item_submenu ( int index ) const |
|
get_item_text ( int index ) const |
|
get_item_text_direction ( int index ) const |
|
get_item_tooltip ( int index ) const |
|
is_item_checkable ( int index ) const |
|
is_item_checked ( int index ) const |
|
is_item_disabled ( int index ) const |
|
is_item_radio_checkable ( int index ) const |
|
is_item_separator ( int index ) const |
|
is_item_shortcut_disabled ( int index ) 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 |