| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/3.6/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.
- .. rst-class:: classref-introduction-group
- 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.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`GUI containers <../tutorials/ui/gui_containers>`
- - `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +----------------------------------------------+------------------------------------------------------+-----------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`columns<class_GridContainer_property_columns>` | ``1`` |
- +----------------------------------------------+------------------------------------------------------+-----------------------------------------------------------------------+
- | :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``1`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
- +----------------------------------------------+------------------------------------------------------+-----------------------------------------------------------------------+
- .. rst-class:: classref-reftable-group
- Theme Properties
- ----------------
- .. table::
- :widths: auto
- +-----------------------+--------------------------------------------------------------------+-------+
- | :ref:`int<class_int>` | :ref:`hseparation<class_GridContainer_theme_constant_hseparation>` | ``4`` |
- +-----------------------+--------------------------------------------------------------------+-------+
- | :ref:`int<class_int>` | :ref:`vseparation<class_GridContainer_theme_constant_vseparation>` | ``4`` |
- +-----------------------+--------------------------------------------------------------------+-------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_GridContainer_property_columns:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **columns** = ``1``
- .. rst-class:: classref-property-setget
- - void **set_columns** **(** :ref:`int<class_int>` value **)**
- - :ref:`int<class_int>` **get_columns** **(** **)**
- The number of columns in the **GridContainer**. If modified, **GridContainer** reorders its Control-derived children to accommodate the new layout.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Theme Property Descriptions
- ---------------------------
- .. _class_GridContainer_theme_constant_hseparation:
- .. rst-class:: classref-themeproperty
- :ref:`int<class_int>` **hseparation** = ``4``
- The horizontal separation of children nodes.
- .. rst-class:: classref-item-separator
- ----
- .. _class_GridContainer_theme_constant_vseparation:
- .. rst-class:: classref-themeproperty
- :ref:`int<class_int>` **vseparation** = ``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.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
