QSystemTrayIcon

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

Inheritance diagram of PySide6.QtWidgets.QSystemTrayIcon

Synopsis

Functions

Slots

Signals

Static functions

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.png

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 ToolTip . Additionally, the QSystemTrayIcon receives wheel events of type Wheel . These are not supported on any other platform.

See also

QDesktopServices System Tray Icon Example

class PySide6.QtWidgets.QSystemTrayIcon([parent=None])

PySide6.QtWidgets.QSystemTrayIcon(icon[, parent=None])

Parameters

Constructs a QSystemTrayIcon object with the given parent.

The icon is initially invisible.

See also

visible

Constructs a QSystemTrayIcon object with the given icon and parent.

The icon is initially invisible.

See also

visible

PySide6.QtWidgets.QSystemTrayIcon.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()

PySide6.QtWidgets.QSystemTrayIcon.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

PySide6.QtWidgets.QSystemTrayIcon.activated(reason)
Parameters

reason – ActivationReason

PySide6.QtWidgets.QSystemTrayIcon.contextMenu()
Return type

PySide6.QtWidgets.QMenu

Returns the current context menu for the system tray entry.

See also

setContextMenu()

PySide6.QtWidgets.QSystemTrayIcon.geometry()
Return type

PySide6.QtCore.QRect

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

See also

visible

PySide6.QtWidgets.QSystemTrayIcon.hide()

Hides the system tray entry.

See also

show() visible

PySide6.QtWidgets.QSystemTrayIcon.icon()
Return type

PySide6.QtGui.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.

static PySide6.QtWidgets.QSystemTrayIcon.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 .

PySide6.QtWidgets.QSystemTrayIcon.isVisible()
Return type

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.

PySide6.QtWidgets.QSystemTrayIcon.messageClicked()
PySide6.QtWidgets.QSystemTrayIcon.setContextMenu(menu)
Parameters

menu – PySide6.QtWidgets.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.

On macOS, this is currently converted to a NSMenu, so the aboutToHide() signal is not emitted.

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()

PySide6.QtWidgets.QSystemTrayIcon.setIcon(icon)
Parameters

icon – PySide6.QtGui.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.

PySide6.QtWidgets.QSystemTrayIcon.setToolTip(tip)
Parameters

tip – 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.

PySide6.QtWidgets.QSystemTrayIcon.setVisible(visible)
Parameters

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.

PySide6.QtWidgets.QSystemTrayIcon.show()

Shows the icon in the system tray.

See also

hide() visible

PySide6.QtWidgets.QSystemTrayIcon.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.

PySide6.QtWidgets.QSystemTrayIcon.showMessage(title, msg, icon[, msecs=10000])
Parameters

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 PySide6.QtWidgets.QSystemTrayIcon.supportsMessages()
Return type

bool

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

See also

showMessage()

PySide6.QtWidgets.QSystemTrayIcon.toolTip()
Return type

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.