kotlin-tauri-apps-api/tauri.apps.api/TrayIcon

TrayIcon

external class TrayIcon : Resource(source)

Tray icon class and associated methods. This type constructor is private, instead, you should use the static method {@linkcode TrayIcon.new}.

Warning

Unlike Rust, javascript does not have any way to run cleanup code when an object is being removed by garbage collection, but this tray icon will be cleaned up when the tauri app exists, however if you want to cleanup this object early, you need to call {@linkcode TrayIcon.close}.

Constructors

TrayIcon

constructor()

Types

Companion

object Companion

Properties

var id: String

The id associated with this tray icon.

rid

val rid: Double

Functions

fun close(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

setIcon

fun setIcon(icon: ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/Double>??): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setIcon(icon: ERROR CLASS: Symbol not found for js.buffer.ArrayBuffer??): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setIcon(icon: ERROR CLASS: Symbol not found for js.typedarrays.Uint8Array<ERROR CLASS: Symbol not found for js.buffer.ArrayBuffer>??): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setIcon(icon: String?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setIcon(icon: Image?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets a new tray icon. If null is provided, it will remove the icon.

setIconAsTemplate

fun setIconAsTemplate(asTemplate: Boolean): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets the current icon as a template. macOS only

setMenu

fun setMenu(menu: Menu?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setMenu(menu: Submenu?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets a new tray menu.

setMenuOnLeftClick

fun setMenuOnLeftClick(onLeft: Boolean): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Disable or enable showing the tray menu on left click.

setShowMenuOnLeftClick

fun setShowMenuOnLeftClick(onLeft: Boolean): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Disable or enable showing the tray menu on left click.

setTempDirPath

fun setTempDirPath(path: String?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets the tray icon temp dir path. Linux only.

setTitle

fun setTitle(title: String?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets the tooltip for this tray icon.

setTooltip

fun setTooltip(tooltip: String?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets the tooltip for this tray icon.

setVisible

fun setVisible(visible: Boolean): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Show or hide this tray icon.