class_gridcontainer.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_GridContainer:
  4. GridContainer
  5. =============
  6. **Inherits:** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Grid container used to arrange elements in a grid like layout
  11. Member Functions
  12. ----------------
  13. +------------------------+-------------------------------------------------------------------------------------------------+
  14. | :ref:`int<class_int>` | :ref:`get_columns<class_GridContainer_get_columns>` **(** **)** const |
  15. +------------------------+-------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_columns<class_GridContainer_set_columns>` **(** :ref:`int<class_int>` columns **)** |
  17. +------------------------+-------------------------------------------------------------------------------------------------+
  18. Description
  19. -----------
  20. 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.
  21. Member Function Description
  22. ---------------------------
  23. .. _class_GridContainer_get_columns:
  24. - :ref:`int<class_int>` **get_columns** **(** **)** const
  25. Returns the number of columns in this container
  26. .. _class_GridContainer_set_columns:
  27. - void **set_columns** **(** :ref:`int<class_int>` columns **)**
  28. Sets the numbers of columns in the container, then reorder its children to accommodate the new layout