summaryrefslogtreecommitdiff
path: root/doc/classes/GridContainer.xml
blob: 30976eff99e7cf803367d38d9373d79ed13103b5 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GridContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Grid container used to arrange elements in a grid like layout
	</brief_description>
	<description>
		Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_columns" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the number of columns in this container
			</description>
		</method>
		<method name="set_columns">
			<return type="void">
			</return>
			<argument index="0" name="columns" type="int">
			</argument>
			<description>
				Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
			</description>
		</method>
	</methods>
	<members>
		<member name="columns" type="int" setter="set_columns" getter="get_columns">
			The number of columns in the [code]GridContainer[/code]. If modified, [code]GridContainer[/code] reorders its children to accommodate the new layout.
		</member>
	</members>
	<constants>
	</constants>
	<theme_items>
		<theme_item name="hseparation" type="int">
		</theme_item>
		<theme_item name="vseparation" type="int">
		</theme_item>
	</theme_items>
</class>