Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

NativeMenu¶

Inherits: Object

A server interface for OS native menus.

Description¶

NativeMenu handles low-level access to the OS native global menu bar and popup menus.

Note: This is low-level API, consider using MenuBar with MenuBar.prefer_global_menu set to true, and PopupMenu with PopupMenu.prefer_native_menu set to true.

To create a menu, use create_menu, add menu items using add_*_item methods. To remove a menu, use free_menu.

var menu

func _menu_callback(item_id):
    if item_id == "ITEM_CUT":
        cut()
    elif item_id == "ITEM_COPY":
        copy()
    elif item_id == "ITEM_PASTE":
        paste()

func _enter_tree():
    # Create new menu and add items:
    menu = NativeMenu.create_menu()
    NativeMenu.add_item(menu, "Cut", _menu_callback, Callable(), "ITEM_CUT")
    NativeMenu.add_item(menu, "Copy", _menu_callback, Callable(), "ITEM_COPY")
    NativeMenu.add_separator(menu)
    NativeMenu.add_item(menu, "Paste", _menu_callback, Callable(), "ITEM_PASTE")

func _on_button_pressed():
    # Show popup menu at mouse position:
    NativeMenu.popup(menu, DisplayServer.mouse_get_position())

func _exit_tree():
    # Remove menu when it's no longer needed:
    NativeMenu.free_menu(menu)

Methods¶

int	add_check_item(rid: RID, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	add_icon_check_item(rid: RID, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	add_icon_item(rid: RID, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	add_icon_radio_check_item(rid: RID, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	add_item(rid: RID, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	add_multistate_item(rid: RID, label: String, max_states: int, default_state: int, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	add_radio_check_item(rid: RID, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)
int	add_separator(rid: RID, index: int = -1)
int	add_submenu_item(rid: RID, label: String, submenu_rid: RID, tag: Variant = null, index: int = -1)
void	clear(rid: RID)
RID	create_menu()
int	find_item_index_with_submenu(rid: RID, submenu_rid: RID) const
int	find_item_index_with_tag(rid: RID, tag: Variant) const
int	find_item_index_with_text(rid: RID, text: String) const
void	free_menu(rid: RID)
Key	get_item_accelerator(rid: RID, idx: int) const
Callable	get_item_callback(rid: RID, idx: int) const
int	get_item_count(rid: RID) const
Texture2D	get_item_icon(rid: RID, idx: int) const
int	get_item_indentation_level(rid: RID, idx: int) const
Callable	get_item_key_callback(rid: RID, idx: int) const
int	get_item_max_states(rid: RID, idx: int) const
int	get_item_state(rid: RID, idx: int) const
RID	get_item_submenu(rid: RID, idx: int) const
Variant	get_item_tag(rid: RID, idx: int) const
String	get_item_text(rid: RID, idx: int) const
String	get_item_tooltip(rid: RID, idx: int) const
float	get_minimum_width(rid: RID) const
Callable	get_popup_close_callback(rid: RID) const
Callable	get_popup_open_callback(rid: RID) const
Vector2	get_size(rid: RID) const
RID	get_system_menu(menu_id: SystemMenus) const
String	get_system_menu_name(menu_id: SystemMenus) const
bool	has_feature(feature: Feature) const
bool	has_menu(rid: RID) const
bool	has_system_menu(menu_id: SystemMenus) const
bool	is_item_checkable(rid: RID, idx: int) const
bool	is_item_checked(rid: RID, idx: int) const
bool	is_item_disabled(rid: RID, idx: int) const
bool	is_item_hidden(rid: RID, idx: int) const
bool	is_item_radio_checkable(rid: RID, idx: int) const
bool	is_system_menu(rid: RID) const
void	popup(rid: RID, position: Vector2i)
void	remove_item(rid: RID, idx: int)
void	set_interface_direction(rid: RID, is_rtl: bool)
void	set_item_accelerator(rid: RID, idx: int, keycode: Key)
void	set_item_callback(rid: RID, idx: int, callback: Callable)
void	set_item_checkable(rid: RID, idx: int, checkable: bool)
void	set_item_checked(rid: RID, idx: int, checked: bool)
void	set_item_disabled(rid: RID, idx: int, disabled: bool)
void	set_item_hidden(rid: RID, idx: int, hidden: bool)
void	set_item_hover_callbacks(rid: RID, idx: int, callback: Callable)
void	set_item_icon(rid: RID, idx: int, icon: Texture2D)
void	set_item_indentation_level(rid: RID, idx: int, level: int)
void	set_item_key_callback(rid: RID, idx: int, key_callback: Callable)
void	set_item_max_states(rid: RID, idx: int, max_states: int)
void	set_item_radio_checkable(rid: RID, idx: int, checkable: bool)
void	set_item_state(rid: RID, idx: int, state: int)
void	set_item_submenu(rid: RID, idx: int, submenu_rid: RID)
void	set_item_tag(rid: RID, idx: int, tag: Variant)
void	set_item_text(rid: RID, idx: int, text: String)
void	set_item_tooltip(rid: RID, idx: int, tooltip: String)
void	set_minimum_width(rid: RID, width: float)
void	set_popup_close_callback(rid: RID, callback: Callable)
void	set_popup_open_callback(rid: RID, callback: Callable)

Enumerations¶

enum Feature:

Feature FEATURE_GLOBAL_MENU = 0

NativeMenu supports native global main menu.

Feature FEATURE_POPUP_MENU = 1

NativeMenu supports native popup menus.

Feature FEATURE_OPEN_CLOSE_CALLBACK = 2

NativeMenu supports menu open and close callbacks.

Feature FEATURE_HOVER_CALLBACK = 3

NativeMenu supports menu item hover callback.

Feature FEATURE_KEY_CALLBACK = 4

NativeMenu supports menu item accelerator/key callback.

enum SystemMenus:

SystemMenus INVALID_MENU_ID = 0

Invalid special system menu ID.

SystemMenus MAIN_MENU_ID = 1

Global main menu ID.

SystemMenus APPLICATION_MENU_ID = 2

Application (first menu after "Apple" menu on macOS) menu ID.

SystemMenus WINDOW_MENU_ID = 3

"Window" menu ID (on macOS this menu includes standard window control items and a list of open windows).

SystemMenus HELP_MENU_ID = 4

"Help" menu ID (on macOS this menu includes help search bar).

SystemMenus DOCK_MENU_ID = 5

Dock icon right-click menu ID (on macOS this menu include standard application control items and a list of open windows).

Method Descriptions¶

int add_check_item(rid: RID, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)

Adds a new checkable item with text label to the global menu rid.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: The callback and key_callback Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to tag.

Note: This method is implemented on macOS and Windows.

Note: On Windows, accelerator and key_callback are ignored.

int add_icon_check_item(rid: RID, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)

Adds a new checkable item with text label and icon icon to the global menu rid.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: The callback and key_callback Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to tag.

Note: This method is implemented on macOS and Windows.

Note: On Windows, accelerator and key_callback are ignored.

int add_icon_item(rid: RID, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)

Adds a new item with text label and icon icon to the global menu rid.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: The callback and key_callback Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to tag.

Note: This method is implemented on macOS and Windows.

Note: On Windows, accelerator and key_callback are ignored.

int add_icon_radio_check_item(rid: RID, icon: Texture2D, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)

Adds a new radio-checkable item with text label and icon icon to the global menu rid.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: Radio-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.

Note: The callback and key_callback Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to tag.

Note: This method is implemented on macOS and Windows.

Note: On Windows, accelerator and key_callback are ignored.

int add_item(rid: RID, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)

Adds a new item with text label to the global menu rid.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: The callback and key_callback Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to tag.

Note: This method is implemented on macOS and Windows.

Note: On Windows, accelerator and key_callback are ignored.

int add_multistate_item(rid: RID, label: String, max_states: int, default_state: int, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)

Adds a new item with text label to the global menu rid.

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.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: By default, there's no indication of the current item state, it should be changed manually.

Note: The callback and key_callback Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to tag.

Note: This method is implemented on macOS and Windows.

Note: On Windows, accelerator and key_callback are ignored.

int add_radio_check_item(rid: RID, label: String, callback: Callable = Callable(), key_callback: Callable = Callable(), tag: Variant = null, accelerator: Key = 0, index: int = -1)

Adds a new radio-checkable item with text label to the global menu rid.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: Radio-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.

Note: The callback and key_callback Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to tag.

Note: This method is implemented on macOS and Windows.

Note: On Windows, accelerator and key_callback are ignored.

int add_separator(rid: RID, index: int = -1)

Adds a separator between items to the global menu rid. Separators also occupy an index.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

Note: This method is implemented on macOS and Windows.

int add_submenu_item(rid: RID, label: String, submenu_rid: RID, tag: Variant = null, index: int = -1)

Adds an item that will act as a submenu of the global menu rid. The submenu_rid argument is the RID of the global menu that will be shown when the item is clicked.

Returns index of the inserted item, it's not guaranteed to be the same as index value.

Note: This method is implemented on macOS and Windows.

void clear(rid: RID)

Removes all items from the global menu rid.

Note: This method is implemented on macOS and Windows.

Creates a new global menu object.

Note: This method is implemented on macOS and Windows.

int find_item_index_with_submenu(rid: RID, submenu_rid: RID) const

Returns the index of the item with the submenu specified by submenu_rid. Indices are automatically assigned to each item by the engine, and cannot be set manually.

Note: This method is implemented on macOS and Windows.

int find_item_index_with_tag(rid: RID, tag: Variant) const

Returns the index of the item with the specified tag. Indices are automatically assigned to each item by the engine, and cannot be set manually.

Note: This method is implemented on macOS and Windows.

int find_item_index_with_text(rid: RID, text: String) const

Returns the index of the item with the specified text. Indices are automatically assigned to each item by the engine, and cannot be set manually.

Note: This method is implemented on macOS and Windows.

Frees a global menu object created by this NativeMenu.

Note: This method is implemented on macOS and Windows.

Key get_item_accelerator(rid: RID, idx: int) 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.

Note: This method is implemented only on macOS.

Callable get_item_callback(rid: RID, idx: int) const

Returns the callback of the item at index idx.

Note: This method is implemented on macOS and Windows.

int get_item_count(rid: RID) const

Returns number of items in the global menu rid.

Note: This method is implemented on macOS and Windows.

Texture2D get_item_icon(rid: RID, idx: int) const

Returns the icon of the item at index idx.

Note: This method is implemented on macOS and Windows.

int get_item_indentation_level(rid: RID, idx: int) const

Returns the horizontal offset of the item at the given idx.

Note: This method is implemented only on macOS.

Callable get_item_key_callback(rid: RID, idx: int) const

Returns the callback of the item accelerator at index idx.

Note: This method is implemented only on macOS.

int get_item_max_states(rid: RID, idx: int) const

Returns number of states of a multistate item. See add_multistate_item for details.

Note: This method is implemented on macOS and Windows.

int get_item_state(rid: RID, idx: int) const

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

Note: This method is implemented on macOS and Windows.

RID get_item_submenu(rid: RID, idx: int) const

Returns the submenu ID of the item at index idx. See add_submenu_item for more info on how to add a submenu.

Note: This method is implemented on macOS and Windows.

Variant get_item_tag(rid: RID, idx: int) const

Returns the metadata of the specified item, which might be of any type. You can set it with set_item_tag, which provides a simple way of assigning context data to items.

Note: This method is implemented on macOS and Windows.

String get_item_text(rid: RID, idx: int) const

Returns the text of the item at index idx.

Note: This method is implemented on macOS and Windows.

Returns the tooltip associated with the specified index idx.

Note: This method is implemented only on macOS.

float get_minimum_width(rid: RID) const

Returns global menu minimum width.

Note: This method is implemented only on macOS.

Returns global menu close callback.

b]Note:** This method is implemented only on macOS.

Returns global menu open callback.

b]Note:** This method is implemented only on macOS.

Vector2 get_size(rid: RID) const

Returns global menu size.

Note: This method is implemented on macOS and Windows.

Returns RID of a special system menu.

Note: This method is implemented only on macOS.

Returns readable name of a special system menu.

Note: This method is implemented only on macOS.

bool has_feature(feature: Feature) const

Returns true if the specified feature is supported by the current NativeMenu, false otherwise.

Note: This method is implemented on macOS and Windows.

Returns true if rid is valid global menu.

Note: This method is implemented on macOS and Windows.

Returns true if a special system menu is supported.

Note: This method is implemented only on macOS.

bool is_item_checkable(rid: RID, idx: int) 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: This method is implemented on macOS and Windows.

bool is_item_checked(rid: RID, idx: int) const

Returns true if the item at index idx is checked.

Note: This method is implemented on macOS and Windows.

bool is_item_disabled(rid: RID, idx: int) 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.

Note: This method is implemented on macOS and Windows.

bool is_item_hidden(rid: RID, idx: int) const

Returns true if the item at index idx is hidden.

See set_item_hidden for more info on how to hide an item.

Note: This method is implemented only on macOS.

bool is_item_radio_checkable(rid: RID, idx: int) 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.

Note: This method is implemented on macOS and Windows.

Return true is global menu is a special system menu.

Note: This method is implemented only on macOS.

Shows the global menu at position in the screen coordinates.

Note: This method is implemented on macOS and Windows.

void remove_item(rid: RID, idx: int)

Removes the item at index idx from the global menu rid.

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

Note: This method is implemented on macOS and Windows.

void set_interface_direction(rid: RID, is_rtl: bool)

Sets the menu text layout direction from right-to-left if is_rtl is true.

Note: This method is implemented on macOS and Windows.

void set_item_accelerator(rid: RID, idx: int, keycode: Key)

Sets the accelerator of the item at index idx. keycode can be a single Key, or a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A).

Note: This method is implemented only on macOS.

void set_item_callback(rid: RID, idx: int, callback: Callable)

Sets the callback of the item at index idx. Callback is emitted when an item is pressed.

Note: The callback Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the tag parameter when the menu item was created.

Note: This method is implemented on macOS and Windows.

void set_item_checkable(rid: RID, idx: int, checkable: bool)

Sets whether the item at index idx has a checkbox. If false, sets the type of the item to plain text.

Note: This method is implemented on macOS and Windows.

void set_item_checked(rid: RID, idx: int, checked: bool)

Sets the checkstate status of the item at index idx.

Note: This method is implemented on macOS and Windows.

void set_item_disabled(rid: RID, idx: int, disabled: bool)

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

Note: This method is implemented on macOS and Windows.

void set_item_hidden(rid: RID, idx: int, hidden: bool)

Hides/shows the item at index idx. When it is hidden, an item does not appear in a menu and its action cannot be invoked.

Note: This method is implemented only on macOS.

void set_item_hover_callbacks(rid: RID, idx: int, callback: Callable)

Sets the callback of the item at index idx. The callback is emitted when an item is hovered.

Note: The callback Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the tag parameter when the menu item was created.

Note: This method is implemented only on macOS.

void set_item_icon(rid: RID, idx: int, icon: Texture2D)

Replaces the Texture2D icon of the specified idx.

Note: This method is implemented on macOS and Windows.

Note: This method is not supported by macOS Dock menu items.

void set_item_indentation_level(rid: RID, idx: int, level: int)

Sets the horizontal offset of the item at the given idx.

Note: This method is implemented only on macOS.

void set_item_key_callback(rid: RID, idx: int, key_callback: Callable)

Sets the callback of the item at index idx. Callback is emitted when its accelerator is activated.

Note: The key_callback Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the tag parameter when the menu item was created.

Note: This method is implemented only on macOS.

void set_item_max_states(rid: RID, idx: int, max_states: int)

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

Note: This method is implemented on macOS and Windows.

void set_item_radio_checkable(rid: RID, idx: int, checkable: bool)

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.

Note: This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.

Note: This method is implemented on macOS and Windows.

void set_item_state(rid: RID, idx: int, state: int)

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

Note: This method is implemented on macOS and Windows.

void set_item_submenu(rid: RID, idx: int, submenu_rid: RID)

Sets the submenu RID of the item at index idx. The submenu is a global menu that would be shown when the item is clicked.

Note: This method is implemented on macOS and Windows.

void set_item_tag(rid: RID, idx: int, tag: Variant)

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

Note: This method is implemented on macOS and Windows.

void set_item_text(rid: RID, idx: int, text: String)

Sets the text of the item at index idx.

Note: This method is implemented on macOS and Windows.

Sets the String tooltip of the item at the specified index idx.

Note: This method is implemented only on macOS.

void set_minimum_width(rid: RID, width: float)

Sets the minimum width of the global menu.

Note: This method is implemented only on macOS.

Registers callable to emit when the menu is about to show.

Note: This method is implemented only on macOS.

Registers callable to emit when the menu is about to closed.

Note: This method is implemented only on macOS.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.