Struct PopupMenu

PopupMenu displays a list of options.


					
			struct PopupMenu
			;

PopupMenu is a Control that displays a list of options. They are popular in toolbars or context menus.

Properties

Name	Type	Description
`allowSearch`[get, set]	`bool`	If `true`, allows to navigate `PopupMenu` with letter keys.
`hideOnCheckableItemSelection`[get, set]	`bool`	If `true`, hides the `PopupMenu` when a checkbox or radio button is selected.
`hideOnItemSelection`[get, set]	`bool`	If `true`, hides the `PopupMenu` when an item is selected.
`hideOnStateItemSelection`[get, set]	`bool`	If `true`, hides the `PopupMenu` when a state item is selected.
`items`[get, set]	`Array`
`submenuPopupDelay`[get, set]	`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.

Methods

Name	Description
`_getItems`
`_guiInput`
`_setItems`
`_submenuTimeout`
`addCheckItem`	Adds a new checkable item with text `label`. An `id` can optionally be provided, as well as an accelerator (`accel`). If no `id` is provided, one will be created from the index. If no `accel` is provided then the default `0` will be assigned to it. See `getItemAccelerator` for more info on accelerators. Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See `setItemChecked` for more info on how to control it.
`addCheckShortcut`	Adds a new checkable item and assigns the specified `ShortCut` to it. Sets the label of the checkbox to the `ShortCut`'s name. An `id` can optionally be provided. If no `id` is provided, one will be created from the index. Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See `setItemChecked` for more info on how to control it.
`addIconCheckItem`	Adds a new checkable item with text `label` and icon `texture`. An `id` can optionally be provided, as well as an accelerator (`accel`). If no `id` is provided, one will be created from the index. If no `accel` is provided then the default `0` will be assigned to it. See `getItemAccelerator` for more info on accelerators. Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See `setItemChecked` for more info on how to control it.
`addIconCheckShortcut`	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. An `id` can optionally be provided. If no `id` is provided, one will be created from the index. Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See `setItemChecked` for more info on how to control it.
`addIconItem`	Adds a new item with text `label` and icon `texture`. An `id` can optionally be provided, as well as an accelerator (`accel`). If no `id` is provided, one will be created from the index. If no `accel` is provided then the default `0` will be assigned to it. See `getItemAccelerator` for more info on accelerators.
`addIconRadioCheckItem`	Same as `addIconCheckItem`, but uses a radio check button.
`addIconRadioCheckShortcut`	Same as `addIconCheckShortcut`, but uses a radio check button.
`addIconShortcut`	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. An `id` can optionally be provided. If no `id` is provided, one will be created from the index.
`addItem`	Adds a new item with text `label`. An `id` can optionally be provided, as well as an accelerator (`accel`). If no `id` is provided, one will be created from the index. If no `accel` is provided then the default `0` will be assigned to it. See `getItemAccelerator` for more info on accelerators.
`addMultistateItem`	Adds a new multistate item with text `label`. 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`. An `id` can optionally be provided, as well as an accelerator (`accel`). If no `id` is provided, one will be created from the index. If no `accel` is provided then the default `0` will be assigned to it. See `getItemAccelerator` for more info on accelerators.
`addRadioCheckItem`	Adds a new radio check button with text `label`. An `id` can optionally be provided, as well as an accelerator (`accel`). If no `id` is provided, one will be created from the index. If no `accel` is provided then the default `0` will be assigned to it. See `getItemAccelerator` for more info on accelerators. Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See `setItemChecked` for more info on how to control it.
`addRadioCheckShortcut`	Adds a new radio check button and assigns a `ShortCut` to it. Sets the label of the checkbox to the `ShortCut`'s name. An `id` can optionally be provided. If no `id` is provided, one will be created from the index. Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See `setItemChecked` for more info on how to control it.
`addSeparator`	Adds a separator between items. Separators also occupy an index.
`addShortcut`	Adds a `ShortCut`. An `id` can optionally be provided. If no `id` is provided, one will be created from the index.
`addSubmenuItem`	Adds an item that will act as a submenu of the parent `PopupMenu` node when clicked. The `submenu` argument is the name of the child `PopupMenu` node that will be shown when the item is clicked. An `id` can optionally be provided. If no `id` is provided, one will be created from the index.
`clear`	Removes all items from the `PopupMenu`.
`getAllowSearch`
`getItemAccelerator`	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.
`getItemCount`	Returns the number of items in the `PopupMenu`.
`getItemIcon`	Returns the icon of the item at index `idx`.
`getItemId`	Returns the id of the item at index `idx`. `id` can be manually assigned, while index can not.
`getItemIndex`	Returns the index of the item containing the specified `id`. Index is automatically assigned to each item by the engine. Index can not be set manually.
`getItemMetadata`	Returns the metadata of the specified item, which might be of any type. You can set it with `setItemMetadata`, which provides a simple way of assigning context data to items.
`getItemShortcut`	Returns the `ShortCut` associated with the specified `idx` item.
`getItemSubmenu`	Returns the submenu name of the item at index `idx`. See `addSubmenuItem` for more info on how to add a submenu.
`getItemText`	Returns the text of the item at index `idx`.
`getItemTooltip`	Returns the tooltip associated with the specified index index `idx`.
`getSubmenuPopupDelay`
`isHideOnCheckableItemSelection`
`isHideOnItemSelection`
`isHideOnStateItemSelection`
`isHideOnWindowLoseFocus`	Returns `true` if the popup will be hidden when the window loses focus or not.
`isItemCheckable`	Returns `true` if the item at index `idx` is checkable in some way, i.e. if it has a checkbox or radio button. Note: Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.
`isItemChecked`	Returns `true` if the item at index `idx` is checked.
`isItemDisabled`	Returns `true` if the item at index `idx` is disabled. When it is disabled it can't be selected, or its action invoked. See `setItemDisabled` for more info on how to disable an item.
`isItemRadioCheckable`	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.
`isItemSeparator`	Returns `true` if the item is a separator. If it is, it will be displayed as a line. See `addSeparator` for more info on how to add a separator.
`isItemShortcutDisabled`	Returns `true` if the specified item's shortcut is disabled.
`removeItem`	Removes the item at index `idx` from the menu. Note: The indices of items after the removed item will be shifted by one.
`setAllowSearch`
`setHideOnCheckableItemSelection`
`setHideOnItemSelection`
`setHideOnStateItemSelection`
`setHideOnWindowLoseFocus`	Hides the `PopupMenu` when the window loses focus.
`setItemAccelerator`	Sets the accelerator of the item at index `idx`. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
`setItemAsCheckable`	Sets whether the item at index `idx` has a checkbox. If `false`, sets the type of the item to plain text. Note: Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
`setItemAsRadioCheckable`	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.
`setItemAsSeparator`	Mark the item at index `idx` as a separator, which means that it would be displayed as a line. If `false`, sets the type of the item to plain text.
`setItemChecked`	Sets the checkstate status of the item at index `idx`.
`setItemDisabled`	Enables/disables the item at index `idx`. When it is disabled, it can't be selected and its action can't be invoked.
`setItemIcon`	Replaces the `Texture` icon of the specified `idx`.
`setItemId`	Sets the `id` of the item at index `idx`.
`setItemMetadata`	Sets the metadata of an item, which may be of any type. You can later get it with `getItemMetadata`, which provides a simple way of assigning context data to items.
`setItemMultistate`	Sets the state of an multistate item. See `addMultistateItem` for details.
`setItemShortcut`	Sets a `ShortCut` for the specified item `idx`.
`setItemShortcutDisabled`	Disables the `ShortCut` of the specified index `idx`.
`setItemSubmenu`	Sets the submenu of the item at index `idx`. The submenu is the name of a child `PopupMenu` node that would be shown when the item is clicked.
`setItemText`	Sets the text of the item at index `idx`.
`setItemTooltip`	Sets the `String` tooltip of the item at the specified index `idx`.
`setSubmenuPopupDelay`
`toggleItemChecked`	Toggles the check state of the item of the specified index `idx`.
`toggleItemMultistate`	Cycle to the next state of an multistate item. See `addMultistateItem` for details.

Authors
Copyright	Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md) Copyright (c) 2017-2018 Godot-D contributors
License	MIT License

Generated using the DDOX documentation generator