Class Layout

Base class for layout managers.

Hierarchy (View Summary)

ScriptObject
- Layout

Index

Constructors

Properties

enabled isNull spacing

Methods

addWidget clear deleteLater getTypeName isOfType isSame setContentsMargins setLayoutAlignment setWidgetAlignment

Constructors

`Protected`constructor

new Layout(): Layout
Snap Hidden
Returns Layout
Overrides ScriptObject.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

addWidget

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

clear

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

deleteLater

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

Returns void

getTypeName

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

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.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 ScriptObject.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

setLayoutAlignment

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

setWidgetAlignment

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