SystemTrayIcon QML Type

A system tray icon. More...

Import Statement: import Qt.labs.platform 1.1
Since: Qt 5.8
Inherits:

QtObject

Properties

Signals

Methods

  • void hide()
  • void show()
  • void showMessage(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:

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

Note: Types in Qt.labs modules are not guaranteed to remain compatible in future versions.

See also Menu.

Property Documentation

[read-only] available : bool

This property holds whether the system tray is available.


geometry : rect

This property holds the geometry of the system tray icon.

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


icon group

icon.source : url

icon.name : string

icon.mask : bool

This property holds the system tray icon.

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

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


This property holds a menu for the system tray icon.


[read-only] supportsMessages : bool

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

See also showMessage().


tooltip : string

This property holds the tooltip of the system tray icon.


visible : bool

This property holds whether the system tray icon is visible.

The default value is false.


Signal Documentation

activated(reason, )

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:

ConstantDescription
SystemTrayIcon.UnknownUnknown reason
SystemTrayIcon.ContextThe context menu for the system tray icon was requested
SystemTrayIcon.DoubleClickThe system tray icon was double clicked
SystemTrayIcon.TriggerThe system tray icon was clicked
SystemTrayIcon.MiddleClickThe system tray icon was clicked with the middle mouse button

messageClicked()

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

See also showMessage().


Method Documentation

void hide()

Hides the system tray icon.


void show()

Shows the system tray icon.


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

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

Note: System tray messages are dependent on the system configuration and user preferences, and may not appear at all. Therefore, it should not be relied upon as the sole means for providing critical information.

See also supportsMessages and messageClicked().


© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.