Files
godot-docs/classes/class_gridcontainer.rst
2020-03-13 17:17:50 +01:00

56 lines
2.1 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GridContainer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_GridContainer:
GridContainer
=============
**Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Grid container used to arrange elements in a grid like layout.
Description
-----------
Grid container will arrange its children in a grid like structure, the grid columns are specified using the :ref:`columns<class_GridContainer_property_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.
Properties
----------
+-----------------------+------------------------------------------------------+-------+
| :ref:`int<class_int>` | :ref:`columns<class_GridContainer_property_columns>` | ``1`` |
+-----------------------+------------------------------------------------------+-------+
Theme Properties
----------------
+-----------------------+-------------+---+
| :ref:`int<class_int>` | hseparation | 4 |
+-----------------------+-------------+---+
| :ref:`int<class_int>` | vseparation | 4 |
+-----------------------+-------------+---+
Property Descriptions
---------------------
.. _class_GridContainer_property_columns:
- :ref:`int<class_int>` **columns**
+-----------+--------------------+
| *Default* | ``1`` |
+-----------+--------------------+
| *Setter* | set_columns(value) |
+-----------+--------------------+
| *Getter* | get_columns() |
+-----------+--------------------+
The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout.