kopete/protocols/irc/irccontact_channel.h

   1 /*
   2     ircchannelcontact.h - IRC Channel Contact
   3
   4     Copyright (c) 2002      by Nick Betcher <nbetcher@kde.org>
   5     Copyright (c) 2003      by Jason Keirstead <jason@keirstead.org>
   6
   7     Kopete    (c) 2002      by the Kopete developers <kopete-devel@kde.org>
   8
   9     *************************************************************************
  10     *                                                                       *
  11     * This program is free software; you can redistribute it and/or modify  *
  12     * it under the terms of the GNU General Public License as published by  *
  13     * the Free Software Foundation; either version 2 of the License, or     *
  14     * (at your option) any later version.                                   *
  15     *                                                                       *
  16     *************************************************************************
  17 */
  18
  19 #ifndef IRCCONTACT_CHANNEL_H
  20 #define IRCCONTACT_CHANNEL_H
  21
  22 #include "irccontact.h"
  23 #include <QList>
  24
  25 class KAction;
  26 class KActionMenu;
  27 class KCodecAction;
  28 class KToggleAction;
  29
  30 class IRCAccount;
  31
  32 namespace Kopete
  33 {
  34 class MetaContact;
  35 }
  36
  37 /**
  38  * @author Jason Keirstead <jason@keirstead.org>
  39  *
  40  * This class is the @ref Kopete::Contact object representing IRC Channels, not users.
  41  * It is derrived from IRCContact where much of its functionality is shared with @ref IRCUserContact.
  42  */
  43 class IRCChannelContact
  44         : public IRCContact
  45 {
  46         friend class IRCSignalMapper;
  47
  48 public:
  49         IRCChannelContact(IRCAccount *, KIRC::EntityPtr entity, Kopete::MetaContact *metac);
  50         ~IRCChannelContact();
  51
  52         /**
  53          * Returns the current topic for this channel.
  54          */
  55          const QString &topic() const { return mTopic; };
  56
  57         /* Set password for a channel */
  58         void setPassword(const QString &password) { mPassword = password; }
  59         /* Get password for a channel */
  60         const QString &password() const { return mPassword; }
  61
  62         /**
  63          * Returns if a mode is enabled for this channel.
  64          * @param mode The mode you want to check ( 't', 'n', etc. )
  65          * @param value This is a pointer to a QString which is set to
  66          * the value of the mode if it has one. Example, the mode 'l' or
  67          * the mode 'k'. If the mode has no such value then the pointer
  68          * is always returned null.
  69          */
  70         bool modeEnabled( QChar mode, QString *value = 0 );
  71
  72         // Kopete::Contact stuff
  73         virtual QList<KAction*> *customContextMenuActions();
  74         virtual const QString caption() const;
  75
  76         //Methods handled by the signal mapper
  77         void userJoinedChannel(const QString &user);
  78         void userPartedChannel(const QString &user, const QString &reason);
  79         void userKicked(const QString &nick, const QString &nickKicked, const QString &reason);
  80         void channelTopic(const QString &topic);
  81         void channelHomePage(const QString &url);
  82         void topicChanged(const QString &nick, const QString &newtopic);
  83         void topicUser(const QString &nick, const QDateTime &time);
  84         void namesList(const QStringList &nicknames);
  85         void endOfNames();
  86         void incomingModeChange(const QString &nick, const QString &mode);
  87         void incomingChannelMode(const QString &mode, const QString &params );
  88         void failedChankey();
  89         void failedChanBanned();
  90         void failedChanInvite();
  91         void failedChanFull();
  92
  93 public slots:
  94         void updateStatus();
  95
  96         /**
  97          * Sets the topic of this channel
  98          * @param topic The topic you want set
  99          */
 100         void setTopic( const QString &topic = QString() );
 101
 102         /**
 103          * Sets or unsets a mode on this channel
 104          * @param mode The full text of the mode change you want performed
 105          */
 106         void setMode( const QString &mode = QString() );
 107
 108         void part();
 109
 110         void join();
 111
 112 protected slots:
 113         void chatSessionDestroyed();
 114
 115         virtual void initConversation();
 116
 117 private slots:
 118         void slotIncomingUserIsAway( const QString &nick, const QString &reason );
 119         void slotModeChanged();
 120         void slotAddNicknames();
 121         void slotConnectedToServer();
 122         void slotUpdateInfo();
 123         void slotHomepage();
 124         void slotChannelListed(const QString &channel, uint members, const QString &topic);
 125
 126 private:
 127         // KAction stuff:
 128         KAction *actionJoin;
 129         KAction *actionPart;
 130         KAction *actionTopic;
 131         KAction *actionHomePage;
 132         KActionMenu *actionModeMenu;
 133         KCodecAction *codecAction;
 134
 135         KToggleAction *actionModeT;
 136         KToggleAction *actionModeN;
 137         KToggleAction *actionModeS;
 138         KToggleAction *actionModeI;
 139         KToggleAction *actionModeP;
 140         KToggleAction *actionModeM;
 141         KToggleAction *actionModeB;
 142
 143         QString mTopic;
 144         QString mPassword;
 145         QStringList mJoinedNicks;
 146         QMap<QString,bool> modeMap;
 147         QTimer *mInfoTimer;
 148
 149         void toggleMode( QChar mode, bool enabled, bool update );
 150 };
 151
 152 #endif // IRCCONTACT_CHANNEL_H