mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
97 lines
3.9 KiB
ReStructuredText
97 lines
3.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GridContainer.xml.
|
|
|
|
.. _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
|
|
---------
|
|
|
|
- :doc:`GUI containers <../tutorials/ui/gui_containers>`
|
|
|
|
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------+------------------------------------------------------+-------+
|
|
| :ref:`int<class_int>` | :ref:`columns<class_GridContainer_property_columns>` | ``1`` |
|
|
+-----------------------+------------------------------------------------------+-------+
|
|
|
|
Theme Properties
|
|
----------------
|
|
|
|
+-----------------------+----------------------------------------------------------------------+-------+
|
|
| :ref:`int<class_int>` | :ref:`h_separation<class_GridContainer_theme_constant_h_separation>` | ``4`` |
|
|
+-----------------------+----------------------------------------------------------------------+-------+
|
|
| :ref:`int<class_int>` | :ref:`v_separation<class_GridContainer_theme_constant_v_separation>` | ``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_h_separation:
|
|
|
|
- :ref:`int<class_int>` **h_separation**
|
|
|
|
+-----------+-------+
|
|
| *Default* | ``4`` |
|
|
+-----------+-------+
|
|
|
|
The horizontal separation of children nodes.
|
|
|
|
----
|
|
|
|
.. _class_GridContainer_theme_constant_v_separation:
|
|
|
|
- :ref:`int<class_int>` **v_separation**
|
|
|
|
+-----------+-------+
|
|
| *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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|