virtualx-engine/doc/classes/Popup.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Popup" inherits="Window" version="4.0">
	<brief_description>
		Base container control for popups and dialogs.
	</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.
	</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.
		</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" />
		<member name="visible" type="bool" setter="set_visible" getter="is_visible" overrides="Window" default="false" />
		<member name="wrap_controls" type="bool" setter="set_wrap_controls" getter="is_wrapping_controls" overrides="Window" default="true" />
	</members>
	<signals>
		<signal name="popup_hide">
			<description>
				Emitted when a popup is hidden.
			</description>
		</signal>
	</signals>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Sync classref with DisplayServer/Window changes 2020-03-31 11:56:58 +02:00			`<class name="Popup" inherits="Window" version="4.0">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
			`Base container control for popups and dialogs.`
			`</brief_description>`
			`<description>`
doc: Sync classref with DisplayServer/Window changes 2020-03-31 11:56:58 +02:00			`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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com> 2021-12-02 20:38:49 +01:00			`<member name="borderless" type="bool" setter="set_flag" getter="get_flag" overrides="Window" default="true" />`
doc: Sync classref with Variant utility methods Copied relevant documentation from the original `@GDScript` built-ins, which will likely be removed in a future commit. Various fixups to `variant_utility.cpp` while working on this. 2020-11-17 11:21:08 +01:00			`<member name="close_on_parent_focus" type="bool" setter="set_close_on_parent_focus" getter="get_close_on_parent_focus" default="true">`
Add multiple descriptions to several classes This pull request adds several descriptions to multiple different classes. This improves the completeness of the documentation and enhances usability by doing so. 2021-07-06 13:22:53 +02:00			`If [code]true[/code], the [Popup] will close when its parent is focused.`
doc: Sync classref with Variant utility methods Copied relevant documentation from the original `@GDScript` built-ins, which will likely be removed in a future commit. Various fixups to `variant_utility.cpp` while working on this. 2020-11-17 11:21:08 +01:00			`</member>`
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com> 2021-12-02 20:38:49 +01:00			`<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" />`
			`<member name="visible" type="bool" setter="set_visible" getter="is_visible" overrides="Window" default="false" />`
			`<member name="wrap_controls" type="bool" setter="set_wrap_controls" getter="is_wrapping_controls" overrides="Window" default="true" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</members>`
			`<signals>`
			`<signal name="popup_hide">`
			`<description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 01:04:47 +02:00			`Emitted when a popup is hidden.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`</signal>`
			`</signals>`
			`</class>`