1 /***************************************************************************
2 * Copyright (C) 2005-08 by the Quassel IRC Team *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #ifndef MESSAGEMODEL_H_
22 #define MESSAGEMODEL_H_
24 #include <QAbstractItemModel>
30 class MessageModelItem;
33 class MessageModel : public QAbstractItemModel {
38 DisplayRole = Qt::DisplayRole,
39 EditRole = Qt::EditRole,
40 MsgIdRole = Qt::UserRole,
52 TimestampColumn, SenderColumn, ContentsColumn, UserColumnType
55 MessageModel(QObject *parent);
57 inline QModelIndex index(int row, int column, const QModelIndex &/*parent*/ = QModelIndex()) const { return createIndex(row, column); }
58 inline QModelIndex parent(const QModelIndex &) const { return QModelIndex(); }
59 inline int rowCount(const QModelIndex &parent = QModelIndex()) const { return parent.isValid() ? 0 : _messageList.count(); }
60 inline int columnCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return 3; }
62 virtual QVariant data(const QModelIndex &index, int role) const;
63 virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
65 //virtual Qt::ItemFlags flags(const QModelIndex &index) const;
67 bool insertMessage(const Message &, bool fakeMsg = false);
68 void insertMessages(const QList<Message> &);
73 void requestBacklog(BufferId bufferId);
74 void messagesReceived(BufferId bufferId, int count);
77 virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
78 virtual void customEvent(QEvent *event);
84 void insertMessageGroup(const QList<Message> &);
85 int insertMessagesGracefully(const QList<Message> &); // inserts as many contiguous msgs as possible. returns numer of inserted msgs.
86 int indexForId(MsgId);
88 QList<MessageModelItem *> _messageList;
89 QList<Message> _messageBuffer;
90 QTimer _dayChangeTimer;
91 QDateTime _nextDayChange;
92 QHash<BufferId, int> _messagesWaiting;
95 // **************************************************
97 // **************************************************
98 class MessageModelItem {
100 //! Creates a MessageModelItem from a Message object.
101 /** This baseclass implementation takes care of all Message data *except* the stylable strings.
102 * Subclasses need to provide Qt::DisplayRole at least, which should describe the plaintext
103 * strings without formattings (e.g. for searching purposes).
105 MessageModelItem(const Message &);
106 inline virtual ~MessageModelItem() {}
108 virtual QVariant data(int column, int role) const;
109 virtual bool setData(int column, const QVariant &value, int role);
111 inline const QDateTime &timeStamp() const { return _timestamp; }
112 inline MsgId msgId() const { return _msgId; }
113 inline BufferId bufferId() const { return _bufferId; }
114 inline Message::Type msgType() const { return _type; }
115 inline Message::Flags msgFlags() const { return _flags; }
118 bool operator<(const MessageModelItem &) const;
119 bool operator==(const MessageModelItem &) const;
120 bool operator>(const MessageModelItem &) const;
121 static bool lessThan(const MessageModelItem *m1, const MessageModelItem *m2);
124 QDateTime _timestamp;
127 BufferId _redirectedTo;
129 Message::Flags _flags;
132 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem);