src/common/ircchannel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005/06 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _IRCCHANNEL_H_
  22 #define _IRCCHANNEL_H_
  23
  24 #include <QHash>
  25 #include <QString>
  26 #include <QStringList>
  27 #include <QVariantMap>
  28
  29 #include "syncableobject.h"
  30
  31 class IrcUser;
  32 class Network;
  33 class SignalProxy;
  34
  35 class IrcChannel : public SyncableObject {
  36   Q_OBJECT
  37
  38   Q_PROPERTY(QString name READ name STORED false)
  39   Q_PROPERTY(QString topic READ topic WRITE setTopic STORED false)
  40   Q_PROPERTY(QString password READ password WRITE setPassword STORED false)
  41
  42 public:
  43   IrcChannel(const QString &channelname, Network *network);
  44   ~IrcChannel();
  45
  46   bool isKnownUser(IrcUser *ircuser) const;
  47   bool isValidChannelUserMode(const QString &mode) const;
  48
  49   inline QString name() const { return _name; }
  50   inline QString topic() const { return _topic; }
  51   inline QString password() const { return _password; }
  52
  53   inline QList<IrcUser *> ircUsers() const { return _userModes.keys(); }
  54
  55   QString userModes(IrcUser *ircuser) const;
  56   QString userModes(const QString &nick) const;
  57
  58   inline QTextCodec *codecForEncoding() const { return _codecForEncoding; }
  59   inline QTextCodec *codecForDecoding() const { return _codecForDecoding; }
  60   void setCodecForEncoding(const QString &codecName);
  61   void setCodecForEncoding(QTextCodec *codec);
  62   void setCodecForDecoding(const QString &codecName);
  63   void setCodecForDecoding(QTextCodec *codec);
  64
  65   QString decodeString(const QByteArray &text) const;
  66   QByteArray encodeString(const QString &string) const;
  67
  68 public slots:
  69   void setTopic(const QString &topic);
  70   void setPassword(const QString &password);
  71
  72   void joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes);
  73   void joinIrcUsers(const QStringList &nicks, const QStringList &modes);
  74   void joinIrcUsers(IrcUser *ircuser);
  75   void joinIrcUsers(const QString &nick);
  76
  77   void part(IrcUser *ircuser);
  78   void part(const QString &nick);
  79
  80   void setUserModes(IrcUser *ircuser, const QString &modes);
  81   void setUserModes(const QString &nick, const QString &modes);
  82
  83   void addUserMode(IrcUser *ircuser, const QString &mode);
  84   void addUserMode(const QString &nick, const QString &mode);
  85
  86   void removeUserMode(IrcUser *ircuser, const QString &mode);
  87   void removeUserMode(const QString &nick, const QString &mode);
  88
  89   // init geters
  90   QVariantMap initUserModes() const;
  91
  92   // init seters
  93   void initSetUserModes(const QVariantMap &usermodes);
  94
  95 signals:
  96   void topicSet(const QString &topic);
  97   void passwordSet(const QString &password);
  98   void userModesSet(QString nick, QString modes);
  99   //void userModesSet(IrcUser *ircuser, QString modes);
 100   void userModeAdded(QString nick, QString mode);
 101   //void userModeAdded(IrcUser *ircuser, QString mode);
 102   void userModeRemoved(QString nick, QString mode);
 103   //void userModeRemoved(IrcUser *ircuser, QString mode);
 104
 105   void ircUsersJoined(QList<IrcUser *> ircusers);
 106   void ircUsersJoined(QStringList nicks, QStringList modes);
 107   void ircUserParted(IrcUser *ircuser);
 108   void ircUserNickSet(IrcUser *ircuser, QString nick);
 109   void ircUserModeAdded(IrcUser *ircuser, QString mode);
 110   void ircUserModeRemoved(IrcUser *ircuser, QString mode);
 111   void ircUserModesSet(IrcUser *ircuser, QString modes);
 112
 113 private slots:
 114    void ircUserDestroyed();
 115    void ircUserNickSet(QString nick);
 116
 117 private:
 118   bool _initialized;
 119   QString _name;
 120   QString _topic;
 121   QString _password;
 122
 123   QHash<IrcUser *, QString> _userModes;
 124
 125   Network *network;
 126
 127   QTextCodec *_codecForEncoding;
 128   QTextCodec *_codecForDecoding;
 129 };
 130
 131 #endif