virtualx-engine/doc/classes/Container.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Container" inherits="Control" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base node for containers.
	</brief_description>
	<description>
		Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way.
		A Control can inherit this to create custom container classes.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="fit_child_in_rect">
			<return type="void" />
			<argument index="0" name="child" type="Control" />
			<argument index="1" name="rect" type="Rect2" />
			<description>
				Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
			</description>
		</method>
		<method name="queue_sort">
			<return type="void" />
			<description>
				Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="sort_children">
			<description>
				Emitted when sorting the children is needed.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="NOTIFICATION_SORT_CHILDREN" value="50">
			Notification for when sorting the children, it must be obeyed immediately.
		</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 22:42:36 +02: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-03-16 23:01:02 +01:00			`<class name="Container" inherits="Control" version="3.5" 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>`
			`Base node for containers.`
			`</brief_description>`
			`<description>`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 23:37:35 +01:00			`Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way.`
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			`A Control can inherit this to create custom container classes.`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="fit_child_in_rect">`
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="void" />`
			`<argument index="0" name="child" type="Control" />`
			`<argument index="1" name="rect" type="Rect2" />`
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>`
			`Fit a child control in a given rect. This is mainly a helper for creating custom container classes.`
			`</description>`
			`</method>`
			`<method name="queue_sort">`
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="void" />`
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>`
			`Queue resort of the contained children. This is called automatically anyway, but can be called upon request.`
			`</description>`
			`</method>`
			`</methods>`
			`<signals>`
			`<signal name="sort_children">`
			`<description>`
			`Emitted when sorting the children is needed.`
			`</description>`
			`</signal>`
			`</signals>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="NOTIFICATION_SORT_CHILDREN" value="50">`
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			`Notification for when sorting the children, it must be obeyed immediately.`
			`</constant>`
			`</constants>`
			`</class>`