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 IRCLISTHELPER_H |
22 | #define IRCLISTHELPER_H |
23 | |
24 | #include "syncableobject.h" |
25 | #include "types.h" |
26 | |
27 | /* |
28 | * This is a little helper to display channel lists of a network. |
29 | * The whole process is done in 3 steps: |
30 | * 1.) the client requests to issue a LIST command with requestChannelList() |
31 | * 2.) RPL_LIST fills on the core the list of available channels |
32 | * when RPL_LISTEND is received the clients will be informed, that they can pull the data |
33 | * 3.) client pulls the data by calling requestChannelList again. receiving the data in receiveChannelList |
34 | */ |
35 | class IrcListHelper : public SyncableObject |
36 | { |
37 | SYNCABLE_OBJECT |
38 | Q_OBJECT |
39 | |
40 | public: |
41 | inline IrcListHelper(QObject *parent = 0) : SyncableObject(parent) { setInitialized(); }; |
42 | |
43 | struct ChannelDescription { |
44 | QString channelName; |
45 | quint32 userCount; |
46 | QString topic; |
47 | ChannelDescription(const QString &channelName_, quint32 userCount_, const QString &topic_) : channelName(channelName_), userCount(userCount_), topic(topic_) {}; |
48 | }; |
49 | |
50 | public slots: |
51 | inline virtual QVariantList requestChannelList(const NetworkId &netId, const QStringList &channelFilters) { REQUEST(ARG(netId), ARG(channelFilters)); return QVariantList(); } |
52 | inline virtual void receiveChannelList(const NetworkId &, const QStringList &, const QVariantList &) {}; |
53 | inline virtual void reportFinishedList(const NetworkId &netId) { SYNC(ARG(netId)) } |
54 | inline virtual void reportError(const QString &error) { SYNC(ARG(error)) } |
55 | }; |
56 | |
57 | |
58 | #endif //IRCLISTHELPER_H |
59 | |