src/core/keyevent.h

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