summaryrefslogtreecommitdiff
path: root/doc/classes/FlowContainer.xml
blob: d449049ef1e46689906ae3911cf8de42e61f3e7e (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="FlowContainer" inherits="Container" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base class for flow containers.
	</brief_description>
	<description>
		Arranges child [Control] nodes vertically or horizontally in a left-to-right or top-to-bottom flow.
		A line is filled with [Control] nodes until no more fit on the same line, similar to text in an autowrapped label.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_line_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the current line count.
			</description>
		</method>
	</methods>
	<members>
		<member name="vertical" type="bool" setter="set_vertical" getter="is_vertical" default="false">
			If [code]true[/code], the [FlowContainer] will arrange its children vertically, rather than horizontally.
			Can't be changed when using [HFlowContainer] and [VFlowContainer].
		</member>
	</members>
	<theme_items>
		<theme_item name="h_separation" data_type="constant" type="int" default="4">
			The horizontal separation of children nodes.
		</theme_item>
		<theme_item name="v_separation" data_type="constant" type="int" default="4">
			The vertical separation of children nodes.
		</theme_item>
	</theme_items>
</class>