FlowContainer

Inherits: Container < Control < CanvasItem < Node < Object

Inherited By: HFlowContainer, VFlowContainer

Base class for flow containers.

Description

Arranges child Control nodes vertically or horizontally in a left-to-right or top-to-bottom flow.

A line is filled with Control nodes until no more fit on the same line, similar to text in an autowrapped label.

Properties

AlignmentMode

alignment

0

bool

vertical

false

Methods

int

get_line_count ( ) const

Theme Properties

int

h_separation

4

int

v_separation

4


Enumerations

enum AlignmentMode:

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

AlignmentMode ALIGNMENT_CENTER = 1

The child controls will be centered in the container.

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


Property Descriptions

AlignmentMode alignment = 0

The alignment of the container's children (must be one of ALIGNMENT_BEGIN, ALIGNMENT_CENTER, or ALIGNMENT_END).


bool vertical = false

  • void set_vertical ( bool value )

  • bool is_vertical ( )

If true, the FlowContainer will arrange its children vertically, rather than horizontally.

Can't be changed when using HFlowContainer and VFlowContainer.


Method Descriptions

int get_line_count ( ) const

Returns the current line count.


Theme Property Descriptions

int h_separation = 4

The horizontal separation of children nodes.


int v_separation = 4

The vertical separation of children nodes.