FlexLayout

Custom layout to help layout child widgets using flex layout.

This class is a JS wrapper around custom Qt layout implemented using Yoga

A FlexLayout can be used to layout all child NodeGui widgets using flex.

Example

const { FlexLayout, QWidget, QLabel } = require("@nodegui/nodegui");

const view = new QWidget();
const layout = new FlexLayout();
view.setLayout(layout);

const label = new QLabel();
label.setText("label1");
const label2 = new QLabel();
label2.setText("label2");

layout.addWidget(label);
layout.addWidget(label2);

Hierarchy

↳ QLayout‹FlexLayoutSignals›

↳ FlexLayout

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

+ new FlexLayout(parent?: QWidget): FlexLayout

Overrides QObject.constructor

Parameters:

Name	Type
`parent?`	QWidget

Returns: FlexLayout

Properties

native

• native: NativeElement | null

Inherited from Component.native

type

• type: string = "layout"

Inherited from QLayout.type

Methods

_id

▸ _id(): number

Inherited from QObject._id

Get an ID identifying the underlying C++ object.

This can be useful when debugging memory problems with help from setLogCreateQObject() and setLogDestroyQObject(). The number is hash of the memory address of the C++ object.

Returns: number

a unique number which is valid for the lifetime of the C++ object.

activate

▸ activate(): boolean

Inherited from QLayout.activate

Returns: boolean

addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: FlexLayoutSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof FlexLayoutSignals

Parameters:

Name	Type	Description
`signalType`	SignalType	SignalType is a signal from the widgets signals interface.
`callback`	FlexLayoutSignals[SignalType]	Corresponding callback for the signal as mentioned in the widget's signal interface
`options?`	EventListenerOptions	Extra optional options controlling how this event listener is added.

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, options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

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

Parameters:

Name	Type
`event?`	NativeRawPointer‹"QEvent"›

▪Optional options: EventListenerOptions

Extra optional options controlling how this event listener is added.

For example in the case of QPushButton:

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

Returns: void

addWidget

▸ addWidget(childWidget: QWidget, childFlexNode?: FlexNode): void

Overrides QLayout.addWidget

Parameters:

Name	Type
`childWidget`	QWidget
`childFlexNode?`	FlexNode

Returns: void

children

▸ children(): QObject[]

Inherited from QObject.children

Returns: QObject[]

delete

▸ delete(): void

Inherited from QObject.delete

Returns: void

deleteLater

▸ deleteLater(): void

Inherited from QObject.deleteLater

Returns: void

dumpObjectInfo

▸ dumpObjectInfo(): void

Inherited from QObject.dumpObjectInfo

Returns: void

dumpObjectTree

▸ dumpObjectTree(): void

Inherited from QObject.dumpObjectTree

Returns: void

eventProcessed

▸ eventProcessed(): boolean

Inherited from EventWidget.eventProcessed

Get the state of the event processed flag

See setEventProcessed().

Returns: boolean

boolean True if the current event is flagged as processed.

getChildIndex

▸ getChildIndex(childWidget: QWidget): number

Parameters:

Name	Type
`childWidget`	QWidget

Returns: number

getNextSibling

▸ getNextSibling(childWidget: QWidget): QWidget | null

Parameters:

Name	Type
`childWidget`	QWidget

Returns: QWidget | null

inherits

▸ inherits(className: string): boolean

Inherited from QObject.inherits

Parameters:

Name	Type
`className`	string

Returns: boolean

insertChildBefore

▸ insertChildBefore(childWidget: QWidget, beforeChildWidget: QWidget, childFlexNode?: FlexNode, beforeChildFlexNode?: FlexNode): void

Parameters:

Name	Type
`childWidget`	QWidget
`beforeChildWidget`	QWidget
`childFlexNode?`	FlexNode
`beforeChildFlexNode?`	FlexNode

Returns: void

invalidate

▸ invalidate(): void

Inherited from QLayout.invalidate

Returns: void

isEnabled

▸ isEnabled(): boolean

Inherited from QLayout.isEnabled

Returns: boolean

killTimer

▸ killTimer(timerId: number): void

Inherited from QObject.killTimer

Parameters:

Name	Type
`timerId`	number

Returns: void

objectName

▸ objectName(): string

Inherited from QObject.objectName

Returns: string

parent

▸ parent(): QObject

Inherited from QObject.parent

Returns: QObject

property

▸ property(name: string): QVariant

Inherited from QObject.property

Parameters:

Name	Type
`name`	string

Returns: QVariant

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: FlexLayoutSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof FlexLayoutSignals

Parameters:

Name	Type
`signalType`	SignalType
`callback`	FlexLayoutSignals[SignalType]
`options?`	EventListenerOptions

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function, options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

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

Parameters:

Name	Type
`event?`	NativeRawPointer‹"QEvent"›

▪Optional options: EventListenerOptions

Returns: void

removeWidget

▸ removeWidget(childWidget: QWidget, childFlexNode?: FlexNode): void

Overrides QLayout.removeWidget

Parameters:

Name	Type
`childWidget`	QWidget
`childFlexNode?`	FlexNode

Returns: void

setContentsMargins

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

Inherited from QLayout.setContentsMargins

Parameters:

Name	Type
`left`	number
`top`	number
`right`	number
`bottom`	number

Returns: void

setEnabled

▸ setEnabled(enable: boolean): void

Inherited from QLayout.setEnabled

Parameters:

Name	Type
`enable`	boolean

Returns: void

setEventProcessed

▸ setEventProcessed(isProcessed: boolean): void

Inherited from EventWidget.setEventProcessed

Mark the current event as having been processed

This method is used to indicate that the currently dispatched event has been processed and no further processing by superclasses is required. It only makes sense to call this method from an event handler.

When set, this flag will cause NodeGui's QObject::event() method to return true and not call the superclass event(), effectively preventing any further processing on this event.

Parameters:

Name	Type	Description
`isProcessed`	boolean	true if the event has been processed.

Returns: void

setFlexNode

▸ setFlexNode(flexNode: FlexNode): void

Parameters:

Name	Type
`flexNode`	FlexNode

Returns: void

setObjectName

▸ setObjectName(objectName: string): void

Inherited from QObject.setObjectName

Parameters:

Name	Type
`objectName`	string

Returns: void

setParent

▸ setParent(parent: QObject): void

Inherited from QObject.setParent

Parameters:

Name	Type
`parent`	QObject

Returns: void

setProperty

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

Inherited from QObject.setProperty

Parameters:

Name	Type
`name`	string
`value`	QVariantType

Returns: boolean

setSizeConstraint

▸ setSizeConstraint(constraint: SizeConstraint): void

Inherited from QLayout.setSizeConstraint

Parameters:

Name	Type
`constraint`	SizeConstraint

Returns: void

setSpacing

▸ setSpacing(spacing: number): void

Inherited from QLayout.setSpacing

Parameters:

Name	Type
`spacing`	number

Returns: void

sizeConstraint

▸ sizeConstraint(): SizeConstraint

Inherited from QLayout.sizeConstraint

Returns: SizeConstraint

spacing

▸ spacing(): number

Inherited from QLayout.spacing

Returns: number

startTimer

▸ startTimer(intervalMS: number, timerType: TimerType): number

Inherited from QObject.startTimer

Parameters:

Name	Type	Default
`intervalMS`	number	-
`timerType`	TimerType	TimerType.CoarseTimer

Returns: number

update

▸ update(): void

Inherited from QLayout.update

Returns: void

Example#

Hierarchy#

Index#

Constructors#

Properties#

Methods#

Constructors#

constructor#

Properties#

native#

type#

Methods#

_id#

activate#

addEventListener#

addWidget#

children#

delete#

deleteLater#

dumpObjectInfo#

dumpObjectTree#

eventProcessed#

getChildIndex#

getNextSibling#

inherits#

insertChildBefore#

invalidate#

isEnabled#

killTimer#

objectName#

parent#

property#

removeEventListener#

removeWidget#

setContentsMargins#

setEnabled#

setEventProcessed#

setFlexNode#

setObjectName#

setParent#

setProperty#

setSizeConstraint#

setSpacing#

sizeConstraint#

spacing#

startTimer#

update#

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

native

type

Methods

_id

activate

addEventListener

addWidget

children

delete

deleteLater

dumpObjectInfo

dumpObjectTree

eventProcessed

getChildIndex

getNextSibling

inherits

insertChildBefore

invalidate

isEnabled

killTimer

objectName

parent

property

removeEventListener

removeWidget

setContentsMargins

setEnabled

setEventProcessed

setFlexNode

setObjectName

setParent

setProperty

setSizeConstraint

setSpacing

sizeConstraint

spacing

startTimer

update