summaryrefslogtreecommitdiff
path: root/doc/classes/SplitContainer.xml
blob: 71731f685a51745544ddbba24ee00f245fab8c05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SplitContainer" inherits="Container" category="Core" version="3.2">
	<brief_description>
		Container for splitting and adjusting.
	</brief_description>
	<description>
		Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="clamp_split_offset">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed" default="false">
		</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 options.
		</member>
		<member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset" default="0">
		</member>
	</members>
	<signals>
		<signal name="dragged">
			<argument index="0" name="offset" type="int">
			</argument>
			<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.
		</constant>
		<constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">
			The split dragger is invisible.
		</constant>
		<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">
			The split dragger is invisible and collapsed.
		</constant>
	</constants>
</class>