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 --- .../-dialog/index.html | 168 +++++++++++++++++++++ .../-dialog/show-certificate-trust-dialog.html | 18 +++ .../-dialog/show-error-box.html | 14 ++ .../-dialog/show-message-box.html | 16 ++ .../-dialog/show-open-dialog.html | 16 ++ .../-dialog/show-save-dialog.html | 16 ++ 6 files changed, 248 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-dialog/index.html create mode 100644 api/pl.treksoft.kvision.electron/-dialog/show-certificate-trust-dialog.html create mode 100644 api/pl.treksoft.kvision.electron/-dialog/show-error-box.html create mode 100644 api/pl.treksoft.kvision.electron/-dialog/show-message-box.html create mode 100644 api/pl.treksoft.kvision.electron/-dialog/show-open-dialog.html create mode 100644 api/pl.treksoft.kvision.electron/-dialog/show-save-dialog.html (limited to 'api/pl.treksoft.kvision.electron/-dialog') diff --git a/api/pl.treksoft.kvision.electron/-dialog/index.html b/api/pl.treksoft.kvision.electron/-dialog/index.html new file mode 100644 index 00000000..2380c1b4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-dialog/index.html @@ -0,0 +1,168 @@ + + + +Dialog - kvision + + + +kvision / pl.treksoft.kvision.electron / Dialog
+
+

Dialog

+external interface Dialog : EventEmitter +

Functions

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

+ showCertificateTrustDialog +	+`abstract fun showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions, callback: Function<>): Unit` +`abstract fun showCertificateTrustDialog(options: CertificateTrustDialogOptions, callback: Function<>): Unit` +`abstract fun showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions, callback: Function<*>): Unit`
+ showErrorBox +	+`abstract fun showErrorBox(title: String, content: String): Unit`
+ showMessageBox +	+`abstract fun showMessageBox(browserWindow: BrowserWindow, options: MessageBoxOptions, callback: (response: Number, checkboxChecked: Boolean) -> Unit = definedExternally): Number` +`abstract fun showMessageBox(options: MessageBoxOptions, callback: (response: Number, checkboxChecked: Boolean) -> Unit = definedExternally): Number`
+ showOpenDialog +	+`abstract fun showOpenDialog(browserWindow: BrowserWindow, options: OpenDialogOptions, callback: (filePaths: Array<String>, bookmarks: Array<String>) -> Unit = definedExternally): Array<String>` +`abstract fun showOpenDialog(options: OpenDialogOptions, callback: (filePaths: Array<String>, bookmarks: Array<String>) -> Unit = definedExternally): Array<String>`
+ showSaveDialog +	+`abstract fun showSaveDialog(browserWindow: BrowserWindow, options: SaveDialogOptions, callback: (filename: String, bookmark: String) -> Unit = definedExternally): String` +`abstract fun showSaveDialog(options: SaveDialogOptions, callback: (filename: String, bookmark: String) -> Unit = definedExternally): String`

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/-dialog/show-certificate-trust-dialog.html b/api/pl.treksoft.kvision.electron/-dialog/show-certificate-trust-dialog.html new file mode 100644 index 00000000..98edda70 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-dialog/show-certificate-trust-dialog.html @@ -0,0 +1,18 @@ + + + +Dialog.showCertificateTrustDialog - kvision + + + +kvision / pl.treksoft.kvision.electron / Dialog / showCertificateTrustDialog
+
+

showCertificateTrustDialog

+ +

abstract fun showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions, callback: Function<*>): Unit

+ +abstract fun showCertificateTrustDialog(options: CertificateTrustDialogOptions, callback: Function<*>): Unit
+ +

abstract fun showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions, callback: Function<*>): Unit

+ + diff --git a/api/pl.treksoft.kvision.electron/-dialog/show-error-box.html b/api/pl.treksoft.kvision.electron/-dialog/show-error-box.html new file mode 100644 index 00000000..f727cd8b --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-dialog/show-error-box.html @@ -0,0 +1,14 @@ + + + +Dialog.showErrorBox - kvision + + + +kvision / pl.treksoft.kvision.electron / Dialog / showErrorBox
+
+

showErrorBox

+ +abstract fun showErrorBox(title: String, content: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-dialog/show-message-box.html b/api/pl.treksoft.kvision.electron/-dialog/show-message-box.html new file mode 100644 index 00000000..3b4924fe --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-dialog/show-message-box.html @@ -0,0 +1,16 @@ + + + +Dialog.showMessageBox - kvision + + + +kvision / pl.treksoft.kvision.electron / Dialog / showMessageBox
+
+

showMessageBox

+ +

abstract fun showMessageBox(browserWindow: BrowserWindow, options: MessageBoxOptions, callback: (response: Number, checkboxChecked: Boolean) -> Unit = definedExternally): Number

+ +

abstract fun showMessageBox(options: MessageBoxOptions, callback: (response: Number, checkboxChecked: Boolean) -> Unit = definedExternally): Number

+ + diff --git a/api/pl.treksoft.kvision.electron/-dialog/show-open-dialog.html b/api/pl.treksoft.kvision.electron/-dialog/show-open-dialog.html new file mode 100644 index 00000000..ebd787fc --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-dialog/show-open-dialog.html @@ -0,0 +1,16 @@ + + + +Dialog.showOpenDialog - kvision + + + +kvision / pl.treksoft.kvision.electron / Dialog / showOpenDialog
+
+

showOpenDialog

+ +

abstract fun showOpenDialog(browserWindow: BrowserWindow, options: OpenDialogOptions, callback: (filePaths: Array<String>, bookmarks: Array<String>) -> Unit = definedExternally): Array<String>

+ +

abstract fun showOpenDialog(options: OpenDialogOptions, callback: (filePaths: Array<String>, bookmarks: Array<String>) -> Unit = definedExternally): Array<String>

+ + diff --git a/api/pl.treksoft.kvision.electron/-dialog/show-save-dialog.html b/api/pl.treksoft.kvision.electron/-dialog/show-save-dialog.html new file mode 100644 index 00000000..4a90b78e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-dialog/show-save-dialog.html @@ -0,0 +1,16 @@ + + + +Dialog.showSaveDialog - kvision + + + +kvision / pl.treksoft.kvision.electron / Dialog / showSaveDialog
+
+

showSaveDialog

+ +

abstract fun showSaveDialog(browserWindow: BrowserWindow, options: SaveDialogOptions, callback: (filename: String, bookmark: String) -> Unit = definedExternally): String

+ +

abstract fun showSaveDialog(options: SaveDialogOptions, callback: (filename: String, bookmark: String) -> Unit = definedExternally): String

+ + -- cgit