kotlin-electron/electron.core/Screen

Screen

external interface Screen : EventEmitter(source)

Properties

displayAddedEvent

abstract external val displayAddedEvent: EventInstance<Tuple2<Event<*>, Display>>

displayMetricsChangedEvent

abstract external val displayMetricsChangedEvent: EventInstance<Tuple3<Event<*>, Display, ReadonlyArray<String>>>

displayRemovedEvent

abstract external val displayRemovedEvent: EventInstance<Tuple2<Event<*>, Display>>

Functions

addListener

external fun addListener(type: EventType, listener: EventListener)

dipToScreenPoint

abstract external fun dipToScreenPoint(point: Point): Point

Converts a screen DIP point to a screen physical point. The DPI scale is performed relative to the display containing the DIP point.

dipToScreenRect

abstract external fun dipToScreenRect(window: BrowserWindow?, rect: Rectangle): Rectangle

Converts a screen DIP rect to a screen physical rect. The DPI scale is performed relative to the display nearest to window. If window is null, scaling will be performed to the display nearest to rect.

emit

external fun emit(type: EventType, vararg args: Any?): Boolean

eventNames

external fun eventNames(): ReadonlyArray<EventType>

getAllDisplays

abstract external fun getAllDisplays(): ReadonlyArray<Display>

An array of displays that are currently available.

getCursorScreenPoint

abstract external fun getCursorScreenPoint(): Point

The current absolute position of the mouse pointer.

getDisplayMatching

abstract external fun getDisplayMatching(rect: Rectangle): Display

The display that most closely intersects the provided bounds.

getDisplayNearestPoint

abstract external fun getDisplayNearestPoint(point: Point): Display

The display nearest the specified point.

getMaxListeners

external fun getMaxListeners(): Double

getPrimaryDisplay

abstract external fun getPrimaryDisplay(): Display

The primary display.

listenerCount

external fun listenerCount(type: EventType, listener: EventListener): Double

listeners

external fun listeners(type: EventType): ReadonlyArray<EventListener>

off

external fun off(type: EventType, listener: EventListener)

external fun on(type: EventType, listener: EventListener)

once

external fun once(type: EventType, listener: EventListener)

prependListener

external fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

external fun prependOnceListener(type: EventType, listener: EventListener)

rawListeners

external fun rawListeners(type: EventType): ReadonlyArray<EventListener>

removeAllListeners

external fun removeAllListeners(type: EventType)

removeListener

external fun removeListener(type: EventType, listener: EventListener)

screenToDipPoint

abstract external fun screenToDipPoint(point: Point): Point

Converts a screen physical point to a screen DIP point. The DPI scale is performed relative to the display containing the physical point.

screenToDipRect

abstract external fun screenToDipRect(window: BrowserWindow?, rect: Rectangle): Rectangle

Converts a screen physical rect to a screen DIP rect. The DPI scale is performed relative to the display nearest to window. If window is null, scaling will be performed to the display nearest to rect.

setMaxListeners

external fun setMaxListeners(n: Number)