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 --- .../-web-frame/clear-cache.html | 14 ++ .../execute-java-script-in-isolated-world.html | 14 ++ .../-web-frame/execute-java-script.html | 14 ++ .../-web-frame/get-resource-usage.html | 14 ++ .../-web-frame/get-zoom-factor.html | 14 ++ .../-web-frame/get-zoom-level.html | 14 ++ .../-web-frame/index.html | 254 +++++++++++++++++++++ .../-web-frame/insert-text.html | 14 ++ .../register-u-r-l-scheme-as-bypassing-c-s-p.html | 14 ++ .../register-u-r-l-scheme-as-privileged.html | 14 ++ .../register-u-r-l-scheme-as-secure.html | 14 ++ ...set-isolated-world-content-security-policy.html | 14 ++ .../set-isolated-world-human-readable-name.html | 14 ++ .../set-isolated-world-security-origin.html | 14 ++ .../-web-frame/set-layout-zoom-level-limits.html | 14 ++ .../-web-frame/set-spell-check-provider.html | 14 ++ .../-web-frame/set-visual-zoom-level-limits.html | 14 ++ .../-web-frame/set-zoom-factor.html | 14 ++ .../-web-frame/set-zoom-level.html | 14 ++ 19 files changed, 506 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/clear-cache.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/execute-java-script-in-isolated-world.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/execute-java-script.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/get-resource-usage.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/get-zoom-factor.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/get-zoom-level.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/index.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/insert-text.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-bypassing-c-s-p.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-privileged.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-secure.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-content-security-policy.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-human-readable-name.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-security-origin.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-layout-zoom-level-limits.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-spell-check-provider.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-visual-zoom-level-limits.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-zoom-factor.html create mode 100644 api/pl.treksoft.kvision.electron/-web-frame/set-zoom-level.html (limited to 'api/pl.treksoft.kvision.electron/-web-frame') diff --git a/api/pl.treksoft.kvision.electron/-web-frame/clear-cache.html b/api/pl.treksoft.kvision.electron/-web-frame/clear-cache.html new file mode 100644 index 00000000..dfd9753a --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/clear-cache.html @@ -0,0 +1,14 @@ + + + +WebFrame.clearCache - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / clearCache
+
+

clearCache

+ +abstract fun clearCache(): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/execute-java-script-in-isolated-world.html b/api/pl.treksoft.kvision.electron/-web-frame/execute-java-script-in-isolated-world.html new file mode 100644 index 00000000..de960c84 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/execute-java-script-in-isolated-world.html @@ -0,0 +1,14 @@ + + + +WebFrame.executeJavaScriptInIsolatedWorld - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / executeJavaScriptInIsolatedWorld
+
+

executeJavaScriptInIsolatedWorld

+ +

abstract fun executeJavaScriptInIsolatedWorld(worldId: Number, scripts: Array<WebSource>, userGesture: Boolean? = definedExternally, callback: (result: Any) -> Unit = definedExternally): Unit

+ + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/execute-java-script.html b/api/pl.treksoft.kvision.electron/-web-frame/execute-java-script.html new file mode 100644 index 00000000..f5d65d16 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/execute-java-script.html @@ -0,0 +1,14 @@ + + + +WebFrame.executeJavaScript - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / executeJavaScript
+
+

executeJavaScript

+ +

abstract fun executeJavaScript(code: String, userGesture: Boolean? = definedExternally, callback: (result: Any) -> Unit = definedExternally): Promise<Any>

+ + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/get-resource-usage.html b/api/pl.treksoft.kvision.electron/-web-frame/get-resource-usage.html new file mode 100644 index 00000000..618a0f62 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/get-resource-usage.html @@ -0,0 +1,14 @@ + + + +WebFrame.getResourceUsage - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / getResourceUsage
+
+

getResourceUsage

+ +abstract fun getResourceUsage(): ResourceUsage + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/get-zoom-factor.html b/api/pl.treksoft.kvision.electron/-web-frame/get-zoom-factor.html new file mode 100644 index 00000000..79b8edc1 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/get-zoom-factor.html @@ -0,0 +1,14 @@ + + + +WebFrame.getZoomFactor - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / getZoomFactor
+
+

getZoomFactor

+ +abstract fun getZoomFactor(): Number + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/get-zoom-level.html b/api/pl.treksoft.kvision.electron/-web-frame/get-zoom-level.html new file mode 100644 index 00000000..6f6efa5f --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/get-zoom-level.html @@ -0,0 +1,14 @@ + + + +WebFrame.getZoomLevel - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / getZoomLevel
+
+

getZoomLevel

+ +abstract fun getZoomLevel(): Number + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/index.html b/api/pl.treksoft.kvision.electron/-web-frame/index.html new file mode 100644 index 00000000..a9bb748e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/index.html @@ -0,0 +1,254 @@ + + + +WebFrame - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame
+
+

WebFrame

+external interface WebFrame : EventEmitter +

Functions

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

+ clearCache +	+`abstract fun clearCache(): Unit`
+ executeJavaScript +	+`abstract fun executeJavaScript(code: String, userGesture: Boolean? = definedExternally, callback: (result: Any) -> Unit = definedExternally): Promise<Any>`
+ executeJavaScriptInIsolatedWorld +	+`abstract fun executeJavaScriptInIsolatedWorld(worldId: Number, scripts: Array<WebSource>, userGesture: Boolean? = definedExternally, callback: (result: Any) -> Unit = definedExternally): Unit`
+ getResourceUsage +	+`abstract fun getResourceUsage(): ResourceUsage`
+ getZoomFactor +	+`abstract fun getZoomFactor(): Number`
+ getZoomLevel +	+`abstract fun getZoomLevel(): Number`
+ insertText +	+`abstract fun insertText(text: String): Unit`
+ registerURLSchemeAsBypassingCSP +	+`abstract fun registerURLSchemeAsBypassingCSP(scheme: String): Unit`
+ registerURLSchemeAsPrivileged +	+`abstract fun registerURLSchemeAsPrivileged(scheme: String, options: RegisterURLSchemeAsPrivilegedOptions? = definedExternally): Unit`
+ registerURLSchemeAsSecure +	+`abstract fun registerURLSchemeAsSecure(scheme: String): Unit`
+ setIsolatedWorldContentSecurityPolicy +	+`abstract fun setIsolatedWorldContentSecurityPolicy(worldId: Number, csp: String): Unit`
+ setIsolatedWorldHumanReadableName +	+`abstract fun setIsolatedWorldHumanReadableName(worldId: Number, name: String): Unit`
+ setIsolatedWorldSecurityOrigin +	+`abstract fun setIsolatedWorldSecurityOrigin(worldId: Number, securityOrigin: String): Unit`
+ setLayoutZoomLevelLimits +	+`abstract fun setLayoutZoomLevelLimits(minimumLevel: Number, maximumLevel: Number): Unit`
+ setSpellCheckProvider +	+`abstract fun setSpellCheckProvider(language: String, autoCorrectWord: Boolean, provider: Provider): Unit`
+ setVisualZoomLevelLimits +	+`abstract fun setVisualZoomLevelLimits(minimumLevel: Number, maximumLevel: Number): Unit`
+ setZoomFactor +	+`abstract fun setZoomFactor(factor: Number): Unit`
+ setZoomLevel +	+`abstract fun setZoomLevel(level: 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/-web-frame/insert-text.html b/api/pl.treksoft.kvision.electron/-web-frame/insert-text.html new file mode 100644 index 00000000..8c713f7b --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/insert-text.html @@ -0,0 +1,14 @@ + + + +WebFrame.insertText - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / insertText
+
+

insertText

+ +abstract fun insertText(text: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-bypassing-c-s-p.html b/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-bypassing-c-s-p.html new file mode 100644 index 00000000..9ce03bdf --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-bypassing-c-s-p.html @@ -0,0 +1,14 @@ + + + +WebFrame.registerURLSchemeAsBypassingCSP - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / registerURLSchemeAsBypassingCSP
+
+

registerURLSchemeAsBypassingCSP

+ +abstract fun registerURLSchemeAsBypassingCSP(scheme: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-privileged.html b/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-privileged.html new file mode 100644 index 00000000..c8c0c623 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-privileged.html @@ -0,0 +1,14 @@ + + + +WebFrame.registerURLSchemeAsPrivileged - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / registerURLSchemeAsPrivileged
+
+

registerURLSchemeAsPrivileged

+ +

abstract fun registerURLSchemeAsPrivileged(scheme: String, options: RegisterURLSchemeAsPrivilegedOptions? = definedExternally): Unit

+ + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-secure.html b/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-secure.html new file mode 100644 index 00000000..8023fb6c --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/register-u-r-l-scheme-as-secure.html @@ -0,0 +1,14 @@ + + + +WebFrame.registerURLSchemeAsSecure - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / registerURLSchemeAsSecure
+
+

registerURLSchemeAsSecure

+ +abstract fun registerURLSchemeAsSecure(scheme: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-content-security-policy.html b/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-content-security-policy.html new file mode 100644 index 00000000..e208ec40 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-content-security-policy.html @@ -0,0 +1,14 @@ + + + +WebFrame.setIsolatedWorldContentSecurityPolicy - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setIsolatedWorldContentSecurityPolicy
+
+

setIsolatedWorldContentSecurityPolicy

+ +abstract fun setIsolatedWorldContentSecurityPolicy(worldId: Number, csp: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-human-readable-name.html b/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-human-readable-name.html new file mode 100644 index 00000000..5fa1960c --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-human-readable-name.html @@ -0,0 +1,14 @@ + + + +WebFrame.setIsolatedWorldHumanReadableName - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setIsolatedWorldHumanReadableName
+
+

setIsolatedWorldHumanReadableName

+ +abstract fun setIsolatedWorldHumanReadableName(worldId: Number, name: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-security-origin.html b/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-security-origin.html new file mode 100644 index 00000000..5850bdda --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-isolated-world-security-origin.html @@ -0,0 +1,14 @@ + + + +WebFrame.setIsolatedWorldSecurityOrigin - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setIsolatedWorldSecurityOrigin
+
+

setIsolatedWorldSecurityOrigin

+ +abstract fun setIsolatedWorldSecurityOrigin(worldId: Number, securityOrigin: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-layout-zoom-level-limits.html b/api/pl.treksoft.kvision.electron/-web-frame/set-layout-zoom-level-limits.html new file mode 100644 index 00000000..1ffc50bf --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-layout-zoom-level-limits.html @@ -0,0 +1,14 @@ + + + +WebFrame.setLayoutZoomLevelLimits - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setLayoutZoomLevelLimits
+
+

setLayoutZoomLevelLimits

+ +abstract fun setLayoutZoomLevelLimits(minimumLevel: Number, maximumLevel: Number): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-spell-check-provider.html b/api/pl.treksoft.kvision.electron/-web-frame/set-spell-check-provider.html new file mode 100644 index 00000000..e58e1fdf --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-spell-check-provider.html @@ -0,0 +1,14 @@ + + + +WebFrame.setSpellCheckProvider - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setSpellCheckProvider
+
+

setSpellCheckProvider

+ +abstract fun setSpellCheckProvider(language: String, autoCorrectWord: Boolean, provider: Provider): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-visual-zoom-level-limits.html b/api/pl.treksoft.kvision.electron/-web-frame/set-visual-zoom-level-limits.html new file mode 100644 index 00000000..b86ec7c3 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-visual-zoom-level-limits.html @@ -0,0 +1,14 @@ + + + +WebFrame.setVisualZoomLevelLimits - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setVisualZoomLevelLimits
+
+

setVisualZoomLevelLimits

+ +abstract fun setVisualZoomLevelLimits(minimumLevel: Number, maximumLevel: Number): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-zoom-factor.html b/api/pl.treksoft.kvision.electron/-web-frame/set-zoom-factor.html new file mode 100644 index 00000000..af6365e3 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-zoom-factor.html @@ -0,0 +1,14 @@ + + + +WebFrame.setZoomFactor - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setZoomFactor
+
+

setZoomFactor

+ +abstract fun setZoomFactor(factor: Number): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-web-frame/set-zoom-level.html b/api/pl.treksoft.kvision.electron/-web-frame/set-zoom-level.html new file mode 100644 index 00000000..43f150d4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-web-frame/set-zoom-level.html @@ -0,0 +1,14 @@ + + + +WebFrame.setZoomLevel - kvision + + + +kvision / pl.treksoft.kvision.electron / WebFrame / setZoomLevel
+
+

setZoomLevel

+ +abstract fun setZoomLevel(level: Number): Unit + + -- cgit