src/uisupport/abstractnotificationbackend.h

   1 /***************************************************************************
   2 *   Copyright (C) 2005-09 by the Quassel Project                          *
   3 *   devel@quassel-irc.org                                                 *
   4 *                                                                         *
   5 *   This program is free software; you can redistribute it and/or modify  *
   6 *   it under the terms of the GNU General Public License as published by  *
   7 *   the Free Software Foundation; either version 2 of the License, or     *
   8 *   (at your option) version 3.                                           *
   9 *                                                                         *
  10 *   This program is distributed in the hope that it will be useful,       *
  11 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13 *   GNU General Public License for more details.                          *
  14 *                                                                         *
  15 *   You should have received a copy of the GNU General Public License     *
  16 *   along with this program; if not, write to the                         *
  17 *   Free Software Foundation, Inc.,                                       *
  18 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19 ***************************************************************************/
  20
  21 #ifndef ABSTRACTNOTIFICATIONBACKEND_H_
  22 #define ABSTRACTNOTIFICATIONBACKEND_H_
  23
  24 #include <QObject>
  25 #include <QString>
  26
  27 #include "bufferinfo.h"
  28
  29 class SettingsPage;
  30
  31 class AbstractNotificationBackend : public QObject {
  32   Q_OBJECT
  33
  34 public:
  35   enum NotificationType {
  36     Highlight = 0x01,
  37     PrivMsg = 0x02,
  38     HighlightFocused = 0x11,
  39     PrivMsgFocused = 0x12
  40   };
  41
  42   struct Notification {
  43     uint notificationId;
  44     BufferId bufferId;
  45     NotificationType type;
  46     QString sender;
  47     QString message;
  48
  49     Notification(uint id_, BufferId buf_, NotificationType type_, const QString &sender_, const QString &msg_)
  50       : notificationId(id_), bufferId(buf_), type(type_), sender(sender_), message(msg_) {};
  51   };
  52
  53   inline AbstractNotificationBackend(QObject *parent) : QObject(parent) {};
  54   virtual ~AbstractNotificationBackend() {};
  55
  56   virtual void notify(const Notification &) = 0;
  57   virtual void close(uint notificationId) { Q_UNUSED(notificationId); }
  58
  59   //! Factory to create a configuration widget suitable for a specific notification backend
  60   /**
  61    * AbstractNotification will not take ownership of that configWidget!
  62    * In case you need to communicate with the configWidget directly, make your connections here
  63    */
  64   virtual SettingsPage *createConfigWidget() const = 0;
  65
  66 signals:
  67   //! May be emitted by the notification to tell the MainWin to raise itself
  68   void activated(uint notificationId = 0);
  69
  70 };
  71
  72 #endif