Provide some new accessors for Chat{View|Scene}
[quassel.git] / 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   virtual bool event(QEvent *event);
73
74 public slots:
75   inline virtual void clear() {}
76   void zoomIn();
77   void zoomOut();
78   void zoomOriginal();
79
80 protected:
81   virtual void resizeEvent(QResizeEvent *event);
82
83 protected slots:
84   virtual void verticalScrollbarChanged(int);
85
86 private slots:
87   void lastLineChanged(QGraphicsItem *chatLine, qreal offset);
88   void adjustSceneRect();
89   void mouseMoveWhileSelecting(const QPointF &scenePos);
90   void scrollTimerTimeout();
91   void invalidateFilter();
92
93 private:
94   void init(MessageFilter *filter);
95
96   AbstractBufferContainer *_bufferContainer;
97   ChatScene *_scene;
98   int _lastScrollbarPos;
99   qreal _currentScaleFactor;
100   QTimer _scrollTimer;
101   int _scrollOffset;
102   bool _invalidateFilter;
103 };
104
105
106 #endif