QScreen

Hierarchy

NodeObjectQScreenSignals

QScreen

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QScreen(native: NativeElement): QScreen

Overrides EventWidget.constructor

Parameters:

NameType
nativeNativeElement

Returns: QScreen

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: QScreenSignals[SignalType]): 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

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


availableGeometry

availableGeometry(): QRect

Returns: QRect


availableSize

availableSize(): QSize

Returns: QSize


availableVirtualGeometry

availableVirtualGeometry(): QRect

Returns: QRect


availableVirtualSize

availableVirtualSize(): QSize

Returns: QSize


depth

depth(): number

Returns: number


devicePixelRatio

devicePixelRatio(): number

Returns: number


dumpObjectInfo

dumpObjectInfo(): void

Inherited from NodeObject.dumpObjectInfo

Returns: void


dumpObjectTree

dumpObjectTree(): void

Inherited from NodeObject.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


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


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 NodeObject.objectName

Returns: string


orientation

orientation(): ScreenOrientation

Returns: ScreenOrientation


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 NodeObject.property

Parameters:

NameType
namestring

Returns: QVariant


refreshRate

refreshRate(): number

Returns: number


removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QScreenSignals

Parameters:

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


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


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


setParent

setParent(parent: NodeObjectQObjectSignals›): void

Inherited from NodeObject.setParent

Parameters:

NameType
parentNodeObjectQObjectSignals

Returns: void


setProperty

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

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


size

size(): QSize

Returns: QSize


virtualGeometry

virtualGeometry(): QRect

Returns: QRect


virtualSize

virtualSize(): QSize

Returns: QSize