| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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 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 :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.
- **Note:** GridContainer only works with child nodes inheriting from Control. It won't rearrange child nodes inheriting from Node2D.
- Tutorials
- ---------
- - `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__
- Properties
- ----------
- +----------------------------------------------+------------------------------------------------------+---------------------------+
- | :ref:`int<class_int>` | :ref:`columns<class_GridContainer_property_columns>` | ``1`` |
- +----------------------------------------------+------------------------------------------------------+---------------------------+
- | :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``1`` *(parent override)* |
- +----------------------------------------------+------------------------------------------------------+---------------------------+
- Theme Properties
- ----------------
- +-----------------------+--------------------------------------------------------------------+-------+
- | :ref:`int<class_int>` | :ref:`hseparation<class_GridContainer_theme_constant_hseparation>` | ``4`` |
- +-----------------------+--------------------------------------------------------------------+-------+
- | :ref:`int<class_int>` | :ref:`vseparation<class_GridContainer_theme_constant_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 Control-derived children to accommodate the new layout.
- Theme Property Descriptions
- ---------------------------
- .. _class_GridContainer_theme_constant_hseparation:
- - :ref:`int<class_int>` **hseparation**
- +-----------+-------+
- | *Default* | ``4`` |
- +-----------+-------+
- The horizontal separation of children nodes.
- ----
- .. _class_GridContainer_theme_constant_vseparation:
- - :ref:`int<class_int>` **vseparation**
- +-----------+-------+
- | *Default* | ``4`` |
- +-----------+-------+
- The vertical separation of children nodes.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
