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