mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
54 lines
2.3 KiB
ReStructuredText
54 lines
2.3 KiB
ReStructuredText
.. 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>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Grid container used to arrange elements in a grid like layout
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------+-------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_columns<class_GridContainer_get_columns>` **(** **)** const |
|
|
+------------------------+-------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_columns<class_GridContainer_set_columns>` **(** :ref:`int<class_int>` columns **)** |
|
|
+------------------------+-------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`int<class_int>` **columns** - The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Grid container will arrange its children in a grid like structure, the grid columns are specified using the :ref:`set_columns<class_GridContainer_set_columns>` method 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.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_GridContainer_get_columns:
|
|
|
|
- :ref:`int<class_int>` **get_columns** **(** **)** const
|
|
|
|
Returns the number of columns in this container
|
|
|
|
.. _class_GridContainer_set_columns:
|
|
|
|
- void **set_columns** **(** :ref:`int<class_int>` columns **)**
|
|
|
|
Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
|
|
|
|
|