virtualx-engine/doc/classes/SplitContainer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SplitContainer" inherits="Container" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Container for splitting and adjusting.
	</brief_description>
	<description>
		Container for splitting two [Control]s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
	</description>
	<tutorials>
		<link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
	</tutorials>
	<methods>
		<method name="clamp_split_offset">
			<return type="void" />
			<description>
				Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values.
			</description>
		</method>
	</methods>
	<members>
		<member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed" default="false">
			If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled.
		</member>
		<member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility" default="0">
			Determines the dragger's visibility. See [enum DraggerVisibility] for details.
		</member>
		<member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset" default="0">
			The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].
		</member>
	</members>
	<signals>
		<signal name="dragged">
			<param index="0" name="offset" type="int" />
			<description>
				Emitted when the dragger is dragged by user.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility">
			The split dragger is visible when the cursor hovers it.
		</constant>
		<constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">
			The split dragger is never visible.
		</constant>
		<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">
			The split dragger is never visible and its space collapsed.
		</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-02-14 14:18:53 +01:00			`<class name="SplitContainer" 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 22:42:36 +02:00			`<brief_description>`
			`Container for splitting and adjusting.`
			`</brief_description>`
			`<description>`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`Container for splitting two [Control]s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.`
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. 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>`
doc: Sync classref with current source 2018-11-23 01:06:24 +01:00			`<method name="clamp_split_offset">`
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="void" />`
doc: Sync classref with current source 2018-11-23 01:06:24 +01:00			`<description>`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values.`
doc: Sync classref with current source 2018-11-23 01:06:24 +01:00			`</description>`
			`</method>`
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			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed" default="false">`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled.`
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			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility" default="0">`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`Determines the dragger's visibility. See [enum DraggerVisibility] for details.`
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			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset" default="0">`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].`
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			`</member>`
			`</members>`
			`<signals>`
			`<signal name="dragged">`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="offset" type="int" />`
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>`
			`Emitted when the dragger is dragged by user.`
			`</description>`
			`</signal>`
			`</signals>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility">`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`The split dragger is visible when the cursor hovers it.`
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			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`The split dragger is never visible.`
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			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">`
Complete the SplitContainer and Tabs documentations 2020-01-05 22:19:08 +01:00			`The split dragger is never visible and its space collapsed.`
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			`</constant>`
			`</constants>`
			`</class>`