Source code for qpageview.scrollarea

# -*- coding: utf-8 -*-
# This file is part of the qpageview package.
# Copyright (c) 2016 - 2019 by Wilbert Berendsen
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
# See for more information.

ScrollArea, that supports kinetic scrolling and other features.

import math

from PyQt5.QtCore import QPoint, QRect, QSize, Qt
from PyQt5.QtWidgets import QAbstractScrollArea

from . import util

[docs]class ScrollArea(QAbstractScrollArea): """A scroll area that supports kinetic scrolling and other features.""" #: how to align the scrolled area if smaller than the viewport (Qt.AlignCenter) alignment = Qt.AlignCenter #: how many scroll updates to draw per second (50, 50 is recommended). scrollupdatespersec = 50 #: whether the mouse wheel and PgUp/PgDn keys etc use kinetic scrolling (True) kineticScrollingEnabled = True #: If enabled, the user can drag the contents of the scrollarea to #: move it with the mouse. draggingEnabled = True def __init__(self, parent=None, **kwds): super().__init__(parent, **kwds) self._areaSize = 0, 0 self._dragPos = None self._dragSpeed = None self._dragTime = None self._scroller = None self._scrollTimer = None
[docs] def setAreaSize(self, size): """Updates the scrollbars to be able to display an area of this size.""" self._areaSize = (size.width(), size.height()) self._updateScrollBars()
[docs] def areaSize(self): """Return the size of the area as set by setAreaSize().""" return QSize(*self._areaSize)
[docs] def areaPos(self): """Return the position of the area relative to the viewport. The alignment attribute is taken into account when the area is smaller than the viewport (horizontally and/or vertically). """ w, h = self._areaSize vw = self.viewport().width() vh = self.viewport().height() left, top = util.align(w, h, vw, vh, self.alignment) if left < 0: left = -self.horizontalScrollBar().value() if top < 0: top = -self.verticalScrollBar().value() return QPoint(left, top)
[docs] def visibleArea(self): """Return a rectangle describing the part of the area that is visible.""" pos = self.areaPos() r = self.viewport().rect() & QRect(pos, self.areaSize()) return r.translated(-pos)
[docs] def offsetToEnsureVisible(self, rect): """Return an offset QPoint with the minimal scroll to make rect visible. If the rect is too large, it is positioned top-left. """ area = self.visibleArea() # vertical dy = 0 if rect.bottom() > area.bottom(): dy = rect.bottom() - area.bottom() if < + dy: dy = - # horizontal dx = 0 if rect.right() > area.right(): dx = rect.right() - area.right() if rect.left() < area.left() + dx: dx = rect.left() - area.left() return QPoint(dx, dy)
[docs] def ensureVisible(self, rect, margins=None, allowKinetic=True): """Performs the minimal scroll to make rect visible. If the rect is not completely visible it is scrolled into view, adding the margins if given (a QMargins instance). If allowKinetic is False, immediately jumps to the position, otherwise scrolls smoothly (if kinetic scrolling is enabled). """ if rect not in self.visibleArea(): if margins is not None: rect = rect + margins diff = self.offsetToEnsureVisible(rect) if allowKinetic and self.kineticScrollingEnabled: self.kineticScrollBy(diff) else: self.scrollBy(diff)
def _updateScrollBars(self): """Internal. Adjust the range of the scrollbars to the area size. Called in setAreaSize() and resizeEvent(). """ w, h = self._areaSize maxsize = self.maximumViewportSize() vbar = self.verticalScrollBar() hbar = self.horizontalScrollBar() if w <= maxsize.width() and h <= maxsize.height(): vbar.setRange(0, 0) hbar.setRange(0, 0) else: viewport = self.viewport() vbar.setRange(0, h - viewport.height()) vbar.setPageStep(int(viewport.height() * .9)) hbar.setRange(0, w - viewport.width()) hbar.setPageStep(int(viewport.width() * .9))
[docs] def scrollOffset(self): """Return the current scroll offset.""" x = self.horizontalScrollBar().value() y = self.verticalScrollBar().value() return QPoint(x, y)
[docs] def canScrollBy(self, diff): """Does not scroll, but return the actual distance the View would scroll. diff is a QPoint instance. """ hbar = self.horizontalScrollBar() vbar = self.verticalScrollBar() x = min(max(0, hbar.value() + diff.x()), hbar.maximum()) y = min(max(0, vbar.value() + diff.y()), vbar.maximum()) return QPoint(x - hbar.value(), y - vbar.value())
[docs] def scrollForDragging(self, pos): """Slowly scroll the View if pos is close to the edge of the viewport. Can be used while dragging things. """ viewport = self.viewport().rect() dx = pos.x() - viewport.left() - 12 if dx >= 0: dx = max(0, pos.x() - viewport.right() + 12) dy = pos.y() - - 12 if dy >= 0: dy = max(0, pos.y() - viewport.bottom() + 12) self.steadyScroll(QPoint(dx*10, dy*10))
[docs] def scrollTo(self, pos): """Scroll the View to get pos (QPoint) in the top left corner (if possible). Returns the actual distance moved. """ return self.scrollBy(pos - self.scrollOffset())
[docs] def scrollBy(self, diff): """Scroll the View diff pixels (QPoint) in x and y direction. Returns the actual distance moved. """ hbar = self.horizontalScrollBar() vbar = self.verticalScrollBar() x = hbar.value() hbar.setValue(hbar.value() + diff.x()) x = hbar.value() - x y = vbar.value() vbar.setValue(vbar.value() + diff.y()) y = vbar.value() - y return QPoint(x, y)
[docs] def kineticScrollTo(self, pos): """Scroll the View to get pos (QPoint) in the top left corner (if possible). Returns the actual distance the scroll area will move. """ return self.kineticScrollBy(pos - self.scrollOffset())
[docs] def kineticScrollBy(self, diff): """Scroll the View diff pixels (QPoint) in x and y direction. Returns the actual distance the scroll area will move. """ ret = self.canScrollBy(diff) if diff: scroller = KineticScroller() scroller.scrollBy(diff) self.startScrolling(scroller) return ret
[docs] def kineticAddDelta(self, diff): """Add diff (QPoint) to an existing kinetic scroll. If no scroll is active, a new one is started (like kineticScrollBy). """ if isinstance(self._scroller, KineticScroller): self._scroller.scrollBy(self._scroller.remainingDistance() + diff) else: self.kineticScrollBy(diff)
[docs] def steadyScroll(self, diff): """Start steadily scrolling diff (QPoint) pixels per second. Stops automatically when the end is reached. """ if diff: self.startScrolling(SteadyScroller(diff, self.scrollupdatespersec)) else: self.stopScrolling()
[docs] def startScrolling(self, scroller): """Begin a scrolling operation using the specified scroller.""" self._scroller = scroller if self._scrollTimer is None: self._scrollTimer = self.startTimer(1000 // self.scrollupdatespersec)
[docs] def stopScrolling(self): """Stop scrolling.""" if self._scroller: self.killTimer(self._scrollTimer) self._scroller = None self._scrollTimer = None
[docs] def isScrolling(self): """Return True if a scrolling movement is active.""" return self._scroller is not None
[docs] def remainingScrollTime(self): """If a kinetic scroll is active, return how many msecs the scroll wil last. Otherwise, return 0. """ if isinstance(self._scroller, KineticScroller): return 1000 // self.scrollupdatespersec * self._scroller.remainingTicks() return 0
[docs] def isDragging(self): """Return True if the user is dragging the background.""" return self._dragPos is not None
[docs] def timerEvent(self, ev): """Implemented to handle the scroll timer.""" if ev.timerId() == self._scrollTimer: diff = self._scroller.step() # when scrolling slowly, it might be that no redraw is needed if diff: # change the scrollbars, but check how far they really moved. if not self.scrollBy(diff) or self._scroller.finished(): self.stopScrolling()
[docs] def resizeEvent(self, ev): """Implemented to update the scrollbars to the aera size.""" self._updateScrollBars()
[docs] def mousePressEvent(self, ev): """Implemented to handle dragging the document with the left button.""" self.stopScrolling() super().mousePressEvent(ev)
[docs] def mouseMoveEvent(self, ev): """Implemented to handle dragging the document with the left button.""" if self.draggingEnabled and ev.buttons() & Qt.LeftButton: if self._dragPos is None: self.setCursor(Qt.SizeAllCursor) else: diff = self._dragPos - ev.pos() self._dragSpeed = (ev.timestamp() - self._dragTime, diff) self.scrollBy(diff) self._dragPos = ev.pos() self._dragTime = ev.timestamp() super().mouseMoveEvent(ev)
[docs] def mouseReleaseEvent(self, ev): """Implemented to handle dragging the document with the left button.""" if self.draggingEnabled and ev.button() == Qt.LeftButton and self._dragPos is not None: self.unsetCursor() if self.kineticScrollingEnabled and self._dragSpeed is not None: # compute speed of last movement time, speed = self._dragSpeed time += ev.timestamp() - self._dragTime # add time between last mvt and release speed = speed * 1000 / self.scrollupdatespersec / time # compute diff to scroll sx = abs(speed.x()) diffx = int(sx * (sx + 1) / 2) sy = abs(speed.y()) diffy = int(sy * (sy + 1) / 2) if speed.x() < 0: diffx = -diffx if speed.y() < 0: diffy = -diffy self.kineticScrollBy(QPoint(diffx, diffy)) self._dragPos = None self._dragTime = None self._dragSpeed = None super().mouseReleaseEvent(ev)
[docs] def wheelEvent(self, ev): """Reimplemented to use kinetic mouse wheel scrolling if enabled.""" if self.kineticScrollingEnabled: self.kineticAddDelta(-ev.angleDelta()) else: super().wheelEvent(ev)
[docs] def keyPressEvent(self, ev): """Reimplemented to use kinetic cursor movements.""" hbar = self.horizontalScrollBar() vbar = self.verticalScrollBar() # add Home and End, even in non-kinetic mode scroll = self.kineticScrollBy if self.kineticScrollingEnabled else self.scrollBy if ev.key() == Qt.Key_Home: scroll(QPoint(0, -vbar.value())) elif ev.key() == Qt.Key_End: scroll(QPoint(0, vbar.maximum() - vbar.value())) elif self.kineticScrollingEnabled: # make arrow keys and PgUp and PgDn kinetic if ev.key() == Qt.Key_PageDown: self.kineticAddDelta(QPoint(0, vbar.pageStep())) elif ev.key() == Qt.Key_PageUp: self.kineticAddDelta(QPoint(0, -vbar.pageStep())) elif ev.key() == Qt.Key_Down: self.kineticAddDelta(QPoint(0, vbar.singleStep())) elif ev.key() == Qt.Key_Up: self.kineticAddDelta(QPoint(0, -vbar.singleStep())) elif ev.key() == Qt.Key_Left: self.kineticAddDelta(QPoint(-hbar.singleStep(), 0)) elif ev.key() == Qt.Key_Right: self.kineticAddDelta(QPoint(hbar.singleStep(), 0)) else: super().keyPressEvent(ev) else: super().keyPressEvent(ev)
[docs]class Scroller: """Abstract base class, encapsulates scrolling behaviour. A Scroller subclass must implement the step() and finished() methods and may define additional methods. """
[docs] def step(self): """Implement this method to return a QPoint for the current scrolling step."""
[docs] def finished(self): """Implement this method to return True if scrolling is finished."""
[docs]class SteadyScroller(Scroller): """Scrolls the area steadily n pixels per second.""" def __init__(self, speed, updates_per_second): """Initializes with speed (QPoint) pixels per second.""" self._x = speed.x() self._y = speed.y() self._restx = 0 self._resty = 0 self._ups = updates_per_second
[docs] def step(self): """Return a QPoint indicating the diff to scroll in this step. If this is a QPoint(0, 0) it does not indicate that scrolling has finished. Use finished() for that. """ # the amount of pixels to scroll per second x = self._x y = self._y # how many updates per second, compute the number of pixes to scroll now ups = self._ups dx, rx = divmod(abs(x), ups) dy, ry = divmod(abs(y), ups) dx1, self._restx = divmod(self._restx + rx, ups) dy1, self._resty = divmod(self._resty + ry, ups) dx += dx1 dy += dy1 # scroll in the right direction diff = QPoint(-dx if x < 0 else dx, -dy if y < 0 else dy) return diff
[docs] def finished(self): """As this scroller has a constant speed, it never stops.""" return False
[docs]class KineticScroller(Scroller): """Scrolls the area with a decreasing speed.""" def __init__(self): self._x = 0 self._y = 0 self._offset = None
[docs] def scrollBy(self, diff): """Start a new kinetic scroll of the specified amount.""" ### logic by Richard Cognot, May 2012, simplified by WB dx = diff.x() dy = diff.y() # solve speed*(speed+1)/2 = delta to ensure 1+2+3+...+speed is as close as possible under delta.. sx = int(math.sqrt(1 + 8 * abs(dx)) - 1) // 2 sy = int(math.sqrt(1 + 8 * abs(dy)) - 1) // 2 # compute the amount of displacement still needed because we're dealing with integer values. # Since this function is called for exact moves (not free scrolling) # limit the kinetic time to 2 seconds, which means 100 ticks, 5050 pixels. # (TODO: adapt for other ticker speeds? WB) if sy > 100: sy = 100 offy = abs(dy) - sy * (sy + 1) // 2 # Although it is less likely to go beyond that limit for horizontal scrolling, # do it for x as well. if sx > 100: sx = 100 offx = abs(dx) - sx * (sx + 1) // 2 # adjust directions if dx < 0: sx = -sx offx = -offx if dy < 0: sy = -sy offy = -offy self._x = sx self._y = sy # the offset is accounted for in the first step self._offset = QPoint(offx, offy)
[docs] def remainingDistance(self): """Return the remaining distance.""" sx = abs(self._x) dx = sx * (sx + 1) // 2 if self._x < 0: dx = -dx sy = abs(self._y) dy = sy * (sy + 1) // 2 if self._y < 0: dy = -dy return QPoint(dx, dy)
[docs] def remainingTicks(self): """Return the remaining ticks of this scroll.""" return max(abs(self._x), abs(self._y))
[docs] def step(self): """Return a QPoint indicating the diff to scroll in this step.""" ret = QPoint(self._x, self._y) if self._offset: ret += self._offset self._offset = None if self._x > 0: self._x -= 1 elif self._x < 0: self._x += 1 if self._y > 0: self._y -= 1 elif self._y < 0: self._y += 1 return ret
[docs] def finished(self): """Return True if scrolling is done.""" return self._x == 0 and self._y == 0