src/core/keyevent.h

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