class_gridcontainer.rst 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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. Member Functions
  13. ----------------
  14. +------------------------+-------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_columns<class_GridContainer_get_columns>` **(** **)** const |
  16. +------------------------+-------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_columns<class_GridContainer_set_columns>` **(** :ref:`int<class_int>` columns **)** |
  18. +------------------------+-------------------------------------------------------------------------------------------------+
  19. Member Variables
  20. ----------------
  21. - :ref:`int<class_int>` **columns** - The number of columns in the [code]GridContainer[/code]. If modified, [code]GridContainer[/code] reorders its children to accommodate the new layout.
  22. Description
  23. -----------
  24. 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.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_GridContainer_get_columns:
  28. - :ref:`int<class_int>` **get_columns** **(** **)** const
  29. Returns the number of columns in this container
  30. .. _class_GridContainer_set_columns:
  31. - void **set_columns** **(** :ref:`int<class_int>` columns **)**
  32. Sets the numbers of columns in the container, then reorder its children to accommodate the new layout