1 /***************************************************************************
2 * Copyright (C) 2005-2020 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
25 #include <QGraphicsTextItem>
30 #include "bufferwidget.h"
32 #include "chatscene.h"
34 #include "clientignorelistmanager.h"
35 #include "messagefilter.h"
37 #include "qtuistyle.h"
40 ChatView::ChatView(BufferId bufferId, QWidget* parent)
41 : QGraphicsView(parent)
44 QList<BufferId> filterList;
45 filterList.append(bufferId);
46 auto* filter = new MessageFilter(Client::messageModel(), filterList, this);
50 ChatView::ChatView(MessageFilter* filter, QWidget* parent)
51 : QGraphicsView(parent)
57 void ChatView::init(MessageFilter* filter)
59 _bufferContainer = nullptr;
60 _currentScaleFactor = 1;
61 _invalidateFilter = false;
63 setAttribute(Qt::WA_AcceptTouchEvents);
64 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
65 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
66 setAlignment(Qt::AlignLeft | Qt::AlignBottom);
68 // setOptimizationFlags(QGraphicsView::DontClipPainter | QGraphicsView::DontAdjustForAntialiasing);
69 // setOptimizationFlags(QGraphicsView::DontAdjustForAntialiasing);
70 setViewportUpdateMode(QGraphicsView::BoundingRectViewportUpdate);
71 // setTransformationAnchor(QGraphicsView::NoAnchor);
72 setTransformationAnchor(QGraphicsView::AnchorViewCenter);
74 _scrollTimer.setInterval(100);
75 _scrollTimer.setSingleShot(true);
76 connect(&_scrollTimer, &QTimer::timeout, this, &ChatView::scrollTimerTimeout);
78 _scene = new ChatScene(filter, filter->idString(), viewport()->width(), this);
79 connect(_scene, &QGraphicsScene::sceneRectChanged, this, &ChatView::adjustSceneRect);
80 connect(_scene, &ChatScene::lastLineChanged, this, &ChatView::lastLineChanged);
81 connect(_scene, &ChatScene::mouseMoveWhileSelecting, this, &ChatView::mouseMoveWhileSelecting);
84 connect(verticalScrollBar(), &QAbstractSlider::valueChanged, this, &ChatView::verticalScrollbarChanged);
85 _lastScrollbarPos = verticalScrollBar()->maximum();
87 connect(Client::networkModel(), &NetworkModel::markerLineSet, this, &ChatView::markerLineSet);
89 // only connect if client is synched with a core
90 if (Client::isConnected())
91 connect(Client::ignoreListManager(), &ClientIgnoreListManager::ignoreListChanged, this, &ChatView::invalidateFilter);
94 bool ChatView::event(QEvent* event)
96 if (event->type() == QEvent::KeyPress) {
97 auto* keyEvent = static_cast<QKeyEvent*>(event);
98 switch (keyEvent->key()) {
102 case Qt::Key_PageDown:
103 if (requestBacklogForScroll()) {
111 if (event->type() == QEvent::TouchBegin && ((QTouchEvent*)event)->device()->type() == QTouchDevice::TouchScreen) {
112 // Enable scrolling by draging, disable selecting/clicking content
113 setDragMode(QGraphicsView::ScrollHandDrag);
114 setInteractive(false);
115 // if scrollbar is not visible we need to request backlog below else we need to accept
116 // the event now (return true) so that we will receive TouchUpdate and TouchEnd/TouchCancel
117 if (verticalScrollBar()->isVisible())
121 if (event->type() == QEvent::TouchEnd || event->type() == QEvent::TouchCancel) {
122 // End scroll and reset settings to default
123 setDragMode(QGraphicsView::NoDrag);
124 setInteractive(true);
125 _firstTouchUpdateHappened = false;
129 if (event->type() == QEvent::TouchUpdate) {
130 if (!_firstTouchUpdateHappened) {
131 // After the first movement of a Touch-Point, calculate the distance in both axis
132 // and if the point moved more horizontally abort scroll.
133 QTouchEvent::TouchPoint p = ((QTouchEvent*)event)->touchPoints().at(0);
134 double dx = qAbs(p.lastPos().x() - p.pos().x());
135 double dy = qAbs(p.lastPos().y() - p.pos().y());
137 setDragMode(QGraphicsView::NoDrag);
138 setInteractive(true);
140 _firstTouchUpdateHappened = true;
142 // Applying the movement happens automatically by the drag-mode
144 if (event->type() == QEvent::Wheel
145 || (event->type() == QEvent::TouchBegin && ((QTouchEvent*)event)->device()->type() == QTouchDevice::TouchScreen)
146 || event->type() == QEvent::TouchUpdate) {
147 if (requestBacklogForScroll()) {
152 if (event->type() == QEvent::Show) {
153 if (_invalidateFilter)
157 return QGraphicsView::event(event);
160 void ChatView::resizeEvent(QResizeEvent* event)
162 // if view is currently scrolled to bottom, we want it that way after resizing
163 bool atBottom = (_lastScrollbarPos == verticalScrollBar()->maximum());
165 QGraphicsView::resizeEvent(event);
167 // if scrolling to bottom, do it immediately.
169 // we can reduce viewport updates if we scroll to the bottom allready at the beginning
170 verticalScrollBar()->setValue(verticalScrollBar()->maximum());
173 scene()->updateForViewport(viewport()->width(), viewport()->height());
177 _lastScrollbarPos = verticalScrollBar()->maximum();
178 verticalScrollBar()->setValue(verticalScrollBar()->maximum());
180 checkChatLineCaches();
183 void ChatView::adjustSceneRect()
185 // Workaround for QTBUG-6322
186 // If the viewport's sceneRect() is (almost) as wide as as the viewport itself,
187 // Qt wants to reserve space for scrollbars even if they're turned off, resulting in
188 // an ugly white space at the bottom of the ChatView.
189 // Since the view's scene's width actually doesn't matter at all, we just adjust it
190 // by some hopefully large enough value to avoid this problem.
192 setSceneRect(scene()->sceneRect().adjusted(0, 0, -25, 0));
195 void ChatView::mouseMoveWhileSelecting(const QPointF& scenePos)
197 int y = (int)mapFromScene(scenePos).y();
201 else if (y > height())
202 _scrollOffset = y - height();
204 if (_scrollOffset && !_scrollTimer.isActive())
205 _scrollTimer.start();
208 void ChatView::scrollTimerTimeout()
211 QAbstractSlider* vbar = verticalScrollBar();
212 if (_scrollOffset < 0 && vbar->value() > 0)
213 vbar->setValue(qMax(vbar->value() + _scrollOffset, 0));
214 else if (_scrollOffset > 0 && vbar->value() < vbar->maximum())
215 vbar->setValue(qMin(vbar->value() + _scrollOffset, vbar->maximum()));
218 void ChatView::lastLineChanged(QGraphicsItem* chatLine, qreal offset)
221 // disabled until further testing/discussion
222 // if(!scene()->isScrollingAllowed())
225 QAbstractSlider* vbar = verticalScrollBar();
227 if (vbar->maximum() - vbar->value() <= (offset + 5) * _currentScaleFactor) { // 5px grace area
228 vbar->setValue(vbar->maximum());
232 void ChatView::verticalScrollbarChanged(int newPos)
234 QAbstractSlider* vbar = verticalScrollBar();
237 // check for backlog request
238 if (newPos < _lastScrollbarPos) {
239 int relativePos = 100;
240 if (vbar->maximum() - vbar->minimum() != 0)
241 relativePos = (newPos - vbar->minimum()) * 100 / (vbar->maximum() - vbar->minimum());
243 if (relativePos < 20) {
244 scene()->requestBacklog();
247 _lastScrollbarPos = newPos;
249 // FIXME: Fugly workaround for the ChatView scrolling up 1px on buffer switch
250 if (vbar->maximum() - newPos <= 2)
251 vbar->setValue(vbar->maximum());
254 MsgId ChatView::lastMsgId() const
259 QAbstractItemModel* model = scene()->model();
260 if (!model || model->rowCount() == 0)
263 return model->index(model->rowCount() - 1, 0).data(MessageModel::MsgIdRole).value<MsgId>();
266 MsgId ChatView::lastVisibleMsgId() const
268 ChatLine* line = lastVisibleChatLine();
271 return line->msgId();
276 bool chatLinePtrLessThan(ChatLine* one, ChatLine* other)
278 return one->row() < other->row();
281 // TODO: figure out if it's cheaper to use a cached list (that we'd need to keep updated)
282 QSet<ChatLine*> ChatView::visibleChatLines(Qt::ItemSelectionMode mode) const
284 QSet<ChatLine*> result;
285 foreach (QGraphicsItem* item, items(viewport()->rect().adjusted(-1, -1, 1, 1), mode)) {
286 auto* line = qgraphicsitem_cast<ChatLine*>(item);
293 QList<ChatLine*> ChatView::visibleChatLinesSorted(Qt::ItemSelectionMode mode) const
295 QList<ChatLine*> result = visibleChatLines(mode).values();
296 std::sort(result.begin(), result.end(), chatLinePtrLessThan);
300 ChatLine* ChatView::lastVisibleChatLine(bool ignoreDayChange) const
305 QAbstractItemModel* model = scene()->model();
306 if (!model || model->rowCount() == 0)
311 QSet<ChatLine*> visibleLines = visibleChatLines(Qt::ContainsItemBoundingRect);
312 foreach (ChatLine* line, visibleLines) {
313 if (line->row() > row && (ignoreDayChange ? line->msgType() != Message::DayChange : true))
318 return scene()->chatLine(row);
323 void ChatView::setMarkerLineVisible(bool visible)
325 scene()->setMarkerLineVisible(visible);
328 void ChatView::setMarkerLine(MsgId msgId)
330 if (!scene()->isSingleBufferScene())
333 BufferId bufId = scene()->singleBufferId();
334 Client::setMarkerLine(bufId, msgId);
337 void ChatView::markerLineSet(BufferId buffer, MsgId msgId)
339 if (!scene()->isSingleBufferScene() || scene()->singleBufferId() != buffer)
342 scene()->setMarkerLine(msgId);
343 scene()->setMarkerLineVisible(true);
346 void ChatView::jumpToMarkerLine(bool requestBacklog)
348 scene()->jumpToMarkerLine(requestBacklog);
351 void ChatView::addActionsToMenu(QMenu* menu, const QPointF& pos)
354 auto* bw = qobject_cast<BufferWidget*>(bufferContainer());
356 bw->addActionsToMenu(menu, pos);
357 menu->addSeparator();
361 void ChatView::zoomIn()
363 _currentScaleFactor *= 1.2;
365 scene()->setWidth(viewport()->width() / _currentScaleFactor - 2);
368 void ChatView::zoomOut()
370 _currentScaleFactor /= 1.2;
371 scale(1 / 1.2, 1 / 1.2);
372 scene()->setWidth(viewport()->width() / _currentScaleFactor - 2);
375 void ChatView::zoomOriginal()
377 scale(1 / _currentScaleFactor, 1 / _currentScaleFactor);
378 _currentScaleFactor = 1;
379 scene()->setWidth(viewport()->width() - 2);
382 void ChatView::invalidateFilter()
384 // if this is the currently selected chatview
385 // invalidate immediately
387 _scene->filter()->invalidateFilter();
388 _invalidateFilter = false;
390 // otherwise invalidate whenever the view is shown
392 _invalidateFilter = true;
396 void ChatView::scrollContentsBy(int dx, int dy)
398 QGraphicsView::scrollContentsBy(dx, dy);
399 checkChatLineCaches();
402 void ChatView::setHasCache(ChatLine* line, bool hasCache)
405 _linesWithCache.insert(line);
407 _linesWithCache.remove(line);
410 bool ChatView::requestBacklogForScroll()
412 if (!verticalScrollBar()->isVisible()) {
413 // Not able to scroll, fetch backlog
415 // Future improvement: continue fetching backlog in chunks until the scrollbar is visible,
416 // or the beginning of the buffer has been reached.
417 scene()->requestBacklog();
418 // Backlog has been requested
422 // Scrollbar already visible, no backlog requested
427 void ChatView::checkChatLineCaches()
429 qreal top = mapToScene(viewport()->rect().topLeft()).y() - 10; // some grace area to avoid premature cleaning
430 qreal bottom = mapToScene(viewport()->rect().bottomRight()).y() + 10;
431 QSet<ChatLine*>::iterator iter = _linesWithCache.begin();
432 while (iter != _linesWithCache.end()) {
433 ChatLine* line = *iter;
434 if (line->pos().y() + line->height() < top || line->pos().y() > bottom) {
436 iter = _linesWithCache.erase(iter);