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
↳ QObject‹QSystemTrayIconSignals›
↳ QSystemTrayIcon
Index
Constructors
Properties
Methods
- _id
- addEventListener
- children
- delete
- deleteLater
- dumpObjectInfo
- dumpObjectTree
- eventProcessed
- hide
- inherits
- isVisible
- killTimer
- objectName
- parent
- property
- removeEventListener
- setContextMenu
- setEventProcessed
- setIcon
- setObjectName
- setParent
- setProperty
- setToolTip
- show
- showMessage
- startTimer
Constructors
constructor
+ new QSystemTrayIcon(arg?
: QWidget‹QWidgetSignals› | NativeElement): QSystemTrayIcon
Overrides QObject.constructor
Parameters:
Name | Type |
---|---|
arg? | QWidget‹QWidgetSignals› | NativeElement |
Returns: QSystemTrayIcon
Properties
native
• native: NativeElement | null
Inherited from Component.native
Methods
_id
▸ _id(): number
Get an ID identifying the underlying C++ object.
This can be useful when debugging memory problems with help from
setLogCreateQObject()
and setLogDestroyQObject()
. The number is
hash of the memory address of the C++ object.
Returns: number
a unique number which is valid for the lifetime of the C++ object.
addEventListener
▸ addEventListener‹SignalType›(signalType
: SignalType, callback
: QSystemTrayIconSignals[SignalType], options?
: EventListenerOptions): 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 |
options? | EventListenerOptions | Extra optional options controlling how this event listener is added. |
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, options?
: EventListenerOptions): void
Inherited from EventWidget.addEventListener
Parameters:
▪ eventType: WidgetEventTypes
▪ callback: function
▸ (event?
: NativeRawPointer‹"QEvent"›): void
Parameters:
Name | Type |
---|---|
event? | NativeRawPointer‹"QEvent"› |
▪Optional
options: EventListenerOptions
Extra optional options controlling how this event listener is added.
For example in the case of QPushButton:
const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));
Returns: void
children
▸ children(): QObject[]
Inherited from QObject.children
Returns: QObject[]
delete
▸ delete(): void
Returns: void
deleteLater
▸ deleteLater(): void
Inherited from QObject.deleteLater
Returns: void
dumpObjectInfo
▸ dumpObjectInfo(): void
Inherited from QObject.dumpObjectInfo
Returns: void
dumpObjectTree
▸ dumpObjectTree(): void
Inherited from QObject.dumpObjectTree
Returns: void
eventProcessed
▸ eventProcessed(): boolean
Inherited from EventWidget.eventProcessed
Get the state of the event processed flag
See setEventProcessed()
.
Returns: boolean
boolean True if the current event is flagged as processed.
hide
▸ hide(): void
Returns: void
inherits
▸ inherits(className
: string): boolean
Inherited from QObject.inherits
Parameters:
Name | Type |
---|---|
className | string |
Returns: boolean
isVisible
▸ isVisible(): boolean
Returns: boolean
killTimer
▸ killTimer(timerId
: number): void
Inherited from QObject.killTimer
Parameters:
Name | Type |
---|---|
timerId | number |
Returns: void
objectName
▸ objectName(): string
Inherited from QObject.objectName
Returns: string
parent
▸ parent(): QObject
Returns: QObject
property
▸ property(name
: string): QVariant
Inherited from QObject.property
Parameters:
Name | Type |
---|---|
name | string |
Returns: QVariant
removeEventListener
▸ removeEventListener‹SignalType›(signalType
: SignalType, callback
: QSystemTrayIconSignals[SignalType], options?
: EventListenerOptions): void
Inherited from EventWidget.removeEventListener
Type parameters:
▪ SignalType: keyof QSystemTrayIconSignals
Parameters:
Name | Type |
---|---|
signalType | SignalType |
callback | QSystemTrayIconSignals[SignalType] |
options? | EventListenerOptions |
Returns: void
▸ removeEventListener(eventType
: WidgetEventTypes, callback
: function, options?
: EventListenerOptions): void
Inherited from EventWidget.removeEventListener
Parameters:
▪ eventType: WidgetEventTypes
▪ callback: function
▸ (event?
: NativeRawPointer