Class GridLayout

Layout manager arranging widgets in a grid.

Hierarchy (View Summary)

Layout
- GridLayout

Constructors

constructor

new GridLayout(): GridLayout
Constructor for a grid layout container that arranges child widgets in rows and columns.

Returns GridLayout
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,
    row: number,
    column: number,
    alignment: Alignment,
): void
Add a layout to the grid at a specific row and column with alignment.
Parameters
- layout: Layout
- row: number
- column: number
- alignment: Alignment
Returns void

addWidget

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

addWidgetAt

addWidgetAt(
    widget: Widget,
    row: number,
    column: number,
    alignment: Alignment,
): void
Add a widget to the grid at a specific row and column with alignment.
Parameters
- widget: Widget
- row: number
- column: number
- alignment: Alignment
Returns void

addWidgetWithSpan

addWidgetWithSpan(
    widget: Widget,
    fromRow: number,
    fromColumn: number,
    rowSpan: number,
    columnSpan: number,
    alignment: Alignment,
): void
Add a widget to the grid spanning multiple rows and columns with alignment.
Parameters
- widget: Widget
- fromRow: number
- fromColumn: number
- rowSpan: number
- columnSpan: 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

getColumnMinimumWidth

getColumnMinimumWidth(column: number): number
Get the minimum width of a column.
Parameters
- column: number
Returns number

getColumnStretch

getColumnStretch(column: number): number
Get the stretch factor of a column.
Parameters
- column: number
Returns number

getRowMinimumHeight

getRowMinimumHeight(row: number): number
Get the minimum height of a row.
Parameters
- row: number
Returns number

getRowStretch

getRowStretch(row: number): number
Get the stretch factor of a row.
Parameters
- row: number
Returns number

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

setColumnMinimumWidth

setColumnMinimumWidth(column: number, minSize: number): void
Set the minimum width of a column.
Parameters
- column: number
- minSize: number
Returns void

setColumnStretch

setColumnStretch(column: number, stretch: number): void
Set the stretch factor of a column.
Parameters
- column: number
- stretch: number
Returns void

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

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

setRowMinimumHeight

setRowMinimumHeight(row: number, minSize: number): void
Set the minimum height of a row.
Parameters
- row: number
- minSize: number
Returns void

setRowStretch

setRowStretch(row: number, stretch: number): void
Set the stretch factor of a row.
Parameters
- row: number
- stretch: number
Returns void

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