SystemTrayIcon QML Type

SystemTrayIcon can have a menu that opens when the icon is activated.

The following example illustrates how to assign a Menu to a system tray icon:

SystemTrayIcon {
    visible: true
    icon.source: "qrc:/images/tray-icon.png"

    menu: Menu {
        MenuItem {
            text: qsTr("Quit")
            onTriggered: Qt.quit()
        }
    }
}

SystemTrayIcon can display notification messages.

The following example presents how to show a notification message using showMessage(), and how to make use of the messageClicked() signal:

SystemTrayIcon {
    visible: true
    icon.source: "qrc:/images/tray-icon.png"

    onMessageClicked: console.log("Message clicked")
    Component.onCompleted: showMessage("Message title", "Something important came up. Click this to know more.")
}

A native system tray icon is currently available on the following platforms:

• All window managers and independent tray implementations for X11 that implement the freedesktop.org XEmbed system tray specification.

• All desktop environments that implement the freedesktop.org D-Bus StatusNotifierItem specification, including recent versions of KDE and Unity.

• All supported versions of macOS. Note that the Growl notification system must be installed for showMessage() to display messages on OS X prior to 10.8 (Mountain Lion).

The Qt Labs Platform module uses Qt Widgets as a fallback on platforms that do not have a native implementation available. Therefore, applications that use types from the Qt Labs Platform module should link to QtWidgets and use QApplication instead of QGuiApplication.

To link against the QtWidgets library, add the following to your qmake project file:

QT += widgets

Create an instance of QApplication in main():

#include <QApplication>
#include <QQmlApplicationEngine>

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);
    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
    return app.exec();
}

See also Menu

This property holds whether the system tray is available.

This property holds the geometry of the system tray icon.

This property was introduced in Qt.labs.platform 1.1 (Qt 5.12).

[since Qt.labs.platform 1.1 (Qt 5.12)] icon.mask : bool

[since Qt.labs.platform 1.1 (Qt 5.12)] icon.name : string

[since Qt.labs.platform 1.1 (Qt 5.12)] icon.source : url

This property holds the system tray icon.

SystemTrayIcon {
    icon.mask: true
    icon.source: "qrc:/images/tray-icon.png"
}

This QML property was introduced in Qt.labs.platform 1.1 (Qt 5.12).

This property holds a menu for the system tray icon.

This property holds whether the system tray icon supports notification messages.

See Also▲

This property holds the tooltip of the system tray icon.

This property holds whether the system tray icon is visible.

The default value is false.

This signal is emitted when the system tray icon is activated by the user. The reason argument specifies how the system tray icon was activated.

Available reasons:

This signal is emitted when a notification message is clicked by the user.

See Also▲

Hides the system tray icon.

Shows the system tray icon.

Shows a system tray message with the given title, message and icon for the time specified in msecs.

See Also▲