src/common/keyevent.h

   1 /***************************************************************************
   2  *   Copyright (C) 2013 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 KEYEVENT_H
  22 #define KEYEVENT_H
  23
  24 #include "ircevent.h"
  25
  26 class KeyEvent : public IrcEvent
  27 {
  28 public:
  29     enum ExchangeType {
  30         Init,
  31         Finish
  32     };
  33
  34     explicit KeyEvent(EventManager::EventType type, Network *network, const QString &prefix, const QString &target,
  35         ExchangeType exchangeType, const QByteArray &key,
  36         const QDateTime &timestamp = QDateTime())
  37         : IrcEvent(type, network, prefix),
  38         _exchangeType(exchangeType),
  39         _target(target),
  40         _key(key)
  41     {
  42         setTimestamp(timestamp);
  43     }
  44
  45
  46     inline ExchangeType exchangeType() const { return _exchangeType; }
  47     inline void setExchangeType(ExchangeType type) { _exchangeType = type; }
  48
  49     inline QString target() const { return _target; }
  50     inline void setTarget(const QString &target) { _target = target; }
  51
  52     inline QByteArray key() const { return _key; }
  53     inline void setKey(const QByteArray &key) { _key = key; }
  54
  55     static Event *create(EventManager::EventType type, QVariantMap &map, Network *network);
  56
  57 protected:
  58     explicit KeyEvent(EventManager::EventType type, QVariantMap &map, Network *network);
  59     void toVariantMap(QVariantMap &map) const;
  60
  61     virtual inline QString className() const { return "KeyEvent"; }
  62     virtual inline void debugInfo(QDebug &dbg) const
  63     {
  64         NetworkEvent::debugInfo(dbg);
  65         dbg << ", prefix = " << qPrintable(prefix())
  66             << ", target = " << qPrintable(target())
  67             << ", exchangetype = " << (exchangeType() == Init ? "init" : "finish")
  68             << ", key = " << key();
  69     }
  70
  71
  72 private:
  73     ExchangeType _exchangeType;
  74     QString _target;
  75     QByteArray _key;
  76 };
  77
  78
  79 #endif