QScrollEvent Class

The QScrollEvent class is sent when scrolling. More...

Header: #include <QScrollEvent>
qmake: QT += gui
Since: Qt 4.8
Inherits: QEvent

Public Types

enum ScrollState { ScrollStarted, ScrollUpdated, ScrollFinished }

Public Functions

QScrollEvent(const QPointF &contentPos, const QPointF &overshootDistance, QScrollEvent::ScrollState scrollState)
virtual ~QScrollEvent()
QPointF contentPos() const
QPointF overshootDistance() const
QScrollEvent::ScrollState scrollState() const
  • 7 public functions inherited from QEvent

Additional Inherited Members

  • 1 property inherited from QEvent
  • 1 public variable inherited from QEvent
  • 1 static public member inherited from QEvent
  • 2 protected variables inherited from QEvent

Detailed Description

The QScrollEvent class is sent when scrolling.

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 QScroller::scrollTo is save however.

See also QScrollPrepareEvent and QScroller.

Member Type Documentation

enum QScrollEvent::ScrollState

This enum describes the states a scroll event can have.

QScrollEvent::ScrollStarted0Set for the first scroll event of a scroll activity.
QScrollEvent::ScrollUpdated1Set for all but the first and the last scroll event of a scroll activity.
QScrollEvent::ScrollFinished2Set for the last scroll event of a scroll activity.

See also QScrollEvent::scrollState().

Member Function Documentation

QScrollEvent::QScrollEvent(const QPointF &contentPos, const QPointF &overshootDistance, QScrollEvent::ScrollState scrollState)

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.

[virtual] QScrollEvent::~QScrollEvent()

Destroys QScrollEvent.

QPointF QScrollEvent::contentPos() const

Returns the new scroll position.

QPointF QScrollEvent::overshootDistance() const

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

See also QScroller.

QScrollEvent::ScrollState QScrollEvent::scrollState() const

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.

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.