QScrollEvent#

The QScrollEvent class is sent when scrolling. More…

Synopsis#

Functions#

def contentPos ()
def overshootDistance ()
def scrollState ()

Detailed Description#

The scroll event is sent to indicate that the receiver should be scrolled. Usually the receiver should be something visual like QWidget or QGraphicsObject .

Some care should be taken that no conflicting QScrollEvents are sent from two sources. Using scrollTo is save however.

See also

QScrollPrepareEvent QScroller

class PySide6.QtGui.QScrollEvent(contentPos, overshoot, scrollState)#

PySide6.QtGui.QScrollEvent(arg__1)

Parameters

contentPos – PySide6.QtCore.QPointF
arg__1 – PySide6.QtGui.QScrollEvent
scrollState – ScrollState
overshoot – PySide6.QtCore.QPointF

Creates a new QScrollEvent contentPos is the new content position, overshootDistance is the new overshoot distance while scrollState indicates if this scroll event is the first one, the last one or some event in between.

PySide6.QtGui.QScrollEvent.ScrollState#

This enum describes the states a scroll event can have.

Constant

Description

QScrollEvent.ScrollStarted

Set for the first scroll event of a scroll activity.

QScrollEvent.ScrollUpdated

Set for all but the first and the last scroll event of a scroll activity.

QScrollEvent.ScrollFinished

Set for the last scroll event of a scroll activity.

See also

scrollState()

Constant	Description
QScrollEvent.ScrollStarted	Set for the first scroll event of a scroll activity.
QScrollEvent.ScrollUpdated	Set for all but the first and the last scroll event of a scroll activity.
QScrollEvent.ScrollFinished	Set for the last scroll event of a scroll activity.

PySide6.QtGui.QScrollEvent.contentPos()#

Return type: PySide6.QtCore.QPointF

Returns the new scroll position.

PySide6.QtGui.QScrollEvent.overshootDistance()#

Return type: PySide6.QtCore.QPointF

Returns the new overshoot distance. See QScroller for an explanation of the term overshoot.

See also

QScroller

PySide6.QtGui.QScrollEvent.scrollState()#

Return type: ScrollState

Returns the current scroll state as a combination of ScrollStateFlag values. ScrollStarted (or ScrollFinished ) will be set, if this scroll event is the first (or last) event in a scrolling activity. Please note that both values can be set at the same time, if the activity consists of a single QScrollEvent . All other scroll events in between will have their state set to ScrollUpdated .

A widget could for example revert selections when scrolling is started and stopped.