QApplication

QApplication is the root object for the entire application. It manages app level settings.

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

The QApplication class manages the GUI application's control flow and main settings. In NodeGui you will never create an instance of it manually. NodeGui's internal runtime Qode does it for you on app start. You can access the initialised QApplication though if needed.

Example

const { QApplication } = require("@nodegui/nodegui");
const qApp = QApplication.instance();
qApp.quit();

Hierarchy

NodeObjectQApplicationSignals

QApplication

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QApplication(): QApplication

Overrides EventWidget.constructor

Returns: QApplication

+ new QApplication(native: NativeElement): QApplication

Overrides EventWidget.constructor

Parameters:

NameType
nativeNativeElement

Returns: QApplication

Properties

native

native: NativeElement

Overrides Component.native


nodeChildren

nodeChildren: Set‹Component

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent

Methods

addEventListener

addEventListenerSignalType›(signalType: SignalType, callback: QApplicationSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QApplicationSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackQApplicationSignals[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:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


exec

exec(): number

Returns: number


exit

exit(exitCode: number): number

Parameters:

NameType
exitCodenumber

Returns: number


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


objectName

objectName(): string

Inherited from NodeObject.objectName

Returns: string


processEvents

processEvents(): void

Returns: void


property

property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

NameType
namestring

Returns: QVariant


quit

quit(): number

Returns: number


quitOnLastWindowClosed

quitOnLastWindowClosed(): boolean

Returns: boolean


removeEventListener

removeEventListenerSignalType›(signalType: SignalType, callback: QApplicationSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QApplicationSignals

Parameters:

NameType
signalTypeSignalType
callbackQApplicationSignals[SignalType]

Returns: void

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

Inherited from EventWidget.removeEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

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

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from NodeObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setProperty

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

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setQuitOnLastWindowClosed

setQuitOnLastWindowClosed(quit: boolean): void

Parameters:

NameType
quitboolean

Returns: void


Static clipboard

clipboard(): QClipboard

Returns: QClipboard


Static instance

instance(): QApplication

Returns: QApplication


Static style

style(): QStyle

Returns: QStyle