SystemTrayIcon QML Type

A system tray icon. 更多...

import 语句：	import Qt.labs.platform 1.1
Since:	Qt 5.8
继承：	QtObject

特性

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

信号

activated (ActivationReason reason )
messageClicked ()

方法

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

详细描述

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

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

可用性

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

用于 X11 的所有窗口管理器和独立托盘实现有实现 freedesktop.org XEmbed 系统托盘规范 .
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 而不是 QGuiApplication .

要链接到 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();
}

注意： Types in Qt.labs modules are not guaranteed to remain compatible in future versions.

另请参阅 Menu .

特性文档编制

[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.mask : bool
icon.name : string
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.

[read-only] supportsMessages : bool

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

另请参阅 showMessage() .

This property holds the tooltip of the system tray icon.

visible : bool

This property holds whether the system tray icon is visible.

默认值为 false .

信号文档编制

activated ( ActivationReason 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:

常量	描述
`SystemTrayIcon.Unknown`	未知原因
`SystemTrayIcon.Context`	The context menu for the system tray icon was requested
`SystemTrayIcon.DoubleClick`	The system tray icon was double clicked
`SystemTrayIcon.Trigger`	The system tray icon was clicked
`SystemTrayIcon.MiddleClick`	The system tray icon was clicked with the middle mouse button

注意： 相应处理程序是 onActivated .

messageClicked ()

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

注意： 相应处理程序是 onMessageClicked .

另请参阅 showMessage() .

方法文档编制

void hide ()

Hides the system tray icon.

void show ()

Shows the system tray icon.

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

Shows a system tray message with the given title , message and icon 按指定时间 msecs .

注意： 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.

另请参阅 supportsMessages and messageClicked() .