class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS Object NativeMenu
A server interface for OS native menus.

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

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)
Enum Feature<>():Enum

FEATURE_GLOBAL_MENU = 0

NativeMenu supports native global main menu.


FEATURE_POPUP_MENU = 1

NativeMenu supports native popup menus.


FEATURE_OPEN_CLOSE_CALLBACK = 2

NativeMenu supports menu open and close callbacks.


FEATURE_HOVER_CALLBACK = 3

NativeMenu supports menu item hover callback.


FEATURE_KEY_CALLBACK = 4

NativeMenu supports menu item accelerator/key callback.

 Enum SystemMenus<>():Enum

INVALID_MENU_ID = 0

Invalid special system menu ID.


MAIN_MENU_ID = 1

Global main menu ID.


APPLICATION_MENU_ID = 2

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


WINDOW_MENU_ID = 3

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


HELP_MENU_ID = 4

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


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

 int add_check_item<>():int

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<>():int

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<>():int

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<>():int

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<>():int

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<>():int

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<>():int

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=, rid:RID=, int index=-1, index:int=-1, ):int

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=, rid:RID=, String label=, label:String=, RID submenu_rid=, submenu_rid:RID=, Variant tag=null, tag:Variant=null, int index=-1, index:int=-1, ):int

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=, rid:RID=, ):void

Removes all items from the global menu rid.

Note: This method is implemented on macOS and Windows.

 RID create_menu<>():RID

Creates a new global menu object.

Note: This method is implemented on macOS and Windows.

 int find_item_index_with_submenu<>( RID rid=, rid:RID=, RID submenu_rid=, submenu_rid:RID=, ):int

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=, rid:RID=, Variant tag=, tag:Variant=, ):int

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=, rid:RID=, String text=, text:String=, ):int

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.

 void free_menu<>( RID rid=, rid:RID=, ):void

Frees a global menu object created by this NativeMenu.

Note: This method is implemented on macOS and Windows.

 Key get_item_accelerator<>( RID rid=, rid:RID=, int idx=, idx:int=, ):Key

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=, rid:RID=, int idx=, idx:int=, ):Callable

Returns the callback of the item at index idx.

Note: This method is implemented on macOS and Windows.

 int get_item_count<>( RID rid=, rid:RID=, ):int

Returns number of items in the global menu rid.

Note: This method is implemented on macOS and Windows.

 Texture2D get_item_icon<>( RID rid=, rid:RID=, int idx=, idx:int=, ):Texture2D

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=, rid:RID=, int idx=, idx:int=, ):int

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=, rid:RID=, int idx=, idx:int=, ):Callable

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=, rid:RID=, int idx=, idx:int=, ):int

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=, rid:RID=, int idx=, idx:int=, ):int

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=, rid:RID=, int idx=, idx:int=, ):RID

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=, rid:RID=, int idx=, idx:int=, ):Variant

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=, rid:RID=, int idx=, idx:int=, ):String

Returns the text of the item at index idx.

Note: This method is implemented on macOS and Windows.

 String get_item_tooltip<>( RID rid=, rid:RID=, int idx=, idx:int=, ):String

Returns the tooltip associated with the specified index idx.

Note: This method is implemented only on macOS.

 float get_minimum_width<>( RID rid=, rid:RID=, ):float

Returns global menu minimum width.

Note: This method is implemented only on macOS.

 Callable get_popup_close_callback<>( RID rid=, rid:RID=, ):Callable

Returns global menu close callback.

Note: This method is implemented on macOS and Windows.

 Callable get_popup_open_callback<>( RID rid=, rid:RID=, ):Callable

Returns global menu open callback.

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

 Vector2 get_size<>( RID rid=, rid:RID=, ):Vector2

Returns global menu size.

Note: This method is implemented on macOS and Windows.

 RID get_system_menu<>( SystemMenus menu_id=, menu_id:SystemMenus=, ):RID

Returns RID of a special system menu.

Note: This method is implemented only on macOS.

 String get_system_menu_name<>( SystemMenus menu_id=, menu_id:SystemMenus=, ):String

Returns readable name of a special system menu.

Note: This method is implemented only on macOS.

 bool has_feature<>( Feature feature=, feature:Feature=, ):bool

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

Note: This method is implemented on macOS and Windows.

 bool has_menu<>( RID rid=, rid:RID=, ):bool

Returns true if rid is valid global menu.

Note: This method is implemented on macOS and Windows.

 bool has_system_menu<>( SystemMenus menu_id=, menu_id:SystemMenus=, ):bool

Returns true if a special system menu is supported.

Note: This method is implemented only on macOS.

 bool is_item_checkable<>( RID rid=, rid:RID=, int idx=, idx:int=, ):bool

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

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

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

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

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.

 bool is_opened<>( RID rid=, rid:RID=, ):bool

Returns true if the menu is currently opened.

Note: This method is implemented only on macOS.

 bool is_system_menu<>( RID rid=, rid:RID=, ):bool

Return true is global menu is a special system menu.

Note: This method is implemented only on macOS.

 void popup<>( RID rid=, rid:RID=, Vector2i position=, position:Vector2i=, ):void

Shows the global menu at position in the screen coordinates.

Note: This method is implemented on macOS and Windows.

 void remove_item<>( RID rid=, rid:RID=, int idx=, idx:int=, ):void

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=, rid:RID=, bool is_rtl=, is_rtl:bool=, ):void

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=, rid:RID=, int idx=, idx:int=, Key keycode=, keycode:Key=, ):void

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=, rid:RID=, int idx=, idx:int=, Callable callback=, callback:Callable=, ):void

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=, rid:RID=, int idx=, idx:int=, bool checkable=, checkable:bool=, ):void

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=, rid:RID=, int idx=, idx:int=, bool checked=, checked:bool=, ):void

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=, rid:RID=, int idx=, idx:int=, bool disabled=, disabled:bool=, ):void

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=, rid:RID=, int idx=, idx:int=, bool hidden=, hidden:bool=, ):void

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=, rid:RID=, int idx=, idx:int=, Callable callback=, callback:Callable=, ):void

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=, rid:RID=, int idx=, idx:int=, Texture2D icon=, icon:Texture2D=, ):void

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=, rid:RID=, int idx=, idx:int=, int level=, level:int=, ):void

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=, rid:RID=, int idx=, idx:int=, Callable key_callback=, key_callback:Callable=, ):void

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=, rid:RID=, int idx=, idx:int=, int max_states=, max_states:int=, ):void

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=, rid:RID=, int idx=, idx:int=, bool checkable=, checkable:bool=, ):void

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=, rid:RID=, int idx=, idx:int=, int state=, state:int=, ):void

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=, rid:RID=, int idx=, idx:int=, RID submenu_rid=, submenu_rid:RID=, ):void

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=, rid:RID=, int idx=, idx:int=, Variant tag=, tag:Variant=, ):void

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=, rid:RID=, int idx=, idx:int=, String text=, text:String=, ):void

Sets the text of the item at index idx.

Note: This method is implemented on macOS and Windows.

 void set_item_tooltip<>( RID rid=, rid:RID=, int idx=, idx:int=, String tooltip=, tooltip:String=, ):void

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=, rid:RID=, float width=, width:float=, ):void

Sets the minimum width of the global menu.

Note: This method is implemented only on macOS.

 void set_popup_close_callback<>( RID rid=, rid:RID=, Callable callback=, callback:Callable=, ):void

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

Note: The OS can simulate menu opening to track menu item changes and global shortcuts, in which case the corresponding close callback is not triggered. Use is_opened() to check if the menu is currently opened.

Note: This method is implemented on macOS and Windows.

 void set_popup_open_callback<>( RID rid=, rid:RID=, Callable callback=, callback:Callable=, ):void

Registers callable to emit after the menu is closed.

Note: This method is implemented only on macOS.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...