QObject

Type parameters

â–ª Signals: QObjectSignals

Hierarchy

↳ EventWidget‹Signals›

↳ QObject

↳ QLayout

↳ YogaWidget

↳ QAction

↳ QGraphicsEffect

↳ QClipboard

↳ QScreen

↳ QApplication

↳ QMovie

↳ QWindow

↳ QAbstractItemModel

↳ QItemSelectionModel

↳ QAbstractItemDelegate

↳ QStandardItemModel

↳ QButtonGroup

↳ QSystemTrayIcon

↳ QShortcut

↳ CacheTestQObject

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QObject(nativeElementOrParent?: NativeElement | QObject): QObject

Overrides EventWidget.constructor

Parameters:

NameType
nativeElementOrParent?NativeElement | QObject

Returns: QObject

Properties

native

• native: NativeElement | null

Inherited from Component.native

Methods

_id

â–¸ _id(): number

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.


addEventListener

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

Inherited from EventWidget.addEventListener

Type parameters:

â–ª SignalType: keyof Signals

Parameters:

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


children

â–¸ children(): QObject[]

Returns: QObject[]


delete

â–¸ delete(): void

Returns: void


deleteLater

â–¸ deleteLater(): void

Returns: void


dumpObjectInfo

â–¸ dumpObjectInfo(): void

Returns: void


dumpObjectTree

â–¸ dumpObjectTree(): void

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.


inherits

â–¸ inherits(className: string): boolean

Parameters:

NameType
classNamestring

Returns: boolean


killTimer

â–¸ killTimer(timerId: number): void

Parameters:

NameType
timerIdnumber

Returns: void


objectName

â–¸ objectName(): string

Returns: string


parent

â–¸ parent(): QObject

Returns: QObject


property

â–¸ property(name: string): QVariant

Parameters:

NameType
namestring

Returns: QVariant


removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

â–ª SignalType: keyof Signals

Parameters:

NameType
signalTypeSignalType
callbackSignals[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


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


setObjectName

â–¸ setObjectName(objectName: string): void

Parameters:

NameType
objectNamestring

Returns: void


setParent

â–¸ setParent(parent: QObject): void

Parameters:

NameType
parentQObject

Returns: void


setProperty

â–¸ setProperty(name: string, value: QVariantType): boolean

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


startTimer

â–¸ startTimer(intervalMS: number, timerType: TimerType): number

Parameters:

NameTypeDefault
intervalMSnumber-
timerTypeTimerTypeTimerType.CoarseTimer

Returns: number