virtualx-engine/doc/classes/ConfirmationDialog.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ConfirmationDialog" inherits="AcceptDialog" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Dialog for confirmation of actions.
	</brief_description>
	<description>
		Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order).
		To get cancel action, you can use:
		[codeblocks]
		[gdscript]
		get_cancel_button().pressed.connect(self.canceled)
		[/gdscript]
		[csharp]
		GetCancelButton().Pressed += Canceled;
		[/csharp]
		[/codeblocks]
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_cancel_button">
			<return type="Button" />
			<description>
				Returns the cancel button.
				[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
			</description>
		</method>
	</methods>
	<members>
		<member name="cancel_button_text" type="String" setter="set_cancel_button_text" getter="get_cancel_button_text" default="&quot;Cancel&quot;">
			The text displayed by the cancel button (see [method get_cancel_button]).
		</member>
		<member name="min_size" type="Vector2i" setter="set_min_size" getter="get_min_size" overrides="Window" default="Vector2i(200, 70)" />
		<member name="size" type="Vector2i" setter="set_size" getter="get_size" overrides="Window" default="Vector2i(200, 100)" />
		<member name="title" type="String" setter="set_title" getter="get_title" overrides="Window" default="&quot;Please Confirm...&quot;" />
	</members>
</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" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 01:44:37 +01:00			`<class name="ConfirmationDialog" inherits="AcceptDialog" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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>`
			`Dialog for confirmation of actions.`
			`</brief_description>`
			`<description>`
			`Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order).`
Mention how to handle cancel in ConfirmationDialog 2019-12-21 00:19:13 +01:00			`To get cancel action, you can use:`
Translate GDScript Code Examples to C# (C) Translates Code Examples in classes beginning with `C`. Includes: * Callable * CanvasItem * CharFXTransform * Color * ColorRect * ConfigFile * ConfirmationDialog * Control * Crypto 2020-09-12 17:06:13 +02:00			`[codeblocks]`
			`[gdscript]`
Convert en_GB spelling to en_US with codespell 2023-01-21 12:25:29 +01:00			`get_cancel_button().pressed.connect(self.canceled)`
Translate GDScript Code Examples to C# (C) Translates Code Examples in classes beginning with `C`. Includes: * Callable * CanvasItem * CharFXTransform * Color * ColorRect * ConfigFile * ConfirmationDialog * Control * Crypto 2020-09-12 17:06:13 +02:00			`[/gdscript]`
			`[csharp]`
Convert en_GB spelling to en_US with codespell 2023-01-21 12:25:29 +01:00			`GetCancelButton().Pressed += Canceled;`
Translate GDScript Code Examples to C# (C) Translates Code Examples in classes beginning with `C`. Includes: * Callable * CanvasItem * CharFXTransform * Color * ColorRect * ConfigFile * ConfirmationDialog * Control * Crypto 2020-09-12 17:06:13 +02:00			`[/csharp]`
			`[/codeblocks]`
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>`
			`<methods>`
Rename AcceptDialog get_ok() to get_ok_button() Also renames: - AcceptDialog add_cancel() to add_cancel_button() - ConfirmationDiaglog get_cancel() to get_cancel_button() 2020-12-14 19:37:30 +01:00			`<method name="get_cancel_button">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="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 22:42:36 +02:00			`<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 04:15:43 +02:00			`Returns the cancel button.`
Add warnings to methods that give access to internal nodes 2021-10-10 21:28:56 +02:00			`[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.`
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>`
			`</method>`
			`</methods>`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`<members>`
Add ok_button_text to AcceptDialog and cancel_button_text to ConfirmationDialog 2022-07-08 02:31:19 +02:00			`<member name="cancel_button_text" type="String" setter="set_cancel_button_text" getter="get_cancel_button_text" default=""Cancel"">`
			`The text displayed by the cancel button (see [method get_cancel_button]).`
			`</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="min_size" type="Vector2i" setter="set_min_size" getter="get_min_size" overrides="Window" default="Vector2i(200, 70)" />`
			`<member name="size" type="Vector2i" setter="set_size" getter="get_size" overrides="Window" default="Vector2i(200, 100)" />`
			`<member name="title" type="String" setter="set_title" getter="get_title" overrides="Window" default=""Please Confirm..."" />`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`</members>`
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			`</class>`