Class BoxLayout

Layout manager arranging widgets in a row or column.

Hierarchy (View Summary)

Layout
- BoxLayout

Index

Constructors

Properties

enabled isNull spacing

Methods

addLayout addStretch addWidget addWidgetWithStretch clear deleteLater getTypeName isOfType isSame setContentsMargins setDirection setLayoutAlignment setWidgetAlignment

Constructors

constructor

new BoxLayout(): BoxLayout
Construct a BoxLayout for arranging widgets in a linear direction.

Returns BoxLayout
Overrides Layout.constructor

Properties

enabled

enabled: boolean

Whether the layout is active and responsive to user input.

`Readonly`isNull

isNull: boolean

Whether this object references a valid layout.

spacing

spacing: number

Distance between widgets in the layout.

Methods

addLayout

addLayout(layout: Layout): void
Adds a child layout to this BoxLayout. The child layout is appended in the current direction (left-to-right or top-to-bottom).
Parameters
- layout: Layout
Returns void

addStretch

addStretch(stretch: number): void
Adds a stretch space (spacer) with the specified stretch factor. Higher stretch values take more available space proportionally. Default factor is 0 (fixed space).
Parameters
- stretch: number
Returns void

addWidget

addWidget(widget: Widget): void
Add a widget to the layout.
Parameters
- widget: Widget
Returns void
Inherited from Layout.addWidget

addWidgetWithStretch

addWidgetWithStretch(
    widget: Widget,
    stretch: number,
    alignment: Alignment,
): void
Adds a widget to the layout with an optional stretch factor and alignment. The stretch determines how much space the widget claims; alignment controls its position within its allocated space.
Parameters
- widget: Widget
- stretch: number
- alignment: Alignment
Returns void

clear

clear(behavior: ClearLayoutBehavior): void
Remove all widgets from the layout with specified cleanup behavior.
Parameters
- behavior: ClearLayoutBehavior
Returns void
Inherited from Layout.clear

deleteLater

deleteLater(): void
Schedule layout for deletion after event processing.

Returns void
Inherited from Layout.deleteLater

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Layout.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from Layout.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Layout.isSame

setContentsMargins

setContentsMargins(
    left: number,
    top: number,
    right: number,
    bottom: number,
): void
Set the margins around layout contents.
Parameters
- left: number
- top: number
- right: number
- bottom: number
Returns void
Inherited from Layout.setContentsMargins

setDirection

setDirection(direction: Direction): void
Sets the layout direction (LeftToRight, RightToLeft, TopToBottom, BottomToTop). Controls whether widgets are arranged horizontally or vertically.
Parameters
- direction: Direction
Returns void

setLayoutAlignment

setLayoutAlignment(layout: Layout, alignment: Alignment): boolean
Set alignment for a nested layout within this layout.
Parameters
- layout: Layout
- alignment: Alignment
Returns boolean
Inherited from Layout.setLayoutAlignment

setWidgetAlignment

setWidgetAlignment(widget: Widget, alignment: Alignment): boolean
Set alignment for a widget within this layout.
Parameters
- widget: Widget
- alignment: Alignment
Returns boolean
Inherited from Layout.setWidgetAlignment