2017-09-12 20:42:36 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2022-08-05 16:51:38 +00:00
|
|
|
<class name="BoxContainer" inherits="Container" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
2017-09-12 20:42:36 +00:00
|
|
|
<brief_description>
|
2017-09-16 05:26:04 +00:00
|
|
|
Base class for box containers.
|
2017-09-12 20:42:36 +00:00
|
|
|
</brief_description>
|
|
|
|
<description>
|
2017-09-16 05:26:04 +00:00
|
|
|
Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
2022-04-21 06:16:02 +00:00
|
|
|
<link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
|
2017-09-12 20:42:36 +00:00
|
|
|
</tutorials>
|
|
|
|
<methods>
|
|
|
|
<method name="add_spacer">
|
2021-07-30 13:28:05 +00:00
|
|
|
<return type="void" />
|
|
|
|
<argument index="0" name="begin" type="bool" />
|
2017-09-12 20:42:36 +00:00
|
|
|
<description>
|
2019-06-21 23:04:47 +00:00
|
|
|
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.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
</methods>
|
|
|
|
<members>
|
2019-06-29 10:38:01 +00:00
|
|
|
<member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode" default="0">
|
2019-06-21 23:04:47 +00:00
|
|
|
The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2021-12-02 20:15:17 +00:00
|
|
|
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="1" />
|
2017-09-12 20:42:36 +00:00
|
|
|
</members>
|
|
|
|
<constants>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="ALIGN_BEGIN" value="0" enum="AlignMode">
|
2017-09-16 05:26:04 +00:00
|
|
|
Aligns children with the beginning of the container.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="ALIGN_CENTER" value="1" enum="AlignMode">
|
2017-09-16 05:26:04 +00:00
|
|
|
Aligns children with the center of the container.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="ALIGN_END" value="2" enum="AlignMode">
|
2017-09-16 05:26:04 +00:00
|
|
|
Aligns children with the end of the container.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
|
|
|
</constants>
|
|
|
|
</class>
|