Sanitize topic message
[quassel.git] / src / qtui / chatview.h
index 100b311..7869ab2 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2013 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #ifndef CHATVIEW_H_
 #define CHATVIEW_H_
 
 #include <QGraphicsView>
+#include <QTimer>
 
 #include "abstractbuffercontainer.h"
 
+class AbstractBufferContainer;
 class AbstractUiMsg;
 class Buffer;
 class ChatLine;
 class ChatScene;
+class MessageFilter;
+class QMenu;
+
+class ChatView : public QGraphicsView, public AbstractChatView
+{
+    Q_OBJECT
+
+public:
+    ChatView(MessageFilter *, QWidget *parent = 0);
+    ChatView(BufferId bufferId, QWidget *parent = 0);
+
+    virtual MsgId lastMsgId() const;
+    virtual MsgId lastVisibleMsgId() const;
+    inline AbstractBufferContainer *bufferContainer() const { return _bufferContainer; }
+    inline void setBufferContainer(AbstractBufferContainer *c) { _bufferContainer = c; }
+
+    inline ChatScene *scene() const { return _scene; }
+
+    //! Return a set of ChatLines currently visible in the view
+    /** \param mode How partially visible ChatLines are handled
+     *  \return A set of visible ChatLines
+     */
+    QSet<ChatLine *> visibleChatLines(Qt::ItemSelectionMode mode = Qt::ContainsItemBoundingRect) const;
+
+    //! Return a sorted list of ChatLines currently visible in the view
+    /** \param mode How partially visible ChatLines are handled
+     *  \return A list of visible ChatLines sorted by row
+     *  \note If the order of ChatLines does not matter, use visibleChatLines() instead
+     */
+    QList<ChatLine *> visibleChatLinesSorted(Qt::ItemSelectionMode mode = Qt::ContainsItemBoundingRect) const;
+
+    //! Return the last fully visible ChatLine in this view
+    /** Using this method more efficient than calling visibleChatLinesSorted() and taking its last element.
+     *  \return The last fully visible ChatLine in the view
+     */
+    ChatLine *lastVisibleChatLine(bool ignoreDayChange = false) const;
+
+    virtual void addActionsToMenu(QMenu *, const QPointF &pos);
+
+    //! Tell the view that this ChatLine has cached data
+    /** ChatLines cache some layout data that should be cleared as soon as it's no
+     *  longer visible. A ChatLine caching data registers itself with this method to
+     *  tell the view about it. The view will call ChatLine::clearCache() when
+     *  appropriate.
+     *  \param line The ChatLine having cached data
+     */
+    void setHasCache(ChatLine *line, bool hasCache = true);
+
+public slots:
+    inline virtual void clear() {}
+    void zoomIn();
+    void zoomOut();
+    void zoomOriginal();
+
+    void setMarkerLineVisible(bool visible = true);
+    void setMarkerLine(MsgId msgId);
+    void jumpToMarkerLine(bool requestBacklog);
+
+protected:
+    virtual bool event(QEvent *event);
+    virtual void resizeEvent(QResizeEvent *event);
+    virtual void scrollContentsBy(int dx, int dy);
 
-class ChatView : public QGraphicsView, public AbstractChatView {
-  Q_OBJECT
-
-  public:
-    ChatView(Buffer *, QWidget *parent = 0);
-    ~ChatView();
-
-    ChatScene *scene() const;
-
-  public slots:
-
-    void clear();
-
-    void prependMsg(AbstractUiMsg *);
-    void appendMsg(AbstractUiMsg *);
-
-    void prependChatLine(ChatLine *);
-    void appendChatLine(ChatLine *);
-    void prependChatLines(QList<ChatLine *>);
-    void appendChatLines(QList<ChatLine *>);
+protected slots:
+    virtual void verticalScrollbarChanged(int);
 
-    void setContents(const QList<AbstractUiMsg *> &);
+private slots:
+    void lastLineChanged(QGraphicsItem *chatLine, qreal offset);
+    void adjustSceneRect();
+    void checkChatLineCaches();
+    void mouseMoveWhileSelecting(const QPointF &scenePos);
+    void scrollTimerTimeout();
+    void invalidateFilter();
+    void markerLineSet(BufferId buffer, MsgId msg);
 
-  protected:
-    virtual void resizeEvent(QResizeEvent *event);
+private:
+    void init(MessageFilter *filter);
 
-  protected slots:
-    virtual void sceneHeightChanged(int height);
-
-  private:
+    AbstractBufferContainer *_bufferContainer;
     ChatScene *_scene;
+    int _lastScrollbarPos;
+    qreal _currentScaleFactor;
+    QTimer _scrollTimer;
+    int _scrollOffset;
+    bool _invalidateFilter;
+    QSet<ChatLine *> _linesWithCache;
 };
 
+
 #endif