diff options
Diffstat (limited to 'doc/classes/BoxContainer.xml')
| -rw-r--r-- | doc/classes/BoxContainer.xml | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml new file mode 100644 index 0000000000..0c70d919f3 --- /dev/null +++ b/doc/classes/BoxContainer.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BoxContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for box containers. + </brief_description> + <description> + Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_spacer"> + <return type="void"> + </return> + <argument index="0" name="begin" type="bool"> + </argument> + <description> + Adds a control to the box as a spacer. If [code]true[/code], [i]begin[/i] will insert the spacer control in front of other children. + </description> + </method> + <method name="get_alignment" qualifiers="const"> + <return type="int" enum="BoxContainer.AlignMode"> + </return> + <description> + Return the alignment of children in the container. + </description> + </method> + <method name="set_alignment"> + <return type="void"> + </return> + <argument index="0" name="alignment" type="int" enum="BoxContainer.AlignMode"> + </argument> + <description> + Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END). + </description> + </method> + </methods> + <members> + <member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode"> + The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). + </member> + </members> + <constants> + <constant name="ALIGN_BEGIN" value="0"> + Aligns children with the beginning of the container. + </constant> + <constant name="ALIGN_CENTER" value="1"> + Aligns children with the center of the container. + </constant> + <constant name="ALIGN_END" value="2"> + Aligns children with the end of the container. + </constant> + </constants> +</class> |