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 --- .../-clipboard/available-formats.html | 14 ++ .../-clipboard/clear.html | 14 ++ .../-clipboard/has.html | 14 ++ .../-clipboard/index.html | 261 +++++++++++++++++++++ .../-clipboard/read-bookmark.html | 14 ++ .../-clipboard/read-buffer.html | 14 ++ .../-clipboard/read-find-text.html | 14 ++ .../-clipboard/read-h-t-m-l.html | 14 ++ .../-clipboard/read-image.html | 14 ++ .../-clipboard/read-r-t-f.html | 14 ++ .../-clipboard/read-text.html | 14 ++ .../-clipboard/read.html | 14 ++ .../-clipboard/write-bookmark.html | 14 ++ .../-clipboard/write-buffer.html | 14 ++ .../-clipboard/write-find-text.html | 14 ++ .../-clipboard/write-h-t-m-l.html | 14 ++ .../-clipboard/write-image.html | 14 ++ .../-clipboard/write-r-t-f.html | 14 ++ .../-clipboard/write-text.html | 14 ++ .../-clipboard/write.html | 14 ++ 20 files changed, 527 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/available-formats.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/clear.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/has.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/index.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read-bookmark.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read-buffer.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read-find-text.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read-h-t-m-l.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read-image.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read-r-t-f.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read-text.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/read.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write-bookmark.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write-buffer.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write-find-text.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write-h-t-m-l.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write-image.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write-r-t-f.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write-text.html create mode 100644 api/pl.treksoft.kvision.electron/-clipboard/write.html (limited to 'api/pl.treksoft.kvision.electron/-clipboard') diff --git a/api/pl.treksoft.kvision.electron/-clipboard/available-formats.html b/api/pl.treksoft.kvision.electron/-clipboard/available-formats.html new file mode 100644 index 00000000..91352e29 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/available-formats.html @@ -0,0 +1,14 @@ + + + +Clipboard.availableFormats - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / availableFormats
+
+

availableFormats

+ +abstract fun availableFormats(type: String? = definedExternally): Array<String> + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/clear.html b/api/pl.treksoft.kvision.electron/-clipboard/clear.html new file mode 100644 index 00000000..8f2474d3 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/clear.html @@ -0,0 +1,14 @@ + + + +Clipboard.clear - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / clear
+
+

clear

+ +abstract fun clear(type: String? = definedExternally): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/has.html b/api/pl.treksoft.kvision.electron/-clipboard/has.html new file mode 100644 index 00000000..704f7dd0 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/has.html @@ -0,0 +1,14 @@ + + + +Clipboard.has - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / has
+
+

has

+ +abstract fun has(format: String, type: String? = definedExternally): Boolean + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/index.html b/api/pl.treksoft.kvision.electron/-clipboard/index.html new file mode 100644 index 00000000..795b92e8 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/index.html @@ -0,0 +1,261 @@ + + + +Clipboard - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard
+
+

Clipboard

+external interface Clipboard : EventEmitter +

Functions

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

+ availableFormats +	+`abstract fun availableFormats(type: String? = definedExternally): Array<String>`
+ clear +	+`abstract fun clear(type: String? = definedExternally): Unit`
+ has +	+`abstract fun has(format: String, type: String? = definedExternally): Boolean`
+ read +	+`abstract fun read(format: String): String`
+ readBookmark +	+`abstract fun readBookmark(): ReadBookmark`
+ readBuffer +	+`abstract fun readBuffer(format: String): <ERROR CLASS>`
+ readFindText +	+`abstract fun readFindText(): String`
+ readHTML +	+`abstract fun readHTML(type: String? = definedExternally): String`
+ readImage +	+`abstract fun readImage(type: String? = definedExternally): NativeImage`
+ readRTF +	+`abstract fun readRTF(type: String? = definedExternally): String`
+ readText +	+`abstract fun readText(type: String? = definedExternally): String`
+ write +	+`abstract fun write(data: Data, type: String? = definedExternally): Unit`
+ writeBookmark +	+`abstract fun writeBookmark(title: String, url: String, type: String? = definedExternally): Unit`
+ writeBuffer +	+`abstract fun writeBuffer(format: String, buffer: <ERROR CLASS>, type: String? = definedExternally): Unit`
+ writeFindText +	+`abstract fun writeFindText(text: String): Unit`
+ writeHTML +	+`abstract fun writeHTML(markup: String, type: String? = definedExternally): Unit`
+ writeImage +	+`abstract fun writeImage(image: NativeImage, type: String? = definedExternally): Unit`
+ writeRTF +	+`abstract fun writeRTF(text: String, type: String? = definedExternally): Unit`
+ writeText +	+`abstract fun writeText(text: String, type: String? = definedExternally): 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/-clipboard/read-bookmark.html b/api/pl.treksoft.kvision.electron/-clipboard/read-bookmark.html new file mode 100644 index 00000000..70d9808f --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read-bookmark.html @@ -0,0 +1,14 @@ + + + +Clipboard.readBookmark - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / readBookmark
+
+

readBookmark

+ +abstract fun readBookmark(): ReadBookmark + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/read-buffer.html b/api/pl.treksoft.kvision.electron/-clipboard/read-buffer.html new file mode 100644 index 00000000..0519806f --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read-buffer.html @@ -0,0 +1,14 @@ + + + +Clipboard.readBuffer - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / readBuffer
+
+

readBuffer

+ +abstract fun readBuffer(format: String): <ERROR CLASS> + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/read-find-text.html b/api/pl.treksoft.kvision.electron/-clipboard/read-find-text.html new file mode 100644 index 00000000..f477475a --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read-find-text.html @@ -0,0 +1,14 @@ + + + +Clipboard.readFindText - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / readFindText
+
+

readFindText

+ +abstract fun readFindText(): String + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/read-h-t-m-l.html b/api/pl.treksoft.kvision.electron/-clipboard/read-h-t-m-l.html new file mode 100644 index 00000000..8ee44446 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read-h-t-m-l.html @@ -0,0 +1,14 @@ + + + +Clipboard.readHTML - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / readHTML
+
+

readHTML

+ +abstract fun readHTML(type: String? = definedExternally): String + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/read-image.html b/api/pl.treksoft.kvision.electron/-clipboard/read-image.html new file mode 100644 index 00000000..6e2362c4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read-image.html @@ -0,0 +1,14 @@ + + + +Clipboard.readImage - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / readImage
+
+

readImage

+ +abstract fun readImage(type: String? = definedExternally): NativeImage + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/read-r-t-f.html b/api/pl.treksoft.kvision.electron/-clipboard/read-r-t-f.html new file mode 100644 index 00000000..f3f0b2f4 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read-r-t-f.html @@ -0,0 +1,14 @@ + + + +Clipboard.readRTF - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / readRTF
+
+

readRTF

+ +abstract fun readRTF(type: String? = definedExternally): String + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/read-text.html b/api/pl.treksoft.kvision.electron/-clipboard/read-text.html new file mode 100644 index 00000000..802eff1e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read-text.html @@ -0,0 +1,14 @@ + + + +Clipboard.readText - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / readText
+
+

readText

+ +abstract fun readText(type: String? = definedExternally): String + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/read.html b/api/pl.treksoft.kvision.electron/-clipboard/read.html new file mode 100644 index 00000000..f4706fca --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/read.html @@ -0,0 +1,14 @@ + + + +Clipboard.read - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / read
+
+

read

+ +abstract fun read(format: String): String + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write-bookmark.html b/api/pl.treksoft.kvision.electron/-clipboard/write-bookmark.html new file mode 100644 index 00000000..2a531557 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write-bookmark.html @@ -0,0 +1,14 @@ + + + +Clipboard.writeBookmark - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / writeBookmark
+
+

writeBookmark

+ +abstract fun writeBookmark(title: String, url: String, type: String? = definedExternally): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write-buffer.html b/api/pl.treksoft.kvision.electron/-clipboard/write-buffer.html new file mode 100644 index 00000000..bfed1efd --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write-buffer.html @@ -0,0 +1,14 @@ + + + +Clipboard.writeBuffer - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / writeBuffer
+
+

writeBuffer

+ +abstract fun writeBuffer(format: String, buffer: <ERROR CLASS>, type: String? = definedExternally): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write-find-text.html b/api/pl.treksoft.kvision.electron/-clipboard/write-find-text.html new file mode 100644 index 00000000..bd881403 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write-find-text.html @@ -0,0 +1,14 @@ + + + +Clipboard.writeFindText - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / writeFindText
+
+

writeFindText

+ +abstract fun writeFindText(text: String): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write-h-t-m-l.html b/api/pl.treksoft.kvision.electron/-clipboard/write-h-t-m-l.html new file mode 100644 index 00000000..e1a83f79 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write-h-t-m-l.html @@ -0,0 +1,14 @@ + + + +Clipboard.writeHTML - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / writeHTML
+
+

writeHTML

+ +abstract fun writeHTML(markup: String, type: String? = definedExternally): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write-image.html b/api/pl.treksoft.kvision.electron/-clipboard/write-image.html new file mode 100644 index 00000000..45a10632 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write-image.html @@ -0,0 +1,14 @@ + + + +Clipboard.writeImage - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / writeImage
+
+

writeImage

+ +abstract fun writeImage(image: NativeImage, type: String? = definedExternally): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write-r-t-f.html b/api/pl.treksoft.kvision.electron/-clipboard/write-r-t-f.html new file mode 100644 index 00000000..518a3df0 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write-r-t-f.html @@ -0,0 +1,14 @@ + + + +Clipboard.writeRTF - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / writeRTF
+
+

writeRTF

+ +abstract fun writeRTF(text: String, type: String? = definedExternally): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write-text.html b/api/pl.treksoft.kvision.electron/-clipboard/write-text.html new file mode 100644 index 00000000..c9670057 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write-text.html @@ -0,0 +1,14 @@ + + + +Clipboard.writeText - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / writeText
+
+

writeText

+ +abstract fun writeText(text: String, type: String? = definedExternally): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-clipboard/write.html b/api/pl.treksoft.kvision.electron/-clipboard/write.html new file mode 100644 index 00000000..13cf8b5e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-clipboard/write.html @@ -0,0 +1,14 @@ + + + +Clipboard.write - kvision + + + +kvision / pl.treksoft.kvision.electron / Clipboard / write
+
+

write

+ +abstract fun write(data: Data, type: String? = definedExternally): Unit + + -- cgit