godot/doc/classes/BoxContainer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BoxContainer" inherits="Container" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base class for box containers.
	</brief_description>
	<description>
		Arranges child [Control] nodes vertically or horizontally, and rearranges them automatically when their minimum size changes.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_spacer">
			<return type="Control" />
			<argument index="0" name="begin" type="bool" />
			<description>
				Adds a [Control] node to the box as a spacer. If [code]begin[/code] is [code]true[/code], it will insert the [Control] node in front of all other children.
			</description>
		</method>
	</methods>
	<members>
		<member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignmentMode" default="0">
			The alignment of the container's children (must be one of [constant ALIGNMENT_BEGIN], [constant ALIGNMENT_CENTER], or [constant ALIGNMENT_END]).
		</member>
	</members>
	<constants>
		<constant name="ALIGNMENT_BEGIN" value="0" enum="AlignmentMode">
		</constant>
		<constant name="ALIGNMENT_CENTER" value="1" enum="AlignmentMode">
		</constant>
		<constant name="ALIGNMENT_END" value="2" enum="AlignmentMode">
		</constant>
	</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 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="BoxContainer" inherits="Container" version="4.0" 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 20:42:36 +00:00			`<brief_description>`
Refactor the BoxContainer and BoxShape classes 2017-09-16 05:26:04 +00:00			`Base class for box containers.`
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>`
			`<description>`
Docs: Improved wording and added links - Added missing links to the Control node in BoxContainer - Added Oxford commas in BoxContainer and CanvasItem - Clarified ambiguous boolean wording in BoxContainer - Improved paragraphing in ScrollContainer's description - Simplified ControlPicker description 2020-02-26 03:47:06 +00:00			`Arranges child [Control] nodes vertically or horizontally, and rearranges them automatically when their minimum size changes.`
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>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="add_spacer">`
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 13:28:05 +00:00			`<return type="Control" />`
			`<argument index="0" name="begin" type="bool" />`
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>`
Docs: Improved wording and added links - Added missing links to the Control node in BoxContainer - Added Oxford commas in BoxContainer and CanvasItem - Clarified ambiguous boolean wording in BoxContainer - Improved paragraphing in ScrollContainer's description - Simplified ControlPicker description 2020-02-26 03:47:06 +00:00			`Adds a [Control] node to the box as a spacer. If [code]begin[/code] is [code]true[/code], it will insert the [Control] node in front of all other children.`
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>`
align to horizontal_alignment, valign to vertical_alignment, related 2021-11-25 02:58:47 +00:00			`<member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignmentMode" default="0">`
			`The alignment of the container's children (must be one of [constant ALIGNMENT_BEGIN], [constant ALIGNMENT_CENTER], or [constant ALIGNMENT_END]).`
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>`
align to horizontal_alignment, valign to vertical_alignment, related 2021-11-25 02:58:47 +00:00			`<constant name="ALIGNMENT_BEGIN" value="0" enum="AlignmentMode">`
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			`</constant>`
align to horizontal_alignment, valign to vertical_alignment, related 2021-11-25 02:58:47 +00:00			`<constant name="ALIGNMENT_CENTER" value="1" enum="AlignmentMode">`
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			`</constant>`
align to horizontal_alignment, valign to vertical_alignment, related 2021-11-25 02:58:47 +00:00			`<constant name="ALIGNMENT_END" value="2" enum="AlignmentMode">`
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			`</constant>`
			`</constants>`
			`</class>`