2022-01-07 14:51:49 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 08:08:05 +00:00
<class name= "FlowContainer" inherits= "Container" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2022-01-07 14:51:49 +00:00
<brief_description >
2023-04-30 14:26:09 +00:00
A container that arranges its child controls horizontally or vertically and wraps them around at the borders.
2022-01-07 14:51:49 +00:00
</brief_description>
<description >
2023-04-30 14:26:09 +00:00
A container that arranges its child controls horizontally or vertically and wraps them around at the borders. This is similar to how text in a book wraps around when no more words can fit on a line.
2022-01-07 14:51:49 +00:00
</description>
<tutorials >
2023-04-30 14:26:09 +00:00
<link title= "Using Containers" > $DOCS_URL/tutorials/ui/gui_containers.html</link>
2022-01-07 14:51:49 +00:00
</tutorials>
<methods >
<method name= "get_line_count" qualifiers= "const" >
<return type= "int" />
<description >
Returns the current line count.
</description>
</method>
</methods>
2022-08-22 11:08:57 +00:00
<members >
2022-10-23 09:45:31 +00:00
<member name= "alignment" type= "int" setter= "set_alignment" getter= "get_alignment" enum= "FlowContainer.AlignmentMode" default= "0" >
The alignment of the container's children (must be one of [constant ALIGNMENT_BEGIN], [constant ALIGNMENT_CENTER], or [constant ALIGNMENT_END]).
</member>
2022-08-22 11:08:57 +00:00
<member name= "vertical" type= "bool" setter= "set_vertical" getter= "is_vertical" default= "false" >
If [code]true[/code], the [FlowContainer] will arrange its children vertically, rather than horizontally.
Can't be changed when using [HFlowContainer] and [VFlowContainer].
</member>
</members>
2022-10-23 09:45:31 +00:00
<constants >
<constant name= "ALIGNMENT_BEGIN" value= "0" enum= "AlignmentMode" >
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).
</constant>
<constant name= "ALIGNMENT_CENTER" value= "1" enum= "AlignmentMode" >
The child controls will be centered in the container.
</constant>
<constant name= "ALIGNMENT_END" value= "2" enum= "AlignmentMode" >
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).
</constant>
</constants>
2022-08-22 11:08:57 +00:00
<theme_items >
<theme_item name= "h_separation" data_type= "constant" type= "int" default= "4" >
The horizontal separation of children nodes.
</theme_item>
<theme_item name= "v_separation" data_type= "constant" type= "int" default= "4" >
The vertical separation of children nodes.
</theme_item>
</theme_items>
2022-01-07 14:51:49 +00:00
</class>