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 --- .../-system-preferences/add-listener.html | 18 ++ .../-system-preferences/get-accent-color.html | 14 + .../-system-preferences/get-color.html | 14 + .../-system-preferences/get-user-default.html | 28 ++ .../-system-preferences/index.html | 283 +++++++++++++++++++++ .../-system-preferences/is-aero-glass-enabled.html | 14 + .../-system-preferences/is-dark-mode.html | 14 + .../is-inverted-color-scheme.html | 14 + ...-swipe-tracking-from-scroll-events-enabled.html | 14 + .../-system-preferences/on.html | 18 ++ .../-system-preferences/once.html | 18 ++ .../post-local-notification.html | 14 + .../-system-preferences/post-notification.html | 14 + .../-system-preferences/register-defaults.html | 14 + .../-system-preferences/remove-listener.html | 18 ++ .../-system-preferences/remove-user-default.html | 14 + .../-system-preferences/set-user-default.html | 14 + .../subscribe-local-notification.html | 14 + .../subscribe-notification.html | 14 + .../unsubscribe-local-notification.html | 14 + .../unsubscribe-notification.html | 14 + 21 files changed, 593 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/add-listener.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/get-accent-color.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/get-color.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/get-user-default.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/index.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/is-aero-glass-enabled.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/is-dark-mode.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/is-inverted-color-scheme.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/is-swipe-tracking-from-scroll-events-enabled.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/on.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/once.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/post-local-notification.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/post-notification.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/register-defaults.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/remove-listener.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/remove-user-default.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/set-user-default.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/subscribe-local-notification.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/subscribe-notification.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-local-notification.html create mode 100644 api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-notification.html (limited to 'api/pl.treksoft.kvision.electron/-system-preferences') diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/add-listener.html b/api/pl.treksoft.kvision.electron/-system-preferences/add-listener.html new file mode 100644 index 00000000..235255a3 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/add-listener.html @@ -0,0 +1,18 @@ + + + +SystemPreferences.addListener - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / addListener
+
+

addListener

+ +abstract fun addListener(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences
+ +abstract fun addListener(event: String, listener: (event: Event) -> Unit): SystemPreferences
+ +

abstract fun addListener(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences

+ + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/get-accent-color.html b/api/pl.treksoft.kvision.electron/-system-preferences/get-accent-color.html new file mode 100644 index 00000000..1942cf1f --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/get-accent-color.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.getAccentColor - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / getAccentColor
+
+

getAccentColor

+ +abstract fun getAccentColor(): String + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/get-color.html b/api/pl.treksoft.kvision.electron/-system-preferences/get-color.html new file mode 100644 index 00000000..b35715d9 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/get-color.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.getColor - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / getColor
+
+

getColor

+ +abstract fun getColor(color: dynamic): String + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/get-user-default.html b/api/pl.treksoft.kvision.electron/-system-preferences/get-user-default.html new file mode 100644 index 00000000..cce52de0 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/get-user-default.html @@ -0,0 +1,28 @@ + + + +SystemPreferences.getUserDefault - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / getUserDefault
+
+

getUserDefault

+ +abstract fun getUserDefault(key: String, type: String): Any
+ +abstract fun getUserDefault(key: String, type: String): Any
+ +abstract fun getUserDefault(key: String, type: String): Any
+ +abstract fun getUserDefault(key: String, type: String): Any
+ +abstract fun getUserDefault(key: String, type: String): Any
+ +abstract fun getUserDefault(key: String, type: String): Any
+ +abstract fun getUserDefault(key: String, type: String): Any
+ +abstract fun getUserDefault(key: String, type: String): Any + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/index.html b/api/pl.treksoft.kvision.electron/-system-preferences/index.html new file mode 100644 index 00000000..437384f2 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/index.html @@ -0,0 +1,283 @@ + + + +SystemPreferences - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences
+
+

SystemPreferences

+external interface SystemPreferences : EventEmitter +

Functions

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

+ addListener +	+`abstract fun addListener(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences` +`abstract fun addListener(event: String, listener: (event: Event) -> Unit): SystemPreferences` +`abstract fun addListener(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences`
+ getAccentColor +	+`abstract fun getAccentColor(): String`
+ getColor +	+`abstract fun getColor(color: dynamic): String`
+ getUserDefault +	+`abstract fun getUserDefault(key: String, type: String): Any` +`abstract fun getUserDefault(key: String, type: String): Any` +`abstract fun getUserDefault(key: String, type: String): Any` +`abstract fun getUserDefault(key: String, type: String): Any` +`abstract fun getUserDefault(key: String, type: String): Any` +`abstract fun getUserDefault(key: String, type: String): Any` +`abstract fun getUserDefault(key: String, type: String): Any` +`abstract fun getUserDefault(key: String, type: String): Any`
+ isAeroGlassEnabled +	+`abstract fun isAeroGlassEnabled(): Boolean`
+ isDarkMode +	+`abstract fun isDarkMode(): Boolean`
+ isInvertedColorScheme +	+`abstract fun isInvertedColorScheme(): Boolean`
+ isSwipeTrackingFromScrollEventsEnabled +	+`abstract fun isSwipeTrackingFromScrollEventsEnabled(): Boolean`
+ on +	+`abstract fun on(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences` +`abstract fun on(event: String, listener: (event: Event) -> Unit): SystemPreferences` +`abstract fun on(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences`
+ once +	+`abstract fun once(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences` +`abstract fun once(event: String, listener: (event: Event) -> Unit): SystemPreferences` +`abstract fun once(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences`
+ postLocalNotification +	+`abstract fun postLocalNotification(event: String, userInfo: Any): Unit`
+ postNotification +	+`abstract fun postNotification(event: String, userInfo: Any): Unit`
+ registerDefaults +	+`abstract fun registerDefaults(defaults: Any): Unit`
+ removeListener +	+`abstract fun removeListener(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences` +`abstract fun removeListener(event: String, listener: (event: Event) -> Unit): SystemPreferences` +`abstract fun removeListener(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences`
+ removeUserDefault +	+`abstract fun removeUserDefault(key: String): Unit`
+ setUserDefault +	+`abstract fun setUserDefault(key: String, type: String, value: String): Unit`
+ subscribeLocalNotification +	+`abstract fun subscribeLocalNotification(event: String, callback: (event: String, userInfo: Any) -> Unit): Unit`
+ subscribeNotification +	+`abstract fun subscribeNotification(event: String, callback: (event: String, userInfo: Any) -> Unit): Unit`
+ unsubscribeLocalNotification +	+`abstract fun unsubscribeLocalNotification(id: Number): Unit`
+ unsubscribeNotification +	+`abstract fun unsubscribeNotification(id: Number): Unit`

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/-system-preferences/is-aero-glass-enabled.html b/api/pl.treksoft.kvision.electron/-system-preferences/is-aero-glass-enabled.html new file mode 100644 index 00000000..945c724d --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/is-aero-glass-enabled.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.isAeroGlassEnabled - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / isAeroGlassEnabled
+
+

isAeroGlassEnabled

+ +abstract fun isAeroGlassEnabled(): Boolean + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/is-dark-mode.html b/api/pl.treksoft.kvision.electron/-system-preferences/is-dark-mode.html new file mode 100644 index 00000000..8f9fe6c5 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/is-dark-mode.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.isDarkMode - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / isDarkMode
+
+

isDarkMode

+ +abstract fun isDarkMode(): Boolean + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/is-inverted-color-scheme.html b/api/pl.treksoft.kvision.electron/-system-preferences/is-inverted-color-scheme.html new file mode 100644 index 00000000..58034655 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/is-inverted-color-scheme.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.isInvertedColorScheme - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / isInvertedColorScheme
+
+

isInvertedColorScheme

+ +abstract fun isInvertedColorScheme(): Boolean + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/is-swipe-tracking-from-scroll-events-enabled.html b/api/pl.treksoft.kvision.electron/-system-preferences/is-swipe-tracking-from-scroll-events-enabled.html new file mode 100644 index 00000000..ea10c3b6 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/is-swipe-tracking-from-scroll-events-enabled.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.isSwipeTrackingFromScrollEventsEnabled - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / isSwipeTrackingFromScrollEventsEnabled
+
+

isSwipeTrackingFromScrollEventsEnabled

+ +abstract fun isSwipeTrackingFromScrollEventsEnabled(): Boolean + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/on.html b/api/pl.treksoft.kvision.electron/-system-preferences/on.html new file mode 100644 index 00000000..51a10adb --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/on.html @@ -0,0 +1,18 @@ + + + +SystemPreferences.on - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / on
+
+

on

+ +abstract fun on(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences
+ +abstract fun on(event: String, listener: (event: Event) -> Unit): SystemPreferences
+ +abstract fun on(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/once.html b/api/pl.treksoft.kvision.electron/-system-preferences/once.html new file mode 100644 index 00000000..d66131ac --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/once.html @@ -0,0 +1,18 @@ + + + +SystemPreferences.once - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / once
+
+

once

+ +abstract fun once(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences
+ +abstract fun once(event: String, listener: (event: Event) -> Unit): SystemPreferences
+ +

abstract fun once(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences

+ + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/post-local-notification.html b/api/pl.treksoft.kvision.electron/-system-preferences/post-local-notification.html new file mode 100644 index 00000000..d1757654 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/post-local-notification.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.postLocalNotification - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / postLocalNotification
+
+

postLocalNotification

+ +abstract fun postLocalNotification(event: String, userInfo: Any): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/post-notification.html b/api/pl.treksoft.kvision.electron/-system-preferences/post-notification.html new file mode 100644 index 00000000..e934c611 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/post-notification.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.postNotification - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / postNotification
+
+

postNotification

+ +abstract fun postNotification(event: String, userInfo: Any): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/register-defaults.html b/api/pl.treksoft.kvision.electron/-system-preferences/register-defaults.html new file mode 100644 index 00000000..7f06ba37 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/register-defaults.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.registerDefaults - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / registerDefaults
+
+

registerDefaults

+ +abstract fun registerDefaults(defaults: Any): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/remove-listener.html b/api/pl.treksoft.kvision.electron/-system-preferences/remove-listener.html new file mode 100644 index 00000000..c7c7e5a4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/remove-listener.html @@ -0,0 +1,18 @@ + + + +SystemPreferences.removeListener - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / removeListener
+
+

removeListener

+ +abstract fun removeListener(event: String, listener: (event: Event, newColor: String) -> Unit): SystemPreferences
+ +abstract fun removeListener(event: String, listener: (event: Event) -> Unit): SystemPreferences
+ +

abstract fun removeListener(event: String, listener: (event: Event, invertedColorScheme: Boolean) -> Unit): SystemPreferences

+ + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/remove-user-default.html b/api/pl.treksoft.kvision.electron/-system-preferences/remove-user-default.html new file mode 100644 index 00000000..b7dd1c1c --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/remove-user-default.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.removeUserDefault - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / removeUserDefault
+
+

removeUserDefault

+ +abstract fun removeUserDefault(key: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/set-user-default.html b/api/pl.treksoft.kvision.electron/-system-preferences/set-user-default.html new file mode 100644 index 00000000..df12eb1e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/set-user-default.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.setUserDefault - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / setUserDefault
+
+

setUserDefault

+ +abstract fun setUserDefault(key: String, type: String, value: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/subscribe-local-notification.html b/api/pl.treksoft.kvision.electron/-system-preferences/subscribe-local-notification.html new file mode 100644 index 00000000..8ae77817 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/subscribe-local-notification.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.subscribeLocalNotification - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / subscribeLocalNotification
+
+

subscribeLocalNotification

+ +abstract fun subscribeLocalNotification(event: String, callback: (event: String, userInfo: Any) -> Unit): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/subscribe-notification.html b/api/pl.treksoft.kvision.electron/-system-preferences/subscribe-notification.html new file mode 100644 index 00000000..3cb0b7e4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/subscribe-notification.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.subscribeNotification - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / subscribeNotification
+
+

subscribeNotification

+ +abstract fun subscribeNotification(event: String, callback: (event: String, userInfo: Any) -> Unit): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-local-notification.html b/api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-local-notification.html new file mode 100644 index 00000000..3a2ef683 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-local-notification.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.unsubscribeLocalNotification - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / unsubscribeLocalNotification
+
+

unsubscribeLocalNotification

+ +abstract fun unsubscribeLocalNotification(id: Number): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-notification.html b/api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-notification.html new file mode 100644 index 00000000..bbcf0d7e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-system-preferences/unsubscribe-notification.html @@ -0,0 +1,14 @@ + + + +SystemPreferences.unsubscribeNotification - kvision + + + +kvision / pl.treksoft.kvision.electron / SystemPreferences / unsubscribeNotification
+
+

unsubscribeNotification

+ +abstract fun unsubscribeNotification(id: Number): Unit + + -- cgit