src/qtui/chatview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 CHATVIEW_H_
  22 #define CHATVIEW_H_
  23
  24 #include <QGraphicsView>
  25 #include <QTimer>
  26
  27 #include "abstractbuffercontainer.h"
  28
  29 class AbstractBufferContainer;
  30 class AbstractUiMsg;
  31 class Buffer;
  32 class ChatLine;
  33 class ChatScene;
  34 class MessageFilter;
  35 class QMenu;
  36
  37 class ChatView : public QGraphicsView, public AbstractChatView {
  38   Q_OBJECT
  39
  40 public:
  41   ChatView(MessageFilter *, QWidget *parent = 0);
  42   ChatView(BufferId bufferId, QWidget *parent = 0);
  43
  44   virtual MsgId lastMsgId() const;
  45   virtual MsgId lastVisibleMsgId() const;
  46   inline AbstractBufferContainer *bufferContainer() const { return _bufferContainer; }
  47   inline void setBufferContainer(AbstractBufferContainer *c) { _bufferContainer = c; }
  48
  49   inline ChatScene *scene() const { return _scene; }
  50
  51   //! Return a set of ChatLines currently visible in the view
  52   /** \param mode How partially visible ChatLines are handled
  53    *  \return A set of visible ChatLines
  54    */
  55   QSet<ChatLine *> visibleChatLines(Qt::ItemSelectionMode mode = Qt::ContainsItemBoundingRect) const;
  56
  57   //! Return a sorted list of ChatLines currently visible in the view
  58   /** \param mode How partially visible ChatLines are handled
  59    *  \return A list of visible ChatLines sorted by row
  60    *  \note If the order of ChatLines does not matter, use visibleChatLines() instead
  61    */
  62   QList<ChatLine *> visibleChatLinesSorted(Qt::ItemSelectionMode mode = Qt::ContainsItemBoundingRect) const;
  63
  64   //! Return the last fully visible ChatLine in this view
  65   /** Using this method more efficient than calling visibleChatLinesSorted() and taking its last element.
  66    *  \return The last fully visible ChatLine in the view
  67    */
  68   ChatLine *lastVisibleChatLine() const;
  69
  70   virtual void addActionsToMenu(QMenu *, const QPointF &pos);
  71
  72   inline bool isMarkerLineVisible() const { return _markerLineVisible; }
  73   inline ChatLine *markedLine() const { return _markedLine; }
  74
  75   //! Tell the view that this ChatLine has cached data
  76   /** ChatLines cache some layout data that should be cleared as soon as it's no
  77    *  longer visible. A ChatLine caching data registers itself with this method to
  78    *  tell the view about it. The view will call ChatLine::clearCache() when
  79    *  appropriate.
  80    *  \param line The ChatLine having cached data
  81    */
  82   void setHasCache(ChatLine *line, bool hasCache = true);
  83
  84 public slots:
  85   inline virtual void clear() {}
  86   void zoomIn();
  87   void zoomOut();
  88   void zoomOriginal();
  89
  90   void setMarkerLineVisible(bool visible = true);
  91   void setMarkedLine(ChatLine *line);
  92
  93 protected:
  94   virtual bool event(QEvent *event);
  95   virtual void resizeEvent(QResizeEvent *event);
  96   virtual void scrollContentsBy(int dx, int dy);
  97
  98 protected slots:
  99   virtual void verticalScrollbarChanged(int);
 100
 101 private slots:
 102   void lastLineChanged(QGraphicsItem *chatLine, qreal offset);
 103   void adjustSceneRect();
 104   void checkChatLineCaches();
 105   void mouseMoveWhileSelecting(const QPointF &scenePos);
 106   void scrollTimerTimeout();
 107   void invalidateFilter();
 108   void markerLineSet(BufferId buffer, MsgId msg);
 109
 110 private:
 111   void init(MessageFilter *filter);
 112
 113   AbstractBufferContainer *_bufferContainer;
 114   ChatScene *_scene;
 115   int _lastScrollbarPos;
 116   qreal _currentScaleFactor;
 117   QTimer _scrollTimer;
 118   int _scrollOffset;
 119   bool _invalidateFilter;
 120   bool _markerLineVisible;
 121   ChatLine *_markedLine;
 122   QSet<ChatLine *> _linesWithCache;
 123 };
 124
 125
 126 #endif