1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
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 {
37 enum MessageModelRole {
38 DisplayRole = Qt::DisplayRole,
39 EditRole = Qt::EditRole,
40 BackgroundRole = Qt::BackgroundRole,
41 MessageRole = Qt::UserRole,
54 TimestampColumn, SenderColumn, ContentsColumn, UserColumnType
57 MessageModel(QObject *parent);
59 inline QModelIndex index(int row, int column, const QModelIndex &/*parent*/ = QModelIndex()) const { return createIndex(row, column); }
60 inline QModelIndex parent(const QModelIndex &) const { return QModelIndex(); }
61 inline int rowCount(const QModelIndex &parent = QModelIndex()) const { return parent.isValid() ? 0 : messageCount(); }
62 inline int columnCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return 3; }
64 virtual QVariant data(const QModelIndex &index, int role) const;
65 virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
67 //virtual Qt::ItemFlags flags(const QModelIndex &index) const;
69 bool insertMessage(const Message &, bool fakeMsg = false);
70 void insertMessages(const QList<Message> &);
75 void requestBacklog(BufferId bufferId);
76 void messagesReceived(BufferId bufferId, int count);
77 void buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2);
78 void insertErrorMessage(BufferInfo bufferInfo, const QString &errorString);
81 // virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
83 virtual int messageCount() const = 0;
84 virtual bool messagesIsEmpty() const = 0;
85 virtual const MessageModelItem *messageItemAt(int i) const = 0;
86 virtual MessageModelItem *messageItemAt(int i) = 0;
87 virtual const MessageModelItem *firstMessageItem() const= 0;
88 virtual MessageModelItem *firstMessageItem() = 0;
89 virtual const MessageModelItem *lastMessageItem() const= 0;
90 virtual MessageModelItem *lastMessageItem() = 0;
91 virtual void insertMessage__(int pos, const Message &) = 0;
92 virtual void insertMessages__(int pos, const QList<Message> &) = 0;
93 virtual void removeMessageAt(int i) = 0;
94 virtual void removeAllMessages() = 0;
95 virtual Message takeMessageAt(int i) = 0;
97 virtual void customEvent(QEvent *event);
103 void insertMessageGroup(const QList<Message> &);
104 int insertMessagesGracefully(const QList<Message> &); // inserts as many contiguous msgs as possible. returns numer of inserted msgs.
105 int indexForId(MsgId);
107 // QList<MessageModelItem *> _messageList;
108 QList<Message> _messageBuffer;
109 QTimer _dayChangeTimer;
110 QDateTime _nextDayChange;
111 QHash<BufferId, int> _messagesWaiting;
114 // **************************************************
116 // **************************************************
117 class MessageModelItem {
119 //! Creates a MessageModelItem from a Message object.
120 /** This baseclass implementation takes care of all Message data *except* the stylable strings.
121 * Subclasses need to provide Qt::DisplayRole at least, which should describe the plaintext
122 * strings without formattings (e.g. for searching purposes).
124 MessageModelItem() {}
125 inline virtual ~MessageModelItem() {}
127 virtual QVariant data(int column, int role) const;
128 virtual bool setData(int column, const QVariant &value, int role);
130 virtual const Message &message() const = 0;
131 virtual const QDateTime ×tamp() const = 0;
132 virtual const MsgId &msgId() const = 0;
133 virtual const BufferId &bufferId() const = 0;
134 virtual void setBufferId(BufferId bufferId) = 0;
135 virtual Message::Type msgType() const = 0;
136 virtual Message::Flags msgFlags() const = 0;
139 bool operator<(const MessageModelItem &) const;
140 bool operator==(const MessageModelItem &) const;
141 bool operator>(const MessageModelItem &) const;
142 static bool lessThan(const MessageModelItem *m1, const MessageModelItem *m2);
145 BufferId _redirectedTo;
148 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem);