src/uisupport/abstractnotificationbackend.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include "uisupport-export.h"
  24
  25 #include <QObject>
  26 #include <QString>
  27
  28 #include "bufferinfo.h"
  29
  30 class SettingsPage;
  31
  32 class UISUPPORT_EXPORT AbstractNotificationBackend : public QObject
  33 {
  34     Q_OBJECT
  35
  36 public:
  37     enum NotificationType {
  38         Highlight = 0x01,
  39         PrivMsg = 0x02,
  40         HighlightFocused = 0x11,
  41         PrivMsgFocused = 0x12
  42     };
  43
  44     struct Notification {
  45         uint notificationId;
  46         BufferId bufferId;
  47         NotificationType type;
  48         QString sender;
  49         QString message;
  50
  51         Notification(uint id_, BufferId buf_, NotificationType type_, const QString &sender_, const QString &msg_)
  52             : notificationId(id_), bufferId(buf_), type(type_), sender(sender_), message(msg_) {};
  53     };
  54
  55     inline AbstractNotificationBackend(QObject *parent) : QObject(parent) {};
  56     ~AbstractNotificationBackend() override {};
  57
  58     virtual void notify(const Notification &) = 0;
  59     virtual void close(uint notificationId) { Q_UNUSED(notificationId); }
  60
  61     //! Factory to create a configuration widget suitable for a specific notification backend
  62     /**
  63      * AbstractNotification will not take ownership of that configWidget!
  64      * In case you need to communicate with the configWidget directly, make your connections here
  65      */
  66     virtual SettingsPage *createConfigWidget() const = 0;
  67
  68 signals:
  69     //! May be emitted by the notification to tell the MainWin to raise itself
  70     void activated(uint notificationId = 0);
  71 };