summaryrefslogtreecommitdiff
path: root/doc/classes/BoxContainer.xml
diff options
context:
space:
mode:
authorRoger Smith <nz.rogersmith@gmail.com>2017-09-16 17:26:04 +1200
committerRoger Smith <nz.rogersmith@gmail.com>2017-09-16 18:39:00 +1200
commitf818448199bfc13674016499d545c95b9befb3a9 (patch)
treeec8a9d1192ffb66834ed9aa93b95161bd4a6088a /doc/classes/BoxContainer.xml
parent62cb43bb8dec8f5078012b58ff06a2077078565f (diff)
Refactor the BoxContainer and BoxShape classes
Diffstat (limited to 'doc/classes/BoxContainer.xml')
-rw-r--r--doc/classes/BoxContainer.xml14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml
index f7e50f02d8..0c70d919f3 100644
--- a/doc/classes/BoxContainer.xml
+++ b/doc/classes/BoxContainer.xml
@@ -1,10 +1,10 @@
<?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.
+ Base class for box containers.
</brief_description>
<description>
- Base class for Box containers. It arranges children controls vertically or horizontally, and rearranges them automatically when their minimum size changes.
+ Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.
</description>
<tutorials>
</tutorials>
@@ -17,8 +17,7 @@
<argument index="0" name="begin" type="bool">
</argument>
<description>
- Add a control to the box as a spacer.
- If [i]begin[/i] is true the spacer control will be inserted in front of other children.
+ 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">
@@ -40,17 +39,18 @@
</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">
- Align children with beginning of the container.
+ Aligns children with the beginning of the container.
</constant>
<constant name="ALIGN_CENTER" value="1">
- Align children with center of the container.
+ Aligns children with the center of the container.
</constant>
<constant name="ALIGN_END" value="2">
- Align children with end of the container.
+ Aligns children with the end of the container.
</constant>
</constants>
</class>