view src/qt/notificator.h @ 3526:ba853f68e2c6 draft

enhance Qt5 compatibility - replace Q_WS_MAC (not supported anymore in Qt5) with Q_OS_MAC (supported in Qt4/5)
author Philip Kaufmann <phil.kaufmann@t-online.de>
date Fri, 21 Sep 2012 19:06:53 +0200
parents 56ff97ff8aec
children
line wrap: on
line source

#ifndef NOTIFICATOR_H
#define NOTIFICATOR_H

#include <QObject>
#include <QIcon>

QT_BEGIN_NAMESPACE
class QSystemTrayIcon;
#ifdef USE_DBUS
class QDBusInterface;
#endif
QT_END_NAMESPACE

/** Cross-platform desktop notification client. */
class Notificator: public QObject
{
    Q_OBJECT
public:
    /** Create a new notificator.
       @note Ownership of trayIcon is not transferred to this object.
    */
    Notificator(const QString &programName=QString(), QSystemTrayIcon *trayIcon=0, QWidget *parent=0);
    ~Notificator();

    // Message class
    enum Class
    {
        Information,         /**< Informational message */
        Warning,             /**< Notify user of potential problem */
        Critical             /**< An error occurred */
    };

public slots:

    /** Show notification message.
       @param[in] cls    general message class
       @param[in] title  title shown with message
       @param[in] text   message content
       @param[in] icon   optional icon to show with message
       @param[in] millisTimeout notification timeout in milliseconds (defaults to 10 seconds)
       @note Platform implementations are free to ignore any of the provided fields except for \a text.
     */
    void notify(Class cls, const QString &title, const QString &text,
                const QIcon &icon = QIcon(), int millisTimeout = 10000);

private:
    QWidget *parent;
    enum Mode {
        None,        /**< Ignore informational notifications, and show a modal pop-up dialog for Critical notifications. */
        Freedesktop, /**< Use DBus org.freedesktop.Notifications */
        QSystemTray, /**< Use QSystemTray::showMessage */
        Growl12,        /**< Use the Growl 1.2 notification system (Mac only) */
        Growl13        /**< Use the Growl 1.3 notification system (Mac only) */
    };
    QString programName;
    Mode mode;
    QSystemTrayIcon *trayIcon;
#ifdef USE_DBUS
    QDBusInterface *interface;

    void notifyDBus(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout);
#endif
    void notifySystray(Class cls, const QString &title, const QString &text, const QIcon &icon, int millisTimeout);
#ifdef Q_OS_MAC
    void notifyGrowl(Class cls, const QString &title, const QString &text, const QIcon &icon);
#endif
};

#endif // NOTIFICATOR_H