GridContainer.xml 1.9 KB

12345678910111213141516171819202122232425262728293031323334
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="GridContainer" inherits="Container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Grid container used to arrange Control-derived children in a grid like layout.
  5. </brief_description>
  6. <description>
  7. GridContainer will arrange its Control-derived children in a grid like structure, the grid columns are specified using the [member 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.
  8. Notice that grid layout will preserve the columns and rows for every size of the container, and that empty columns will be expanded automatically.
  9. [b]Note:[/b] GridContainer only works with child nodes inheriting from Control. It won't rearrange child nodes inheriting from Node2D.
  10. </description>
  11. <tutorials>
  12. <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
  13. <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link>
  14. </tutorials>
  15. <methods>
  16. </methods>
  17. <members>
  18. <member name="columns" type="int" setter="set_columns" getter="get_columns" default="1">
  19. The number of columns in the [GridContainer]. If modified, [GridContainer] reorders its Control-derived children to accommodate the new layout.
  20. </member>
  21. <member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="1" />
  22. </members>
  23. <constants>
  24. </constants>
  25. <theme_items>
  26. <theme_item name="hseparation" data_type="constant" type="int" default="4">
  27. The horizontal separation of children nodes.
  28. </theme_item>
  29. <theme_item name="vseparation" data_type="constant" type="int" default="4">
  30. The vertical separation of children nodes.
  31. </theme_item>
  32. </theme_items>
  33. </class>