class_gridcontainer.rst 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the GridContainer.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_GridContainer:
  5. GridContainer
  6. =============
  7. **Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Grid container used to arrange elements in a grid like layout.
  12. Properties
  13. ----------
  14. +-----------------------+------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`columns<class_GridContainer_property_columns>` |
  16. +-----------------------+------------------------------------------------------+
  17. Theme Properties
  18. ----------------
  19. +-----------------------+-------------+
  20. | :ref:`int<class_int>` | hseparation |
  21. +-----------------------+-------------+
  22. | :ref:`int<class_int>` | vseparation |
  23. +-----------------------+-------------+
  24. Description
  25. -----------
  26. 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.
  27. Property Descriptions
  28. ---------------------
  29. .. _class_GridContainer_property_columns:
  30. - :ref:`int<class_int>` **columns**
  31. +----------+--------------------+
  32. | *Setter* | set_columns(value) |
  33. +----------+--------------------+
  34. | *Getter* | get_columns() |
  35. +----------+--------------------+
  36. The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout.