virtualx-engine/doc/classes/ConfirmationDialog.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ConfirmationDialog" inherits="AcceptDialog" version="3.4">
	<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:
		[codeblock]
		get_cancel().connect("pressed", self, "cancelled")
		[/codeblock].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_cancel">
			<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="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size" override="true" default="Vector2( 200, 70 )" />
		<member name="window_title" type="String" setter="set_title" getter="get_title" override="true" default="&quot;Please Confirm...&quot;" />
	</members>
	<constants>
	</constants>
</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: Update classref headers with 3.4 version 2021-04-26 13:14:51 +02:00			`<class name="ConfirmationDialog" inherits="AcceptDialog" version="3.4">`
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:`
			`[codeblock]`
			`get_cancel().connect("pressed", self, "cancelled")`
			`[/codeblock].`
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>`
			`<method name="get_cancel">`
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 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 22:10:07 +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>`
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`. 2019-09-24 13:34:03 +02:00			`<member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size" override="true" default="Vector2( 200, 70 )" />`
			`<member name="window_title" type="String" setter="set_title" getter="get_title" override="true" 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			`<constants>`
			`</constants>`
			`</class>`