summaryrefslogtreecommitdiff
path: root/doc/classes/GridContainer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/GridContainer.xml')
-rw-r--r--doc/classes/GridContainer.xml43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml
new file mode 100644
index 0000000000..ca7b868cd8
--- /dev/null
+++ b/doc/classes/GridContainer.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="GridContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Grid container used to arrange elements in a grid like layout
+ </brief_description>
+ <description>
+ Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method 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.
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_columns" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Returns the number of columns in this container
+ </description>
+ </method>
+ <method name="set_columns">
+ <return type="void">
+ </return>
+ <argument index="0" name="columns" type="int">
+ </argument>
+ <description>
+ Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="columns" type="int" setter="set_columns" getter="get_columns">
+ </member>
+ </members>
+ <constants>
+ </constants>
+ <theme_items>
+ <theme_item name="hseparation" type="int">
+ </theme_item>
+ <theme_item name="vseparation" type="int">
+ </theme_item>
+ </theme_items>
+</class>