SystemTrayIcon QML Type

A system tray icon. More...

• List of all members, including inherited members
• Obsolete members

Properties

• available : bool
• geometry : rect
• icon
  • icon.mask : bool
  • icon.name : string
  • icon.source : url
• menu : Menu
• supportsMessages : bool
• tooltip : string
• visible : bool

Signals

• activated(ActivationReason reason)
• messageClicked()

Methods

• void hide()
• void show()
• void showMessage(string title, string message, MessageIcon icon, int msecs)

Detailed Description

The SystemTrayIcon type provides an icon for an application in the system tray.

Many desktop platforms provide a special system tray or notification area, where applications can display icons and notification messages.

The following example shows how to create a system tray icon, and how to make use of the activated() signal:

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

    onActivated: {
        window.show()
        window.raise()
        window.requestActivate()
    }
}

Tray menu

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

Notification messages

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.")
}

Availability

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::setAttribute(Qt::AA_EnableHighDpiScaling);
    QApplication app(argc, argv);
    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
    return app.exec();
}

See also Menu.

Property Documentation

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

Signal Documentation

Method Documentation