kotlin-electron/electron.core/Screen

Screen

external interface Screen : EventEmitter(source)

Properties

displayAddedEvent

abstract val displayAddedEvent: EventInstance<JsTuple2<Event<*>, Display>>

displayMetricsChangedEvent

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

displayRemovedEvent

abstract val displayRemovedEvent: EventInstance<JsTuple2<Event<*>, Display>>

Functions

addListener

fun addListener(type: EventType, listener: EventListener)

dipToScreenPoint

abstract 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 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

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

eventNames

fun eventNames(): Array<EventType>

getAllDisplays

abstract fun getAllDisplays(): ReadonlyArray<Display>

An array of displays that are currently available.

getCursorScreenPoint

abstract fun getCursorScreenPoint(): Point

The current absolute position of the mouse pointer.

getDisplayMatching

abstract fun getDisplayMatching(rect: Rectangle): Display

The display that most closely intersects the provided bounds.

getDisplayNearestPoint

abstract fun getDisplayNearestPoint(point: Point): Display

The display nearest the specified point.

getMaxListeners

fun getMaxListeners(): Double

getPrimaryDisplay

abstract fun getPrimaryDisplay(): Display

The primary display.

listenerCount

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

listeners

fun listeners(type: EventType): Array<EventListener>

off

fun off(type: EventType, listener: EventListener)

fun on(type: EventType, listener: EventListener)

once

fun once(type: EventType, listener: EventListener)

prependListener

fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

rawListeners

fun rawListeners(type: EventType): Array<EventListener>

removeAllListeners

fun removeAllListeners(type: EventType)

removeListener

fun removeListener(type: EventType, listener: EventListener)

screenToDipPoint

abstract 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 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

fun setMaxListeners(n: Number)