QScreen

Hierarchy

QObjectQScreenSignals

QScreen

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QScreen(native: NativeElement): QScreen

Overrides QObject.constructor

Parameters:

NameType
nativeNativeElement

Returns: QScreen

Properties

native

native: NativeElement | null

Inherited from Component.native

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.


addEventListener

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

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QScreenSignals

Parameters:

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


availableGeometry

availableGeometry(): QRect

Returns: QRect


availableSize

availableSize(): QSize

Returns: QSize


availableVirtualGeometry

availableVirtualGeometry(): QRect

Returns: QRect


availableVirtualSize

availableVirtualSize(): QSize

Returns: QSize


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


depth

depth(): number

Returns: number


devicePixelRatio

devicePixelRatio(): number

Returns: number


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.


geometry

geometry(): QRect

Returns: QRect


grabWindow

grabWindow(window: number, x: number, y: number, width: number, height: number): QPixmap

Parameters:

NameTypeDefault
windownumber-
xnumber0
ynumber0
widthnumber-1
heightnumber-1

Returns: QPixmap


inherits

inherits(className: string): boolean

Inherited from QObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


killTimer

killTimer(timerId: number): void

Inherited from QObject.killTimer

Parameters:

NameType
timerIdnumber

Returns: void


logicalDotsPerInch

logicalDotsPerInch(): number

Returns: number


logicalDotsPerInchX

logicalDotsPerInchX(): number

Returns: number


logicalDotsPerInchY

logicalDotsPerInchY(): number

Returns: number


manufacturer

manufacturer(): string

Returns: string


model

model(): string

Returns: string


name

name(): string

Returns: string


nativeOrientation

nativeOrientation(): ScreenOrientation

Returns: ScreenOrientation


objectName

objectName(): string

Inherited from QObject.objectName

Returns: string


orientation

orientation(): ScreenOrientation

Returns: ScreenOrientation


parent

parent(): QObject

Inherited from QObject.parent

Returns: QObject


physicalDotsPerInch

physicalDotsPerInch(): number

Returns: number


physicalDotsPerInchX

physicalDotsPerInchX(): number

Returns: number


physicalDotsPerInchY

physicalDotsPerInchY(): number

Returns: number


physicalSize

physicalSize(): QSizeF

Returns: QSizeF


primaryOrientation

primaryOrientation(): ScreenOrientation

Returns: ScreenOrientation


property

property(name: string): QVariant

Inherited from QObject.property

Parameters:

NameType
namestring

Returns: QVariant


refreshRate

refreshRate(): number

Returns: number


removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QScreenSignals

Parameters:

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


serialNumber

serialNumber(): string

Returns: string


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

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


size

size(): QSize

Returns: QSize


startTimer

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

Inherited from QObject.startTimer

Parameters:

NameTypeDefault
intervalMSnumber-
timerTypeTimerTypeTimerType.CoarseTimer

Returns: number


virtualGeometry

virtualGeometry(): QRect

Returns: QRect


virtualSize

virtualSize(): QSize

Returns: QSize