kotlin-electron/electron.core/Tray

Tray

open external class Tray : EventEmitter(source)

Inheritors

Constructors

constructor(image: NativeImage, guid: String = definedExternally)

Tray

constructor(image: String, guid: String = definedExternally)

Tray

Properties

balloonClickEvent

external val balloonClickEvent: EventInstance<Tuple>

balloonClosedEvent

external val balloonClosedEvent: EventInstance<Tuple>

balloonShowEvent

external val balloonShowEvent: EventInstance<Tuple>

external val clickEvent: EventInstance<Tuple3<KeyboardEvent, Rectangle, Point>>

doubleClickEvent

external val doubleClickEvent: EventInstance<Tuple2<KeyboardEvent, Rectangle>>

external val dragEndEvent: EventInstance<Tuple>

external val dragEnterEvent: EventInstance<Tuple>

external val dragLeaveEvent: EventInstance<Tuple>

external val dropEvent: EventInstance<Tuple>

external val dropFilesEvent: EventInstance<Tuple2<Event<*>, ReadonlyArray<String>>>

external val dropTextEvent: EventInstance<Tuple2<Event<*>, String>>

middleClickEvent

external val middleClickEvent: EventInstance<Tuple2<KeyboardEvent, Rectangle>>

external val mouseDownEvent: EventInstance<Tuple2<KeyboardEvent, Point>>

mouseEnterEvent

external val mouseEnterEvent: EventInstance<Tuple2<KeyboardEvent, Point>>

mouseLeaveEvent

external val mouseLeaveEvent: EventInstance<Tuple2<KeyboardEvent, Point>>

external val mouseMoveEvent: EventInstance<Tuple2<KeyboardEvent, Point>>

external val mouseUpEvent: EventInstance<Tuple2<KeyboardEvent, Point>>

rightClickEvent

external val rightClickEvent: EventInstance<Tuple2<KeyboardEvent, Rectangle>>

Functions

external fun addListener(type: EventType, listener: EventListener)

closeContextMenu

external fun closeContextMenu()

Closes an open context menu, as set by tray.setContextMenu().

external fun destroy()

Destroys the tray icon immediately.

external fun displayBalloon(options: DisplayBalloonOptions)

Displays a tray balloon.

external fun emit(type: EventType, vararg args: Any?): Boolean

external fun eventNames(): ReadonlyArray<EventType>

external fun focus()

Returns focus to the taskbar notification area. Notification area icons should use this message when they have completed their UI operation. For example, if the icon displays a shortcut menu, but the user presses ESC to cancel it, use tray.focus() to return focus to the notification area.

external fun getBounds(): Rectangle

The bounds of this tray icon as Object.

external fun getGUID(): String?

The GUID used to uniquely identify the tray icon and allow it to retain its position between relaunches, or null if none is set.

getIgnoreDoubleClickEvents

external fun getIgnoreDoubleClickEvents(): Boolean

Whether double click events will be ignored.

getMaxListeners

external fun getMaxListeners(): Double

external fun getTitle(): String

the title displayed next to the tray icon in the status bar

external fun isDestroyed(): Boolean

Whether the tray icon is destroyed.

external fun listenerCount(type: EventType, listener: EventListener): Double

external fun listeners(type: EventType): ReadonlyArray<EventListener>

external fun off(type: EventType, listener: EventListener)

external fun on(type: EventType, listener: EventListener)

external fun once(type: EventType, listener: EventListener)

popUpContextMenu

external fun popUpContextMenu(menu: Menu = definedExternally, position: Point = definedExternally)

Pops up the context menu of the tray icon. When menu is passed, the menu will be shown instead of the tray icon's context menu.

prependListener

external fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

external fun prependOnceListener(type: EventType, listener: EventListener)

external fun rawListeners(type: EventType): ReadonlyArray<EventListener>

removeAllListeners

external fun removeAllListeners(type: EventType)

external fun removeBalloon()

Removes a tray balloon.

external fun removeListener(type: EventType, listener: EventListener)

external fun setContextMenu(menu: Menu?)

Sets the context menu for this icon.

setIgnoreDoubleClickEvents

external fun setIgnoreDoubleClickEvents(ignore: Boolean)

Sets the option to ignore double click events. Ignoring these events allows you to detect every individual click of the tray icon.

external fun setImage(image: NativeImage)

external fun setImage(image: String)

Sets the image associated with this tray icon.

setMaxListeners

external fun setMaxListeners(n: Number)

setPressedImage

external fun setPressedImage(image: NativeImage)

external fun setPressedImage(image: String)

Sets the image associated with this tray icon when pressed on macOS.

external fun setTitle(title: String, options: TitleOptions = definedExternally)

Sets the title displayed next to the tray icon in the status bar (Support ANSI colors).

external fun setToolTip(toolTip: String)

Sets the hover text for this tray icon. Setting the text to an empty string will remove the tooltip.