src/qtui/chatscene.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2010 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 <QClipboard>
  26 #include <QGraphicsItem>
  27 #include <QGraphicsScene>
  28 #include <QSet>
  29 #include <QTimer>
  30
  31 #include "chatlinemodel.h"
  32 #include "messagefilter.h"
  33
  34 class AbstractUiMsg;
  35 class ChatItem;
  36 class ChatLine;
  37 class ChatView;
  38 class ColumnHandleItem;
  39 class MarkerLineItem;
  40 class WebPreviewItem;
  41
  42 class QGraphicsSceneMouseEvent;
  43
  44 class ChatScene : public QGraphicsScene {
  45   Q_OBJECT
  46
  47 public:
  48   enum CutoffMode {
  49     CutoffLeft,
  50     CutoffRight
  51   };
  52
  53   enum ItemType {
  54     ChatLineType = QGraphicsItem::UserType + 1,
  55     ChatItemType,
  56     TimestampChatItemType,
  57     SenderChatItemType,
  58     ContentsChatItemType,
  59     SearchHighlightType,
  60     WebPreviewType,
  61     ColumnHandleType,
  62     MarkerLineType
  63   };
  64
  65   enum ClickMode {
  66     NoClick,
  67     DragStartClick,
  68     SingleClick,
  69     DoubleClick,
  70     TripleClick
  71   };
  72
  73   ChatScene(QAbstractItemModel *model, const QString &idString, qreal width, ChatView *parent);
  74   virtual ~ChatScene();
  75
  76   inline QAbstractItemModel *model() const { return _model; }
  77   inline MessageFilter *filter() const { return qobject_cast<MessageFilter*>(_model); }
  78   inline QString idString() const { return _idString; }
  79
  80   int rowByScenePos(qreal y) const;
  81   inline int rowByScenePos(const QPointF &pos) const { return rowByScenePos(pos.y()); }
  82   ChatLineModel::ColumnType columnByScenePos(qreal x) const ;
  83   inline ChatLineModel::ColumnType columnByScenePos(const QPointF &pos) const { return columnByScenePos(pos.x()); }
  84
  85   ChatView *chatView() const;
  86   ChatItem *chatItemAt(const QPointF &pos) const;
  87   inline ChatLine *chatLine(int row) const { return (row < _lines.count()) ? _lines.value(row) : 0; }
  88   inline ChatLine *chatLine(const QModelIndex &index) const { return _lines.value(index.row()); }
  89
  90   //! Find the ChatLine belonging to a MsgId
  91   /** Searches for the ChatLine belonging to a MsgId. If there are more than one ChatLine with the same msgId,
  92    *  the first one is returned.
  93    *  Note that this method performs a binary search, hence it has as complexity of O(log n).
  94    *  If matchExact is false, and we don't have an exact match for the given msgId, we return the visible line right
  95    *  above the requested one.
  96    *  \param msgId      The message ID to look for
  97    *  \param matchExact Whether we find only exact matches
  98    *  \param ignoreDayChange Whether we ignore day change messages
  99    *  \return The ChatLine corresponding to the given MsgId
 100    */
 101   ChatLine *chatLine(MsgId msgId, bool matchExact = true, bool ignoreDayChange = true) const;
 102
 103   inline ChatLine *lastLine() const { return _lines.count() ? _lines.last() : 0; }
 104
 105   inline MarkerLineItem *markerLine() const { return _markerLine; }
 106
 107   inline bool isSingleBufferScene() const { return _singleBufferId.isValid(); }
 108   inline BufferId singleBufferId() const { return _singleBufferId; }
 109   bool containsBuffer(const BufferId &id) const;
 110
 111   ColumnHandleItem *firstColumnHandle() const;
 112   ColumnHandleItem *secondColumnHandle() const;
 113
 114   inline CutoffMode senderCutoffMode() const { return _cutoffMode; }
 115   inline void setSenderCutoffMode(CutoffMode mode) { _cutoffMode = mode; }
 116
 117   QString selection() const;
 118   bool hasSelection() const;
 119   bool hasGlobalSelection() const;
 120   bool isPosOverSelection(const QPointF &) const;
 121   bool isGloballySelecting() const;
 122   void initiateDrag(QWidget *source);
 123
 124   bool isScrollingAllowed() const;
 125
 126   virtual bool event(QEvent *e);
 127
 128  public slots:
 129   void updateForViewport(qreal width, qreal height);
 130   void setWidth(qreal width);
 131   void layout(int start, int end, qreal width);
 132
 133   void setMarkerLineVisible(bool visible = true);
 134   void setMarkerLine(MsgId msgId = MsgId());
 135   void jumpToMarkerLine(bool requestBacklog);
 136
 137   // these are used by the chatitems to notify the scene and manage selections
 138   void setSelectingItem(ChatItem *item);
 139   ChatItem *selectingItem() const { return _selectingItem; }
 140   void startGlobalSelection(ChatItem *item, const QPointF &itemPos);
 141   void clearGlobalSelection();
 142   void clearSelection();
 143   void selectionToClipboard(QClipboard::Mode = QClipboard::Clipboard);
 144   void stringToClipboard(const QString &str, QClipboard::Mode = QClipboard::Clipboard);
 145
 146   void requestBacklog();
 147
 148 #ifdef HAVE_WEBKIT
 149   void loadWebPreview(ChatItem *parentItem, const QUrl &url, const QRectF &urlRect);
 150   void clearWebPreview(ChatItem *parentItem = 0);
 151 #endif
 152
 153 signals:
 154   void lastLineChanged(QGraphicsItem *item, qreal offset);
 155   void layoutChanged(); // indicates changes to the scenerect due to resizing of the contentsitems
 156   void mouseMoveWhileSelecting(const QPointF &scenePos);
 157
 158 protected:
 159   virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *contextMenuEvent);
 160   virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *mouseEvent);
 161   virtual void mousePressEvent(QGraphicsSceneMouseEvent *mouseEvent);
 162   virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *mouseEvent);
 163   virtual void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *mouseEvent);
 164   virtual void handleClick(Qt::MouseButton button, const QPointF &scenePos);
 165
 166 protected slots:
 167   void rowsInserted(const QModelIndex &, int, int);
 168   void rowsAboutToBeRemoved(const QModelIndex &, int, int);
 169   void dataChanged(const QModelIndex &, const QModelIndex &);
 170
 171 private slots:
 172   void firstHandlePositionChanged(qreal xpos);
 173   void secondHandlePositionChanged(qreal xpos);
 174 #ifdef HAVE_WEBKIT
 175   void webPreviewNextStep();
 176 #endif
 177   void showWebPreviewChanged();
 178
 179   void rowsRemoved();
 180
 181   void clickTimeout();
 182
 183 private:
 184   void setHandleXLimits();
 185   void updateSelection(const QPointF &pos);
 186
 187   ChatView *_chatView;
 188   QString _idString;
 189   QAbstractItemModel *_model;
 190   QList<ChatLine *> _lines;
 191   BufferId _singleBufferId;
 192
 193   // calls to QChatScene::sceneRect() are very expensive. As we manage the scenerect ourselves
 194   // we store the size in a member variable.
 195   QRectF _sceneRect;
 196   int _firstLineRow; // the first row to display (aka: not a daychange msg)
 197   void updateSceneRect(qreal width);
 198   inline void updateSceneRect() { updateSceneRect(_sceneRect.width()); }
 199   void updateSceneRect(const QRectF &rect);
 200   qreal _viewportHeight;
 201
 202   MarkerLineItem *_markerLine;
 203   bool _markerLineVisible, _markerLineValid, _markerLineJumpPending;
 204
 205   ColumnHandleItem *_firstColHandle, *_secondColHandle;
 206   qreal _firstColHandlePos, _secondColHandlePos;
 207   CutoffMode _cutoffMode;
 208
 209   ChatItem *_selectingItem;
 210   int _selectionStartCol, _selectionMinCol;
 211   int _selectionStart;
 212   int _selectionEnd;
 213   int _firstSelectionRow;
 214   bool _isSelecting;
 215
 216   QTimer _clickTimer;
 217   ClickMode _clickMode;
 218   QPointF _clickPos;
 219   bool _clickHandled;
 220   bool _leftButtonPressed;
 221
 222   bool _showWebPreview;
 223
 224 #ifdef HAVE_WEBKIT
 225   struct WebPreview {
 226     enum PreviewState {
 227       NoPreview,
 228       NewPreview,
 229       DelayPreview,
 230       ShowPreview,
 231       HidePreview
 232     };
 233     ChatItem *parentItem;
 234     QGraphicsItem *previewItem;
 235     QUrl url;
 236     QRectF urlRect;
 237     PreviewState previewState;
 238     QTimer timer;
 239     WebPreview() : parentItem(0), previewItem(0), previewState(NoPreview) {}
 240   };
 241   WebPreview webPreview;
 242 #endif // HAVE_WEBKIT
 243 };
 244
 245 #endif