class QSystemTrayIcon

The QSystemTrayIcon class provides an icon for an application in the system tray. More…

Inheritance diagram of PySide6.QtWidgets.QSystemTrayIcon

Synopsis

Properties

  • iconᅟ - The system tray icon

  • toolTipᅟ - The tooltip for the system tray entry

  • visibleᅟ - Whether the system tray entry is visible

Methods

Slots

Signals

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Modern operating systems usually provide a special area on the desktop, called the system tray or notification area, where long-running applications can display icons and short messages.

../../_images/system-tray.webp

The QSystemTrayIcon class can be used on the following platforms:

To check whether a system tray is present on the user’s desktop, call the isSystemTrayAvailable() static function.

To add a system tray entry, create a QSystemTrayIcon object, call setContextMenu() to provide a context menu for the icon, and call show() to make it visible in the system tray. Status notification messages (“balloon messages”) can be displayed at any time using showMessage() .

If the system tray is unavailable when a system tray icon is constructed, but becomes available later, QSystemTrayIcon will automatically add an entry for the application in the system tray if the icon is visible .

The activated() signal is emitted when the user activates the icon.

Only on X11, when a tooltip is requested, the QSystemTrayIcon receives a QHelpEvent of type QEvent::ToolTip. Additionally, the QSystemTrayIcon receives wheel events of type QEvent::Wheel. These are not supported on any other platform. Note: Since GNOME Shell version 3.26, not all ActivationReason are supported by the system without shell extensions installed.

See also

System Tray Icon Example

class ActivationReason

This enum describes the reason the system tray was activated.

Constant

Description

QSystemTrayIcon.Unknown

Unknown reason

QSystemTrayIcon.Context

The context menu for the system tray entry was requested

QSystemTrayIcon.DoubleClick

The system tray entry was double clicked.

Note

On macOS, a double click will only be emitted if no context menu is set, since the menu opens on mouse press

Constant

Description

QSystemTrayIcon.Trigger

The system tray entry was clicked

QSystemTrayIcon.MiddleClick

The system tray entry was clicked with the middle mouse button

See also

activated()

class MessageIcon

This enum describes the icon that is shown when a balloon message is displayed.

Constant

Description

QSystemTrayIcon.NoIcon

No icon is shown.

QSystemTrayIcon.Information

An information icon is shown.

QSystemTrayIcon.Warning

A standard warning icon is shown.

QSystemTrayIcon.Critical

A critical warning icon is shown.

See also

QMessageBox

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property iconᅟ: QIcon

This property holds the system tray icon.

On Windows, the system tray icon size is 16x16; on X11, the preferred size is 22x22. The icon will be scaled to the appropriate size as necessary.

Access functions:
property toolTipᅟ: str

This property holds the tooltip for the system tray entry.

On some systems, the tooltip’s length is limited. The tooltip will be truncated if necessary.

Access functions:
property visibleᅟ: bool

This property holds whether the system tray entry is visible.

Setting this property to true or calling show() makes the system tray icon visible; setting this property to false or calling hide() hides it.

Access functions:
__init__([parent=None])
Parameters:

parent – QObject

Constructs a QSystemTrayIcon object with the given parent.

The icon is initially invisible.

See also

visible

__init__(icon[, parent=None])
Parameters:

Constructs a QSystemTrayIcon object with the given icon and parent.

The icon is initially invisible.

See also

visible

activated(reason)
Parameters:

reason – ActivationReason

This signal is emitted when the user activates the system tray icon. reason specifies the reason for activation. ActivationReason enumerates the various reasons.

See also

ActivationReason

contextMenu()
Return type:

QMenu

Returns the current context menu for the system tray entry.

See also

setContextMenu()

geometry()
Return type:

QRect

Returns the geometry of the system tray icon in screen coordinates.

See also

visible

hide()

Hides the system tray entry.

See also

show() visible

icon()
Return type:

QIcon

See also

setIcon()

Getter of property iconᅟ .

static isSystemTrayAvailable()
Return type:

bool

Returns true if the system tray is available; otherwise returns false.

If the system tray is currently unavailable but becomes available later, QSystemTrayIcon will automatically add an entry in the system tray if it is visible .

isVisible()
Return type:

bool

Getter of property visibleᅟ .

messageClicked()

This signal is emitted when the message displayed using showMessage() was clicked by the user.

Note

We follow Microsoft Windows behavior, so the signal is also emitted when the user clicks on a tray icon with a balloon message displayed.

See also

activated()

setContextMenu(menu)
Parameters:

menu – QMenu

Sets the specified menu to be the context menu for the system tray icon.

The menu will pop up when the user requests the context menu for the system tray icon by clicking the mouse button.

Note

The system tray icon does not take ownership of the menu. You must ensure that it is deleted at the appropriate time by, for example, creating the menu with a suitable parent object.

See also

contextMenu()

setIcon(icon)
Parameters:

icon – QIcon

See also

icon()

Setter of property iconᅟ .

setToolTip(tip)
Parameters:

tip – str

See also

toolTip()

Setter of property toolTipᅟ .

setVisible(visible)
Parameters:

visible – bool

See also

isVisible()

Setter of property visibleᅟ .

show()

Shows the icon in the system tray.

See also

hide() visible

showMessage(title, msg[, icon=QSystemTrayIcon.Information[, msecs=10000]])
Parameters:

  • title – str

  • msg – str

  • icon – MessageIcon

  • msecs – int

Shows a balloon message for the entry with the given title, message and icon for the time specified in millisecondsTimeoutHint. title and message must be plain text strings.

Message can be clicked by the user; the messageClicked() signal will emitted when this occurs.

Note that display of messages are dependent on the system configuration and user preferences, and that messages may not appear at all. Hence, it should not be relied upon as the sole means for providing critical information.

On Windows, the millisecondsTimeoutHint is usually ignored by the system when the application has focus.

Has been turned into a slot in Qt 5.2.

showMessage(title, msg, icon[, msecs=10000])
Parameters:

  • title – str

  • msg – str

  • icon – QIcon

  • msecs – int

This function overloads showMessage() .

Shows a balloon message for the entry with the given title, message, and custom icon icon for the time specified in millisecondsTimeoutHint.

static supportsMessages()
Return type:

bool

Returns true if the system tray supports balloon messages; otherwise returns false.

See also

showMessage()

toolTip()
Return type:

str

See also

setToolTip()

Getter of property toolTipᅟ .