f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
38 lines
1.5 KiB
XML
38 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="BoxContainer" inherits="Container" version="3.4">
|
|
<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>
|
|
<methods>
|
|
<method name="add_spacer">
|
|
<return type="void" />
|
|
<argument index="0" name="begin" type="bool" />
|
|
<description>
|
|
Adds a control to the box as a spacer. If [code]true[/code], [code]begin[/code] will insert the spacer control in front of other children.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode" default="0">
|
|
The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).
|
|
</member>
|
|
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" override="true" enum="Control.MouseFilter" default="1" />
|
|
</members>
|
|
<constants>
|
|
<constant name="ALIGN_BEGIN" value="0" enum="AlignMode">
|
|
Aligns children with the beginning of the container.
|
|
</constant>
|
|
<constant name="ALIGN_CENTER" value="1" enum="AlignMode">
|
|
Aligns children with the center of the container.
|
|
</constant>
|
|
<constant name="ALIGN_END" value="2" enum="AlignMode">
|
|
Aligns children with the end of the container.
|
|
</constant>
|
|
</constants>
|
|
</class>
|