2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "PopupMenu" inherits= "Popup" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
PopupMenu displays a list of options.
</brief_description>
<description >
2019-06-19 19:35:00 +00:00
[PopupMenu] is a [Control] that displays a list of options. They are popular in toolbars or context menus.
2020-09-01 23:43:11 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_check_item" >
<return type= "void" >
</return>
<argument index= "0" name= "label" type= "String" >
</argument>
<argument index= "1" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "2" name= "accel" type= "int" default= "0" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Adds a new checkable item with text [code]label[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] 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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_check_shortcut" >
<return type= "void" >
</return>
2020-09-09 19:53:24 +00:00
<argument index= "0" name= "shortcut" type= "Shortcut" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "2" name= "global" type= "bool" default= "false" >
</argument>
<description >
2020-09-09 19:53:24 +00:00
Adds a new checkable item and assigns the specified [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name.
2019-06-19 19:35:00 +00:00
An [code]id[/code] can optionally be provided. If no [code]id[/code] 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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_icon_check_item" >
<return type= "void" >
</return>
2020-02-12 08:59:06 +00:00
<argument index= "0" name= "texture" type= "Texture2D" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "label" type= "String" >
</argument>
<argument index= "2" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "3" name= "accel" type= "int" default= "0" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] 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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_icon_check_shortcut" >
<return type= "void" >
</return>
2020-02-12 08:59:06 +00:00
<argument index= "0" name= "texture" type= "Texture2D" >
2017-09-12 20:42:36 +00:00
</argument>
2020-09-09 19:53:24 +00:00
<argument index= "1" name= "shortcut" type= "Shortcut" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "2" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "3" name= "global" type= "bool" default= "false" >
</argument>
<description >
2020-09-09 19:53:24 +00:00
Adds a new checkable item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name.
2019-06-19 19:35:00 +00:00
An [code]id[/code] can optionally be provided. If no [code]id[/code] 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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_icon_item" >
<return type= "void" >
</return>
2020-02-12 08:59:06 +00:00
<argument index= "0" name= "texture" type= "Texture2D" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "label" type= "String" >
</argument>
<argument index= "2" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "3" name= "accel" type= "int" default= "0" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Adds a new item with text [code]label[/code] and icon [code]texture[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-10-08 06:28:26 +00:00
<method name= "add_icon_radio_check_item" >
<return type= "void" >
</return>
2020-02-12 08:59:06 +00:00
<argument index= "0" name= "texture" type= "Texture2D" >
2019-10-08 06:28:26 +00:00
</argument>
<argument index= "1" name= "label" type= "String" >
</argument>
<argument index= "2" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "3" name= "accel" type= "int" default= "0" >
</argument>
<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" >
</return>
2020-02-12 08:59:06 +00:00
<argument index= "0" name= "texture" type= "Texture2D" >
2019-10-08 06:28:26 +00:00
</argument>
2020-09-09 19:53:24 +00:00
<argument index= "1" name= "shortcut" type= "Shortcut" >
2019-10-08 06:28:26 +00:00
</argument>
<argument index= "2" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "3" name= "global" type= "bool" default= "false" >
</argument>
<description >
Same as [method add_icon_check_shortcut], but uses a radio check button.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "add_icon_shortcut" >
<return type= "void" >
</return>
2020-02-12 08:59:06 +00:00
<argument index= "0" name= "texture" type= "Texture2D" >
2017-09-12 20:42:36 +00:00
</argument>
2020-09-09 19:53:24 +00:00
<argument index= "1" name= "shortcut" type= "Shortcut" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "2" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "3" name= "global" type= "bool" default= "false" >
</argument>
<description >
2020-09-09 19:53:24 +00:00
Adds a new item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name.
2019-06-19 19:35:00 +00:00
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_item" >
<return type= "void" >
</return>
<argument index= "0" name= "label" type= "String" >
</argument>
<argument index= "1" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "2" name= "accel" type= "int" default= "0" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Adds a new item with text [code]label[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-10-08 06:28:26 +00:00
<method name= "add_multistate_item" >
<return type= "void" >
</return>
<argument index= "0" name= "label" type= "String" >
</argument>
<argument index= "1" name= "max_states" type= "int" >
</argument>
2019-10-11 06:45:03 +00:00
<argument index= "2" name= "default_state" type= "int" default= "0" >
2019-10-08 06:28:26 +00:00
</argument>
<argument index= "3" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "4" name= "accel" type= "int" default= "0" >
</argument>
<description >
Adds a new multistate item with text [code]label[/code].
Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] 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>
2018-04-10 08:12:42 +00:00
<method name= "add_radio_check_item" >
<return type= "void" >
</return>
<argument index= "0" name= "label" type= "String" >
</argument>
<argument index= "1" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "2" name= "accel" type= "int" default= "0" >
</argument>
<description >
2019-10-08 06:28:26 +00:00
Adds a new radio check button with text [code]label[/code].
2019-06-19 19:35:00 +00:00
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] 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.
2018-04-10 08:12:42 +00:00
</description>
</method>
<method name= "add_radio_check_shortcut" >
<return type= "void" >
</return>
2020-09-09 19:53:24 +00:00
<argument index= "0" name= "shortcut" type= "Shortcut" >
2018-04-10 08:12:42 +00:00
</argument>
<argument index= "1" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "2" name= "global" type= "bool" default= "false" >
</argument>
<description >
2020-09-09 19:53:24 +00:00
Adds a new radio check button and assigns a [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name.
2019-06-19 19:35:00 +00:00
An [code]id[/code] can optionally be provided. If no [code]id[/code] 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.
2018-04-10 08:12:42 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "add_separator" >
<return type= "void" >
</return>
2018-07-26 09:56:21 +00:00
<argument index= "0" name= "label" type= "String" default= """" >
</argument>
2020-12-27 12:18:47 +00:00
<argument index= "1" name= "id" type= "int" default= "-1" >
</argument>
2017-09-12 20:42:36 +00:00
<description >
2020-12-27 12:18:47 +00:00
Adds a separator between items. Separators also occupy an index, which you can set by using the [code]id[/code] parameter.
2020-12-03 14:36:03 +00:00
A [code]label[/code] can optionally be provided, which will appear at the center of the separator.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_shortcut" >
<return type= "void" >
</return>
2020-09-09 19:53:24 +00:00
<argument index= "0" name= "shortcut" type= "Shortcut" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "id" type= "int" default= "-1" >
</argument>
<argument index= "2" name= "global" type= "bool" default= "false" >
</argument>
<description >
2020-09-09 19:53:24 +00:00
Adds a [Shortcut].
2019-06-19 19:35:00 +00:00
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "add_submenu_item" >
<return type= "void" >
</return>
<argument index= "0" name= "label" type= "String" >
</argument>
<argument index= "1" name= "submenu" type= "String" >
</argument>
<argument index= "2" name= "id" type= "int" default= "-1" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [code]submenu[/code] argument is the name of the child [PopupMenu] node that will be shown when the item is clicked.
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "clear" >
<return type= "void" >
</return>
<description >
2019-06-19 19:35:00 +00:00
Removes all items from the [PopupMenu].
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "clear_item_opentype_features" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
Removes all OpenType features form the item's text.
</description>
</method>
2020-05-11 11:23:39 +00:00
<method name= "get_current_index" qualifiers= "const" >
<return type= "int" >
</return>
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_item_accelerator" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_item_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2019-06-19 19:35:00 +00:00
Returns the number of items in the [PopupMenu].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_item_icon" qualifiers= "const" >
2020-02-12 08:59:06 +00:00
<return type= "Texture2D" >
2017-09-12 20:42:36 +00:00
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Returns the icon of the item at index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_item_id" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Returns the id of the item at index [code]idx[/code]. [code]id[/code] can be manually assigned, while index can not.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_item_index" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "id" type= "int" >
</argument>
<description >
Fix misc. source comment typos
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
2019-09-19 18:36:39 +00:00
Returns the index of the item containing the specified [code]id[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "get_item_language" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
Returns item's text language code.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_item_metadata" qualifiers= "const" >
<return type= "Variant" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "get_item_opentype_feature" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "tag" type= "String" >
</argument>
<description >
Returns OpenType feature [code]tag[/code] of the item's text.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_item_shortcut" qualifiers= "const" >
2020-09-09 19:53:24 +00:00
<return type= "Shortcut" >
2017-09-12 20:42:36 +00:00
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2020-09-09 19:53:24 +00:00
Returns the [Shortcut] associated with the specified [code]idx[/code] item.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_item_submenu" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Returns the submenu name of the item at index [code]idx[/code]. See [method add_submenu_item] for more info on how to add a submenu.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_item_text" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Returns the text of the item at index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "get_item_text_direction" qualifiers= "const" >
<return type= "int" enum= "Control.TextDirection" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
Returns item's text base writing direction.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_item_tooltip" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Returns the tooltip associated with the specified index index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_item_checkable" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Returns [code]true[/code] if the item at index [code]idx[/code] 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.
2018-03-23 20:55:40 +00:00
</description>
</method>
2018-04-10 08:12:42 +00:00
<method name= "is_item_checked" qualifiers= "const" >
2018-03-23 20:55:40 +00:00
<return type= "bool" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Returns [code]true[/code] if the item at index [code]idx[/code] is checked.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-04-10 08:12:42 +00:00
<method name= "is_item_disabled" qualifiers= "const" >
2017-09-12 20:42:36 +00:00
<return type= "bool" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. When it is disabled it can't be selected, or its action invoked.
2019-06-19 19:35:00 +00:00
See [method set_item_disabled] for more info on how to disable an item.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-04-10 08:12:42 +00:00
<method name= "is_item_radio_checkable" qualifiers= "const" >
2017-09-12 20:42:36 +00:00
<return type= "bool" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Returns [code]true[/code] if the item at index [code]idx[/code] has radio button-style checkability.
2019-06-21 23:04:47 +00:00
[b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_item_separator" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-06-11 16:41:16 +00:00
<method name= "is_item_shortcut_disabled" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2020-01-02 01:08:19 +00:00
Returns [code]true[/code] if the specified item's shortcut is disabled.
2018-06-11 16:41:16 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "remove_item" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Removes the item at index [code]idx[/code] from the menu.
[b]Note:[/b] The indices of items after the removed item will be shifted by one.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_item_accelerator" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "accel" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Sets the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_item_as_checkable" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Sets whether the item at index [code]idx[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text.
2019-06-21 23:04:47 +00:00
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-03-23 20:55:40 +00:00
<method name= "set_item_as_radio_checkable" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
2019-11-02 11:14:15 +00:00
Sets the type of the item at the specified index [code]idx[/code] to radio button. If [code]false[/code], sets the type of the item to plain text.
2018-03-23 20:55:40 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_item_as_separator" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Mark the item at index [code]idx[/code] 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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_item_checked" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "checked" type= "bool" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Sets the checkstate status of the item at index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_item_disabled" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "disabled" type= "bool" >
</argument>
<description >
2020-01-02 01:08:19 +00:00
Enables/disables the item at index [code]idx[/code]. When it is disabled, it can't be selected and its action can't be invoked.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_item_icon" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
2020-02-12 08:59:06 +00:00
<argument index= "1" name= "icon" type= "Texture2D" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-02-12 08:59:06 +00:00
Replaces the [Texture2D] icon of the specified [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_item_id" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "id" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Sets the [code]id[/code] of the item at index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_item_language" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "language" type= "String" >
</argument>
<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>
2017-09-12 20:42:36 +00:00
<method name= "set_item_metadata" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "metadata" type= "Variant" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
2017-12-13 23:07:39 +00:00
<method name= "set_item_multistate" >
2017-09-12 20:42:36 +00:00
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
2017-12-13 23:07:39 +00:00
<argument index= "1" name= "state" type= "int" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-01-08 01:05:32 +00:00
Sets the state of an multistate item. See [method add_multistate_item] for details.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_item_opentype_feature" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "tag" type= "String" >
</argument>
<argument index= "2" name= "value" type= "int" >
</argument>
<description >
Sets OpenType feature [code]tag[/code] for the item's text. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url].
</description>
</method>
2017-12-13 23:07:39 +00:00
<method name= "set_item_shortcut" >
2017-12-10 14:10:54 +00:00
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
2020-09-09 19:53:24 +00:00
<argument index= "1" name= "shortcut" type= "Shortcut" >
2017-12-13 23:07:39 +00:00
</argument>
<argument index= "2" name= "global" type= "bool" default= "false" >
2017-12-10 14:10:54 +00:00
</argument>
<description >
2020-09-09 19:53:24 +00:00
Sets a [Shortcut] for the specified item [code]idx[/code].
2017-12-10 14:10:54 +00:00
</description>
</method>
2018-06-11 16:41:16 +00:00
<method name= "set_item_shortcut_disabled" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "disabled" type= "bool" >
</argument>
<description >
2020-09-09 19:53:24 +00:00
Disables the [Shortcut] of the specified index [code]idx[/code].
2018-06-11 16:41:16 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_item_submenu" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "submenu" type= "String" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Sets the submenu of the item at index [code]idx[/code]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "set_item_text" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "text" type= "String" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Sets the text of the item at index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_item_text_direction" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "direction" type= "int" enum= "Control.TextDirection" >
</argument>
<description >
Sets item's text base writing direction.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_item_tooltip" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "tooltip" type= "String" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Sets the [String] tooltip of the item at the specified index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "toggle_item_checked" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-19 19:35:00 +00:00
Toggles the check state of the item of the specified index [code]idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2017-12-12 02:37:37 +00:00
<method name= "toggle_item_multistate" >
2017-12-10 14:10:54 +00:00
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2020-01-08 01:05:32 +00:00
Cycle to the next state of an multistate item. See [method add_multistate_item] for details.
2017-12-10 14:10:54 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
<members >
2020-05-20 13:29:37 +00:00
<member name= "allow_search" type= "bool" setter= "set_allow_search" getter= "get_allow_search" default= "true" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], allows to navigate [PopupMenu] with letter keys.
2019-06-01 10:34:29 +00:00
</member>
2019-06-29 10:38:01 +00:00
<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" >
2019-06-19 19:35:00 +00:00
If [code]true[/code], hides the [PopupMenu] when a checkbox or radio button is selected.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "hide_on_item_selection" type= "bool" setter= "set_hide_on_item_selection" getter= "is_hide_on_item_selection" default= "true" >
2019-06-19 19:35:00 +00:00
If [code]true[/code], hides the [PopupMenu] when an item is selected.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<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" >
2019-06-19 19:35:00 +00:00
If [code]true[/code], hides the [PopupMenu] when a state item is selected.
2018-01-11 22:38:35 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "submenu_popup_delay" type= "float" setter= "set_submenu_popup_delay" getter= "get_submenu_popup_delay" default= "0.3" >
2019-06-29 13:24:23 +00:00
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.
2018-07-09 12:16:06 +00:00
</member>
2017-09-12 20:42:36 +00:00
</members>
<signals >
2018-04-10 08:12:42 +00:00
<signal name= "id_focused" >
2019-05-15 10:51:58 +00:00
<argument index= "0" name= "id" type= "int" >
2018-04-10 08:12:42 +00:00
</argument>
<description >
2019-06-21 23:04:47 +00:00
Emitted when user navigated to an item of some [code]id[/code] using [code]ui_up[/code] or [code]ui_down[/code] action.
2018-04-10 08:12:42 +00:00
</description>
</signal>
2017-09-12 20:42:36 +00:00
<signal name= "id_pressed" >
2019-05-15 10:51:58 +00:00
<argument index= "0" name= "id" type= "int" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-06-21 23:04:47 +00:00
Emitted when an item of some [code]id[/code] is pressed or its accelerator is activated.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name= "index_pressed" >
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Emitted when an item of some [code]index[/code] is pressed or its accelerator is activated.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants >
</constants>
<theme_items >
2020-02-12 08:59:06 +00:00
<theme_item name= "checked" type= "Texture2D" >
[Texture2D] icon for the checked checkbox items.
2017-09-12 20:42:36 +00:00
</theme_item>
<theme_item name= "font" type= "Font" >
2020-01-27 01:15:37 +00:00
[Font] used for the menu items.
2017-09-12 20:42:36 +00:00
</theme_item>
2019-07-09 07:13:00 +00:00
<theme_item name= "font_color" type= "Color" default= "Color( 0.88, 0.88, 0.88, 1 )" >
2020-01-27 01:15:37 +00:00
The default text [Color] for menu items' names.
2017-09-12 20:42:36 +00:00
</theme_item>
2019-06-29 10:38:01 +00:00
<theme_item name= "font_color_accel" type= "Color" default= "Color( 0.7, 0.7, 0.7, 0.8 )" >
2020-01-27 01:15:37 +00:00
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.
2017-09-12 20:42:36 +00:00
</theme_item>
2019-06-29 10:38:01 +00:00
<theme_item name= "font_color_disabled" type= "Color" default= "Color( 0.4, 0.4, 0.4, 0.8 )" >
2020-01-27 01:15:37 +00:00
[Color] used for disabled menu items' text.
2017-09-12 20:42:36 +00:00
</theme_item>
2019-07-09 07:13:00 +00:00
<theme_item name= "font_color_hover" type= "Color" default= "Color( 0.88, 0.88, 0.88, 1 )" >
2020-01-27 01:15:37 +00:00
[Color] used for the hovered text.
2017-09-12 20:42:36 +00:00
</theme_item>
2020-12-03 14:36:03 +00:00
<theme_item name= "font_color_separator" type= "Color" default= "Color( 0.88, 0.88, 0.88, 1 )" >
[Color] used for labeled separators' text. See [method add_separator].
</theme_item>
2020-08-12 11:49:10 +00:00
<theme_item name= "font_size" type= "int" >
Font size of the menu items.
</theme_item>
2017-09-12 20:42:36 +00:00
<theme_item name= "hover" type= "StyleBox" >
2020-01-27 01:15:37 +00:00
[StyleBox] displayed when the [PopupMenu] item is hovered.
2017-09-12 20:42:36 +00:00
</theme_item>
2019-06-29 10:38:01 +00:00
<theme_item name= "hseparation" type= "int" default= "4" >
2020-01-27 01:15:37 +00:00
The horizontal space between the item's name and the shortcut text/submenu arrow.
2017-09-12 20:42:36 +00:00
</theme_item>
2018-07-26 09:56:21 +00:00
<theme_item name= "labeled_separator_left" type= "StyleBox" >
2020-01-27 01:15:37 +00:00
[StyleBox] for the left side of labeled separator. See [method add_separator].
2018-07-26 09:56:21 +00:00
</theme_item>
<theme_item name= "labeled_separator_right" type= "StyleBox" >
2020-01-27 01:15:37 +00:00
[StyleBox] for the right side of labeled separator. See [method add_separator].
2018-07-26 09:56:21 +00:00
</theme_item>
2017-09-12 20:42:36 +00:00
<theme_item name= "panel" type= "StyleBox" >
2020-01-27 01:15:37 +00:00
Default [StyleBox] of the [PopupMenu] items.
2017-09-12 20:42:36 +00:00
</theme_item>
<theme_item name= "panel_disabled" type= "StyleBox" >
2020-01-27 01:15:37 +00:00
[StyleBox] used when the [PopupMenu] item is disabled.
2017-09-12 20:42:36 +00:00
</theme_item>
2020-02-12 08:59:06 +00:00
<theme_item name= "radio_checked" type= "Texture2D" >
[Texture2D] icon for the checked radio button items.
2018-04-10 08:12:42 +00:00
</theme_item>
2020-02-12 08:59:06 +00:00
<theme_item name= "radio_unchecked" type= "Texture2D" >
[Texture2D] icon for the unchecked radio button items.
2018-04-10 08:12:42 +00:00
</theme_item>
2017-09-12 20:42:36 +00:00
<theme_item name= "separator" type= "StyleBox" >
2020-01-27 01:15:37 +00:00
[StyleBox] used for the separators. See [method add_separator].
2017-09-12 20:42:36 +00:00
</theme_item>
2020-02-12 08:59:06 +00:00
<theme_item name= "submenu" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
[Texture2D] icon for the submenu arrow (for left-to-right layouts).
</theme_item>
<theme_item name= "submenu_mirrored" type= "Texture2D" >
[Texture2D] icon for the submenu arrow (for right-to-left layouts).
2017-09-12 20:42:36 +00:00
</theme_item>
2020-02-12 08:59:06 +00:00
<theme_item name= "unchecked" type= "Texture2D" >
[Texture2D] icon for the unchecked checkbox items.
2017-09-12 20:42:36 +00:00
</theme_item>
2019-06-29 10:38:01 +00:00
<theme_item name= "vseparation" type= "int" default= "4" >
2020-01-27 01:15:37 +00:00
The vertical space between each menu item.
2017-09-12 20:42:36 +00:00
</theme_item>
</theme_items>
</class>
