1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWidgets module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSYSTEMTRAYICON_H
41#define QSYSTEMTRAYICON_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44#include <QtCore/qobject.h>
45
46#ifndef QT_NO_SYSTEMTRAYICON
47
48#include <QtGui/qicon.h>
49
50QT_BEGIN_NAMESPACE
51
52
53class QSystemTrayIconPrivate;
54
55class QMenu;
56class QEvent;
57class QWheelEvent;
58class QMouseEvent;
59class QPoint;
60
61class Q_WIDGETS_EXPORT QSystemTrayIcon : public QObject
62{
63 Q_OBJECT
64 Q_PROPERTY(QString toolTip READ toolTip WRITE setToolTip)
65 Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
66 Q_PROPERTY(bool visible READ isVisible WRITE setVisible DESIGNABLE false)
67
68public:
69 QSystemTrayIcon(QObject *parent = nullptr);
70 QSystemTrayIcon(const QIcon &icon, QObject *parent = nullptr);
71 ~QSystemTrayIcon();
72
73 enum ActivationReason {
74 Unknown,
75 Context,
76 DoubleClick,
77 Trigger,
78 MiddleClick
79 };
80
81#if QT_CONFIG(menu)
82 void setContextMenu(QMenu *menu);
83 QMenu *contextMenu() const;
84#endif
85
86 QIcon icon() const;
87 void setIcon(const QIcon &icon);
88
89 QString toolTip() const;
90 void setToolTip(const QString &tip);
91
92 static bool isSystemTrayAvailable();
93 static bool supportsMessages();
94
95 enum MessageIcon { NoIcon, Information, Warning, Critical };
96
97 QRect geometry() const;
98 bool isVisible() const;
99
100public Q_SLOTS:
101 void setVisible(bool visible);
102 inline void show() { setVisible(true); }
103 inline void hide() { setVisible(false); }
104 void showMessage(const QString &title, const QString &msg, const QIcon &icon, int msecs = 10000);
105 void showMessage(const QString &title, const QString &msg,
106 QSystemTrayIcon::MessageIcon icon = QSystemTrayIcon::Information, int msecs = 10000);
107
108Q_SIGNALS:
109 void activated(QSystemTrayIcon::ActivationReason reason);
110 void messageClicked();
111
112protected:
113 bool event(QEvent *event) override;
114
115private:
116 Q_DISABLE_COPY(QSystemTrayIcon)
117 Q_DECLARE_PRIVATE(QSystemTrayIcon)
118
119 Q_PRIVATE_SLOT(d_func(), void _q_emitActivated(QPlatformSystemTrayIcon::ActivationReason))
120
121 friend class QSystemTrayIconSys;
122 friend class QBalloonTip;
123};
124
125QT_END_NAMESPACE
126
127#endif // QT_NO_SYSTEMTRAYICON
128#endif // QSYSTEMTRAYICON_H
129