From 047767b824708f722d59a9d32bb2a7894ab4845c Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Sun, 1 May 2016 17:52:42 +0300 Subject: [PATCH] Document Popup, PopupDialog, PopupMenu, and PopupPanel (cherry picked from commit 5cdf4a63792ab7979da90977cf7d36568c8fd83e) --- doc/base/classes.xml | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index f3230dd4263..bdf42b1c37b 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -26262,6 +26262,7 @@ This method controls whether the position between two cached points is interpola + Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than [code]minsize[/code]. @@ -26273,18 +26274,21 @@ This method controls whether the position between two cached points is interpola + Make the popup hide other popups when shown on the screen. + Returns whether the popup will hide other popups when shown on the screen. + This signal is emitted when a popup is hidden. @@ -26295,8 +26299,10 @@ This method controls whether the position between two cached points is interpola + Notification sent right after the popup is shown. + Notification sent right after the popup is hidden. @@ -26305,6 +26311,7 @@ This method controls whether the position between two cached points is interpola Base class for Popup Dialogs. + PopupDialog is a base class for popup dialogs, along with [WindowDialog]. @@ -26329,7 +26336,7 @@ This method controls whether the position between two cached points is interpola - Add a new 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. + 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. @@ -26340,7 +26347,7 @@ This method controls whether the position between two cached points is interpola - Add a new 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. + 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. @@ -26353,7 +26360,7 @@ This method controls whether the position between two cached points is interpola - Add a new check able 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. + 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. @@ -26375,6 +26382,7 @@ This method controls whether the position between two cached points is interpola + 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. @@ -26410,6 +26418,7 @@ This method controls whether the position between two cached points is interpola + Sets the metadata of an item, which might 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. @@ -26427,6 +26436,7 @@ This method controls whether the position between two cached points is interpola + Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. @@ -26435,6 +26445,7 @@ This method controls whether the position between two cached points is interpola + 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. @@ -26443,6 +26454,7 @@ This method controls whether the position between two cached points is interpola + Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. @@ -26451,6 +26463,7 @@ This method controls whether the position between two cached points is interpola + 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. @@ -26484,6 +26497,7 @@ This method controls whether the position between two cached points is interpola + Return 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. @@ -26501,6 +26515,7 @@ This method controls whether the position between two cached points is interpola + Return the submenu name of the item at index "idx". @@ -26509,6 +26524,7 @@ This method controls whether the position between two cached points is interpola + Return whether the item is a seperator. If it is, it would be displayed as a line. @@ -26517,6 +26533,7 @@ This method controls whether the position between two cached points is interpola + Return 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. @@ -26534,6 +26551,7 @@ This method controls whether the position between two cached points is interpola + Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. @@ -26570,11 +26588,12 @@ This method controls whether the position between two cached points is interpola + Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. - Clear the popup menu. + Clear the popup menu, in effect removing all items. @@ -26622,9 +26641,10 @@ This method controls whether the position between two cached points is interpola - Base class for Popup Panels + Class for displaying popups with a panel background. + Class for displaying popups with a panel background. In some cases it might be simpler to use than [Popup], since it provides a configurable background. If you are making windows, better check [WindowDialog]. @@ -38261,9 +38281,11 @@ This method controls whether the position between two cached points is interpola - + - + + +