nodeguy/website/docs/api/generated/classes/qboxlayout.md

id	title	sidebar_label
qboxlayout	QBoxLayout	QBoxLayout

Lines up child widgets horizontally or vertically.

This class is a JS wrapper around Qt's QBoxLayout class

Example

// This example arranges two calendars horizontally.

const { QBoxLayout, QCalendarWidget } = require("@nodegui/nodegui");

const centralWidget = new QWidget();
const boxLayout = new QBoxLayout(0);

boxLayout.addWidget(new QCalendarWidget());
boxLayout.addWidget(new QCalendarWidget());
centralWidget.setLayout(boxLayout);

Hierarchy

↳ NodeLayout‹QBoxLayoutSignals›

↳ QBoxLayout

Index

Constructors

• constructor

Properties

• childLayouts
• native
• nodeChildren
• nodeParent
• type

Methods

• activate
• addEventListener
• addLayout
• addSpacing
• addStretch
• addStrut
• addWidget
• count
• direction
• inherits
• insertLayout
• insertSpacing
• insertStretch
• insertWidget
• invalidate
• isEnabled
• objectName
• property
• removeEventListener
• removeWidget
• setContentsMargins
• setDirection
• setEnabled
• setNodeParent
• setObjectName
• setProperty
• setSizeConstraint
• setSpacing
• setStretch
• sizeConstraint
• spacing
• update

Constructors

constructor

+ new QBoxLayout(dir: Direction): QBoxLayout

Overrides EventWidget.constructor

Parameters:

Name	Type
dir	Direction

Returns: QBoxLayout

+ new QBoxLayout(dir: Direction, parent: NodeWidget‹any›): QBoxLayout

Overrides EventWidget.constructor

Parameters:

Name	Type
dir	Direction
parent	NodeWidget‹any›

Returns: QBoxLayout

Properties

childLayouts

• childLayouts: Set‹NodeLayout‹any››

---

native

• native: NativeElement

Overrides Component.native

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from Component.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent

---

type

• type: string = "layout"

Inherited from NodeLayout.type

Methods

activate

▸ activate(): boolean

Inherited from NodeLayout.activate

Returns: boolean

---

addEventListener

▸ addEventListener<SignalType>(signalType: SignalType, callback: QBoxLayoutSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof QBoxLayoutSignals

Parameters:

Name	Type	Description
signalType	SignalType	SignalType is a signal from the widgets signals interface.
callback	QBoxLayoutSignals[SignalType]	Corresponding callback for the signal as mentioned in the widget's signal interface

Returns: void

void

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface

▸ addEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.addEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

addLayout

▸ addLayout(layout: NodeLayout‹any›, stretch: number): void

Parameters:

Name	Type	Default
layout	NodeLayout‹any›	-
stretch	number	0

Returns: void

---

addSpacing

▸ addSpacing(size: number): void

Parameters:

Name	Type
size	number

Returns: void

---

addStretch

▸ addStretch(stretch: number): void

Parameters:

Name	Type	Default
stretch	number	0

Returns: void

---

addStrut

▸ addStrut(size: number): void

Parameters:

Name	Type
size	number

Returns: void

---

addWidget

▸ addWidget(widget: NodeWidget‹any›, stretch: number): void

Overrides NodeLayout.addWidget

Parameters:

Name	Type	Default
widget	NodeWidget‹any›	-
stretch	number	0

Returns: void

---

count

▸ count(): number

Returns: number

---

direction

▸ direction(): Direction

Returns: Direction

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

insertLayout

▸ insertLayout(index: number, layout: NodeLayout‹any›, stretch: number): void

Parameters:

Name	Type	Default
index	number	-
layout	NodeLayout‹any›	-
stretch	number	0

Returns: void

---

insertSpacing

▸ insertSpacing(index: number, size: number): void

Parameters:

Name	Type
index	number
size	number

Returns: void

---

insertStretch

▸ insertStretch(index: number, stretch: number): void

Parameters:

Name	Type	Default
index	number	-
stretch	number	0

Returns: void

---

insertWidget

▸ insertWidget(index: number, widget: NodeWidget‹any›, stretch: number): void

Parameters:

Name	Type	Default
index	number	-
widget	NodeWidget‹any›	-
stretch	number	0

Returns: void

---

invalidate

▸ invalidate(): void

Inherited from NodeLayout.invalidate

Returns: void

---

isEnabled

▸ isEnabled(): boolean

Inherited from NodeLayout.isEnabled

Returns: boolean

---

objectName

▸ objectName(): string

Inherited from NodeObject.objectName

Returns: string

---

property

▸ property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

removeEventListener

▸ removeEventListener<SignalType>(signalType: SignalType, callback: QBoxLayoutSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QBoxLayoutSignals

Parameters:

Name	Type
signalType	SignalType
callback	QBoxLayoutSignals[SignalType]

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

removeWidget

▸ removeWidget(widget: NodeWidget‹any›): void

Overrides NodeLayout.removeWidget

Parameters:

Name	Type
widget	NodeWidget‹any›

Returns: void

---

setContentsMargins

▸ setContentsMargins(left: number, top: number, right: number, bottom: number): void

Inherited from NodeLayout.setContentsMargins

Parameters:

Name	Type
left	number
top	number
right	number
bottom	number

Returns: void

---

setDirection

▸ setDirection(dir: Direction): void

Parameters:

Name	Type
dir	Direction

Returns: void

---

setEnabled

▸ setEnabled(enable: boolean): void

Inherited from NodeLayout.setEnabled

Parameters:

Name	Type
enable	boolean

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from NodeObject.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setProperty

▸ setProperty(name: string, value: QVariantType): boolean

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setSizeConstraint

▸ setSizeConstraint(constraint: SizeConstraint): void

Inherited from NodeLayout.setSizeConstraint

Parameters:

Name	Type
constraint	SizeConstraint

Returns: void

---

setSpacing

▸ setSpacing(spacing: number): void

Inherited from NodeLayout.setSpacing

Parameters:

Name	Type
spacing	number

Returns: void

---

setStretch

▸ setStretch(index: number, stretch: number): void

Parameters:

Name	Type
index	number
stretch	number

Returns: void

---

sizeConstraint

▸ sizeConstraint(): SizeConstraint

Inherited from NodeLayout.sizeConstraint

Returns: SizeConstraint

---

spacing

▸ spacing(): number

Inherited from NodeLayout.spacing

Returns: number

---

update

▸ update(): void

Inherited from NodeLayout.update

Returns: void