Communi  3.5.0
A cross-platform IRC framework written with Qt
ircchannel.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008-2016 The Communi Project
3 
4  You may use this file under the terms of BSD license as follows:
5 
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8  * Redistributions of source code must retain the above copyright
9  notice, this list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright
11  notice, this list of conditions and the following disclaimer in the
12  documentation and/or other materials provided with the distribution.
13  * Neither the name of the copyright holder nor the names of its
14  contributors may be used to endorse or promote products derived
15  from this software without specific prior written permission.
16 
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR
21  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28 
29 #ifndef IRCCHANNEL_H
30 #define IRCCHANNEL_H
31 
32 #include <IrcGlobal>
33 #include <IrcBuffer>
34 #include <QtCore/qmetatype.h>
35 
36 IRC_BEGIN_NAMESPACE
37 
38 class IrcChannelPrivate;
39 
40 class IRC_MODEL_EXPORT IrcChannel : public IrcBuffer
41 {
42  Q_OBJECT
43  Q_PROPERTY(QString key READ key NOTIFY keyChanged)
44  Q_PROPERTY(QString mode READ mode NOTIFY modeChanged)
45  Q_PROPERTY(QString topic READ topic NOTIFY topicChanged)
46 
47 public:
48  Q_INVOKABLE explicit IrcChannel(QObject* parent = 0);
49  virtual ~IrcChannel();
50 
51  QString key() const;
52  QString mode() const;
53  QString topic() const;
54 
55  virtual bool isActive() const;
56 
57 public Q_SLOTS:
58  void who();
59  void join(const QString& key = QString());
60  void part(const QString& reason = QString());
61  void close(const QString& reason = QString());
62 
63 Q_SIGNALS:
64  void keyChanged(const QString& key);
65  void modeChanged(const QString& mode);
66  void topicChanged(const QString& topic);
67  void destroyed(IrcChannel* channel);
68 private:
69  Q_DECLARE_PRIVATE(IrcChannel)
70  Q_DISABLE_COPY(IrcChannel)
71 };
72 
73 #ifndef QT_NO_DEBUG_STREAM
74 IRC_MODEL_EXPORT QDebug operator<<(QDebug debug, const IrcChannel* channel);
75 #endif // QT_NO_DEBUG_STREAM
76 
77 IRC_END_NAMESPACE
78 
79 Q_DECLARE_METATYPE(IRC_PREPEND_NAMESPACE(IrcChannel*))
80 Q_DECLARE_METATYPE(QList<IRC_PREPEND_NAMESPACE(IrcChannel*)>)
81 
82 #endif // IRCCHANNEL
Keeps track of buffer status.
Definition: ircbuffer.h:49
Keeps track of channel status.
Definition: ircchannel.h:40