summaryrefslogtreecommitdiff
path: root/doc/classes/GridContainer.xml
blob: ca6b4e69c369f9fcbd3adf76b3a99864d299ea91 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GridContainer" inherits="Container" version="4.0">
	<brief_description>
		Grid container used to arrange Control-derived children in a grid like layout.
	</brief_description>
	<description>
		GridContainer will arrange its Control-derived children in a grid like structure, the grid columns are specified using the [member columns] property 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, and that empty columns will be expanded automatically.
		[b]Note:[/b] GridContainer only works with child nodes inheriting from Control. It won't rearrange child nodes inheriting from Node2D.
	</description>
	<tutorials>
		<link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="columns" type="int" setter="set_columns" getter="get_columns" default="1">
			The number of columns in the [GridContainer]. If modified, [GridContainer] reorders its Control-derived children to accommodate the new layout.
		</member>
	</members>
	<constants>
	</constants>
	<theme_items>
		<theme_item name="hseparation" type="int" default="4">
			The horizontal separation of children nodes.
		</theme_item>
		<theme_item name="vseparation" type="int" default="4">
			The vertical separation of children nodes.
		</theme_item>
	</theme_items>
</class>