ChatView now asks the scene if scrolling is ok on message appending
[quassel.git] / src / qtui / chatscene.h
1 /***************************************************************************
2  *   Copyright (C) 2005-08 by the Quassel Project                          *
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 CHATSCENE_H_
22 #define CHATSCENE_H_
23
24 #include <QAbstractItemModel>
25 #include <QGraphicsScene>
26 #include <QSet>
27
28 #include "columnhandleitem.h"
29 #include "messagefilter.h"
30
31 class AbstractUiMsg;
32 class ChatItem;
33 class ChatLine;
34 class WebPreviewItem;
35
36 class QGraphicsSceneMouseEvent;
37
38 class ChatScene : public QGraphicsScene {
39   Q_OBJECT
40
41 public:
42   enum CutoffMode {
43     CutoffLeft,
44     CutoffRight
45   };
46
47   enum ItemType {
48     ChatLineType = QGraphicsItem::UserType + 1,
49     ChatItemType,
50     TimestampChatItemType,
51     SenderChatItemType,
52     ContentsChatItemType,
53     SearchHighlightType,
54     WebPreviewType
55   };
56
57   ChatScene(QAbstractItemModel *model, const QString &idString, qreal width, QObject *parent);
58   virtual ~ChatScene();
59
60   inline QAbstractItemModel *model() const { return _model; }
61   inline QString idString() const { return _idString; }
62
63   int sectionByScenePos(int x);
64   inline int sectionByScenePos(const QPoint &pos) { return sectionByScenePos(pos.x()); }
65   inline bool isSingleBufferScene() const { return _singleBufferScene; }
66   inline bool containsBuffer(const BufferId &id) const;
67   inline ChatLine *chatLine(int row) { return (row < _lines.count()) ? _lines[row] : 0; }
68
69   inline ColumnHandleItem *firstColumnHandle() const { return _firstColHandle; }
70   inline ColumnHandleItem *secondColumnHandle() const { return _secondColHandle; }
71
72   inline CutoffMode senderCutoffMode() const { return _cutoffMode; }
73   inline void setSenderCutoffMode(CutoffMode mode) { _cutoffMode = mode; }
74
75   bool isScrollingAllowed() const;
76
77   virtual bool event(QEvent *e);
78
79  public slots:
80   void updateForViewport(qreal width, qreal height);
81   void setWidth(qreal width);
82
83   // these are used by the chatitems to notify the scene and manage selections
84   void setSelectingItem(ChatItem *item);
85   ChatItem *selectingItem() const { return _selectingItem; }
86   void startGlobalSelection(ChatItem *item, const QPointF &itemPos);
87   void putToClipboard(const QString &);
88
89   void requestBacklog();
90
91   void loadWebPreview(ChatItem *parentItem, const QString &url, const QRectF &urlRect);
92   void clearWebPreview(ChatItem *parentItem = 0);
93
94 signals:
95   void lastLineChanged(QGraphicsItem *item, qreal offset);
96   void layoutChanged(); // indicates changes to the scenerect due to resizing of the contentsitems
97   void mouseMoveWhileSelecting(const QPointF &scenePos);
98
99 protected:
100   virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *mouseEvent);
101   virtual void mousePressEvent(QGraphicsSceneMouseEvent *mouseEvent);
102   virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *mouseEvent);
103
104 protected slots:
105   void rowsInserted(const QModelIndex &, int, int);
106   void rowsAboutToBeRemoved(const QModelIndex &, int, int);
107
108 private slots:
109   void firstHandlePositionChanged(qreal xpos);
110   void secondHandlePositionChanged(qreal xpos);
111   void showWebPreviewEvent();
112   void deleteWebPreviewEvent();
113
114 private:
115   void setHandleXLimits();
116   void updateSelection(const QPointF &pos);
117   QString selectionToString() const;
118
119   QString _idString;
120   QAbstractItemModel *_model;
121   QList<ChatLine *> _lines;
122   bool _singleBufferScene;
123
124   // calls to QChatScene::sceneRect() are very expensive. As we manage the scenerect ourselves
125   // we store the size in a member variable.
126   QRectF _sceneRect;
127   int _firstLineRow; // the first row to display (aka: not a daychange msg)
128   void updateSceneRect(qreal width);
129   inline void updateSceneRect() { updateSceneRect(_sceneRect.width()); }
130   void updateSceneRect(const QRectF &rect);
131   qreal _viewportHeight;
132
133   ColumnHandleItem *_firstColHandle, *_secondColHandle;
134   qreal _firstColHandlePos, _secondColHandlePos;
135   CutoffMode _cutoffMode;
136
137   ChatItem *_selectingItem;
138   int _selectionStartCol, _selectionMinCol;
139   int _selectionStart;
140   int _selectionEnd;
141   int _firstSelectionRow;
142   bool _isSelecting;
143
144   struct WebPreview {
145     ChatItem *parentItem;
146     QGraphicsItem *previewItem;
147     QString url;
148     QRectF urlRect;
149     QTimer delayTimer;
150     QTimer deleteTimer;
151     WebPreview() : parentItem(0), previewItem(0) {}
152   };
153   WebPreview webPreview;
154 };
155
156 bool ChatScene::containsBuffer(const BufferId &id) const {
157   MessageFilter *filter = qobject_cast<MessageFilter*>(model());
158   if(filter)
159     return filter->containsBuffer(id);
160   else
161     return false;
162 }
163
164 #endif