src/common/bufferinfo.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 #ifndef BUFFERINFO_H
  21 #define BUFFERINFO_H
  22
  23 #include "types.h"
  24
  25 class QString;
  26 class QDataStream;
  27
  28 class BufferInfo {
  29 public:
  30   enum Type {
  31     InvalidBuffer = 0x00,
  32     StatusBuffer = 0x01,
  33     ChannelBuffer = 0x02,
  34     QueryBuffer = 0x04,
  35     GroupBuffer = 0x08
  36   };
  37
  38   enum Activity {
  39     NoActivity = 0x00,
  40     OtherActivity = 0x01,
  41     NewMessage = 0x02,
  42     Highlight = 0x40
  43   };
  44   Q_DECLARE_FLAGS(ActivityLevel, Activity)
  45
  46   BufferInfo();
  47   BufferInfo(BufferId id, NetworkId networkid, Type type, uint gid = 0, QString buf = QString());
  48
  49   static BufferInfo fakeStatusBuffer(NetworkId networkId);
  50
  51   inline bool isValid() const { return _bufferId != 0; }
  52   inline const BufferId &bufferId() const { return _bufferId; }
  53   inline void setBufferId(BufferId id) { _bufferId = id; }
  54   inline const NetworkId &networkId() const { return _netid; }
  55   inline const Type &type() const { return _type; }
  56   inline const uint &groupId() const { return _groupId; }
  57   void setGroupId(uint gid) { _groupId = gid; }
  58
  59   QString bufferName() const;
  60
  61   inline bool operator==(const BufferInfo &other) const { return _bufferId == other._bufferId; }
  62
  63 private:
  64   BufferId _bufferId;
  65   NetworkId _netid;
  66   Type _type;
  67   uint _groupId;
  68   QString _bufferName;
  69
  70   friend uint qHash(const BufferInfo &);
  71   friend QDataStream &operator<<(QDataStream &out, const BufferInfo &bufferInfo);
  72   friend QDataStream &operator>>(QDataStream &in, BufferInfo &bufferInfo);
  73 };
  74
  75 QDataStream &operator<<(QDataStream &out, const BufferInfo &bufferInfo);
  76 QDataStream &operator>>(QDataStream &in, BufferInfo &bufferInfo);
  77 QDebug operator<<(QDebug dbg, const BufferInfo &b);
  78
  79 Q_DECLARE_METATYPE(BufferInfo)
  80 Q_DECLARE_OPERATORS_FOR_FLAGS(BufferInfo::ActivityLevel)
  81
  82 uint qHash(const BufferInfo &);
  83
  84 #endif