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