src/client/buffer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 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
  21 #ifndef _BUFFER_H_
  22 #define _BUFFER_H_
  23
  24 #include <QDateTime>
  25
  26 class AbstractUiMsg;
  27 class IrcChannel;
  28 class NickModel;
  29
  30 struct BufferState;
  31
  32 #include "message.h"
  33 #include "bufferinfo.h"
  34
  35 /// Encapsulates the contents of a single channel, query or server status context.
  36 /**
  37  */
  38 class Buffer : public QObject {
  39   Q_OBJECT
  40
  41 public:
  42   enum Activity {
  43     NoActivity = 0x00,
  44     OtherActivity = 0x01,
  45     NewMessage = 0x02,
  46     Highlight = 0x40
  47   };
  48   Q_DECLARE_FLAGS(ActivityLevel, Activity)
  49
  50   Buffer(BufferInfo, QObject *parent = 0);
  51
  52   BufferInfo bufferInfo() const;
  53   QList<AbstractUiMsg *> contents() const;
  54   inline bool isVisible() const { return _isVisible; }
  55   inline MsgId lastSeenMsg() const { return _lastSeenMsg; }
  56   inline ActivityLevel activityLevel() const { return _activityLevel; }
  57
  58 signals:
  59   void msgAppended(AbstractUiMsg *);
  60   void msgPrepended(AbstractUiMsg *);
  61   void layoutQueueEmpty();
  62
  63 public slots:
  64   void appendMsg(const Message &);
  65   void prependMsg(const Message &);
  66   bool layoutMsg();
  67   void setVisible(bool visible);
  68   void setLastSeenMsg(const MsgId &msgId);
  69   void setActivityLevel(ActivityLevel level);
  70
  71 private:
  72   BufferInfo _bufferInfo;
  73   bool _isVisible;
  74   MsgId _lastSeenMsg;
  75   ActivityLevel _activityLevel;
  76
  77   QList<Message> layoutQueue;
  78   QList<AbstractUiMsg *> layoutedMsgs;
  79
  80   void updateActivityLevel(const Message &msg);
  81 };
  82
  83 Q_DECLARE_OPERATORS_FOR_FLAGS(Buffer::ActivityLevel)
  84
  85 #endif