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

val balloonClickEvent: EventInstance<JsTuple>

balloonClosedEvent

val balloonClosedEvent: EventInstance<JsTuple>

balloonShowEvent

val balloonShowEvent: EventInstance<JsTuple>

val clickEvent: EventInstance<JsTuple3<KeyboardEvent, Rectangle, Point>>

doubleClickEvent

val doubleClickEvent: EventInstance<JsTuple2<KeyboardEvent, Rectangle>>

val dragEndEvent: EventInstance<JsTuple>

val dragEnterEvent: EventInstance<JsTuple>

val dragLeaveEvent: EventInstance<JsTuple>

val dropEvent: EventInstance<JsTuple>

val dropFilesEvent: EventInstance<JsTuple2<Event<*>, ReadonlyArray<String>>>

val dropTextEvent: EventInstance<JsTuple2<Event<*>, String>>

middleClickEvent

val middleClickEvent: EventInstance<JsTuple2<KeyboardEvent, Rectangle>>

val mouseDownEvent: EventInstance<JsTuple2<KeyboardEvent, Point>>

mouseEnterEvent

val mouseEnterEvent: EventInstance<JsTuple2<KeyboardEvent, Point>>

mouseLeaveEvent

val mouseLeaveEvent: EventInstance<JsTuple2<KeyboardEvent, Point>>

val mouseMoveEvent: EventInstance<JsTuple2<KeyboardEvent, Point>>

val mouseUpEvent: EventInstance<JsTuple2<KeyboardEvent, Point>>

rightClickEvent

val rightClickEvent: EventInstance<JsTuple2<KeyboardEvent, Rectangle>>

Functions

fun addListener(type: EventType, listener: EventListener)

closeContextMenu

fun closeContextMenu()

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

Destroys the tray icon immediately.

fun displayBalloon(options: DisplayBalloonOptions)

Displays a tray balloon.

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

fun eventNames(): Array<EventType>

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.

fun getBounds(): Rectangle

The bounds of this tray icon as Object.

getIgnoreDoubleClickEvents

fun getIgnoreDoubleClickEvents(): Boolean

Whether double click events will be ignored.

getMaxListeners

fun getMaxListeners(): Double

fun getTitle(): String

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

fun isDestroyed(): Boolean

Whether the tray icon is destroyed.

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

fun listeners(type: EventType): Array<EventListener>

fun off(type: EventType, listener: EventListener)

fun on(type: EventType, listener: EventListener)

fun once(type: EventType, listener: EventListener)

popUpContextMenu

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

fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

fun rawListeners(type: EventType): Array<EventListener>

removeAllListeners

fun removeAllListeners(type: EventType)

fun removeBalloon()

Removes a tray balloon.

fun removeListener(type: EventType, listener: EventListener)

fun setContextMenu(menu: Menu?)

Sets the context menu for this icon.

setIgnoreDoubleClickEvents

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.

fun setImage(image: NativeImage)

fun setImage(image: String)

Sets the image associated with this tray icon.

setMaxListeners

fun setMaxListeners(n: Number)

setPressedImage

fun setPressedImage(image: NativeImage)

fun setPressedImage(image: String)

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

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

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

fun setToolTip(toolTip: String)

Sets the hover text for this tray icon.