655 lines
32 KiB
XML
655 lines
32 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="PopupMenu" inherits="Popup" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
PopupMenu displays a list of options.
|
|
</brief_description>
|
|
<description>
|
|
[PopupMenu] is a modal window used to display a list of options. They are popular in toolbars or context menus.
|
|
The size of a [PopupMenu] can be limited by using [member Window.max_size]. If the height of the list of items is larger than the maximum height of the [PopupMenu], a [ScrollContainer] within the popup will allow the user to scroll the contents.
|
|
If no maximum size is set, or if it is set to 0, the [PopupMenu] height will be limited by its parent rect.
|
|
All [code]set_*[/code] methods allow negative item index, which makes the item accessed from the last one.
|
|
[b]Incremental search:[/b] Like [ItemList] and [Tree], [PopupMenu] supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing [member ProjectSettings.gui/timers/incremental_search_max_interval_msec].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_check_item">
|
|
<return type="void" />
|
|
<param index="0" name="label" type="String" />
|
|
<param index="1" name="id" type="int" default="-1" />
|
|
<param index="2" name="accel" type="int" enum="Key" default="0" />
|
|
<description>
|
|
Adds a new checkable item with text [param label].
|
|
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
|
|
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
|
|
</description>
|
|
</method>
|
|
<method name="add_check_shortcut">
|
|
<return type="void" />
|
|
<param index="0" name="shortcut" type="Shortcut" />
|
|
<param index="1" name="id" type="int" default="-1" />
|
|
<param index="2" name="global" type="bool" default="false" />
|
|
<description>
|
|
Adds a new checkable item and assigns the specified [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name.
|
|
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
|
|
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
|
|
</description>
|
|
</method>
|
|
<method name="add_icon_check_item">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="label" type="String" />
|
|
<param index="2" name="id" type="int" default="-1" />
|
|
<param index="3" name="accel" type="int" enum="Key" default="0" />
|
|
<description>
|
|
Adds a new checkable item with text [param label] and icon [param texture].
|
|
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
|
|
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
|
|
</description>
|
|
</method>
|
|
<method name="add_icon_check_shortcut">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="shortcut" type="Shortcut" />
|
|
<param index="2" name="id" type="int" default="-1" />
|
|
<param index="3" name="global" type="bool" default="false" />
|
|
<description>
|
|
Adds a new checkable item and assigns the specified [Shortcut] and icon [param texture] to it. Sets the label of the checkbox to the [Shortcut]'s name.
|
|
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
|
|
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
|
|
</description>
|
|
</method>
|
|
<method name="add_icon_item">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="label" type="String" />
|
|
<param index="2" name="id" type="int" default="-1" />
|
|
<param index="3" name="accel" type="int" enum="Key" default="0" />
|
|
<description>
|
|
Adds a new item with text [param label] and icon [param texture].
|
|
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
|
|
</description>
|
|
</method>
|
|
<method name="add_icon_radio_check_item">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="label" type="String" />
|
|
<param index="2" name="id" type="int" default="-1" />
|
|
<param index="3" name="accel" type="int" enum="Key" default="0" />
|
|
<description>
|
|
Same as [method add_icon_check_item], but uses a radio check button.
|
|
</description>
|
|
</method>
|
|
<method name="add_icon_radio_check_shortcut">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="shortcut" type="Shortcut" />
|
|
<param index="2" name="id" type="int" default="-1" />
|
|
<param index="3" name="global" type="bool" default="false" />
|
|
<description>
|
|
Same as [method add_icon_check_shortcut], but uses a radio check button.
|
|
</description>
|
|
</method>
|
|
<method name="add_icon_shortcut">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="shortcut" type="Shortcut" />
|
|
<param index="2" name="id" type="int" default="-1" />
|
|
<param index="3" name="global" type="bool" default="false" />
|
|
<description>
|
|
Adds a new item and assigns the specified [Shortcut] and icon [param texture] to it. Sets the label of the checkbox to the [Shortcut]'s name.
|
|
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
|
|
</description>
|
|
</method>
|
|
<method name="add_item">
|
|
<return type="void" />
|
|
<param index="0" name="label" type="String" />
|
|
<param index="1" name="id" type="int" default="-1" />
|
|
<param index="2" name="accel" type="int" enum="Key" default="0" />
|
|
<description>
|
|
Adds a new item with text [param label].
|
|
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
|
|
[b]Note:[/b] The provided [param id] is used only in [signal id_pressed] and [signal id_focused] signals. It's not related to the [code]index[/code] arguments in e.g. [method set_item_checked].
|
|
</description>
|
|
</method>
|
|
<method name="add_multistate_item">
|
|
<return type="void" />
|
|
<param index="0" name="label" type="String" />
|
|
<param index="1" name="max_states" type="int" />
|
|
<param index="2" name="default_state" type="int" default="0" />
|
|
<param index="3" name="id" type="int" default="-1" />
|
|
<param index="4" name="accel" type="int" enum="Key" default="0" />
|
|
<description>
|
|
Adds a new multistate item with text [param label].
|
|
Contrarily to normal binary items, multistate items can have more than two states, as defined by [param max_states]. Each press or activate of the item will increase the state by one. The default value is defined by [param default_state].
|
|
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
|
|
</description>
|
|
</method>
|
|
<method name="add_radio_check_item">
|
|
<return type="void" />
|
|
<param index="0" name="label" type="String" />
|
|
<param index="1" name="id" type="int" default="-1" />
|
|
<param index="2" name="accel" type="int" enum="Key" default="0" />
|
|
<description>
|
|
Adds a new radio check button with text [param label].
|
|
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
|
|
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
|
|
</description>
|
|
</method>
|
|
<method name="add_radio_check_shortcut">
|
|
<return type="void" />
|
|
<param index="0" name="shortcut" type="Shortcut" />
|
|
<param index="1" name="id" type="int" default="-1" />
|
|
<param index="2" name="global" type="bool" default="false" />
|
|
<description>
|
|
Adds a new radio check button and assigns a [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name.
|
|
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
|
|
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
|
|
</description>
|
|
</method>
|
|
<method name="add_separator">
|
|
<return type="void" />
|
|
<param index="0" name="label" type="String" default="""" />
|
|
<param index="1" name="id" type="int" default="-1" />
|
|
<description>
|
|
Adds a separator between items. Separators also occupy an index, which you can set by using the [param id] parameter.
|
|
A [param label] can optionally be provided, which will appear at the center of the separator.
|
|
</description>
|
|
</method>
|
|
<method name="add_shortcut">
|
|
<return type="void" />
|
|
<param index="0" name="shortcut" type="Shortcut" />
|
|
<param index="1" name="id" type="int" default="-1" />
|
|
<param index="2" name="global" type="bool" default="false" />
|
|
<description>
|
|
Adds a [Shortcut].
|
|
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
|
|
</description>
|
|
</method>
|
|
<method name="add_submenu_item">
|
|
<return type="void" />
|
|
<param index="0" name="label" type="String" />
|
|
<param index="1" name="submenu" type="String" />
|
|
<param index="2" name="id" type="int" default="-1" />
|
|
<description>
|
|
Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [param submenu] argument is the name of the child [PopupMenu] node that will be shown when the item is clicked.
|
|
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
|
|
</description>
|
|
</method>
|
|
<method name="clear">
|
|
<return type="void" />
|
|
<description>
|
|
Removes all items from the [PopupMenu].
|
|
</description>
|
|
</method>
|
|
<method name="get_focused_item" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the index of the currently focused item. Returns [code]-1[/code] if no item is focused.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_accelerator" qualifiers="const">
|
|
<return type="int" enum="Key" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the accelerator of the item at the given [param index]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_icon" qualifiers="const">
|
|
<return type="Texture2D" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the icon of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="get_item_id" qualifiers="const">
|
|
<return type="int" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the ID of the item at the given [param index]. [code]id[/code] can be manually assigned, while index can not.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_indent" qualifiers="const">
|
|
<return type="int" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the horizontal offset of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="get_item_index" qualifiers="const">
|
|
<return type="int" />
|
|
<param index="0" name="id" type="int" />
|
|
<description>
|
|
Returns the index of the item containing the specified [param id]. Index is automatically assigned to each item by the engine and can not be set manually.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_language" qualifiers="const">
|
|
<return type="String" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns item's text language code.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_metadata" qualifiers="const">
|
|
<return type="Variant" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the metadata of the specified item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_shortcut" qualifiers="const">
|
|
<return type="Shortcut" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the [Shortcut] associated with the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="get_item_submenu" qualifiers="const">
|
|
<return type="String" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the submenu name of the item at the given [param index]. See [method add_submenu_item] for more info on how to add a submenu.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_text" qualifiers="const">
|
|
<return type="String" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the text of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="get_item_text_direction" qualifiers="const">
|
|
<return type="int" enum="Control.TextDirection" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns item's text base writing direction.
|
|
</description>
|
|
</method>
|
|
<method name="get_item_tooltip" qualifiers="const">
|
|
<return type="String" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns the tooltip associated with the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="is_item_checkable" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if the item at the given [param index] is checkable in some way, i.e. if it has a checkbox or radio button.
|
|
[b]Note:[/b] Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.
|
|
</description>
|
|
</method>
|
|
<method name="is_item_checked" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if the item at the given [param index] is checked.
|
|
</description>
|
|
</method>
|
|
<method name="is_item_disabled" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if the item at the given [param index] is disabled. When it is disabled it can't be selected, or its action invoked.
|
|
See [method set_item_disabled] for more info on how to disable an item.
|
|
</description>
|
|
</method>
|
|
<method name="is_item_radio_checkable" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if the item at the given [param index] has radio button-style checkability.
|
|
[b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
|
|
</description>
|
|
</method>
|
|
<method name="is_item_separator" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if the item is a separator. If it is, it will be displayed as a line. See [method add_separator] for more info on how to add a separator.
|
|
</description>
|
|
</method>
|
|
<method name="is_item_shortcut_disabled" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if the specified item's shortcut is disabled.
|
|
</description>
|
|
</method>
|
|
<method name="remove_item">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Removes the item at the given [param index] from the menu.
|
|
[b]Note:[/b] The indices of items after the removed item will be shifted by one.
|
|
</description>
|
|
</method>
|
|
<method name="scroll_to_item">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Moves the scroll view to make the item at the given [param index] visible.
|
|
</description>
|
|
</method>
|
|
<method name="set_focused_item">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Sets the currently focused item as the given [param index].
|
|
Passing [code]-1[/code] as the index makes so that no item is focused.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_accelerator">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="accel" type="int" enum="Key" />
|
|
<description>
|
|
Sets the accelerator of the item at the given [param index]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_as_checkable">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="enable" type="bool" />
|
|
<description>
|
|
Sets whether the item at the given [param index] has a checkbox. If [code]false[/code], sets the type of the item to plain text.
|
|
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_as_radio_checkable">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="enable" type="bool" />
|
|
<description>
|
|
Sets the type of the item at the given [param index] to radio button. If [code]false[/code], sets the type of the item to plain text.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_as_separator">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="enable" type="bool" />
|
|
<description>
|
|
Mark the item at the given [param index] as a separator, which means that it would be displayed as a line. If [code]false[/code], sets the type of the item to plain text.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_checked">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="checked" type="bool" />
|
|
<description>
|
|
Sets the checkstate status of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="set_item_disabled">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="disabled" type="bool" />
|
|
<description>
|
|
Enables/disables the item at the given [param index]. When it is disabled, it can't be selected and its action can't be invoked.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_icon">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="icon" type="Texture2D" />
|
|
<description>
|
|
Replaces the [Texture2D] icon of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="set_item_id">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="id" type="int" />
|
|
<description>
|
|
Sets the [param id] of the item at the given [param index].
|
|
The [param id] is used in [signal id_pressed] and [signal id_focused] signals.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_indent">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="indent" type="int" />
|
|
<description>
|
|
Sets the horizontal offset of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="set_item_language">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_metadata">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="metadata" type="Variant" />
|
|
<description>
|
|
Sets the metadata of an item, which may be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_multistate">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="state" type="int" />
|
|
<description>
|
|
Sets the state of a multistate item. See [method add_multistate_item] for details.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_shortcut">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="shortcut" type="Shortcut" />
|
|
<param index="2" name="global" type="bool" default="false" />
|
|
<description>
|
|
Sets a [Shortcut] for the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="set_item_shortcut_disabled">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="disabled" type="bool" />
|
|
<description>
|
|
Disables the [Shortcut] of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="set_item_submenu">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="submenu" type="String" />
|
|
<description>
|
|
Sets the submenu of the item at the given [param index]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_text">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="text" type="String" />
|
|
<description>
|
|
Sets the text of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="set_item_text_direction">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="direction" type="int" enum="Control.TextDirection" />
|
|
<description>
|
|
Sets item's text base writing direction.
|
|
</description>
|
|
</method>
|
|
<method name="set_item_tooltip">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<param index="1" name="tooltip" type="String" />
|
|
<description>
|
|
Sets the [String] tooltip of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="toggle_item_checked">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Toggles the check state of the item at the given [param index].
|
|
</description>
|
|
</method>
|
|
<method name="toggle_item_multistate">
|
|
<return type="void" />
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Cycle to the next state of a multistate item. See [method add_multistate_item] for details.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="allow_search" type="bool" setter="set_allow_search" getter="get_allow_search" default="true">
|
|
If [code]true[/code], allows navigating [PopupMenu] with letter keys.
|
|
</member>
|
|
<member name="hide_on_checkable_item_selection" type="bool" setter="set_hide_on_checkable_item_selection" getter="is_hide_on_checkable_item_selection" default="true">
|
|
If [code]true[/code], hides the [PopupMenu] when a checkbox or radio button is selected.
|
|
</member>
|
|
<member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection" default="true">
|
|
If [code]true[/code], hides the [PopupMenu] when an item is selected.
|
|
</member>
|
|
<member name="hide_on_state_item_selection" type="bool" setter="set_hide_on_state_item_selection" getter="is_hide_on_state_item_selection" default="false">
|
|
If [code]true[/code], hides the [PopupMenu] when a state item is selected.
|
|
</member>
|
|
<member name="item_count" type="int" setter="set_item_count" getter="get_item_count" default="0">
|
|
The number of items currently in the list.
|
|
</member>
|
|
<member name="submenu_popup_delay" type="float" setter="set_submenu_popup_delay" getter="get_submenu_popup_delay" default="0.3">
|
|
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.
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="id_focused">
|
|
<param index="0" name="id" type="int" />
|
|
<description>
|
|
Emitted when the user navigated to an item of some [param id] using the [member ProjectSettings.input/ui_up] or [member ProjectSettings.input/ui_down] input action.
|
|
</description>
|
|
</signal>
|
|
<signal name="id_pressed">
|
|
<param index="0" name="id" type="int" />
|
|
<description>
|
|
Emitted when an item of some [param id] is pressed or its accelerator is activated.
|
|
[b]Note:[/b] If [param id] is negative (either explicitly or due to overflow), this will return the corresponding index instead.
|
|
</description>
|
|
</signal>
|
|
<signal name="index_pressed">
|
|
<param index="0" name="index" type="int" />
|
|
<description>
|
|
Emitted when an item of some [param index] is pressed or its accelerator is activated.
|
|
</description>
|
|
</signal>
|
|
<signal name="menu_changed">
|
|
<description>
|
|
Emitted when any item is added, modified or removed.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<theme_items>
|
|
<theme_item name="font_accelerator_color" data_type="color" type="Color" default="Color(0.7, 0.7, 0.7, 0.8)">
|
|
The text [Color] used for shortcuts and accelerators that show next to the menu item name when defined. See [method get_item_accelerator] for more info on accelerators.
|
|
</theme_item>
|
|
<theme_item name="font_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
|
|
The default text [Color] for menu items' names.
|
|
</theme_item>
|
|
<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.4, 0.4, 0.4, 0.8)">
|
|
[Color] used for disabled menu items' text.
|
|
</theme_item>
|
|
<theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
|
|
[Color] used for the hovered text.
|
|
</theme_item>
|
|
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
|
|
The tint of text outline of the menu item.
|
|
</theme_item>
|
|
<theme_item name="font_separator_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
|
|
[Color] used for labeled separators' text. See [method add_separator].
|
|
</theme_item>
|
|
<theme_item name="font_separator_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
|
|
The tint of text outline of the labeled separator.
|
|
</theme_item>
|
|
<theme_item name="h_separation" data_type="constant" type="int" default="4">
|
|
The horizontal space between the item's elements.
|
|
</theme_item>
|
|
<theme_item name="indent" data_type="constant" type="int" default="10">
|
|
Width of the single indentation level.
|
|
</theme_item>
|
|
<theme_item name="item_end_padding" data_type="constant" type="int" default="2">
|
|
Horizontal padding to the right of the items (or left, in RTL layout).
|
|
</theme_item>
|
|
<theme_item name="item_start_padding" data_type="constant" type="int" default="2">
|
|
Horizontal padding to the left of the items (or right, in RTL layout).
|
|
</theme_item>
|
|
<theme_item name="outline_size" data_type="constant" type="int" default="0">
|
|
The size of the item text outline.
|
|
</theme_item>
|
|
<theme_item name="separator_outline_size" data_type="constant" type="int" default="0">
|
|
The size of the labeled separator text outline.
|
|
</theme_item>
|
|
<theme_item name="v_separation" data_type="constant" type="int" default="4">
|
|
The vertical space between each menu item.
|
|
</theme_item>
|
|
<theme_item name="font" data_type="font" type="Font">
|
|
[Font] used for the menu items.
|
|
</theme_item>
|
|
<theme_item name="font_separator" data_type="font" type="Font">
|
|
[Font] used for the labeled separator.
|
|
</theme_item>
|
|
<theme_item name="font_separator_size" data_type="font_size" type="int">
|
|
Font size of the labeled separator.
|
|
</theme_item>
|
|
<theme_item name="font_size" data_type="font_size" type="int">
|
|
Font size of the menu items.
|
|
</theme_item>
|
|
<theme_item name="checked" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the checked checkbox items.
|
|
</theme_item>
|
|
<theme_item name="checked_disabled" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the checked checkbox items when they are disabled.
|
|
</theme_item>
|
|
<theme_item name="radio_checked" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the checked radio button items.
|
|
</theme_item>
|
|
<theme_item name="radio_checked_disabled" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the checked radio button items when they are disabled.
|
|
</theme_item>
|
|
<theme_item name="radio_unchecked" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the unchecked radio button items.
|
|
</theme_item>
|
|
<theme_item name="radio_unchecked_disabled" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the unchecked radio button items when they are disabled.
|
|
</theme_item>
|
|
<theme_item name="submenu" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the submenu arrow (for left-to-right layouts).
|
|
</theme_item>
|
|
<theme_item name="submenu_mirrored" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the submenu arrow (for right-to-left layouts).
|
|
</theme_item>
|
|
<theme_item name="unchecked" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the unchecked checkbox items.
|
|
</theme_item>
|
|
<theme_item name="unchecked_disabled" data_type="icon" type="Texture2D">
|
|
[Texture2D] icon for the unchecked checkbox items when they are disabled.
|
|
</theme_item>
|
|
<theme_item name="hover" data_type="style" type="StyleBox">
|
|
[StyleBox] displayed when the [PopupMenu] item is hovered.
|
|
</theme_item>
|
|
<theme_item name="labeled_separator_left" data_type="style" type="StyleBox">
|
|
[StyleBox] for the left side of labeled separator. See [method add_separator].
|
|
</theme_item>
|
|
<theme_item name="labeled_separator_right" data_type="style" type="StyleBox">
|
|
[StyleBox] for the right side of labeled separator. See [method add_separator].
|
|
</theme_item>
|
|
<theme_item name="panel" data_type="style" type="StyleBox">
|
|
Default [StyleBox] of the [PopupMenu] items.
|
|
</theme_item>
|
|
<theme_item name="panel_disabled" data_type="style" type="StyleBox">
|
|
[StyleBox] used when the [PopupMenu] item is disabled.
|
|
</theme_item>
|
|
<theme_item name="separator" data_type="style" type="StyleBox">
|
|
[StyleBox] used for the separators. See [method add_separator].
|
|
</theme_item>
|
|
</theme_items>
|
|
</class>
|