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 class MsgId;
  32
  33 class MessageModel : public QAbstractItemModel {
  34   Q_OBJECT
  35
  36   public:
  37     enum MessageRole {
  38       MsgIdRole = Qt::UserRole,
  39       BufferIdRole,
  40       TypeRole,
  41       FlagsRole,
  42       TimestampRole,
  43       DisplayRole,
  44       FormatRole,
  45       UserRole
  46     };
  47
  48     enum ColumnType {
  49       TimestampColumn, SenderColumn, ContentsColumn, UserColumnType
  50     };
  51
  52     MessageModel(QObject *parent);
  53     virtual ~MessageModel();
  54
  55     inline QModelIndex index(int row, int column, const QModelIndex &/*parent*/ = QModelIndex()) const { return createIndex(row, column); }
  56     inline QModelIndex parent(const QModelIndex &) const { return QModelIndex(); }
  57     inline int rowCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return _messageList.count(); }
  58     inline int columnCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return 3; }
  59
  60     virtual QVariant data(const QModelIndex &index, int role) const;
  61     virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
  62
  63     //virtual Qt::ItemFlags flags(const QModelIndex &index) const;
  64
  65     void insertMessage(const Message &);
  66     void insertMessages(const QList<Message> &);
  67
  68   protected:
  69     virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
  70
  71   private:
  72     QList<MessageModelItem *> _messageList;
  73
  74     int indexForId(MsgId);
  75
  76 };
  77
  78 class MessageModelItem {
  79
  80   public:
  81
  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     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   private:
  94     QDateTime _timestamp;
  95     MsgId _msgId;
  96     BufferId _bufferId;
  97     Message::Type _type;
  98     Message::Flags _flags;
  99 };
 100
 101 #endif