From eeb8fdf8f890daeed907a6d0591ea6fae8421860 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 6 Mar 2019 13:53:58 +0100 Subject: API documentation for KVision 0.0.28 --- .../-screen/add-listener.html | 18 ++ .../-screen/get-all-displays.html | 14 ++ .../-screen/get-cursor-screen-point.html | 14 ++ .../-screen/get-display-matching.html | 14 ++ .../-screen/get-display-nearest-point.html | 14 ++ .../-screen/get-menu-bar-height.html | 14 ++ .../-screen/get-primary-display.html | 14 ++ .../-screen/index.html | 206 +++++++++++++++++++++ api/pl.treksoft.kvision.electron/-screen/on.html | 18 ++ api/pl.treksoft.kvision.electron/-screen/once.html | 18 ++ .../-screen/remove-listener.html | 18 ++ 11 files changed, 362 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-screen/add-listener.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/get-all-displays.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/get-cursor-screen-point.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/get-display-matching.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/get-display-nearest-point.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/get-menu-bar-height.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/get-primary-display.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/index.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/on.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/once.html create mode 100644 api/pl.treksoft.kvision.electron/-screen/remove-listener.html (limited to 'api/pl.treksoft.kvision.electron/-screen') diff --git a/api/pl.treksoft.kvision.electron/-screen/add-listener.html b/api/pl.treksoft.kvision.electron/-screen/add-listener.html new file mode 100644 index 00000000..7be725c9 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/add-listener.html @@ -0,0 +1,18 @@ + + + +Screen.addListener - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / addListener
+
+

addListener

+ +abstract fun addListener(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen
+ +

abstract fun addListener(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen

+ +abstract fun addListener(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen + + diff --git a/api/pl.treksoft.kvision.electron/-screen/get-all-displays.html b/api/pl.treksoft.kvision.electron/-screen/get-all-displays.html new file mode 100644 index 00000000..1f9293dc --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/get-all-displays.html @@ -0,0 +1,14 @@ + + + +Screen.getAllDisplays - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / getAllDisplays
+
+

getAllDisplays

+ +abstract fun getAllDisplays(): Array<Display> + + diff --git a/api/pl.treksoft.kvision.electron/-screen/get-cursor-screen-point.html b/api/pl.treksoft.kvision.electron/-screen/get-cursor-screen-point.html new file mode 100644 index 00000000..0ead64b8 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/get-cursor-screen-point.html @@ -0,0 +1,14 @@ + + + +Screen.getCursorScreenPoint - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / getCursorScreenPoint
+
+

getCursorScreenPoint

+ +abstract fun getCursorScreenPoint(): Point + + diff --git a/api/pl.treksoft.kvision.electron/-screen/get-display-matching.html b/api/pl.treksoft.kvision.electron/-screen/get-display-matching.html new file mode 100644 index 00000000..472ba999 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/get-display-matching.html @@ -0,0 +1,14 @@ + + + +Screen.getDisplayMatching - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / getDisplayMatching
+
+

getDisplayMatching

+ +abstract fun getDisplayMatching(rect: Rectangle): Display + + diff --git a/api/pl.treksoft.kvision.electron/-screen/get-display-nearest-point.html b/api/pl.treksoft.kvision.electron/-screen/get-display-nearest-point.html new file mode 100644 index 00000000..ba89fa4b --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/get-display-nearest-point.html @@ -0,0 +1,14 @@ + + + +Screen.getDisplayNearestPoint - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / getDisplayNearestPoint
+
+

getDisplayNearestPoint

+ +abstract fun getDisplayNearestPoint(point: Point): Display + + diff --git a/api/pl.treksoft.kvision.electron/-screen/get-menu-bar-height.html b/api/pl.treksoft.kvision.electron/-screen/get-menu-bar-height.html new file mode 100644 index 00000000..9f2db659 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/get-menu-bar-height.html @@ -0,0 +1,14 @@ + + + +Screen.getMenuBarHeight - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / getMenuBarHeight
+
+

getMenuBarHeight

+ +abstract fun getMenuBarHeight(): Number + + diff --git a/api/pl.treksoft.kvision.electron/-screen/get-primary-display.html b/api/pl.treksoft.kvision.electron/-screen/get-primary-display.html new file mode 100644 index 00000000..920c3dcf --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/get-primary-display.html @@ -0,0 +1,14 @@ + + + +Screen.getPrimaryDisplay - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / getPrimaryDisplay
+
+

getPrimaryDisplay

+ +abstract fun getPrimaryDisplay(): Display + + diff --git a/api/pl.treksoft.kvision.electron/-screen/index.html b/api/pl.treksoft.kvision.electron/-screen/index.html new file mode 100644 index 00000000..07afb689 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/index.html @@ -0,0 +1,206 @@ + + + +Screen - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen
+
+

Screen

+external interface Screen : EventEmitter +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ addListener +	+`abstract fun addListener(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen` +`abstract fun addListener(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen` +`abstract fun addListener(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen`
+ getAllDisplays +	+`abstract fun getAllDisplays(): Array<Display>`
+ getCursorScreenPoint +	+`abstract fun getCursorScreenPoint(): Point`
+ getDisplayMatching +	+`abstract fun getDisplayMatching(rect: Rectangle): Display`
+ getDisplayNearestPoint +	+`abstract fun getDisplayNearestPoint(point: Point): Display`
+ getMenuBarHeight +	+`abstract fun getMenuBarHeight(): Number`
+ getPrimaryDisplay +	+`abstract fun getPrimaryDisplay(): Display`
+ on +	+`abstract fun on(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen` +`abstract fun on(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen` +`abstract fun on(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen`
+ once +	+`abstract fun once(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen` +`abstract fun once(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen` +`abstract fun once(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen`
+ removeListener +	+`abstract fun removeListener(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen` +`abstract fun removeListener(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen` +`abstract fun removeListener(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen`

Inherited Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ addListener +	+`open fun addListener(event: String, listener: Function<*>): EventEmitter`
+ emit +	+`open fun emit(event: String, vararg args: Any): Boolean`
+ eventNames +	+`open fun eventNames(): Array<String>`
+ getMaxListeners +	+`open fun getMaxListeners(): Number`
+ listenerCount +	+`open fun listenerCount(type: String): Number`
+ listeners +	+`open fun listeners(event: String): Array<Function<*>>`
+ on +	+`open fun on(event: String, listener: Function<*>): EventEmitter`
+ once +	+`open fun once(event: String, listener: Function<*>): EventEmitter`
+ prependListener +	+`open fun prependListener(event: String, listener: Function<*>): EventEmitter`
+ prependOnceListener +	+`open fun prependOnceListener(event: String, listener: Function<*>): EventEmitter`
+ removeAllListeners +	+`open fun removeAllListeners(event: String? = definedExternally): EventEmitter`
+ removeListener +	+`open fun removeListener(event: String, listener: Function<*>): EventEmitter`
+ setMaxListeners +	+`open fun setMaxListeners(n: Number): EventEmitter`

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api/pl.treksoft.kvision.electron/-screen/on.html b/api/pl.treksoft.kvision.electron/-screen/on.html new file mode 100644 index 00000000..fe162191 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/on.html @@ -0,0 +1,18 @@ + + + +Screen.on - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / on
+
+

on

+ +abstract fun on(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen
+ +

abstract fun on(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen

+ +abstract fun on(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen + + diff --git a/api/pl.treksoft.kvision.electron/-screen/once.html b/api/pl.treksoft.kvision.electron/-screen/once.html new file mode 100644 index 00000000..0ec3d80a --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/once.html @@ -0,0 +1,18 @@ + + + +Screen.once - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / once
+
+

once

+ +abstract fun once(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen
+ +

abstract fun once(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen

+ +abstract fun once(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen + + diff --git a/api/pl.treksoft.kvision.electron/-screen/remove-listener.html b/api/pl.treksoft.kvision.electron/-screen/remove-listener.html new file mode 100644 index 00000000..d6092475 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-screen/remove-listener.html @@ -0,0 +1,18 @@ + + + +Screen.removeListener - kvision + + + +kvision / pl.treksoft.kvision.electron / Screen / removeListener
+
+

removeListener

+ +abstract fun removeListener(event: String, listener: (event: Event, newDisplay: Display) -> Unit): Screen
+ +

abstract fun removeListener(event: String, listener: (event: Event, display: Display, changedMetrics: Array<String>) -> Unit): Screen

+ +abstract fun removeListener(event: String, listener: (event: Event, oldDisplay: Display) -> Unit): Screen + + -- cgit