1 /***************************************************************************
2 * Copyright (C) 2005-08 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 ***************************************************************************/
25 #include <QGraphicsItem>
28 #include "chatlinemodel.h"
29 #include "chatscene.h"
34 struct ChatItemPrivate;
36 class ChatItem : public QGraphicsItem {
38 ChatItem(const qreal &width, const qreal &height, const QPointF &pos, QGraphicsItem *parent);
42 inline const QAbstractItemModel *model() const;
43 inline int row() const;
44 virtual ChatLineModel::ColumnType column() const = 0;
45 inline ChatScene *chatScene() const { return qobject_cast<ChatScene *>(scene()); }
47 inline QRectF boundingRect() const { return _boundingRect; }
48 inline qreal width() const { return _boundingRect.width(); }
49 inline qreal height() const { return _boundingRect.height(); }
51 QTextLayout *createLayout(QTextOption::WrapMode, Qt::Alignment = Qt::AlignLeft) const;
52 virtual void doLayout();
55 virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
56 enum { Type = ChatScene::ChatItemType };
57 virtual inline int type() const { return Type; }
59 QVariant data(int role) const;
61 // selection stuff, to be called by the scene
62 QString selection() const;
63 void clearSelection();
64 void setFullSelection();
65 void continueSelecting(const QPointF &pos);
66 bool hasSelection() const;
67 bool isPosOverSelection(const QPointF &pos) const;
69 QList<QRectF> findWords(const QString &searchWord, Qt::CaseSensitivity caseSensitive);
71 virtual void addActionsToMenu(QMenu *menu, const QPointF &itemPos);
72 virtual void handleClick(const QPointF &pos, ChatScene::ClickMode);
81 virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
82 virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
83 virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
85 inline QTextLayout *layout() const;
87 virtual QTextLayout::FormatRange selectionFormat() const;
88 virtual inline QVector<QTextLayout::FormatRange> additionalFormats() const { return QVector<QTextLayout::FormatRange>(); }
90 inline qint16 selectionStart() const { return _selectionStart; }
91 inline void setSelectionStart(qint16 start) { _selectionStart = start; }
92 inline qint16 selectionEnd() const { return _selectionEnd; }
93 inline void setSelectionEnd(qint16 end) { _selectionEnd = end; }
94 inline SelectionMode selectionMode() const { return _selectionMode; }
95 inline void setSelectionMode(SelectionMode mode) { _selectionMode = mode; }
96 void setSelection(SelectionMode mode, qint16 selectionStart, qint16 selectionEnd);
98 qint16 posToCursor(const QPointF &pos) const;
100 inline bool hasPrivateData() const { return (bool)_data; }
101 ChatItemPrivate *privateData() const;
102 virtual inline ChatItemPrivate *newPrivateData();
104 // WARNING: setGeometry and setHeight should not be used without either:
105 // a) calling prepareGeometryChange() immediately before setColumns()
106 // b) calling Chatline::setPos() immediately afterwards
107 inline void setGeometry(qreal width, qreal height) {
108 _boundingRect.setWidth(width);
109 _boundingRect.setHeight(height);
111 inline void setHeight(const qreal &height) {
112 _boundingRect.setHeight(height);
114 inline void setWidth(const qreal &width) {
115 _boundingRect.setWidth(width);
119 // internal selection stuff
120 void setSelection(int start, int length);
122 ChatItemPrivate *_data;
123 QRectF _boundingRect;
125 SelectionMode _selectionMode;
126 qint16 _selectionStart, _selectionEnd;
128 friend class ChatLine;
131 struct ChatItemPrivate {
133 ChatItemPrivate(QTextLayout *l) : layout(l) {}
134 virtual ~ChatItemPrivate() {
139 // inlines of ChatItem
140 QTextLayout *ChatItem::layout() const { return privateData()->layout; }
141 ChatItemPrivate *ChatItem::newPrivateData() { return new ChatItemPrivate(createLayout(QTextOption::WrapAnywhere)); }
143 // ************************************************************
145 // ************************************************************
147 //! A ChatItem for the timestamp column
148 class TimestampChatItem : public ChatItem {
150 TimestampChatItem(const qreal &width, const qreal &height, QGraphicsItem *parent) : ChatItem(width, height, QPointF(0, 0), parent) {}
151 enum { Type = ChatScene::TimestampChatItemType };
152 virtual inline int type() const { return Type; }
153 virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::TimestampColumn; }
156 // ************************************************************
158 // ************************************************************
159 //! A ChatItem for the sender column
160 class SenderChatItem : public ChatItem {
162 SenderChatItem(const qreal &width, const qreal &height, const QPointF &pos, QGraphicsItem *parent) : ChatItem(width, height, pos, parent) {}
163 virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::SenderColumn; }
166 virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
167 enum { Type = ChatScene::SenderChatItemType };
168 virtual inline int type() const { return Type; }
169 virtual inline ChatItemPrivate *newPrivateData() { return new ChatItemPrivate(createLayout(QTextOption::ManualWrap, Qt::AlignRight)); }
172 // ************************************************************
174 // ************************************************************
175 struct ContentsChatItemPrivate;
177 //! A ChatItem for the contents column
178 class ContentsChatItem : public ChatItem {
179 Q_DECLARE_TR_FUNCTIONS(ContentsChatItem);
182 ContentsChatItem(const qreal &width, const QPointF &pos, QGraphicsItem *parent);
184 enum { Type = ChatScene::ContentsChatItemType };
185 virtual inline int type() const { return Type; }
187 inline ChatLineModel::ColumnType column() const { return ChatLineModel::ContentsColumn; }
188 inline QFontMetricsF *fontMetrics() const { return _fontMetrics; }
191 virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
192 virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
193 virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
194 virtual void handleClick(const QPointF &pos, ChatScene::ClickMode clickMode);
196 virtual void addActionsToMenu(QMenu *menu, const QPointF &itemPos);
197 virtual void copyLinkToClipboard();
199 virtual QVector<QTextLayout::FormatRange> additionalFormats() const;
201 virtual void doLayout();
202 virtual inline ChatItemPrivate *newPrivateData();
207 class WrapColumnFinder;
209 inline ContentsChatItemPrivate *privateData() const;
211 QList<Clickable> findClickables() const;
212 Clickable clickableAt(const QPointF &pos) const;
215 void showWebPreview(const Clickable &click);
216 void clearWebPreview();
218 qreal setGeometryByWidth(qreal w);
219 friend class ChatLine;
220 friend struct ContentsChatItemPrivate;
222 QFontMetricsF *_fontMetrics;
224 // we need a receiver for Action signals
225 static ActionProxy _actionProxy;
228 struct ContentsChatItem::Clickable {
229 // Don't change these enums without also changing the regexps in analyze()!
241 inline Clickable() : type(Invalid) {};
242 inline Clickable(Type type_, quint16 start_, quint16 length_) : type(type_), start(start_), length(length_) {};
243 inline bool isValid() const { return type != Invalid; }
246 struct ContentsChatItemPrivate : ChatItemPrivate {
247 ContentsChatItem *contentsItem;
248 QList<ContentsChatItem::Clickable> clickables;
249 ContentsChatItem::Clickable currentClickable;
250 ContentsChatItem::Clickable activeClickable;
252 ContentsChatItemPrivate(QTextLayout *l, const QList<ContentsChatItem::Clickable> &c, ContentsChatItem *parent)
253 : ChatItemPrivate(l), contentsItem(parent), clickables(c) {}
256 //inlines regarding ContentsChatItemPrivate
257 ChatItemPrivate *ContentsChatItem::newPrivateData() {
258 return new ContentsChatItemPrivate(createLayout(QTextOption::WrapAnywhere), findClickables(), this);
260 ContentsChatItemPrivate *ContentsChatItem::privateData() const { return (ContentsChatItemPrivate *)ChatItem::privateData(); }
262 class ContentsChatItem::WrapColumnFinder {
264 WrapColumnFinder(ChatItem *parent);
267 qint16 nextWrapColumn();
273 ChatLineModel::WrapList wrapList;
276 qreal choppedTrailing;
279 //! Acts as a proxy for Action signals targetted at a ContentsChatItem
280 /** Since a ChatItem is not a QObject, hence cannot receive signals, we use a static ActionProxy
281 * as a receiver instead. This avoids having to handle ChatItem actions (e.g. context menu entries)
282 * outside the ChatItem.
284 class ContentsChatItem::ActionProxy : public QObject {
288 inline void copyLinkToClipboard() { item()->copyLinkToClipboard(); }
291 /// Returns the ContentsChatItem that should receive the action event.
292 /** For efficiency reasons, values are not checked for validity. You gotta make sure that you set the data() member
293 * in the Action correctly.
294 * @return The ChatItem from which the sending Action originated
296 inline ContentsChatItem *item() const {
297 return static_cast<ContentsChatItem *>(qobject_cast<QAction *>(sender())->data().value<void *>());
301 /*************************************************************************************************/
303 // Avoid circular include deps
304 #include "chatline.h"
305 const QAbstractItemModel *ChatItem::model() const { return static_cast<ChatLine *>(parentItem())->model(); }
306 int ChatItem::row() const { return static_cast<ChatLine *>(parentItem())->row(); }