Container
Base class for all GUI containers.
Container.swift:23class ContainerBase 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.
This object emits the following signals:
Superclasses
class ControlBase class for all GUI controls. Adapts its position and size based on its parent control.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
static let notificationPreSortChildren: IntNotification just before children are going to be sorted, in case there’s something to process beforehand.
static let notificationSortChildren: IntNotification for when sorting the children, it must be obeyed immediately.
class var godotClassName: StringName
Instance members
var preSortChildren: SimpleSignalEmitted when children are going to be sorted.
var sortChildren: SimpleSignalEmitted when sorting the children is needed.
func fitChildInRect(child: Control?, rect: Rect2) Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
func queueSort() Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
Show implementation details (2)
Hide implementation details
func _getAllowedSizeFlagsHorizontal() -> PackedInt32Array Implement to return a list of allowed horizontal
Control.SizeFlagsfor child nodes. 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.func _getAllowedSizeFlagsVertical() -> PackedInt32Array Implement to return a list of allowed vertical
Control.SizeFlagsfor child nodes. 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.
Subclasses
class AspectRatioContainerA container that preserves the proportions of its child controls.
class BoxContainerA container that arranges its child controls horizontally or vertically.
class CenterContainerA container that keeps child controls in its center.
class EditorPropertyCustom control for editing properties that can be added to the
EditorInspector.class FlowContainerA container that arranges its child controls horizontally or vertically and wraps them around at the borders.
class GraphElementA container that represents a basic element that can be placed inside a
GraphEditcontrol.class GridContainerA container that arranges its child controls in a grid layout.
class MarginContainerA container that keeps a margin around its child controls.
class PanelContainerA container that keeps its child controls within the area of a
StyleBox.class ScrollContainerA container used to provide scrollbars to a child control when needed.
class SplitContainerA container that splits two child controls horizontally or vertically and provides a grabber for adjusting the split ratio.
class SubViewportContainerA container used for displaying the contents of a
SubViewport.class TabContainerA container that creates a tab for each child control, displaying only the active tab’s control.