FlowContainer

Inherits:Container<Control<CanvasItem<Node<Object

Inherited By:HFlowContainer,VFlowContainer

A container that arranges its child controls horizontally or vertically and wraps them around at the borders.

Description

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.

Tutorials

Properties

AlignmentMode

alignment

0

LastWrapAlignmentMode

last_wrap_alignment

0

bool

reverse_fill

false

bool

vertical

false

Methods

int

get_line_count()const

Theme Properties

int

h_separation

4

int

v_separation

4


Enumerations

enumAlignmentMode:🔗

AlignmentModeALIGNMENT_BEGIN =0

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).

AlignmentModeALIGNMENT_CENTER =1

The child controls will be centered in the container.

AlignmentModeALIGNMENT_END =2

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).


enumLastWrapAlignmentMode:🔗

LastWrapAlignmentModeLAST_WRAP_ALIGNMENT_INHERIT =0

The last partially filled row or column will wrap aligned to the previous row or column in accordance withalignment.

LastWrapAlignmentModeLAST_WRAP_ALIGNMENT_BEGIN =1

The last partially filled row or column will wrap aligned to the beginning of the previous row or column.

LastWrapAlignmentModeLAST_WRAP_ALIGNMENT_CENTER =2

The last partially filled row or column will wrap aligned to the center of the previous row or column.

LastWrapAlignmentModeLAST_WRAP_ALIGNMENT_END =3

The last partially filled row or column will wrap aligned to the end of the previous row or column.


Property Descriptions

AlignmentModealignment =0🔗

The alignment of the container's children (must be one ofALIGNMENT_BEGIN,ALIGNMENT_CENTER, orALIGNMENT_END).


LastWrapAlignmentModelast_wrap_alignment =0🔗

The wrap behavior of the last, partially filled row or column (must be one ofLAST_WRAP_ALIGNMENT_INHERIT,LAST_WRAP_ALIGNMENT_BEGIN,LAST_WRAP_ALIGNMENT_CENTER, orLAST_WRAP_ALIGNMENT_END).


boolreverse_fill =false🔗

Iftrue, reverses fill direction. HorizontalFlowContainers will fill rows bottom to top, verticalFlowContainers will fill columns right to left.

When using a verticalFlowContainer with a right to leftControl.layout_direction, columns will fill left to right instead.


boolvertical =false🔗

Iftrue, theFlowContainer will arrange its children vertically, rather than horizontally.

Can't be changed when usingHFlowContainer andVFlowContainer.


Method Descriptions

intget_line_count()const🔗

Returns the current line count.


Theme Property Descriptions

inth_separation =4🔗

The horizontal separation of child nodes.


intv_separation =4🔗

The vertical separation of child nodes.


User-contributed notes

Please read theUser-contributed notes policy before submitting a comment.