QSystemTrayIcon uses D-Bus StatusNotifier on Linux when possible

Implementing org.kde.StatusNotifier DBus interface
http://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/
as well as org.canonical.dbusmenu for the limited purpose of showing
the tray icon's context menu.  If a desktop environment (such as
KDE or Unity) has a StatusNotifierWatcher listening, then tray icon
information is sent to be displayed by the tray implementation
instead of being rendered directly in an XEmbed window.  This is
necessary because some modern tray implementations no longer provide
XEmbed "hosting".

[ChangeLog][QPA][Xcb] QSystemTrayIcon uses StatusNotifier D-Bus
protocol when the desktop environment supports it

Task-number: QTBUG-31762
Done-with: Marco Martin <mart@kde.org>
Change-Id: I3b1f744d621eefc7e9c61d1469460ebfcc77fc54
Reviewed-by: Jørgen Lind <jorgen.lind@theqtcompany.com>
Reviewed-by: Dmitry Shachnev <mitya57@gmail.com>

1 files changed, 160 insertions, 0 deletions

diff --git a/src/platformsupport/dbustray/qdbustrayicon_p.h b/src/platformsupport/dbustray/qdbustrayicon_p.h
new file mode 100644
index 0000000000..1b5f262ef1
--- /dev/null
+++ b/src/platformsupport/dbustray/qdbustrayicon_p.h
@@ -0,0 +1,160 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+#ifndef QDBUSTRAYICON_H
+#define QDBUSTRAYICON_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#ifndef QT_NO_SYSTEMTRAYICON
+
+#include <QIcon>
+#include <QTemporaryFile>
+#include <QTimer>
+#include "QtGui/qpa/qplatformsystemtrayicon.h"
+#include "private/qdbusmenuconnection_p.h"
+
+QT_BEGIN_NAMESPACE
+
+class QStatusNotifierItemAdaptor;
+class QDBusMenuAdaptor;
+class QDBusPlatformMenu;
+
+class QDBusTrayIcon: public QPlatformSystemTrayIcon
+{
+    Q_OBJECT
+    Q_PROPERTY(QString category READ category NOTIFY categoryChanged)
+    Q_PROPERTY(QString status READ status NOTIFY statusChanged)
+    Q_PROPERTY(QString tooltip READ tooltip NOTIFY tooltipChanged)
+    Q_PROPERTY(QString iconName READ iconName NOTIFY iconChanged)
+    Q_PROPERTY(QIcon icon READ icon NOTIFY iconChanged)
+    Q_PROPERTY(bool isRequestingAttention READ isRequestingAttention NOTIFY attention)
+    Q_PROPERTY(QString attentionTitle READ attentionTitle NOTIFY attention)
+    Q_PROPERTY(QString attentionMessage READ attentionMessage NOTIFY attention)
+    Q_PROPERTY(QString attentionIconName READ attentionIconName NOTIFY attention)
+    Q_PROPERTY(QIcon attentionIcon READ attentionIcon NOTIFY attention)
+    Q_PROPERTY(QDBusPlatformMenu *menu READ menu NOTIFY menuChanged)
+
+public:
+    QDBusTrayIcon();
+
+    virtual ~QDBusTrayIcon();
+
+    QDBusMenuConnection * dBusConnection();
+
+    void init() Q_DECL_OVERRIDE;
+    void cleanup() Q_DECL_OVERRIDE;
+    void updateIcon(const QIcon &icon) Q_DECL_OVERRIDE;
+    void updateToolTip(const QString &tooltip) Q_DECL_OVERRIDE;
+    void updateMenu(QPlatformMenu *menu) Q_DECL_OVERRIDE;
+    QPlatformMenu *createMenu() const Q_DECL_OVERRIDE;
+    void showMessage(const QString &title, const QString &msg,
+                     const QIcon &icon, MessageIcon iconType, int msecs) Q_DECL_OVERRIDE;
+
+    bool isSystemTrayAvailable() const Q_DECL_OVERRIDE;
+    bool supportsMessages() const Q_DECL_OVERRIDE { return true; }
+    QRect geometry() const Q_DECL_OVERRIDE { return QRect(); }
+
+    QString category() const { return m_category; }
+    QString status() const { return m_status; }
+    QString tooltip() const { return m_tooltip; }
+
+    QString iconName() const { return m_iconName; }
+    const QIcon & icon() const { return m_icon; }
+
+    bool isRequestingAttention() const { return m_attentionTimer.isActive(); }
+    QString attentionTitle() const { return m_messageTitle; }
+    QString attentionMessage() const { return m_message; }
+    QString attentionIconName() const { return m_attentionIconName; }
+    const QIcon & attentionIcon() const { return m_attentionIcon; }
+
+    QString instanceId() const { return m_instanceId; }
+
+    QDBusPlatformMenu *menu() { return m_menu; }
+
+public Q_SLOTS:
+    void activate(int x, int y);
+    void contextMenu(int x, int y);
+
+signals:
+    void categoryChanged();
+    void statusChanged(QString arg);
+    void tooltipChanged();
+    void iconChanged();
+    void attention();
+    void menuChanged();
+
+private Q_SLOTS:
+    void attentionTimerExpired();
+
+private:
+    void setStatus(const QString &status);
+    QTemporaryFile *tempIcon(const QIcon &icon);
+
+private:
+    QDBusMenuConnection* m_dbusConnection;
+    QStatusNotifierItemAdaptor *m_adaptor;
+    QDBusMenuAdaptor *m_menuAdaptor;
+    QDBusPlatformMenu *m_menu;
+    QString m_instanceId;
+    QString m_category;
+    QString m_defaultStatus;
+    QString m_status;
+    QString m_tooltip;
+    QString m_messageTitle;
+    QString m_message;
+    QIcon m_icon;
+    QTemporaryFile *m_tempIcon;
+    QString m_iconName;
+    QIcon m_attentionIcon;
+    QTemporaryFile *m_tempAttentionIcon;
+    QString m_attentionIconName;
+    QTimer m_attentionTimer;
+    bool m_isRequestingAttention;
+    bool m_hasMenu;
+};
+
+QT_END_NAMESPACE
+#endif // QT_NO_SYSTEMTRAYICON
+
+#endif // QDBUSTRAYICON_H