From 316931998c55183995db3643f8915f04d39f2a7c Mon Sep 17 00:00:00 2001 From: Zak Date: Wed, 19 Jun 2019 22:35:00 +0300 Subject: Document PopupMenu node. --- doc/classes/PopupMenu.xml | 93 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 70 insertions(+), 23 deletions(-) (limited to 'doc') diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 0d869fc72f..3ce923e36a 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -4,7 +4,7 @@ PopupMenu displays a list of options. - PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. + [PopupMenu] is a [Control] that displays a list of options. They are popular in toolbars or context menus. @@ -19,8 +19,9 @@ - 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. - [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + 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. @@ -33,6 +34,9 @@ + Adds a new checkable item and assigns the specified [ShortCut] to it. Sets the label of the checkbox to the [ShortCut]'s name. + 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. @@ -47,8 +51,9 @@ - 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. - [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + 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. @@ -63,6 +68,9 @@ + 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. + 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. @@ -77,7 +85,8 @@ - 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 keybinding ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. + 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. @@ -92,6 +101,8 @@ + 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. + An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -104,7 +115,8 @@ - Adds a new item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator keybinding ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. + 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. @@ -117,8 +129,9 @@ - The same as [method add_check_item], but the inserted item will look as a radio button. - [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. + Adds a new radio button 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. @@ -131,6 +144,9 @@ + Adds a new radio check button and assigns a [ShortCut] to it. Sets the label of the checkbox to the [ShortCut]'s name. + 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. @@ -152,6 +168,8 @@ + Adds a [ShortCut]. + An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -164,14 +182,15 @@ - Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. + 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. - Clear the popup menu, in effect removing all items. + Removes all items from the [PopupMenu]. @@ -187,7 +206,7 @@ - Returns the amount of items. + Returns the number of items in the [PopupMenu]. @@ -205,7 +224,7 @@ - Returns the id of the item at index [code]idx[/code]. + Returns the id of the item at index [code]idx[/code]. [code]id[/code] can be manually assigned, while index can not. @@ -214,7 +233,7 @@ - Finds and return the index of the item containing a given [code]id[/code]. + 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 manualy. @@ -223,7 +242,7 @@ - Returns the metadata of an 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. + 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. @@ -232,6 +251,7 @@ + Returns the [ShortCut] associated with the specified [code]idx[/code] item. @@ -240,7 +260,7 @@ - Returns the submenu name of the item at index [code]idx[/code]. + 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. @@ -258,12 +278,14 @@ + Returns the tooltip associated with the specified index index [code]idx[/code]. + Returns whether the popup will be hidden when the window loses focus or not. @@ -292,6 +314,7 @@ 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. + See [method set_item_disabled] for more info on how to disable an item. @@ -300,7 +323,7 @@ - Returns [code]true[/code] if the item at index [code]idx[/code] has radio-button-style checkability. + Returns [code]true[/code] if the item at index [code]idx[/code] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. @@ -310,7 +333,7 @@ - Returns [code]true[/code] if the item is a separator. If it is, it will be displayed as a line. + 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. @@ -319,6 +342,7 @@ + Returns whether the shortcut of the specified item [code]idx[/code] is disabled or not. @@ -337,6 +361,7 @@ + Hides the [PopupMenu] when the window loses focus. @@ -358,7 +383,7 @@ - Sets whether the item at index [code]idx[/code] has a checkbox. + 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. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -370,8 +395,7 @@ - The same as [method set_item_as_checkable] but placing a radio button in case of enabling. If used for disabling, it's the same. - Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + Sets the type of the item at the specified index [code]idx[/code] to radio button. If false, sets the type of the item to plain text. @@ -382,7 +406,7 @@ - Mark the item at index [code]idx[/code] as a separator, which means that it would be displayed as a line. + 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. @@ -415,6 +439,7 @@ + Replaces the [Texture] icon of the specified [code]idx[/code]. @@ -459,6 +484,7 @@ + Sets a [ShortCut] for the specified item [code]idx[/code]. @@ -469,6 +495,7 @@ + Disables the [ShortCut] of the specified index [code]idx[/code]. @@ -479,7 +506,7 @@ - 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. + 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. @@ -501,6 +528,7 @@ + Sets the [String] tooltip of the item at the specified index [code]idx[/code]. @@ -509,6 +537,7 @@ + Toggles the check state of the item of the specified index [code]idx[/code]. @@ -525,10 +554,13 @@ If [code]true[/code], allows to navigate [PopupMenu] with letter keys. Default value: [code]false[/code]. + If [code]true[/code], hides the [PopupMenu] when a checkbox or radio button is selected. + If [code]true[/code], hides the [PopupMenu] when an item is selected. + If [code]true[/code], hides the [PopupMenu] when a state item is selected. Sets the delay time 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. Default value: [code]0.3[/code] seconds. @@ -561,40 +593,55 @@ + Sets a custom [Texture] icon for [code]checked[/code] state of checkbox items. + Sets a custom [Font]. + Sets a custom [Color] for the [Font]. + Sets a custom [Color] for disabled text. + Sets a custom [Color] for the hovered text. + Sets a custom [StyleBox] when the [PopupMenu] is hovered. + Sets the horizontal space separation between each item. + Sets a custom [StyleBox] for the panel of the [PopupMenu]. + Sets a custom [StyleBox] for the panel of the [PopupMenu], when the panel is disabled. + Sets a custom [Texture] icon for [code]checked[/code] of radio button items. + Sets a custom [Texture] icon for [code]unchecked[/code] of radio button items. + Sets a custom [StyleBox] for separator's. + Sets a custom [Texture] for submenu's. + Sets a custom [Texture] icon for [code]unchecked[/code] of checkbox items. + Sets the vertical space separation between each item. -- cgit v1.2.3