Clipboard

Functions

abstract fun availableFormats(type: ClipboardAvailableFormatsType = definedExternally): ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/String>

An array of supported formats for the clipboard type.

clear

abstract fun clear(type: ClipboardClearType = definedExternally)

Clears the clipboard content.

has

abstract fun has(format: String, type: ClipboardHasType = definedExternally): Boolean

Whether the clipboard supports the specified format.

read

abstract fun read(format: String): String

Reads format type from the clipboard.

readBookmark

abstract fun readBookmark(): ReadBookmark

Returns an Object containing title and url keys representing the bookmark in the clipboard. The title and url values will be empty strings when the bookmark is unavailable. The title value will always be empty on Windows.

readBuffer

abstract fun readBuffer(format: String): ERROR CLASS: Symbol not found for Buffer<*>

Reads format type from the clipboard.

readFindText

abstract fun readFindText(): String

The text on the find pasteboard, which is the pasteboard that holds information about the current state of the active application’s find panel.

readHTML

abstract fun readHTML(type: ClipboardReadHTMLType = definedExternally): String

The content in the clipboard as markup.

readImage

abstract fun readImage(type: ClipboardReadImageType = definedExternally): NativeImage

The image content in the clipboard.

readRTF

abstract fun readRTF(type: ClipboardReadRTFType = definedExternally): String

The content in the clipboard as RTF.

readText

abstract fun readText(type: ClipboardReadTextType = definedExternally): String

The content in the clipboard as plain text.

write

abstract fun write(data: Data, type: ClipboardWriteType = definedExternally)

Writes data to the clipboard.

writeBookmark

abstract fun writeBookmark(title: String, url: String, type: ClipboardWriteBookmarkType = definedExternally)

Writes the title (macOS only) and url into the clipboard as a bookmark.

writeBuffer

abstract fun writeBuffer(format: String, buffer: ERROR CLASS: Symbol not found for Buffer<*>, type: ClipboardWriteBufferType = definedExternally)

Writes the buffer into the clipboard as format.

writeFindText

abstract fun writeFindText(text: String)

Writes the text into the find pasteboard (the pasteboard that holds information about the current state of the active application’s find panel) as plain text. This method uses synchronous IPC when called from the renderer process.

writeHTML

abstract fun writeHTML(markup: String, type: ClipboardWriteHTMLType = definedExternally)

Writes markup to the clipboard.

writeImage

abstract fun writeImage(image: NativeImage, type: ClipboardWriteImageType = definedExternally)

Writes image to the clipboard.

writeRTF

abstract fun writeRTF(text: String, type: ClipboardWriteRTFType = definedExternally)

Writes the text into the clipboard in RTF.

writeText

abstract fun writeText(text: String, type: ClipboardWriteTextType = definedExternally)

Writes the text into the clipboard as plain text.