- Qt 6.8
- Qt GUI
- C++ Classes
- QScrollPrepareEvent
- Qt 6.8.1 Reference Documentation

# QScrollPrepareEvent Class

The QScrollPrepareEvent class is sent in preparation of scrolling. More...

Header: | `#include <QScrollPrepareEvent>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Gui)` `target_link_libraries(mytarget PRIVATE Qt6::Gui)`
qmake: | `QT += gui`
Inherits: | QEvent

- List of all members, including inherited members
- QScrollPrepareEvent is part of Event Classes.

## Public Functions

| QScrollPrepareEvent(const QPointF &startPos)
QPointF | contentPos() const
QRectF | contentPosRange() const
void | setContentPos(const QPointF &pos)
void | setContentPosRange(const QRectF &rect)
void | setViewportSize(const QSizeF &size)
QPointF | startPos() const
QSizeF | viewportSize() const

## Detailed Description

The scroll prepare event is sent before scrolling (usually by QScroller) is started. The object receiving this event should set viewportSize, maxContentPos and contentPos. It also should accept this event to indicate that scrolling should be started.

It is not guaranteed that a QScrollEvent will be sent after an accepted QScrollPrepareEvent, e.g. in a case where the maximum content position is (0, 0).

See also QScrollEvent and QScroller.

## Member Function Documentation

### `[explicit]` QScrollPrepareEvent::QScrollPrepareEvent(const QPointF &startPos)

Creates new QScrollPrepareEvent The startPos is the position of a touch or mouse event that started the scrolling.

### QPointF QScrollPrepareEvent::contentPos() const

Returns the current position of the content as set by setContentPos.

See also setContentPos().

### QRectF QScrollPrepareEvent::contentPosRange() const

Returns the range of coordinates for the content as set by setContentPosRange().

See also setContentPosRange().

### void QScrollPrepareEvent::setContentPos(const QPointF &pos)

Sets the current content position to pos.

See also contentPos().

### void QScrollPrepareEvent::setContentPosRange(const QRectF &rect)

Sets the range of content coordinates to rect.

See also contentPosRange().

### void QScrollPrepareEvent::setViewportSize(const QSizeF &size)

Sets the size of the area that is to be scrolled to size.

See also viewportSize().

### QPointF QScrollPrepareEvent::startPos() const

Returns the position of the touch or mouse event that started the scrolling.

### QSizeF QScrollPrepareEvent::viewportSize() const

Returns size of the area that is to be scrolled as set by setViewportSize

See also setViewportSize().