nodeguy/website/docs/api/generated/classes/qsystemtrayicon.md

id	title	sidebar_label
qsystemtrayicon	QSystemTrayIcon	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

↳ NodeObject‹QSystemTrayIconSignals›

↳ QSystemTrayIcon

Index

Constructors

• constructor

Properties

• contextMenu
• native
• nodeChildren
• nodeParent

Methods

• addEventListener
• hide
• inherits
• isVisible
• objectName
• property
• removeEventListener
• setContextMenu
• setIcon
• setNodeParent
• setObjectName
• setProperty
• setToolTip
• show
• showMessage

Constructors

constructor

+ new QSystemTrayIcon(): QSystemTrayIcon

Overrides EventWidget.constructor

Returns: QSystemTrayIcon

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

Overrides EventWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹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

▸ addEventListener‹SignalType›(signalType: SignalType, callback: QSystemTrayIconSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof QSystemTrayIconSignals

Parameters:

Name	Type	Description
signalType	SignalType	SignalType is a signal from the widgets signals interface.
callback	QSystemTrayIconSignals[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:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

hide

▸ hide(): void

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

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:

Name	Type
name	string

Returns: QVariant

---

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QSystemTrayIconSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QSystemTrayIconSignals

Parameters:

Name	Type
signalType	SignalType
callback	QSystemTrayIconSignals[SignalType]

Returns: void

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

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

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

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

setContextMenu

▸ setContextMenu(menu: QMenu): void

Parameters:

Name	Type
menu	QMenu

Returns: void

---

setIcon

▸ setIcon(icon: QIcon): void

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from NodeObject.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setProperty

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

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setToolTip

▸ setToolTip(tooltip: string): void

Parameters:

Name	Type
tooltip	string

Returns: void

---

show

▸ show(): void

Returns: void

---

showMessage

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

Parameters:

Name	Type	Default
title	string	""
message	string	""
icon	QIcon	new QIcon()
millisecondsTimeoutHint	number	10000

Returns: void