PopupMenu

Conformances

• protocol CustomStringConvertible

  A type with a customized textual representation.

• protocol Equatable

  A type that can be compared for value equality.

• protocol Hashable

  A 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

  Types 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 VariantStorable

  Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Types

• class Signal1

  Signal support.

• class Signal2

  Signal support.

• class Signal3

  Signal support.

Type members

• class var godotClassName: StringName

Instance members

• var allowSearch: Bool

  If true, allows navigating PopupMenu with letter keys.

• var hideOnCheckableItemSelection: Bool

  If true, hides the PopupMenu when a checkbox or radio button is selected.

• var hideOnItemSelection: Bool

  If true, hides the PopupMenu when an item is selected.

• var hideOnStateItemSelection: Bool

  If true, hides the PopupMenu when a state item is selected.

• var idFocused: Signal2

  Emitted when the user navigated to an item of some id using the ProjectSettings/input/uiUp or ProjectSettings/input/uiDown input action.

• var idPressed: Signal1

  Emitted when an item of some id is pressed or its accelerator is activated.

• var indexPressed: Signal3

  Emitted when an item of some index is pressed or its accelerator is activated.

• var itemCount: Int32

  The number of items currently in the list.

• var menuChanged: SimpleSignal

  Emitted when any item is added, modified or removed.

• var submenuPopupDelay: Double

  Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item.

• func activateItemByEvent(InputEvent?, forGlobalOnly: Bool) -> Bool

  Checks the provided event against the PopupMenu’s shortcuts and accelerators, and activates the first item with matching events. If forGlobalOnly is true, only shortcuts and accelerators with global set to true will be called.

• func addCheckItem(label: String, id: Int32, accel: Key)

  Adds a new checkable item with text label.

• func addCheckShortcut(Shortcut?, id: Int32, global: Bool)

  Adds a new checkable item and assigns the specified Shortcut to it. Sets the label of the checkbox to the Shortcut’s name.

• func addIconCheckItem(texture: Texture2D?, label: String, id: Int32, accel: Key)

  Adds a new checkable item with text label and icon texture.

• func addIconCheckShortcut(texture: Texture2D?, shortcut: Shortcut?, id: Int32, global: Bool)

  Adds a new checkable item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut’s name.

• func addIconItem(texture: Texture2D?, label: String, id: Int32, accel: Key)

  Adds a new item with text label and icon texture.

• func addIconRadioCheckItem(texture: Texture2D?, label: String, id: Int32, accel: Key)

  Same as addIconCheckItem(texture:label:id:accel:), but uses a radio check button.

• func addIconRadioCheckShortcut(texture: Texture2D?, shortcut: Shortcut?, id: Int32, global: Bool)

  Same as addIconCheckShortcut(texture:shortcut:id:global:), but uses a radio check button.

• func addIconShortcut(texture: Texture2D?, shortcut: Shortcut?, id: Int32, global: Bool, allowEcho: Bool)

  Adds a new item and assigns the specified Shortcut and icon texture to it. Sets the label of the checkbox to the Shortcut’s name.

• func addItem(label: String, id: Int32, accel: Key)

  Adds a new item with text label.

• func addMultistateItem(label: String, maxStates: Int32, defaultState: Int32, id: Int32, accel: Key)

  Adds a new multistate item with text label.

• func addRadioCheckItem(label: String, id: Int32, accel: Key)

  Adds a new radio check button with text label.

• func addRadioCheckShortcut(Shortcut?, id: Int32, global: Bool)

  Adds a new radio check button and assigns a Shortcut to it. Sets the label of the checkbox to the Shortcut’s name.

• func addSeparator(label: String, id: Int32)

  Adds a separator between items. Separators also occupy an index, which you can set by using the id parameter.

• func addShortcut(Shortcut?, id: Int32, global: Bool, allowEcho: Bool)

  Adds a Shortcut.

• func addSubmenuItem(label: String, submenu: String, id: Int32)

  Adds an item that will act as a submenu of the parent PopupMenu node when clicked. The submenu argument must be the name of an existing PopupMenu that has been added as a child to this node. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ui_select or ui_right input actions.

• func clear(freeSubmenus: Bool)

  Removes all items from the PopupMenu. If freeSubmenus is true, the submenu nodes are automatically freed.

• func getFocusedItem() -> Int32

  Returns the index of the currently focused item. Returns -1 if no item is focused.

• func getItemAccelerator(index: Int32) -> Key

  Returns the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it’s not currently open. The return value is an integer which is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). If no accelerator is defined for the specified index, getItemAccelerator(index:) returns 0 (corresponding to @GlobalScope.KEY_NONE).

• func getItemIcon(index: Int32) -> Texture2D?

  Returns the icon of the item at the given index.

• func getItemIconMaxWidth(index: Int32) -> Int32

  Returns the maximum allowed width of the icon for the item at the given index.

• func getItemIconModulate(index: Int32) -> Color

  Returns a Color modulating the item’s icon at the given index.

• func getItemId(index: Int32) -> Int32

  Returns the ID of the item at the given index. id can be manually assigned, while index can not.

• func getItemIndent(index: Int32) -> Int32

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

• func getItemIndex(id: Int32) -> Int32

  Returns the index of the item containing the specified id. Index is automatically assigned to each item by the engine and can not be set manually.

• func getItemLanguage(index: Int32) -> String

  Returns item’s text language code.

• func getItemMetadata(index: Int32) -> Variant

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

• func getItemShortcut(index: Int32) -> Shortcut?

  Returns the Shortcut associated with the item at the given index.

• func getItemSubmenu(index: Int32) -> String

  Returns the submenu name of the item at the given index. See addSubmenuItem(label:submenu:id:) for more info on how to add a submenu.

• func getItemText(index: Int32) -> String

  Returns the text of the item at the given index.

• func getItemTextDirection(index: Int32) -> Control.TextDirection

  Returns item’s text base writing direction.

• func getItemTooltip(index: Int32) -> String

  Returns the tooltip associated with the item at the given index.

• func isItemCheckable(index: Int32) -> Bool

  Returns true if the item at the given index is checkable in some way, i.e. if it has a checkbox or radio button.

• func isItemChecked(index: Int32) -> Bool

  Returns true if the item at the given index is checked.

• func isItemDisabled(index: Int32) -> Bool

  Returns true if the item at the given index is disabled. When it is disabled it can’t be selected, or its action invoked.

• func isItemRadioCheckable(index: Int32) -> Bool

  Returns true if the item at the given index has radio button-style checkability.

• func isItemSeparator(index: Int32) -> Bool

  Returns true if the item is a separator. If it is, it will be displayed as a line. See addSeparator(label:id:) for more info on how to add a separator.

• func isItemShortcutDisabled(index: Int32) -> Bool

  Returns true if the specified item’s shortcut is disabled.

• func removeItem(index: Int32)

  Removes the item at the given index from the menu.

• func scrollToItem(index: Int32)

  Moves the scroll view to make the item at the given index visible.

• func setFocusedItem(index: Int32)

  Sets the currently focused item as the given index.

• func setItemAccelerator(index: Int32, accel: Key)

  Sets the accelerator of the item at the given index. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it’s not currently open. accel is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]).

• func setItemAsCheckable(index: Int32, enable: Bool)

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

• func setItemAsRadioCheckable(index: Int32, enable: Bool)

  Sets the type of the item at the given index to radio button. If false, sets the type of the item to plain text.

• func setItemAsSeparator(index: Int32, enable: Bool)

  Mark the item at the given index as a separator, which means that it would be displayed as a line. If false, sets the type of the item to plain text.

• func setItemChecked(index: Int32, checked: Bool)

  Sets the checkstate status of the item at the given index.

• func setItemDisabled(index: Int32, disabled: Bool)

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

• func setItemIcon(index: Int32, icon: Texture2D?)

  Replaces the Texture2D icon of the item at the given index.

• func setItemIconMaxWidth(index: Int32, width: Int32)

  Sets the maximum allowed width of the icon for the item at the given index. This limit is applied on top of the default size of the icon and on top of [theme_item icon_max_width]. The height is adjusted according to the icon’s ratio.

• func setItemIconModulate(index: Int32, modulate: Color)

  Sets a modulating Color of the item’s icon at the given index.

• func setItemId(index: Int32, id: Int32)

  Sets the id of the item at the given index.

• func setItemIndent(index: Int32, indent: Int32)

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

• func setItemLanguage(index: Int32, language: String)

  Sets language code of item’s text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

• func setItemMetadata(index: Int32, metadata: Variant)

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

• func setItemMultistate(index: Int32, state: Int32)

  Sets the state of a multistate item. See addMultistateItem(label:maxStates:defaultState:id:accel:) for details.

• func setItemShortcut(index: Int32, shortcut: Shortcut?, global: Bool)

  Sets a Shortcut for the item at the given index.

• func setItemShortcutDisabled(index: Int32, disabled: Bool)

  Disables the Shortcut of the item at the given index.

• func setItemSubmenu(index: Int32, submenu: String)

  Sets the submenu of the item at the given index. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.

• func setItemText(index: Int32, text: String)

  Sets the text of the item at the given index.

• func setItemTextDirection(index: Int32, direction: Control.TextDirection)

  Sets item’s text base writing direction.

• func setItemTooltip(index: Int32, tooltip: String)

  Sets the String tooltip of the item at the given index.

• func toggleItemChecked(index: Int32)

  Toggles the check state of the item at the given index.

• func toggleItemMultistate(index: Int32)

  Cycle to the next state of a multistate item. See addMultistateItem(label:maxStates:defaultState:id:accel:) for details.