blob: e4652b742c03a25a396483b62d2a4f15bb45d0a9 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWidgets module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QSYSTEMTRAYICON_H
#define QSYSTEMTRAYICON_H
#include <QtWidgets/qtwidgetsglobal.h>
#include <QtCore/qobject.h>
#ifndef QT_NO_SYSTEMTRAYICON
#include <QtGui/qicon.h>
QT_BEGIN_NAMESPACE
class QSystemTrayIconPrivate;
class QMenu;
class QEvent;
class QWheelEvent;
class QMouseEvent;
class QPoint;
class Q_WIDGETS_EXPORT QSystemTrayIcon : public QObject
{
Q_OBJECT
Q_PROPERTY(QString toolTip READ toolTip WRITE setToolTip)
Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
Q_PROPERTY(bool visible READ isVisible WRITE setVisible DESIGNABLE false)
public:
QSystemTrayIcon(QObject *parent = nullptr);
QSystemTrayIcon(const QIcon &icon, QObject *parent = nullptr);
~QSystemTrayIcon();
enum ActivationReason {
Unknown,
Context,
DoubleClick,
Trigger,
MiddleClick
};
#if QT_CONFIG(menu)
void setContextMenu(QMenu *menu);
QMenu *contextMenu() const;
#endif
QIcon icon() const;
void setIcon(const QIcon &icon);
QString toolTip() const;
void setToolTip(const QString &tip);
static bool isSystemTrayAvailable();
static bool supportsMessages();
enum MessageIcon { NoIcon, Information, Warning, Critical };
QRect geometry() const;
bool isVisible() const;
public Q_SLOTS:
void setVisible(bool visible);
inline void show() { setVisible(true); }
inline void hide() { setVisible(false); }
void showMessage(const QString &title, const QString &msg, const QIcon &icon, int msecs = 10000);
void showMessage(const QString &title, const QString &msg,
QSystemTrayIcon::MessageIcon icon = QSystemTrayIcon::Information, int msecs = 10000);
Q_SIGNALS:
void activated(QSystemTrayIcon::ActivationReason reason);
void messageClicked();
protected:
bool event(QEvent *event) override;
private:
Q_DISABLE_COPY(QSystemTrayIcon)
Q_DECLARE_PRIVATE(QSystemTrayIcon)
Q_PRIVATE_SLOT(d_func(), void _q_emitActivated(QPlatformSystemTrayIcon::ActivationReason))
friend class QSystemTrayIconSys;
friend class QBalloonTip;
};
QT_END_NAMESPACE
#endif // QT_NO_SYSTEMTRAYICON
#endif // QSYSTEMTRAYICON_H