BoxContainer

Inherits: Container < Control < CanvasItem < Node < Object

Inherited By: VBoxContainer, ButtonGroup, HBoxContainer, ColorPicker

Category: Core

Brief Description

Base class for Box containers.

Member Functions

void	add_spacer ( bool begin )
int	get_alignment ( ) const
void	set_alignment ( int alignment )

Numeric Constants

• ALIGN_BEGIN = 0 — Align children with beginning of the container.
• ALIGN_CENTER = 1 — Align children with center of the container.
• ALIGN_END = 2 — Align children with end of the container.

Description

Base class for Box containers. It arranges children controls vertically or horizontally, and rearranges them automatically when their minimum size changes.

Member Function Description

void add_spacer ( bool begin )

Add a control to the box as a spacer.

If begin is true the spacer control will be inserted in front of other children.

int get_alignment ( ) const

Return the alignment of children in the container.

void set_alignment ( int alignment )

Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END).