A server interface for OS native menus.
class NativeMenuNativeMenu handles low-level access to the OS native global menu bar and popup menus.
To create a menu, use createMenu, add menu items using add_*_item methods. To remove a menu, use freeMenu(rid:).
import SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
class MenuBarA horizontal menu bar that creates a MenuButton for each PopupMenu child.
final var preferGlobalMenu: Bool { get set }If true, MenuBar will use system global menu when supported.
class PopupMenuA modal window used to display a list of options.
final var preferNativeMenu: Bool { get set }If true, MenuBar will use native menu when supported.
static func createMenu() -> RID Creates a new global menu object.
static func freeMenu(rid: RID) Frees a global menu object created by this NativeMenu.
class ObjectBase class for all other classes in the engine.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable : VariantStorableTypes that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
static var shared: NativeMenuThe shared instance of this class
static func addCheckItem(rid: RID, label: String, callback: Callable = Callable(), keyCallback: Callable = Callable(), tag: Variant, accelerator: Key = .none, index: Int32 = -1) -> Int32 Adds a new checkable item with text label to the global menu rid.
static func addIconCheckItem(rid: RID, icon: Texture2D?, label: String, callback: Callable = Callable(), keyCallback: Callable = Callable(), tag: Variant, accelerator: Key = .none, index: Int32 = -1) -> Int32 Adds a new checkable item with text label and icon icon to the global menu rid.
static func addIconItem(rid: RID, icon: Texture2D?, label: String, callback: Callable = Callable(), keyCallback: Callable = Callable(), tag: Variant, accelerator: Key = .none, index: Int32 = -1) -> Int32 Adds a new item with text label and icon icon to the global menu rid.
static func addIconRadioCheckItem(rid: RID, icon: Texture2D?, label: String, callback: Callable = Callable(), keyCallback: Callable = Callable(), tag: Variant, accelerator: Key = .none, index: Int32 = -1) -> Int32 Adds a new radio-checkable item with text label and icon icon to the global menu rid.
static func addItem(rid: RID, label: String, callback: Callable = Callable(), keyCallback: Callable = Callable(), tag: Variant, accelerator: Key = .none, index: Int32 = -1) -> Int32 Adds a new item with text label to the global menu rid.
static func addMultistateItem(rid: RID, label: String, maxStates: Int32, defaultState: Int32, callback: Callable = Callable(), keyCallback: Callable = Callable(), tag: Variant, accelerator: Key = .none, index: Int32 = -1) -> Int32 Adds a new item with text label to the global menu rid.
static func addRadioCheckItem(rid: RID, label: String, callback: Callable = Callable(), keyCallback: Callable = Callable(), tag: Variant, accelerator: Key = .none, index: Int32 = -1) -> Int32 Adds a new radio-checkable item with text label to the global menu rid.
static func addSeparator(rid: RID, index: Int32 = -1) -> Int32 Adds a separator between items to the global menu rid. Separators also occupy an index.
static func addSubmenuItem(rid: RID, label: String, submenuRid: RID, tag: Variant, index: Int32 = -1) -> Int32 Adds an item that will act as a submenu of the global menu rid. The submenuRid argument is the RID of the global menu that will be shown when the item is clicked.
static func clear(rid: RID) Removes all items from the global menu rid.
static func findItemIndexWithSubmenu(rid: RID, submenuRid: RID) -> Int32 Returns the index of the item with the submenu specified by submenuRid. Indices are automatically assigned to each item by the engine, and cannot be set manually.
static func findItemIndexWithTag(rid: RID, tag: Variant) -> Int32 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.
static func findItemIndexWithText(rid: RID, text: String) -> Int32 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.
static func getItemAccelerator(rid: RID, idx: Int32) -> 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.
static func getItemCallback(rid: RID, idx: Int32) -> Callable Returns the callback of the item at index idx.
static func getItemCount(rid: RID) -> Int32 Returns number of items in the global menu rid.
static func getItemIcon(rid: RID, idx: Int32) -> Texture2D? Returns the icon of the item at index idx.
static func getItemIndentationLevel(rid: RID, idx: Int32) -> Int32 Returns the horizontal offset of the item at the given idx.
static func getItemKeyCallback(rid: RID, idx: Int32) -> Callable Returns the callback of the item accelerator at index idx.
static func getItemMaxStates(rid: RID, idx: Int32) -> Int32 Returns number of states of a multistate item. See addMultistateItem(rid:label:maxStates:defaultState:callback:keyCallback:tag:accelerator:index:) for details.
static func getItemState(rid: RID, idx: Int32) -> Int32 Returns the state of a multistate item. See addMultistateItem(rid:label:maxStates:defaultState:callback:keyCallback:tag:accelerator:index:) for details.
static func getItemSubmenu(rid: RID, idx: Int32) -> RID Returns the submenu ID of the item at index idx. See addSubmenuItem(rid:label:submenuRid:tag:index:) for more info on how to add a submenu.
static func getItemTag(rid: RID, idx: Int32) -> Variant Returns the metadata of the specified item, which might be of any type. You can set it with setItemTag(rid:idx:tag:), which provides a simple way of assigning context data to items.
static func getItemText(rid: RID, idx: Int32) -> String Returns the text of the item at index idx.
static func getItemTooltip(rid: RID, idx: Int32) -> String Returns the tooltip associated with the specified index idx.
static func getMinimumWidth(rid: RID) -> Double Returns global menu minimum width.
static func getPopupCloseCallback(rid: RID) -> Callable Returns global menu close callback.
static func getPopupOpenCallback(rid: RID) -> Callable Returns global menu open callback.
static func getSize(rid: RID) -> Vector2 Returns global menu size.
static func getSystemMenu(menuId: NativeMenu.SystemMenus) -> RID Returns RID of a special system menu.
static func getSystemMenuName(menuId: NativeMenu.SystemMenus) -> String Returns readable name of a special system menu.
static func hasFeature(_ feature: NativeMenu.Feature) -> Bool Returns true if the specified feature is supported by the current NativeMenu, false otherwise.
static func hasMenu(rid: RID) -> Bool Returns true if rid is valid global menu.
static func hasSystemMenu(menuId: NativeMenu.SystemMenus) -> Bool Returns true if a special system menu is supported.
static func isItemCheckable(rid: RID, idx: Int32) -> Bool Returns true if the item at index idx is checkable in some way, i.e. if it has a checkbox or radio button.
static func isItemChecked(rid: RID, idx: Int32) -> Bool Returns true if the item at index idx is checked.
static func isItemDisabled(rid: RID, idx: Int32) -> Bool Returns true if the item at index idx is disabled. When it is disabled it can’t be selected, or its action invoked.
static func isItemHidden(rid: RID, idx: Int32) -> Bool Returns true if the item at index idx is hidden.
static func isItemRadioCheckable(rid: RID, idx: Int32) -> Bool Returns true if the item at index idx has radio button-style checkability.
static func isOpened(rid: RID) -> Bool Returns true if the menu is currently opened.
static func isSystemMenu(rid: RID) -> Bool Return true is global menu is a special system menu.
static func popup(rid: RID, position: Vector2i) Shows the global menu at position in the screen coordinates.
static func removeItem(rid: RID, idx: Int32) Removes the item at index idx from the global menu rid.
static func setInterfaceDirection(rid: RID, isRtl: Bool) Sets the menu text layout direction from right-to-left if isRtl is true.
static func setItemAccelerator(rid: RID, idx: Int32, 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 ([kbd]Ctrl + A[/kbd]).
static func setItemCallback(rid: RID, idx: Int32, callback: Callable) Sets the callback of the item at index idx. Callback is emitted when an item is pressed.
static func setItemCheckable(rid: RID, idx: Int32, checkable: Bool) Sets whether the item at index idx has a checkbox. If false, sets the type of the item to plain text.
static func setItemChecked(rid: RID, idx: Int32, checked: Bool) Sets the checkstate status of the item at index idx.
static func setItemDisabled(rid: RID, idx: Int32, 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.
static func setItemHidden(rid: RID, idx: Int32, 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.
static func setItemHoverCallbacks(rid: RID, idx: Int32, callback: Callable) Sets the callback of the item at index idx. The callback is emitted when an item is hovered.
static func setItemIcon(rid: RID, idx: Int32, icon: Texture2D?) Replaces the Texture2D icon of the specified idx.
static func setItemIndentationLevel(rid: RID, idx: Int32, level: Int32) Sets the horizontal offset of the item at the given idx.
static func setItemKeyCallback(rid: RID, idx: Int32, keyCallback: Callable) Sets the callback of the item at index idx. Callback is emitted when its accelerator is activated.
static func setItemMaxStates(rid: RID, idx: Int32, maxStates: Int32) Sets number of state of a multistate item. See addMultistateItem(rid:label:maxStates:defaultState:callback:keyCallback:tag:accelerator:index:) for details.
static func setItemRadioCheckable(rid: RID, idx: Int32, 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.
static func setItemState(rid: RID, idx: Int32, state: Int32) Sets the state of a multistate item. See addMultistateItem(rid:label:maxStates:defaultState:callback:keyCallback:tag:accelerator:index:) for details.
static func setItemSubmenu(rid: RID, idx: Int32, submenuRid: 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.
static func setItemTag(rid: RID, idx: Int32, tag: Variant) Sets the metadata of an item, which may be of any type. You can later get it with getItemTag(rid:idx:), which provides a simple way of assigning context data to items.
static func setItemText(rid: RID, idx: Int32, text: String) Sets the text of the item at index idx.
static func setItemTooltip(rid: RID, idx: Int32, tooltip: String) Sets the String tooltip of the item at the specified index idx.
static func setMinimumWidth(rid: RID, width: Double) Sets the minimum width of the global menu.
static func setPopupCloseCallback(rid: RID, callback: Callable) Registers callable to emit when the menu is about to show.
static func setPopupOpenCallback(rid: RID, callback: Callable) Registers callable to emit after the menu is closed.
override class var godotClassName: StringName { get }enum Featureenum SystemMenus