Skip to content
Download
API reference

Container

Inherits: Control < CanvasItem < Actor < Object

Inherited by: AspectRatioContainer, Box, BoxContainer, CenterContainer, EditorProperty, FlowContainer, FoldableContainer, GraphElement, GridContainer, MarginContainer, PanelContainer, ScrollContainer, SplitContainer, SubViewportContainer, TabContainer

Base class for all GUI containers.

Base class for all GUI containers. A Container automatically arranges its child controls in a certain way. This class can be inherited to make custom container types.

TypeNameDefault
boolaccessibility_regionfalse
Control.MouseFiltermouse_filter1
boolpropagate_maximum_sizetrue
ReturnsMethod
[]i32_get_allowed_size_flags_horizontal()
[]i32_get_allowed_size_flags_vertical()
voidfit_child_in_rect(child, rect)
voidqueue_sort()

pre_sort_children()

Emitted when children are going to be sorted.

sort_children()

Emitted when sorting the children is needed.

  • NOTIFICATION_PRE_SORT_CHILDREN = 50 — Notification just before children are going to be sorted, in case there’s something to process beforehand.

  • NOTIFICATION_SORT_CHILDREN = 51 — Notification for when sorting the children, it must be obeyed immediately.

bool accessibility_region = false

Setter/getter: set_accessibility_region(), is_accessibility_region()

If true, this container is marked as a region for accessibility. Use Control.accessibility_name to give the region a descriptive name. Screen readers can navigate between regions using landmark navigation.

Control.MouseFilter mouse_filter = 1

Setter/getter: set_mouse_filter(), get_mouse_filter()

No description yet.

bool propagate_maximum_size = true

Setter/getter: set_propagate_maximum_size(), is_propagating_maximum_size()

No description yet.

[]i32 _get_allowed_size_flags_horizontal() virtual const

Implement to return a list of allowed horizontal Control.SizeFlags for child actors. This doesn’t technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock.

Note: Having no size flags is equal to having Control.SIZE_SHRINK_BEGIN. As such, this value is always implicitly allowed.

[]i32 _get_allowed_size_flags_vertical() virtual const

Implement to return a list of allowed vertical Control.SizeFlags for child actors. This doesn’t technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock.

Note: Having no size flags is equal to having Control.SIZE_SHRINK_BEGIN. As such, this value is always implicitly allowed.

void fit_child_in_rect(child: Control, rect: Rect2)

Fit a child control in a given rect. This is mainly a helper for creating custom container classes.

void queue_sort()

Queue resort of the contained children. This is called automatically anyway, but can be called upon request.