diff options
| author | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2022-02-09 03:34:30 +0100 |
|---|---|---|
| committer | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2022-02-09 18:59:41 +0100 |
| commit | ba565bec1be8184ff02dea7b5d3655d912132ee0 (patch) | |
| tree | ab65223a22aac4896acf6cf48d37d20fdf198011 /doc | |
| parent | f91e5bad8ce2ae30834e0f46be644dbc1d9daf10 (diff) | |
Update Popup and PopupMenu descriptions
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Popup.xml | 8 | ||||
| -rw-r--r-- | doc/classes/PopupMenu.xml | 2 |
2 files changed, 5 insertions, 5 deletions
diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index dc5dd47287..36bdd6e6e4 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -1,17 +1,17 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Popup" inherits="Window" version="4.0"> <brief_description> - Base container control for popups and dialogs. + Popup is a base window container for popup-like subwindows. </brief_description> <description> - Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. + Popup is a base window container for popup-like subwindows. It's a modal by default (see [member close_on_parent_focus]) and has helpers for custom popup behavior. </description> <tutorials> </tutorials> <members> <member name="borderless" type="bool" setter="set_flag" getter="get_flag" overrides="Window" default="true" /> <member name="close_on_parent_focus" type="bool" setter="set_close_on_parent_focus" getter="get_close_on_parent_focus" default="true"> - If [code]true[/code], the [Popup] will close when its parent is focused. + If true, the [Popup] will close when its parent [Window] is focused. </member> <member name="transient" type="bool" setter="set_transient" getter="is_transient" overrides="Window" default="true" /> <member name="unresizable" type="bool" setter="set_flag" getter="get_flag" overrides="Window" default="true" /> @@ -21,7 +21,7 @@ <signals> <signal name="popup_hide"> <description> - Emitted when a popup is hidden. + Emitted when the popup is hidden. </description> </signal> </signals> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index b316f822f0..29a4cfcd46 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -4,7 +4,7 @@ PopupMenu displays a list of options. </brief_description> <description> - [PopupMenu] is a [Control] that displays a list of options. They are popular in toolbars or context menus. + [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. </description> |