class_gridcontainer.rst 2.1 KB

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