virtualx-engine/doc/classes/MarginContainer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="MarginContainer" inherits="Container" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Simple margin container.
	</brief_description>
	<description>
		Adds a top, left, bottom, and right margin to all [Control] nodes that are direct children of the container. To control the [MarginContainer]'s margin, use the [code]margin_*[/code] theme properties listed below.
		[b]Note:[/b] Be careful, [Control] margin values are different than the constant margin values. If you want to change the custom margin values of the [MarginContainer] by code, you should use the following examples:
		[codeblock]
		# This code sample assumes the current script is extending MarginContainer.
		var margin_value = 100
		add_constant_override("margin_top", margin_value)
		add_constant_override("margin_left", margin_value)
		add_constant_override("margin_bottom", margin_value)
		add_constant_override("margin_right", margin_value)
		[/codeblock]
	</description>
	<tutorials>
		<link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
	</tutorials>
	<methods>
	</methods>
	<constants>
	</constants>
	<theme_items>
		<theme_item name="margin_bottom" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a bottom margin of [code]margin_bottom[/code] pixels.
		</theme_item>
		<theme_item name="margin_left" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a left margin of [code]margin_left[/code] pixels.
		</theme_item>
		<theme_item name="margin_right" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a right margin of [code]margin_right[/code] pixels.
		</theme_item>
		<theme_item name="margin_top" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a top margin of [code]margin_top[/code] pixels.
		</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 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00			`<class name="MarginContainer" inherits="Container" version="3.6" 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>`
			`Simple margin container.`
			`</brief_description>`
			`<description>`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`Adds a top, left, bottom, and right margin to all [Control] nodes that are direct children of the container. To control the [MarginContainer]'s margin, use the [code]margin_*[/code] theme properties listed below.`
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			`[b]Note:[/b] Be careful, [Control] margin values are different than the constant margin values. If you want to change the custom margin values of the [MarginContainer] by code, you should use the following examples:`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`[codeblock]`
Use safer `add_theme_constant_override()` in MarginContainer code sample Control has magic setters to set custom theme items, but using the dedicated Control methods is less prone to typos so it should be favored. 2021-03-04 17:18:51 +01:00			`# This code sample assumes the current script is extending MarginContainer.`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`var margin_value = 100`
Use safer `add_theme_constant_override()` in MarginContainer code sample Control has magic setters to set custom theme items, but using the dedicated Control methods is less prone to typos so it should be favored. 2021-03-04 17:18:51 +01:00			`add_constant_override("margin_top", margin_value)`
			`add_constant_override("margin_left", margin_value)`
			`add_constant_override("margin_bottom", margin_value)`
			`add_constant_override("margin_right", margin_value)`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`[/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>`
Link to Container tutorial Users happening across any of the Container pages may not already know the intent of Containers, or which others are available. This commit adds a link to the existing "GUI containers" page in their tutorials sections. (cherry picked from commit 3b941ed98cfb1f72c35684f1d4d458dacd482c63) 2022-04-21 08:16:02 +02:00			`<link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>`
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			`</tutorials>`
			`<methods>`
			`</methods>`
			`<constants>`
			`</constants>`
			`<theme_items>`
Add theme item descriptions to the online documentation 2021-08-06 17:07:21 +02:00			`<theme_item name="margin_bottom" data_type="constant" type="int" default="0">`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`All direct children of [MarginContainer] will have a bottom margin of [code]margin_bottom[/code] pixels.`
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			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 17:07:21 +02:00			`<theme_item name="margin_left" data_type="constant" type="int" default="0">`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`All direct children of [MarginContainer] will have a left margin of [code]margin_left[/code] pixels.`
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			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 17:07:21 +02:00			`<theme_item name="margin_right" data_type="constant" type="int" default="0">`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`All direct children of [MarginContainer] will have a right margin of [code]margin_right[/code] pixels.`
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			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 17:07:21 +02:00			`<theme_item name="margin_top" data_type="constant" type="int" default="0">`
Document MarginContainer Node 2019-06-19 10:29:35 +02:00			`All direct children of [MarginContainer] will have a top margin of [code]margin_top[/code] pixels.`
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			`</theme_item>`
			`</theme_items>`
			`</class>`