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   struct Notification {
  36     uint notificationId;
  37     BufferId bufferId;
  38     QString sender;
  39     QString message;
  40
  41     Notification(uint id_, BufferId buf_, const QString &sender_, const QString &msg_)
  42       : notificationId(id_), bufferId(buf_), sender(sender_), message(msg_) {};
  43   };
  44
  45   inline AbstractNotificationBackend(QObject *parent) : QObject(parent) {};
  46   virtual ~AbstractNotificationBackend() {};
  47
  48   virtual void notify(const Notification &) = 0;
  49   virtual void close(uint notificationId) { Q_UNUSED(notificationId); }
  50
  51   //! Factory to create a configuration widget suitable for a specific notification backend
  52   /**
  53    * AbstractNotification will not take ownership of that configWidget!
  54    * In case you need to communicate with the configWidget directly, make your connections here
  55    */
  56   virtual SettingsPage *createConfigWidget() const = 0;
  57
  58 signals:
  59   //! May be emitted by the notification to tell the MainWin to raise itself
  60   void activated();
  61
  62 };
  63
  64 #endif