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

QLayoutFlexLayoutSignals

FlexLayout

Index

Constructors

Properties

Methods

Constructors

constructor

+ new FlexLayout(parent?: QWidget): FlexLayout

Overrides QObject.constructor

Parameters:

NameType
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

addEventListenerSignalType›(signalType: SignalType, callback: FlexLayoutSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof FlexLayoutSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackFlexLayoutSignals[SignalType]Corresponding callback for the signal as mentioned in the widget's signal interface
options?EventListenerOptionsExtra 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:

NameType
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:

NameType
childWidgetQWidget
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:

NameType
childWidgetQWidget

Returns: number


getNextSibling

getNextSibling(childWidget: QWidget): QWidget | null

Parameters:

NameType
childWidgetQWidget

Returns: QWidget | null


inherits

inherits(className: string): boolean

Inherited from QObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


insertChildBefore

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

Parameters:

NameType
childWidgetQWidget
beforeChildWidgetQWidget
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:

NameType
timerIdnumber

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:

NameType
namestring

Returns: QVariant


removeEventListener

removeEventListenerSignalType›(signalType: SignalType, callback: FlexLayoutSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof FlexLayoutSignals

Parameters:

NameType
signalTypeSignalType
callbackFlexLayoutSignals[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:

NameType
event?NativeRawPointer‹"QEvent"›

Optional options: EventListenerOptions

Returns: void


removeWidget

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

Overrides QLayout.removeWidget

Parameters:

NameType
childWidgetQWidget
childFlexNode?FlexNode

Returns: void


setContentsMargins

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

Inherited from QLayout.setContentsMargins

Parameters:

NameType
leftnumber
topnumber
rightnumber
bottomnumber

Returns: void


setEnabled

setEnabled(enable: boolean): void

Inherited from QLayout.setEnabled

Parameters:

NameType
enableboolean

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:

NameTypeDescription
isProcessedbooleantrue if the event has been processed.

Returns: void


setFlexNode

setFlexNode(flexNode: FlexNode): void

Parameters:

NameType
flexNodeFlexNode

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from QObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setParent

setParent(parent: QObject): void

Inherited from QObject.setParent

Parameters:

NameType
parentQObject

Returns: void


setProperty

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

Inherited from QObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setSizeConstraint

setSizeConstraint(constraint: SizeConstraint): void

Inherited from QLayout.setSizeConstraint

Parameters:

NameType
constraintSizeConstraint

Returns: void


setSpacing

setSpacing(spacing: number): void

Inherited from QLayout.setSpacing

Parameters:

NameType
spacingnumber

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:

NameTypeDefault
intervalMSnumber-
timerTypeTimerTypeTimerType.CoarseTimer

Returns: number


update

update(): void

Inherited from QLayout.update

Returns: void