2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-03-01 08:44:37 +08:00
<class name= "BoxContainer" inherits= "Container" version= "4.1" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2017-09-16 13:26:04 +08:00
Base class for box containers.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2020-02-26 11:47:06 +08:00
Arranges child [Control] nodes vertically or horizontally, and rearranges them automatically when their minimum size changes.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2022-04-21 14:16:02 +08:00
<link title= "GUI containers" > $DOCS_URL/tutorials/ui/gui_containers.html</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
<method name= "add_spacer" >
2021-07-30 21:28:05 +08:00
<return type= "Control" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "begin" type= "bool" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Adds a [Control] node to the box as a spacer. If [param begin] is [code]true[/code], it will insert the [Control] node in front of all other children.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<members >
2021-11-25 10:58:47 +08:00
<member name= "alignment" type= "int" setter= "set_alignment" getter= "get_alignment" enum= "BoxContainer.AlignmentMode" default= "0" >
The alignment of the container's children (must be one of [constant ALIGNMENT_BEGIN], [constant ALIGNMENT_CENTER], or [constant ALIGNMENT_END]).
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 19:08:57 +08:00
<member name= "vertical" type= "bool" setter= "set_vertical" getter= "is_vertical" default= "false" >
If [code]true[/code], the [BoxContainer] will arrange its children vertically, rather than horizontally.
Can't be changed when using [HBoxContainer] and [VBoxContainer].
</member>
2017-09-13 04:42:36 +08:00
</members>
<constants >
2021-11-25 10:58:47 +08:00
<constant name= "ALIGNMENT_BEGIN" value= "0" enum= "AlignmentMode" >
2022-08-22 19:08:57 +08:00
The child controls will be arranged at the beginning of the container, i.e. top if orientation is vertical, left if orientation is horizontal (right for RTL layout).
2017-09-13 04:42:36 +08:00
</constant>
2021-11-25 10:58:47 +08:00
<constant name= "ALIGNMENT_CENTER" value= "1" enum= "AlignmentMode" >
2022-08-22 19:08:57 +08:00
The child controls will be centered in the container.
2017-09-13 04:42:36 +08:00
</constant>
2021-11-25 10:58:47 +08:00
<constant name= "ALIGNMENT_END" value= "2" enum= "AlignmentMode" >
2022-08-22 19:08:57 +08:00
The child controls will be arranged at the end of the container, i.e. bottom if orientation is vertical, right if orientation is horizontal (left for RTL layout).
2017-09-13 04:42:36 +08:00
</constant>
</constants>
2022-08-22 19:08:57 +08:00
<theme_items >
<theme_item name= "separation" data_type= "constant" type= "int" default= "4" >
The space between the [BoxContainer]'s elements, in pixels.
</theme_item>
</theme_items>
2017-09-13 04:42:36 +08:00
</class>