Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QScrollerPrivate Class Reference

#include <qscroller_p.h>

Inheritance diagram for QScrollerPrivate:
Collaboration diagram for QScrollerPrivate:

Classes

struct  ScrollSegment

Public Types

enum  ScrollType { ScrollTypeFlick = 0 , ScrollTypeScrollTo , ScrollTypeOvershoot }

Public Slots

void targetDestroyed ()
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Public Member Functions

 QScrollerPrivate (QScroller *q, QObject *target)
void init ()
void sendEvent (QObject *o, QEvent *e)
void setState (QScroller::State s)
bool pressWhileInactive (const QPointF &position, qint64 timestamp)
bool moveWhilePressed (const QPointF &position, qint64 timestamp)
bool releaseWhilePressed (const QPointF &position, qint64 timestamp)
bool moveWhileDragging (const QPointF &position, qint64 timestamp)
bool releaseWhileDragging (const QPointF &position, qint64 timestamp)
bool pressWhileScrolling (const QPointF &position, qint64 timestamp)
void timerTick ()
void timerEventWhileDragging ()
void timerEventWhileScrolling ()
bool prepareScrolling (const QPointF &position)
void handleDrag (const QPointF &position, qint64 timestamp)
QPointF dpi () const
void setDpi (const QPointF &dpi)
void setDpiFromWidget (QWidget *widget)
void updateVelocity (const QPointF &deltaPixelRaw, qint64 deltaTime)
void pushSegment (ScrollType type, qreal deltaTime, qreal stopProgress, qreal startPos, qreal deltaPos, qreal stopPos, QEasingCurve::Type curve, Qt::Orientation orientation)
void recalcScrollingSegments (bool forceRecalc=false)
qreal scrollingSegmentsEndPos (Qt::Orientation orientation) const
bool scrollingSegmentsValid (Qt::Orientation orientation) const
void createScrollToSegments (qreal v, qreal deltaTime, qreal endPos, Qt::Orientation orientation, ScrollType type)
void createScrollingSegments (qreal v, qreal startPos, qreal deltaTime, qreal deltaPos, Qt::Orientation orientation)
void createScrollingSegments (const QPointF &v, const QPointF &startPos, const QPointF &ppm)
void setContentPositionHelperDragging (const QPointF &deltaPos)
void setContentPositionHelperScrolling ()
qreal nextSnapPos (qreal p, int dir, Qt::Orientation orientation) const
int frameRateSkip () const
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString > bindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread * thread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList & children () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArray > dynamicPropertyNames () const
QBindingStorage * bindingStorage ()
const QBindingStorage * bindingStorage () const
QObject * parent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Static Public Member Functions

static qreal nextSegmentPosition (QQueue< ScrollSegment > &segments, qint64 now, qreal oldPos)
static const char * stateName (QScroller::State state)
static const char * inputName (QScroller::Input input)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)

Public Attributes

QObject * target
QScrollerProperties properties
QFlickGestureRecognizer * recognizer
Qt::GestureType recognizerType
QSizeF viewportSize
QRectF contentPosRange
QPointF contentPosition
QPointF overshootPosition
bool enabled
QScroller::State state
bool firstScroll
QPointF oldVelocity
QPointF pressPosition
QPointF lastPosition
qint64 pressTimestamp
qint64 lastTimestamp
QPointF dragDistance
QQueue< ScrollSegment > xSegments
QQueue< ScrollSegment > ySegments
QList< qreal > snapPositionsX
qreal snapFirstX
qreal snapIntervalX
QList< qreal > snapPositionsY
qreal snapFirstY
qreal snapIntervalY
QPointF pixelPerMeter
QElapsedTimer monotonicTimer
QPointF releaseVelocity
QScroller * q_ptr

Additional Inherited Members

Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Properties inherited from QObject
QString objectName
 the name of this object
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 45 of file qscroller_p.h.

Member Enumeration Documentation

◆ ScrollType

enum QScrollerPrivate::ScrollType
Enumerator
ScrollTypeFlick 
ScrollTypeScrollTo 
ScrollTypeOvershoot 

Definition at line 58 of file qscroller_p.h.

Constructor & Destructor Documentation

◆ QScrollerPrivate()

QScrollerPrivate::QScrollerPrivate ( QScroller * q,
QObject * target )

Definition at line 833 of file qscroller.cpp.

Member Function Documentation

◆ createScrollingSegments() [1/2]

void QScrollerPrivate::createScrollingSegments ( const QPointF & v,
const QPointF & startPos,
const QPointF & ppm )

Definition at line 1339 of file qscroller.cpp.

◆ createScrollingSegments() [2/2]

void QScrollerPrivate::createScrollingSegments ( qreal v,
qreal startPos,
qreal deltaTime,
qreal deltaPos,
Qt::Orientation orientation )

Definition at line 1185 of file qscroller.cpp.

◆ createScrollToSegments()

void QScrollerPrivate::createScrollToSegments ( qreal v,
qreal deltaTime,
qreal endPos,
Qt::Orientation orientation,
ScrollType type )

Creates the sections needed to scroll to the specific endPos to the segments queue.

Definition at line 1158 of file qscroller.cpp.

◆ dpi()

QPointF QScrollerPrivate::dpi ( ) const

Returns the resolution of the used screen.

Definition at line 968 of file qscroller.cpp.

◆ frameRateSkip()

int QScrollerPrivate::frameRateSkip ( ) const
inline

Definition at line 110 of file qscroller_p.h.

◆ handleDrag()

void QScrollerPrivate::handleDrag ( const QPointF & position,
qint64 timestamp )

Definition at line 1428 of file qscroller.cpp.

◆ init()

void QScrollerPrivate::init ( )

Definition at line 855 of file qscroller.cpp.

◆ inputName()

const char * QScrollerPrivate::inputName ( QScroller::Input input)
static

Definition at line 877 of file qscroller.cpp.

◆ moveWhileDragging()

bool QScrollerPrivate::moveWhileDragging ( const QPointF & position,
qint64 timestamp )

Definition at line 1551 of file qscroller.cpp.

◆ moveWhilePressed()

bool QScrollerPrivate::moveWhilePressed ( const QPointF & position,
qint64 timestamp )

Definition at line 1502 of file qscroller.cpp.

◆ nextSegmentPosition()

qreal QScrollerPrivate::nextSegmentPosition ( QQueue< ScrollSegment > & segments,
qint64 now,
qreal oldPos )
static

Definition at line 1788 of file qscroller.cpp.

◆ nextSnapPos()

qreal QScrollerPrivate::nextSnapPos ( qreal p,
int dir,
Qt::Orientation orientation ) const

Returns the next snap point in direction. If direction >0 it will return the next snap point that is larger than the current position. If direction <0 it will return the next snap point that is smaller than the current position. If direction ==0 it will return the nearest snap point (or the current position if we are already on a snap point. Returns the nearest snap position or NaN if no such point could be found.

Definition at line 1848 of file qscroller.cpp.

◆ prepareScrolling()

bool QScrollerPrivate::prepareScrolling ( const QPointF & position)

Prepares scrolling by sending a QScrollPrepareEvent to the receiver widget. Returns true if the scrolling was accepted and a target was returned.

Definition at line 1375 of file qscroller.cpp.

◆ pressWhileInactive()

bool QScrollerPrivate::pressWhileInactive ( const QPointF & position,
qint64 timestamp )

Definition at line 1474 of file qscroller.cpp.

◆ pressWhileScrolling()

bool QScrollerPrivate::pressWhileScrolling ( const QPointF & position,
qint64 timestamp )

Definition at line 1626 of file qscroller.cpp.

◆ pushSegment()

void QScrollerPrivate::pushSegment ( ScrollType type,
qreal deltaTime,
qreal stopProgress,
qreal startPos,
qreal deltaPos,
qreal stopPos,
QEasingCurve::Type curve,
Qt::Orientation orientation )

Definition at line 1041 of file qscroller.cpp.

◆ recalcScrollingSegments()

void QScrollerPrivate::recalcScrollingSegments ( bool forceRecalc = false)

Clears the old segments and recalculates them if the current segments are not longer valid

Definition at line 1079 of file qscroller.cpp.

◆ releaseWhileDragging()

bool QScrollerPrivate::releaseWhileDragging ( const QPointF & position,
qint64 timestamp )

Definition at line 1568 of file qscroller.cpp.

◆ releaseWhilePressed()

bool QScrollerPrivate::releaseWhilePressed ( const QPointF & position,
qint64 timestamp )

Definition at line 1491 of file qscroller.cpp.

◆ scrollingSegmentsEndPos()

qreal QScrollerPrivate::scrollingSegmentsEndPos ( Qt::Orientation orientation) const

Returns the end position after the current scroll has finished.

Definition at line 1095 of file qscroller.cpp.

◆ scrollingSegmentsValid()

bool QScrollerPrivate::scrollingSegmentsValid ( Qt::Orientation orientation) const

Checks if the scroller segment end in a valid position.

Definition at line 1113 of file qscroller.cpp.

◆ sendEvent()

void QScrollerPrivate::sendEvent ( QObject * o,
QEvent * e )

Definition at line 861 of file qscroller.cpp.

◆ setContentPositionHelperDragging()

void QScrollerPrivate::setContentPositionHelperDragging ( const QPointF & deltaPos)

Helps when setting the content position. It will try to move the content by the requested delta but stop in case when we are coming back from an overshoot or a scrollTo. It will also indicate a new overshooting condition by the overshootX and oversthootY flags.

In this cases it will reset the velocity variables and other flags.

Also keeps track of the current over-shooting value in overshootPosition.

deltaPos is the amount of pixels the current content position should be moved

Definition at line 1728 of file qscroller.cpp.

◆ setContentPositionHelperScrolling()

void QScrollerPrivate::setContentPositionHelperScrolling ( )

Definition at line 1815 of file qscroller.cpp.

◆ setDpi()

void QScrollerPrivate::setDpi ( const QPointF & dpi)

Sets the resolution used for scrolling. This resolution is only used by the kinetic scroller. If you change this then the scroller will behave quite different as a lot of the values are given in physical distances (millimeter).

Definition at line 979 of file qscroller.cpp.

◆ setDpiFromWidget()

void QScrollerPrivate::setDpiFromWidget ( QWidget * widget)

Sets the dpi used for scrolling to the value of the widget.

Definition at line 987 of file qscroller.cpp.

◆ setState()

void QScrollerPrivate::setState ( QScroller::State newstate)

This function handles all state changes of the scroller.

Definition at line 1646 of file qscroller.cpp.

◆ stateName()

const char * QScrollerPrivate::stateName ( QScroller::State state)
static

Definition at line 866 of file qscroller.cpp.

◆ targetDestroyed

void QScrollerPrivate::targetDestroyed ( )
slot

Definition at line 887 of file qscroller.cpp.

◆ timerEventWhileDragging()

void QScrollerPrivate::timerEventWhileDragging ( )

Definition at line 1558 of file qscroller.cpp.

◆ timerEventWhileScrolling()

void QScrollerPrivate::timerEventWhileScrolling ( )

Definition at line 1617 of file qscroller.cpp.

◆ timerTick()

void QScrollerPrivate::timerTick ( )

Definition at line 895 of file qscroller.cpp.

◆ updateVelocity()

void QScrollerPrivate::updateVelocity ( const QPointF & deltaPixelRaw,
qint64 deltaTime )

Updates the velocity during dragging. Sets releaseVelocity.

Definition at line 998 of file qscroller.cpp.

Member Data Documentation

◆ contentPosition

QPointF QScrollerPrivate::contentPosition

Definition at line 132 of file qscroller_p.h.

◆ contentPosRange

QRectF QScrollerPrivate::contentPosRange

Definition at line 131 of file qscroller_p.h.

◆ dragDistance

QPointF QScrollerPrivate::dragDistance

Definition at line 148 of file qscroller_p.h.

◆ enabled

bool QScrollerPrivate::enabled

Definition at line 137 of file qscroller_p.h.

◆ firstScroll

bool QScrollerPrivate::firstScroll

Definition at line 139 of file qscroller_p.h.

◆ lastPosition

QPointF QScrollerPrivate::lastPosition

Definition at line 144 of file qscroller_p.h.

◆ lastTimestamp

qint64 QScrollerPrivate::lastTimestamp

Definition at line 146 of file qscroller_p.h.

◆ monotonicTimer

QElapsedTimer QScrollerPrivate::monotonicTimer

Definition at line 163 of file qscroller_p.h.

◆ oldVelocity

QPointF QScrollerPrivate::oldVelocity

Definition at line 141 of file qscroller_p.h.

◆ overshootPosition

QPointF QScrollerPrivate::overshootPosition

Definition at line 133 of file qscroller_p.h.

◆ pixelPerMeter

QPointF QScrollerPrivate::pixelPerMeter

Definition at line 161 of file qscroller_p.h.

◆ pressPosition

QPointF QScrollerPrivate::pressPosition

Definition at line 143 of file qscroller_p.h.

◆ pressTimestamp

qint64 QScrollerPrivate::pressTimestamp

Definition at line 145 of file qscroller_p.h.

◆ properties

QScrollerProperties QScrollerPrivate::properties

Definition at line 121 of file qscroller_p.h.

◆ q_ptr

QScroller* QScrollerPrivate::q_ptr

Definition at line 170 of file qscroller_p.h.

◆ recognizer

QFlickGestureRecognizer* QScrollerPrivate::recognizer

Definition at line 123 of file qscroller_p.h.

◆ recognizerType

Qt::GestureType QScrollerPrivate::recognizerType

Definition at line 124 of file qscroller_p.h.

◆ releaseVelocity

QPointF QScrollerPrivate::releaseVelocity

Definition at line 165 of file qscroller_p.h.

◆ snapFirstX

qreal QScrollerPrivate::snapFirstX

Definition at line 155 of file qscroller_p.h.

◆ snapFirstY

qreal QScrollerPrivate::snapFirstY

Definition at line 158 of file qscroller_p.h.

◆ snapIntervalX

qreal QScrollerPrivate::snapIntervalX

Definition at line 156 of file qscroller_p.h.

◆ snapIntervalY

qreal QScrollerPrivate::snapIntervalY

Definition at line 159 of file qscroller_p.h.

◆ snapPositionsX

QList<qreal> QScrollerPrivate::snapPositionsX

Definition at line 154 of file qscroller_p.h.

◆ snapPositionsY

QList<qreal> QScrollerPrivate::snapPositionsY

Definition at line 157 of file qscroller_p.h.

◆ state

QScroller::State QScrollerPrivate::state

Definition at line 138 of file qscroller_p.h.

◆ target

QObject* QScrollerPrivate::target

Definition at line 120 of file qscroller_p.h.

◆ viewportSize

QSizeF QScrollerPrivate::viewportSize

Definition at line 130 of file qscroller_p.h.

◆ xSegments

QQueue<ScrollSegment> QScrollerPrivate::xSegments

Definition at line 150 of file qscroller_p.h.

◆ ySegments

QQueue<ScrollSegment> QScrollerPrivate::ySegments

Definition at line 151 of file qscroller_p.h.

The documentation for this class was generated from the following files: