Qt 4.8
qsystemtrayicon.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtGui 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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QSYSTEMTRAYICON_H
43 #define QSYSTEMTRAYICON_H
44 
45 #include <QtCore/qobject.h>
46 
47 #ifndef QT_NO_SYSTEMTRAYICON
48 
49 #include <QtGui/qicon.h>
50 
52 
54 
55 QT_MODULE(Gui)
56 
58 
59 class QMenu;
60 class QEvent;
61 class QWheelEvent;
62 class QMouseEvent;
63 class QPoint;
64 
66 {
67  Q_OBJECT
70  bool visible;
71 
72 public:
73  QSystemTrayIcon(QObject *parent = 0);
74  QSystemTrayIcon(const QIcon &icon, QObject *parent = 0);
75  ~QSystemTrayIcon();
76 
82  MiddleClick
83  };
84 
85 #ifndef QT_NO_MENU
86  void setContextMenu(QMenu *menu);
87  QMenu *contextMenu() const;
88 #endif
89 
90  QIcon icon() const;
91  void setIcon(const QIcon &icon);
92 
93  QString toolTip() const;
94  void setToolTip(const QString &tip);
95 
96  static bool isSystemTrayAvailable();
97  static bool supportsMessages();
98 
99  enum MessageIcon { NoIcon, Information, Warning, Critical };
100  void showMessage(const QString &title, const QString &msg,
101  MessageIcon icon = Information, int msecs = 10000);
102 
103  QRect geometry() const;
104  bool isVisible() const;
105 
106 public Q_SLOTS:
107  void setVisible(bool visible);
108  inline void show() { setVisible(true); }
109  inline void hide() { setVisible(false); }
110 
111 Q_SIGNALS:
112  void activated(QSystemTrayIcon::ActivationReason reason);
113  void messageClicked();
114 
115 protected:
116  bool event(QEvent *event);
117 
118 private:
121 
124  friend void qtsystray_sendActivated(QSystemTrayIcon *, int);
125 };
126 
128 
130 
131 #endif // QT_NO_SYSTEMTRAYICON
132 #endif // QSYSTEMTRAYICON_H
bool visible
whether the system tray entry is visible
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
EventRef event
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
The QWheelEvent class contains parameters that describe a wheel event.
Definition: qevent.h:139
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
#define Q_SLOTS
Definition: qobjectdefs.h:71
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
virtual bool event(QEvent *)
This virtual function receives events to an object and should return true if the event e was recogniz...
Definition: qobject.cpp:1200
#define Q_SIGNALS
Definition: qobjectdefs.h:72
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QString toolTip
the tooltip for the system tray entry
QIcon icon
the system tray icon
void show()
Shows the icon in the system tray.
#define Q_OBJECT
Definition: qobjectdefs.h:157
The QMouseEvent class contains parameters that describe a mouse event.
Definition: qevent.h:85
The QMenu class provides a menu widget for use in menu bars, context menus, and other popup menus...
Definition: qmenu.h:72
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
void hide()
Hides the system tray entry.
ActivationReason
This enum describes the reason the system tray was activated.
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
MessageIcon
This enum describes the icon that is shown when a balloon message is displayed.
#define class
void qtsystray_sendActivated(QSystemTrayIcon *i, int r)
The QEvent class is the base class of all event classes.
Definition: qcoreevent.h:56
#define QT_END_HEADER
Definition: qglobal.h:137
The QSystemTrayIcon class provides an icon for an application in the system tray. ...
The QIcon class provides scalable icons in different modes and states.
Definition: qicon.h:60