godot/doc/classes/WindowDialog.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="WindowDialog" inherits="Popup" version="4.0">
	<brief_description>
		Base class for window dialogs.
	</brief_description>
	<description>
		Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_close_button">
			<return type="TextureButton">
			</return>
			<description>
				Returns the close [TextureButton].
			</description>
		</method>
	</methods>
	<members>
		<member name="resizable" type="bool" setter="set_resizable" getter="get_resizable" default="false">
			If [code]true[/code], the user can resize the window.
		</member>
		<member name="window_title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">
			The text displayed in the window's title bar.
		</member>
	</members>
	<constants>
	</constants>
	<theme_items>
		<theme_item name="close" type="Texture2D">
			The icon for the close button.
		</theme_item>
		<theme_item name="close_h_ofs" type="int" default="18">
			The horizontal offset of the close button.
		</theme_item>
		<theme_item name="close_highlight" type="Texture2D">
			The icon used for the close button when it's hovered with the mouse cursor.
		</theme_item>
		<theme_item name="close_v_ofs" type="int" default="18">
			The vertical offset of the close button.
		</theme_item>
		<theme_item name="panel" type="StyleBox">
			The style for both the content background of the [WindowDialog] and the title bar.
		</theme_item>
		<theme_item name="scaleborder_size" type="int" default="4">
			The thickness of the border that can be dragged when scaling the window (if [member resizable] is enabled).
		</theme_item>
		<theme_item name="title_color" type="Color" default="Color( 0, 0, 0, 1 )">
			The color of the title text.
		</theme_item>
		<theme_item name="title_font" type="Font">
			The font used to draw the title.
		</theme_item>
		<theme_item name="title_height" type="int" default="20">
			The vertical offset of the title text.
		</theme_item>
	</theme_items>
</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 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 01:03:48 +00:00			`<class name="WindowDialog" inherits="Popup" 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 20:42:36 +00:00			`<brief_description>`
			`Base class for window dialogs.`
			`</brief_description>`
			`<description>`
			`Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing.`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="get_close_button">`
			`<return type="TextureButton">`
			`</return>`
			`<description>`
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 2019-05-24 02:15:43 +00:00			`Returns the close [TextureButton].`
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 20:42:36 +00:00			`</description>`
			`</method>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="resizable" type="bool" setter="set_resizable" getter="get_resizable" default="false">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`If [code]true[/code], the user can resize the window.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="window_title" type="String" setter="set_title" getter="get_title" default="""">`
[DOCS] Corrections and clarifications 2018-08-26 22:31:09 +00:00			`The text displayed in the window's title bar.`
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 20:42:36 +00:00			`</member>`
			`</members>`
			`<constants>`
			`</constants>`
			`<theme_items>`
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 08:59:06 +00:00			`<theme_item name="close" type="Texture2D">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The icon for the close button.`
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 20:42:36 +00:00			`</theme_item>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<theme_item name="close_h_ofs" type="int" default="18">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The horizontal offset of the close button.`
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 20:42:36 +00:00			`</theme_item>`
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 08:59:06 +00:00			`<theme_item name="close_highlight" type="Texture2D">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The icon used for the close button when it's hovered with the mouse cursor.`
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 20:42:36 +00:00			`</theme_item>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<theme_item name="close_v_ofs" type="int" default="18">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The vertical offset of the close button.`
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 20:42:36 +00:00			`</theme_item>`
			`<theme_item name="panel" type="StyleBox">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The style for both the content background of the [WindowDialog] and the title bar.`
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 20:42:36 +00:00			`</theme_item>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<theme_item name="scaleborder_size" type="int" default="4">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The thickness of the border that can be dragged when scaling the window (if [member resizable] is enabled).`
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 20:42:36 +00:00			`</theme_item>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<theme_item name="title_color" type="Color" default="Color( 0, 0, 0, 1 )">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The color of the title text.`
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 20:42:36 +00:00			`</theme_item>`
			`<theme_item name="title_font" type="Font">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The font used to draw the title.`
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 20:42:36 +00:00			`</theme_item>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<theme_item name="title_height" type="int" default="20">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The vertical offset of the title text.`
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 20:42:36 +00:00			`</theme_item>`
			`</theme_items>`
			`</class>`