SystemTrayIcon

Qt Base Class: QSystemTrayIcon

Signature: QSystemTrayIcon(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], parent: Optional[PySide6.QtCore.QObject] = None) -> None QSystemTrayIcon(self, parent: Optional[PySide6.QtCore.QObject] = None) -> None

Base classes

Name	Children	Inherits
ObjectMixin prettyqt.core.object	Object SocketNotifier SharedMemory SignalMapper TimeLine AbstractEventDispatcher EventLoop AbstractAnimationMixin TranslatorMixin CoreApplicationMixin ...	object
QSystemTrayIcon PySide6.QtWidgets QSystemTrayIcon(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], parent: Optional[PySide6.QtCore.QObject] \= None) -> None	SystemTrayIcon	QObject

⋔ Inheritance diagram

graph TD
  1473296339824["widgets.SystemTrayIcon"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473365443216["QtWidgets.QSystemTrayIcon"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473299815024 --> 1473296339824
  140713234304496 --> 1473299815024
  1473365443216 --> 1473296339824
  1473288842240 --> 1473365443216
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: ObjectMixin, QSystemTrayIcon

Icon for an application in the system tray.

Source code in prettyqt\widgets\systemtrayicon.py

class SystemTrayIcon(core.ObjectMixin, QtWidgets.QSystemTrayIcon):
    """Icon for an application in the system tray."""

    def set_icon(self, icon: datatypes.IconType):
        """Set the system tray icon.

        Args:
            icon: icon to use
        """
        icon = iconprovider.get_icon(icon)
        self.setIcon(icon)

    def show_message(
        self,
        title: str,
        message: str = "",
        icon: datatypes.IconType = None,
        timeout: int = 10,
    ):
        if icon is None:
            ico = gui.Icon()
        if icon in MESSAGE_ICONS:
            ico = MESSAGE_ICONS[icon]
        else:
            ico = iconprovider.get_icon(icon)
        self.showMessage(title, message, ico, timeout * 1000)

set_icon(icon: datatypes.IconType)

Set the system tray icon.

Parameters:

Name	Type	Description	Default
icon	IconType	icon to use	required

Source code in prettyqt\widgets\systemtrayicon.py

def set_icon(self, icon: datatypes.IconType):
    """Set the system tray icon.

    Args:
        icon: icon to use
    """
    icon = iconprovider.get_icon(icon)
    self.setIcon(icon)

⌗ Property table

Qt Property	Type	Doc
objectName	QString
toolTip	QString
icon	QIcon
visible	bool