src/client/messagemodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
   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 MESSAGEMODEL_H_
  22 #define MESSAGEMODEL_H_
  23
  24 #include <QAbstractItemModel>
  25 #include <QDateTime>
  26
  27 #include "message.h"
  28 #include "types.h"
  29
  30 class MessageModelItem;
  31 struct MsgId;
  32
  33 class MessageModel : public QAbstractItemModel {
  34   Q_OBJECT
  35
  36 public:
  37   enum MessageRole {
  38     DisplayRole = Qt::DisplayRole,
  39     EditRole = Qt::EditRole,
  40     MsgIdRole = Qt::UserRole,
  41     BufferIdRole,
  42     TypeRole,
  43     FlagsRole,
  44     TimestampRole,
  45     FormatRole,
  46     ColumnTypeRole,
  47     UserRole
  48   };
  49
  50   enum ColumnType {
  51     TimestampColumn, SenderColumn, ContentsColumn, UserColumnType
  52   };
  53
  54   MessageModel(QObject *parent);
  55
  56   inline QModelIndex index(int row, int column, const QModelIndex &/*parent*/ = QModelIndex()) const { return createIndex(row, column); }
  57   inline QModelIndex parent(const QModelIndex &) const { return QModelIndex(); }
  58   inline int rowCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return _messageList.count(); }
  59   inline int columnCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return 3; }
  60
  61   virtual QVariant data(const QModelIndex &index, int role) const;
  62   virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
  63
  64   //virtual Qt::ItemFlags flags(const QModelIndex &index) const;
  65
  66   bool insertMessage(const Message &, bool fakeMsg = false);
  67   void insertMessages(const QList<Message> &);
  68
  69   void clear();
  70
  71 protected:
  72   virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
  73
  74 private:
  75   void insertMessageGroup(const QList<Message> &);
  76   QList<MessageModelItem *> _messageList;
  77   int indexForId(MsgId);
  78 };
  79
  80 class MessageModelItem {
  81 public:
  82   //! Creates a MessageModelItem from a Message object.
  83   /** This baseclass implementation takes care of all Message data *except* the stylable strings.
  84    *  Subclasses need to provide Qt::DisplayRole at least, which should describe the plaintext
  85    *  strings without formattings (e.g. for searching purposes).
  86    */
  87   MessageModelItem(const Message &);
  88   inline virtual ~MessageModelItem() {}
  89
  90   virtual QVariant data(int column, int role) const;
  91   virtual bool setData(int column, const QVariant &value, int role) = 0;
  92
  93   inline const QDateTime &timeStamp() const { return _timestamp; }
  94   inline MsgId msgId() const { return _msgId; }
  95   inline BufferId bufferId() const { return _bufferId; }
  96   inline Message::Type msgType() const { return _type; }
  97   inline Message::Flags msgFlags() const { return _flags; }
  98
  99   // For sorting
 100   bool operator<(const MessageModelItem &) const;
 101   bool operator==(const MessageModelItem &) const;
 102   bool operator>(const MessageModelItem &) const;
 103   static bool lessThan(const MessageModelItem *m1, const MessageModelItem *m2);
 104
 105 private:
 106   QDateTime _timestamp;
 107   MsgId _msgId;
 108   BufferId _bufferId;
 109   Message::Type _type;
 110   Message::Flags _flags;
 111 };
 112
 113 #endif