QSystemTrayIcon

Create and control system tray icon.

This class is a JS wrapper around Qt's QSystemTrayIcon class

A QSystemTrayIcon provides ability to add and manipulate native system tray icon.

Example

const { QSystemTrayIcon, QIcon } = require("@nodegui/nodegui");
const trayIcon = new QIcon(
resolve(__dirname, "some/image/file.png");
);
const tray = new QSystemTrayIcon();
tray.setIcon(trayIcon);
tray.show();
global.tray = tray; // prevents garbage collection of tray

Hierarchy

NodeObjectQSystemTrayIconSignals

QSystemTrayIcon

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QSystemTrayIcon(): QSystemTrayIcon

Overrides EventWidget.constructor

Returns: QSystemTrayIcon

+ new QSystemTrayIcon(parent: NodeWidget‹any›): QSystemTrayIcon

Overrides EventWidget.constructor

Parameters:

NameType
parentNodeWidget‹any›

Returns: QSystemTrayIcon

Properties

Optional contextMenu

contextMenu? : QMenu


native

native: NativeElement

Overrides Component.native


nodeChildren

nodeChildren: Set‹Component

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent

Methods

addEventListener

addEventListenerSignalType›(signalType: SignalType, callback: QSystemTrayIconSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QSystemTrayIconSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackQSystemTrayIconSignals[SignalType]Corresponding callback for the signal as mentioned in the widget's signal interface

Returns: void

void

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface

addEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.addEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


hide

hide(): void

Returns: void


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


isVisible

isVisible(): boolean

Returns: boolean


objectName

objectName(): string

Inherited from NodeObject.objectName

Returns: string


property

property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

NameType
namestring

Returns: QVariant


removeEventListener

removeEventListenerSignalType›(signalType: SignalType, callback: QSystemTrayIconSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QSystemTrayIconSignals

Parameters:

NameType
signalTypeSignalType
callbackQSystemTrayIconSignals[SignalType]

Returns: void

removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.removeEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


setContextMenu

setContextMenu(menu: QMenu): void

Parameters:

NameType
menuQMenu

Returns: void


setIcon

setIcon(icon: QIcon): void

Parameters:

NameType
iconQIcon

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from NodeObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setProperty

setProperty(name: string, value: QVariantType): boolean

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setToolTip

setToolTip(tooltip: string): void

Parameters:

NameType
tooltipstring

Returns: void


show

show(): void

Returns: void


showMessage

showMessage(title: string, message: string, icon: QIcon, millisecondsTimeoutHint: number): void

Parameters:

NameTypeDefault
titlestring""
messagestring""
iconQIconnew QIcon()
millisecondsTimeoutHintnumber10000

Returns: void