diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml
index 4d14766f124..ac6896ff191 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,7 +19,9 @@
- Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that 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.
@@ -32,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.
@@ -46,8 +51,9 @@
- Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be
- created from the index. Note that 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.
@@ -62,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.
@@ -76,7 +85,8 @@
- Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id 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.
@@ -91,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.
@@ -103,7 +115,8 @@
- Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id 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.
@@ -116,7 +129,9 @@
- The same as [method add_check_item] but the inserted item will look as a radio button. Remember this is just cosmetic and you have to 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.
@@ -129,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.
@@ -150,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.
@@ -162,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].
@@ -185,7 +206,7 @@
- Returns the amount of items.
+ Returns the number of items in the [PopupMenu].
@@ -203,7 +224,7 @@
- Returns the id of the item at index "idx".
+ Returns the id of the item at index [code]idx[/code]. [code]id[/code] can be manually assigned, while index can not.
@@ -212,7 +233,7 @@
- Find and return the index of the item containing a given id.
+ 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.
@@ -221,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.
@@ -230,6 +251,7 @@
+ Returns the [ShortCut] associated with the specified [code]idx[/code] item.
@@ -238,7 +260,7 @@
- Returns the submenu name of the item at index "idx".
+ 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.
@@ -256,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.
@@ -288,7 +312,8 @@
- Returns whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked.
+ 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.
@@ -297,7 +322,8 @@
- Returns whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups.
+ 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.
@@ -306,7 +332,7 @@
- Returns whether the item is a separator. If it is, it would 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.
@@ -315,6 +341,7 @@
+ Returns whether the shortcut of the specified item [code]idx[/code] is disabled or not.
@@ -332,6 +359,7 @@
+ Hides the [PopupMenu] when the window loses focus.
@@ -353,7 +381,8 @@
- Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
+ 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.
@@ -364,8 +393,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.
@@ -376,7 +404,7 @@
- Mark the item at index "idx" 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.
@@ -409,6 +437,7 @@
+ Replaces the [Texture] icon of the specified [code]idx[/code].
@@ -453,6 +482,7 @@
+ Sets a [ShortCut] for the specified item [code]idx[/code].
@@ -463,6 +493,7 @@
+ Disables the [ShortCut] of the specified index [code]idx[/code].
@@ -473,7 +504,7 @@
- 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.
+ 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.
@@ -495,6 +526,7 @@
+ Sets the [String] tooltip of the item at the specified index [code]idx[/code].
@@ -503,6 +535,7 @@
+ Toggles the check state of the item of the specified index [code]idx[/code].
@@ -516,10 +549,13 @@
+ 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.
@@ -552,40 +588,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.