GridContainer

Inherits: Container < Control < CanvasItem < Node < Object

Grid container used to arrange Control-derived children in a grid like layout.

Description

GridContainer will arrange its Control-derived children in a grid like structure, the grid columns are specified using the 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.

Note: GridContainer only works with child nodes inheriting from Control. It won't rearrange child nodes inheriting from Node2D.

Tutorials

• GUI containers

• OS Test Demo

Properties

int	columns	1
MouseFilter	mouse_filter	1 (overrides Control)

Theme Properties

int	hseparation	4
int	vseparation	4

---

Property Descriptions

int columns = 1

• void set_columns ( int value )

• int get_columns ( )

The number of columns in the GridContainer. If modified, GridContainer reorders its Control-derived children to accommodate the new layout.

---

Theme Property Descriptions

int hseparation = 4

The horizontal separation of children nodes.

---

int vseparation = 4

The vertical separation of children nodes.