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 <utility>
  26
  27 #include <QObject>
  28 #include <QString>
  29
  30 #include "bufferinfo.h"
  31
  32 class SettingsPage;
  33
  34 class UISUPPORT_EXPORT AbstractNotificationBackend : public QObject
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     enum NotificationType
  40     {
  41         Highlight = 0x01,
  42         PrivMsg = 0x02,
  43         HighlightFocused = 0x11,
  44         PrivMsgFocused = 0x12
  45     };
  46
  47     struct Notification
  48     {
  49         uint notificationId;
  50         BufferId bufferId;
  51         NotificationType type;
  52         QString sender;
  53         QString message;
  54
  55         Notification(uint id_, BufferId buf_, NotificationType type_, QString sender_, QString msg_)
  56             : notificationId(id_)
  57             , bufferId(buf_)
  58             , type(type_)
  59             , sender(std::move(sender_))
  60             , message(std::move(msg_))
  61         {}
  62     };
  63
  64     using QObject::QObject;
  65
  66     virtual void notify(const Notification&) = 0;
  67     virtual void close(uint notificationId) { Q_UNUSED(notificationId); }
  68
  69     //! Factory to create a configuration widget suitable for a specific notification backend
  70     /**
  71      * AbstractNotification will not take ownership of that configWidget!
  72      * In case you need to communicate with the configWidget directly, make your connections here
  73      */
  74     virtual SettingsPage* createConfigWidget() const = 0;
  75
  76 signals:
  77     //! May be emitted by the notification to tell the MainWin to raise itself
  78     void activated(uint notificationId = 0);
  79 };