Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickFlickable Class Reference

#include <qquickflickable_p.h>

+ Inheritance diagram for QQuickFlickable:
+ Collaboration diagram for QQuickFlickable:

Public Types

enum  BoundsBehaviorFlag { StopAtBounds = 0x0 , DragOverBounds = 0x1 , OvershootBounds = 0x2 , DragAndOvershootBounds = DragOverBounds | OvershootBounds }
 
enum  BoundsMovement { FollowBoundsBehavior = 0x1 }
 
enum  FlickableDirection {
  AutoFlickDirection =0x0 , HorizontalFlick =0x1 , VerticalFlick =0x2 , HorizontalAndVerticalFlick =0x3 ,
  AutoFlickIfNeeded =0xc
}
 
- Public Types inherited from QQuickItem
enum  Flag {
  ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 ,
  ItemIsViewport = 0x20 , ItemObservesViewport = 0x40
}
 \qmltype Item \instantiates QQuickItem \inherits QtObject \inqmlmodule QtQuick More...
 
enum  ItemChange {
  ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged ,
  ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged ,
  ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged
}
 Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...
 
enum  TransformOrigin {
  TopLeft , Top , TopRight , Left ,
  Center , Right , BottomLeft , Bottom ,
  BottomRight
}
 \variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...
 

Signals

void contentWidthChanged ()
 
void contentHeightChanged ()
 
void contentXChanged ()
 
void contentYChanged ()
 
void topMarginChanged ()
 
void bottomMarginChanged ()
 
void leftMarginChanged ()
 
void rightMarginChanged ()
 
void originYChanged ()
 
void originXChanged ()
 
void movingChanged ()
 
void movingHorizontallyChanged ()
 
void movingVerticallyChanged ()
 
void flickingChanged ()
 
void flickingHorizontallyChanged ()
 
void flickingVerticallyChanged ()
 
void draggingChanged ()
 
void draggingHorizontallyChanged ()
 
void draggingVerticallyChanged ()
 
void horizontalVelocityChanged ()
 
void verticalVelocityChanged ()
 
void isAtBoundaryChanged ()
 
void flickableDirectionChanged ()
 
void interactiveChanged ()
 
void boundsBehaviorChanged ()
 
 Q_REVISION (2, 10) void boundsMovementChanged()
 
void reboundChanged ()
 
void maximumFlickVelocityChanged ()
 
void flickDecelerationChanged ()
 
void pressDelayChanged ()
 
void movementStarted ()
 
void movementEnded ()
 
void flickStarted ()
 
void flickEnded ()
 
void dragStarted ()
 
void dragEnded ()
 
void pixelAlignedChanged ()
 
 Q_REVISION (2, 12) void synchronousDragChanged()
 
 Q_REVISION (2, 9) void horizontalOvershootChanged()
 
 Q_REVISION (2, 9) void verticalOvershootChanged()
 
void atXEndChanged ()
 
void atYEndChanged ()
 
void atXBeginningChanged ()
 
void atYBeginningChanged ()
 
- Signals inherited from QQuickItem
void childrenRectChanged (const QRectF &)
 
void baselineOffsetChanged (qreal)
 
void stateChanged (const QString &)
 
void focusChanged (bool)
 
void activeFocusChanged (bool)
 
Q_REVISION(6, 7) void focusPolicyChanged(Qt Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)
 
void parentChanged (QQuickItem *)
 
void transformOriginChanged (TransformOrigin)
 
void smoothChanged (bool)
 
void antialiasingChanged (bool)
 
void clipChanged (bool)
 
 Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)
 
void childrenChanged ()
 
void opacityChanged ()
 
void enabledChanged ()
 
void visibleChanged ()
 
void visibleChildrenChanged ()
 
void rotationChanged ()
 
void scaleChanged ()
 
void xChanged ()
 
void yChanged ()
 
void widthChanged ()
 
void heightChanged ()
 
void zChanged ()
 
void implicitWidthChanged ()
 
void implicitHeightChanged ()
 
 Q_REVISION (2, 11) void containmentMaskChanged()
 
 Q_REVISION (6, 0) void paletteChanged()
 
 Q_REVISION (6, 0) void paletteCreated()
 
- 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.
 

Public Member Functions

 QQuickFlickable (QQuickItem *parent=nullptr)
 \qmlsignal QtQuick::Flickable::dragStarted()
 
 ~QQuickFlickable () override
 
QQmlListProperty< QObjectflickableData ()
 
QQmlListProperty< QQuickItemflickableChildren ()
 
BoundsBehavior boundsBehavior () const
 \qmlproperty enumeration QtQuick::Flickable::boundsBehavior This property holds whether the surface may be dragged beyond the Flickable's boundaries, or overshoot the Flickable's boundaries when flicked.
 
void setBoundsBehavior (BoundsBehavior)
 
BoundsMovement boundsMovement () const
 \qmlproperty enumeration QtQuick::Flickable::boundsMovement
 
void setBoundsMovement (BoundsMovement movement)
 
QQuickTransitionrebound () const
 \qmlproperty Transition QtQuick::Flickable::rebound
 
void setRebound (QQuickTransition *transition)
 
qreal contentWidth () const
 \qmlproperty real QtQuick::Flickable::contentWidth \qmlproperty real QtQuick::Flickable::contentHeight
 
void setContentWidth (qreal)
 
qreal contentHeight () const
 
void setContentHeight (qreal)
 
qreal contentX () const
 \qmlproperty real QtQuick::Flickable::contentX \qmlproperty real QtQuick::Flickable::contentY
 
virtual void setContentX (qreal pos)
 
qreal contentY () const
 
virtual void setContentY (qreal pos)
 
qreal topMargin () const
 \qmlproperty real QtQuick::Flickable::topMargin \qmlproperty real QtQuick::Flickable::leftMargin \qmlproperty real QtQuick::Flickable::bottomMargin \qmlproperty real QtQuick::Flickable::rightMargin
 
void setTopMargin (qreal m)
 
qreal bottomMargin () const
 
void setBottomMargin (qreal m)
 
qreal leftMargin () const
 
void setLeftMargin (qreal m)
 
qreal rightMargin () const
 
void setRightMargin (qreal m)
 
virtual qreal originY () const
 \qmlproperty real QtQuick::Flickable::originX \qmlproperty real QtQuick::Flickable::originY
 
virtual qreal originX () const
 
bool isMoving () const
 \qmlproperty bool QtQuick::Flickable::moving \qmlproperty bool QtQuick::Flickable::movingHorizontally \qmlproperty bool QtQuick::Flickable::movingVertically
 
bool isMovingHorizontally () const
 
bool isMovingVertically () const
 
bool isFlicking () const
 
bool isFlickingHorizontally () const
 \qmlproperty bool QtQuick::Flickable::flicking \qmlproperty bool QtQuick::Flickable::flickingHorizontally \qmlproperty bool QtQuick::Flickable::flickingVertically
 
bool isFlickingVertically () const
 
bool isDragging () const
 \qmlproperty bool QtQuick::Flickable::dragging \qmlproperty bool QtQuick::Flickable::draggingHorizontally \qmlproperty bool QtQuick::Flickable::draggingVertically
 
bool isDraggingHorizontally () const
 
bool isDraggingVertically () const
 
int pressDelay () const
 \qmlproperty int QtQuick::Flickable::pressDelay
 
void setPressDelay (int delay)
 
qreal maximumFlickVelocity () const
 \qmlproperty real QtQuick::Flickable::maximumFlickVelocity This property holds the maximum velocity that the user can flick the view in pixels/second.
 
void setMaximumFlickVelocity (qreal)
 
qreal flickDeceleration () const
 \qmlproperty real QtQuick::Flickable::flickDeceleration This property holds the rate at which a flick will decelerate: the higher the number, the faster it slows down when the user stops flicking via touch.
 
void setFlickDeceleration (qreal)
 
bool isInteractive () const
 \qmlproperty bool QtQuick::Flickable::interactive
 
void setInteractive (bool)
 
qreal horizontalVelocity () const
 \qmlproperty real QtQuick::Flickable::horizontalVelocity \qmlproperty real QtQuick::Flickable::verticalVelocity
 
qreal verticalVelocity () const
 
bool isAtXEnd () const
 \qmlproperty bool QtQuick::Flickable::atXBeginning \qmlproperty bool QtQuick::Flickable::atXEnd \qmlproperty bool QtQuick::Flickable::atYBeginning \qmlproperty bool QtQuick::Flickable::atYEnd
 
bool isAtXBeginning () const
 
bool isAtYEnd () const
 
bool isAtYBeginning () const
 
QQuickItemcontentItem () const
 \qmlproperty Item QtQuick::Flickable::contentItem
 
FlickableDirection flickableDirection () const
 \qmlproperty enumeration QtQuick::Flickable::flickableDirection
 
void setFlickableDirection (FlickableDirection)
 
bool pixelAligned () const
 \qmlproperty bool QtQuick::Flickable::pixelAligned
 
void setPixelAligned (bool align)
 
bool synchronousDrag () const
 \qmlproperty bool QtQuick::Flickable::synchronousDrag
 
void setSynchronousDrag (bool v)
 
qreal horizontalOvershoot () const
 \qmlproperty real QtQuick::Flickable::horizontalOvershoot
 
qreal verticalOvershoot () const
 \qmlproperty real QtQuick::Flickable::verticalOvershoot
 
Q_INVOKABLE void resizeContent (qreal w, qreal h, QPointF center)
 \qmlmethod QtQuick::Flickable::resizeContent(real width, real height, QPointF center)
 
Q_INVOKABLE void returnToBounds ()
 \qmlmethod QtQuick::Flickable::returnToBounds()
 
Q_INVOKABLE void flick (qreal xVelocity, qreal yVelocity)
 \qmlmethod QtQuick::Flickable::flick(qreal xVelocity, qreal yVelocity)
 
Q_INVOKABLE void cancelFlick ()
 \qmlmethod QtQuick::Flickable::cancelFlick()
 
- Public Member Functions inherited from QQuickItem
 QQuickItem (QQuickItem *parent=nullptr)
 Constructs a QQuickItem with the given parent.
 
 ~QQuickItem () override
 Destroys the QQuickItem.
 
QQuickWindowwindow () const
 Returns the window in which this item is rendered.
 
QQuickItemparentItem () const
 
void setParentItem (QQuickItem *parent)
 
void stackBefore (const QQuickItem *)
 Moves the specified sibling item to the index before this item within the list of children.
 
void stackAfter (const QQuickItem *)
 Moves the specified sibling item to the index after this item within the list of children.
 
QRectF childrenRect ()
 \qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly
 
QList< QQuickItem * > childItems () const
 Returns the children of this item.
 
bool clip () const
 \qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled.
 
void setClip (bool)
 
QString state () const
 \qmlproperty string QtQuick::Item::state
 
void setState (const QString &)
 
qreal baselineOffset () const
 \qmlproperty int QtQuick::Item::baselineOffset
 
void setBaselineOffset (qreal)
 
QQmlListProperty< QQuickTransformtransform ()
 
qreal x () const
 
qreal y () const
 
QPointF position () const
 
void setX (qreal)
 
void setY (qreal)
 
void setPosition (const QPointF &)
 
QBindable< qrealbindableX ()
 
QBindable< qrealbindableY ()
 
qreal width () const
 
void setWidth (qreal)
 
void resetWidth ()
 
void setImplicitWidth (qreal)
 
qreal implicitWidth () const
 Returns the width of the item that is implied by other properties that determine the content.
 
QBindable< qrealbindableWidth ()
 
qreal height () const
 
void setHeight (qreal)
 
void resetHeight ()
 
void setImplicitHeight (qreal)
 
qreal implicitHeight () const
 
QBindable< qrealbindableHeight ()
 
QSizeF size () const
 
void setSize (const QSizeF &size)
 
TransformOrigin transformOrigin () const
 
void setTransformOrigin (TransformOrigin)
 
QPointF transformOriginPoint () const
 
void setTransformOriginPoint (const QPointF &)
 
qreal z () const
 
void setZ (qreal)
 
qreal rotation () const
 
void setRotation (qreal)
 
qreal scale () const
 
void setScale (qreal)
 
qreal opacity () const
 
void setOpacity (qreal)
 
bool isVisible () const
 
void setVisible (bool)
 
bool isEnabled () const
 
void setEnabled (bool)
 
bool smooth () const
 
void setSmooth (bool)
 
bool activeFocusOnTab () const
 \qmlproperty bool QtQuick::Item::activeFocusOnTab
 
void setActiveFocusOnTab (bool)
 
bool antialiasing () const
 
void setAntialiasing (bool)
 
void resetAntialiasing ()
 
Flags flags () const
 Returns the item flags for this item.
 
void setFlag (Flag flag, bool enabled=true)
 Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled.
 
void setFlags (Flags flags)
 Enables the specified flags for this item.
 
virtual QRectF boundingRect () const
 Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
 
virtual QRectF clipRect () const
 Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
 
QQuickItemviewportItem () const
 If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag.
 
bool hasActiveFocus () const
 
bool hasFocus () const
 
void setFocus (bool)
 
void setFocus (bool focus, Qt::FocusReason reason)
 
bool isFocusScope () const
 Returns true if this item is a focus scope, and false otherwise.
 
QQuickItemscopedFocusItem () const
 If this item is a focus scope, this returns the item in its focus chain that currently has focus.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 Sets the focus policy of this item to policy.
 
bool isAncestorOf (const QQuickItem *child) const
 Returns true if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).
 
Qt::MouseButtons acceptedMouseButtons () const
 Returns the mouse buttons accepted by this item.
 
void setAcceptedMouseButtons (Qt::MouseButtons buttons)
 Sets the mouse buttons accepted by this item to buttons.
 
bool acceptHoverEvents () const
 Returns whether hover events are accepted by this item.
 
void setAcceptHoverEvents (bool enabled)
 If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item.
 
bool acceptTouchEvents () const
 Returns whether touch events are accepted by this item.
 
void setAcceptTouchEvents (bool accept)
 If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item.
 
bool isUnderMouse () const
 
void grabMouse ()
 
void ungrabMouse ()
 
bool keepMouseGrab () const
 Returns whether mouse input should exclusively remain with this item.
 
void setKeepMouseGrab (bool)
 Sets whether the mouse input should remain exclusively with this item.
 
bool filtersChildMouseEvents () const
 Returns whether pointer events intended for this item's children should be filtered through this item.
 
void setFiltersChildMouseEvents (bool filter)
 Sets whether pointer events intended for this item's children should be filtered through this item.
 
void grabTouchPoints (const QList< int > &ids)
 
void ungrabTouchPoints ()
 
bool keepTouchGrab () const
 Returns whether the touch points grabbed by this item should exclusively remain with this item.
 
void setKeepTouchGrab (bool)
 Sets whether the touch points grabbed by this item should remain exclusively with this item.
 
 Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback
 
QSharedPointer< QQuickItemGrabResultgrabToImage (const QSize &targetSize=QSize())
 Grabs the item into an in-memory image.
 
virtual Q_INVOKABLE bool contains (const QPointF &point) const
 \qmlmethod bool QtQuick::Item::contains(point point)
 
QObjectcontainmentMask () const
 
void setContainmentMask (QObject *mask)
 
QTransform itemTransform (QQuickItem *, bool *) const
 \qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r)
 
QPointF mapToScene (const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate.
 
QRectF mapRectToItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value.
 
QRectF mapRectToScene (const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value.
 
QPointF mapFromScene (const QPointF &point) const
 Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
 
QRectF mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
 
QRectF mapRectFromScene (const QRectF &rect) const
 Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
 
void polish ()
 Schedules a polish event for this item.
 
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
 
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, qreal x, qreal y)
 
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, const QRectF &rect) const
 
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
 
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate.
 
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, qreal x, qreal y)
 
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, const QRectF &rect) const
 
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const
 
Q_INVOKABLE void forceActiveFocus ()
 \qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r)
 
Q_INVOKABLE void forceActiveFocus (Qt::FocusReason reason)
 \qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason.
 
 Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward
 
Q_INVOKABLE QQuickItemchildAt (qreal x, qreal y) const
 \qmlmethod QtQuick::Item::childAt(real x, real y)
 
 Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()
 
 Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const
 
virtual bool isTextureProvider () const
 Returns true if this item is a texture provider.
 
virtual QSGTextureProvidertextureProvider () const
 Returns the texture provider for an item.
 
- 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 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< QStringbindableObjectName ()
 
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 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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Slots

void movementStarting ()
 
void movementEnding ()
 
void movementEnding (bool hMovementEnding, bool vMovementEnding)
 
void velocityTimelineCompleted ()
 
void timelineCompleted ()
 

Protected Member Functions

bool childMouseEventFilter (QQuickItem *, QEvent *) override
 
void mousePressEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse press events for an item.
 
void mouseMoveEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse move events for an item.
 
void mouseReleaseEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse release events for an item.
 
void touchEvent (QTouchEvent *event) override
 This event handler can be reimplemented in a subclass to receive touch events for an item.
 
void timerEvent (QTimerEvent *event) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
QQuickFlickableVisibleAreavisibleArea ()
 
virtual qreal minXExtent () const
 
virtual qreal minYExtent () const
 
virtual qreal maxXExtent () const
 
virtual qreal maxYExtent () const
 
qreal vWidth () const
 
qreal vHeight () const
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
virtual void viewportMoved (Qt::Orientations orient)
 
void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
 
void mouseUngrabEvent () override
 This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.
 
bool filterPointerEvent (QQuickItem *receiver, QPointerEvent *event)
 
bool xflick () const
 
bool yflick () const
 
 QQuickFlickable (QQuickFlickablePrivate &dd, QQuickItem *parent)
 
- Protected Member Functions inherited from QQuickItem
bool event (QEvent *) override
 \reimp
 
bool isComponentComplete () const
 Returns true if construction of the QML component is complete; otherwise returns false.
 
virtual void itemChange (ItemChange, const ItemChangeData &)
 Called when change occurs for this item.
 
bool widthValid () const
 Returns whether the width property has been set explicitly.
 
bool heightValid () const
 Returns whether the height property has been set explicitly.
 
void setImplicitSize (qreal, qreal)
 
void classBegin () override
 \reimp Derived classes should call the base class method before adding their own action to perform at classBegin.
 
void componentComplete () override
 \reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.
 
virtual void keyPressEvent (QKeyEvent *event)
 This event handler can be reimplemented in a subclass to receive key press events for an item.
 
virtual void keyReleaseEvent (QKeyEvent *event)
 This event handler can be reimplemented in a subclass to receive key release events for an item.
 
virtual void focusInEvent (QFocusEvent *)
 This event handler can be reimplemented in a subclass to receive focus-in events for an item.
 
virtual void focusOutEvent (QFocusEvent *)
 This event handler can be reimplemented in a subclass to receive focus-out events for an item.
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.
 
virtual void touchUngrabEvent ()
 This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.
 
virtual void hoverEnterEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-enter events for an item.
 
virtual void hoverMoveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-move events for an item.
 
virtual void hoverLeaveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-leave events for an item.
 
virtual QSGNodeupdatePaintNode (QSGNode *, UpdatePaintNodeData *)
 Called on the render thread when it is time to sync the state of the item with the scene graph.
 
virtual void releaseResources ()
 This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().
 
virtual void updatePolish ()
 This function should perform any layout as required for this item.
 
 QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObjectsender () 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 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)
 

Properties

qreal contentWidth
 
qreal contentHeight
 
qreal contentX
 
qreal contentY
 
QQuickItemcontentItem
 
qreal topMargin
 
qreal bottomMargin
 
qreal originY
 
qreal leftMargin
 
qreal rightMargin
 
qreal originX
 
qreal horizontalVelocity
 
qreal verticalVelocity
 
BoundsBehavior boundsBehavior
 
BoundsMovement boundsMovement
 
QQuickTransitionrebound
 
qreal maximumFlickVelocity
 
qreal flickDeceleration
 
bool moving
 
bool movingHorizontally
 
bool movingVertically
 
bool flicking
 
bool flickingHorizontally
 
bool flickingVertically
 
bool dragging
 
bool draggingHorizontally
 
bool draggingVertically
 
FlickableDirection flickableDirection
 
bool interactive
 
int pressDelay
 
bool atXEnd
 
bool atYEnd
 
bool atXBeginning
 
bool atYBeginning
 
QQuickFlickableVisibleAreavisibleArea
 
bool pixelAligned
 
bool synchronousDrag
 
qreal horizontalOvershoot
 
qreal verticalOvershoot
 
QQmlListProperty< QObjectflickableData
 
QQmlListProperty< QQuickItemflickableChildren
 
- Properties inherited from QQuickItem
QQuickItemparent
 \qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item.
 
qreal x
 \qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height
 
qreal y
 Defines the item's y position relative to its parent.
 
qreal z
 \qmlproperty real QtQuick::Item::z
 
qreal width
 This property holds the width of this item.
 
qreal height
 This property holds the height of this item.
 
qreal opacity
 \qmlproperty real QtQuick::Item::opacity
 
bool enabled
 \qmlproperty bool QtQuick::Item::enabled
 
bool visible
 \qmlproperty bool QtQuick::Item::visible
 
Qt::FocusPolicy focusPolicy
 \qmlproperty enumeration QtQuick::Item::focusPolicy
 
qreal rotation
 \qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin.
 
qreal scale
 \qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item.
 
TransformOrigin transformOrigin
 \qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform.
 
QPointF transformOriginPoint
 
QQmlListProperty< QQuickTransformtransform
 \qmlproperty list<Transform> QtQuick::Item::transform This property holds the list of transformations to apply.
 
bool smooth
 \qmlproperty bool QtQuick::Item::smooth
 
bool antialiasing
 \qmlproperty bool QtQuick::Item::antialiasing
 
qreal implicitWidth
 
qreal implicitHeight
 
QObjectcontainmentMask
 \qmlproperty QObject* QtQuick::Item::containmentMask
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QQuickFlickableVisibleArea
 
class QQuickFlickableReboundTransition
 

Additional Inherited Members

- Public Slots inherited from QQuickItem
void update ()
 Schedules a call to updatePaintNode() for this item.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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 inherited from QQuickItem
const QSizetargetSize = QSize())
 
qreal y const
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 25 of file qquickflickable_p.h.

Member Enumeration Documentation

◆ BoundsBehaviorFlag

Enumerator
StopAtBounds 
DragOverBounds 
OvershootBounds 
DragAndOvershootBounds 

Definition at line 91 of file qquickflickable_p.h.

◆ BoundsMovement

Enumerator
FollowBoundsBehavior 

Definition at line 103 of file qquickflickable_p.h.

◆ FlickableDirection

Enumerator
AutoFlickDirection 
HorizontalFlick 
VerticalFlick 
HorizontalAndVerticalFlick 
AutoFlickIfNeeded 

Definition at line 174 of file qquickflickable_p.h.

Constructor & Destructor Documentation

◆ QQuickFlickable() [1/2]

QQuickFlickable::QQuickFlickable ( QQuickItem * parent = nullptr)

\qmlsignal QtQuick::Flickable::dragStarted()

This signal is emitted when the view starts to be dragged due to user interaction.

\qmlsignal QtQuick::Flickable::dragEnded()

This signal is emitted when the user stops dragging the view.

If the velocity of the drag is sufficient at the time the touch/mouse button is released then a flick will start.

\qmltype Flickable \instantiates QQuickFlickable \inqmlmodule QtQuick

Provides a surface that can be "flicked". \inherits Item

The Flickable item places its children on a surface that can be dragged and flicked, causing the view onto the child items to scroll. This behavior forms the basis of Items that are designed to show large numbers of child items, such as \l ListView and \l GridView.

In traditional user interfaces, views can be scrolled using standard controls, such as scroll bars and arrow buttons. In some situations, it is also possible to drag the view directly by pressing and holding a mouse button while moving the cursor. In touch-based user interfaces, this dragging action is often complemented with a flicking action, where scrolling continues after the user has stopped touching the view.

Flickable does not automatically clip its contents. If it is not used as a full-screen item, you should consider setting the \l{Item::}{clip} property to true.

Definition at line 760 of file qquickflickable.cpp.

References d.

◆ ~QQuickFlickable()

QQuickFlickable::~QQuickFlickable ( )
override

Definition at line 774 of file qquickflickable.cpp.

◆ QQuickFlickable() [2/2]

QQuickFlickable::QQuickFlickable ( QQuickFlickablePrivate & dd,
QQuickItem * parent )
protected

Definition at line 767 of file qquickflickable.cpp.

References d.

Member Function Documentation

◆ atXBeginningChanged

void QQuickFlickable::atXBeginningChanged ( )
signal

◆ atXEndChanged

void QQuickFlickable::atXEndChanged ( )
signal

◆ atYBeginningChanged

void QQuickFlickable::atYBeginningChanged ( )
signal

◆ atYEndChanged

void QQuickFlickable::atYEndChanged ( )
signal

Referenced by QQuickTableViewPrivate::connectToModel(), and QQuickTableViewPrivate::disconnectFromModel().

+ Here is the caller graph for this function:

◆ bottomMargin()

qreal QQuickFlickable::bottomMargin ( ) const

Definition at line 2429 of file qquickflickable.cpp.

References d.

◆ bottomMarginChanged

void QQuickFlickable::bottomMarginChanged ( )
signal

Referenced by setBottomMargin().

+ Here is the caller graph for this function:

◆ boundsBehavior()

QQuickFlickable::BoundsBehavior QQuickFlickable::boundsBehavior ( ) const

\qmlproperty enumeration QtQuick::Flickable::boundsBehavior This property holds whether the surface may be dragged beyond the Flickable's boundaries, or overshoot the Flickable's boundaries when flicked.

When the \l boundsMovement is Flickable.FollowBoundsBehavior, a value other than Flickable.StopAtBounds will give a feeling that the edges of the view are soft, rather than a hard physical boundary.

The boundsBehavior can be one of:

\list

  • Flickable.StopAtBounds - the contents can not be dragged beyond the boundary of the flickable, and flicks will not overshoot.
  • Flickable.DragOverBounds - the contents can be dragged beyond the boundary of the Flickable, but flicks will not overshoot.
  • Flickable.OvershootBounds - the contents can overshoot the boundary when flicked, but the content cannot be dragged beyond the boundary of the flickable. (since {QtQuick 2.5})
  • Flickable.DragAndOvershootBounds (default) - the contents can be dragged beyond the boundary of the Flickable, and can overshoot the boundary when flicked. \endlist
See also
horizontalOvershoot, verticalOvershoot, boundsMovement

Definition at line 2239 of file qquickflickable.cpp.

References d.

◆ boundsBehaviorChanged

void QQuickFlickable::boundsBehaviorChanged ( )
signal

Referenced by setBoundsBehavior().

+ Here is the caller graph for this function:

◆ boundsMovement()

QQuickFlickable::BoundsMovement QQuickFlickable::boundsMovement ( ) const

\qmlproperty enumeration QtQuick::Flickable::boundsMovement

Since
5.10

This property holds whether the flickable will give a feeling that the edges of the view are soft, rather than a hard physical boundary.

The boundsMovement can be one of:

\list

  • Flickable.StopAtBounds - this allows implementing custom edge effects where the contents do not follow drags or flicks beyond the bounds of the flickable. The values of \l horizontalOvershoot and \l verticalOvershoot can be utilized to implement custom edge effects.
  • Flickable.FollowBoundsBehavior (default) - whether the contents follow drags or flicks beyond the bounds of the flickable is determined by \l boundsBehavior. \endlist

The following example keeps the contents within bounds and instead applies a flip effect when flicked over horizontal bounds:

Flickable {
id: flickable
boundsMovement: Flickable.StopAtBounds
boundsBehavior: Flickable.DragAndOvershootBounds
transform: Rotation {
axis { x: 0; y: 1; z: 0 }
origin.x: flickable.width / 2
origin.y: flickable.height / 2
angle: Math.min(30, Math.max(-30, flickable.horizontalOvershoot))
}
}
BoundsBehavior boundsBehavior
BoundsMovement boundsMovement
qreal x
\qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item...
Definition qquickitem.h:72
qreal z
\qmlproperty real QtQuick::Item::z
Definition qquickitem.h:74
qreal y
Defines the item's y position relative to its parent.
Definition qquickitem.h:73
QQmlListProperty< QQuickTransform > transform
\qmlproperty list<Transform> QtQuick::Item::transform This property holds the list of transformations...
Definition qquickitem.h:110
GLenum GLuint id
[7]
GLfloat angle

The following example keeps the contents within bounds and instead applies an opacity effect when dragged over vertical bounds:

Flickable {
boundsMovement: Flickable.StopAtBounds
boundsBehavior: Flickable.DragOverBounds
opacity: Math.max(0.5, 1.0 - Math.abs(verticalOvershoot) / height)
}
qreal opacity
\qmlproperty real QtQuick::Item::opacity
Definition qquickitem.h:78
GLint GLsizei GLsizei height
See also
boundsBehavior, verticalOvershoot, horizontalOvershoot

Definition at line 3228 of file qquickflickable.cpp.

References d.

◆ cancelFlick()

void QQuickFlickable::cancelFlick ( )

\qmlmethod QtQuick::Flickable::cancelFlick()

Cancels the current flick animation.

Definition at line 2159 of file qquickflickable.cpp.

References d, and movementEnding().

Referenced by QQuickItemView::modelUpdated().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ childMouseEventFilter()

bool QQuickFlickable::childMouseEventFilter ( QQuickItem * i,
QEvent * e )
overrideprotectedvirtual

Despite the name, this function filters all pointer events on their way to any child within. Returns true if the event will be stolen and should not be delivered to the receiver.

Reimplemented from QQuickItem.

Definition at line 2774 of file qquickflickable.cpp.

References QQuickItem::childMouseEventFilter(), d, filterPointerEvent(), i, QQuickItem::isEnabled(), isInteractive(), QEvent::isPointerEvent(), QEvent::isSinglePointEvent(), QQuickItem::isVisible(), QQuickDeliveryAgentPrivate::localizePointerEvent(), mouseUngrabEvent(), Q_ASSERT, qCDebug, QEvent::type(), and QEvent::UngrabMouse.

+ Here is the call graph for this function:

◆ componentComplete()

void QQuickFlickable::componentComplete ( )
overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Reimplemented in QQuickItemView.

Definition at line 2001 of file qquickflickable.cpp.

References QQuickItem::componentComplete(), d, minXExtent(), minYExtent(), QObject::objectName, setContentX(), and setContentY().

Referenced by QQuickItemView::componentComplete().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ contentHeight()

qreal QQuickFlickable::contentHeight ( ) const

Definition at line 2368 of file qquickflickable.cpp.

References d.

◆ contentHeightChanged

void QQuickFlickable::contentHeightChanged ( )
signal

Referenced by QQuickTextAreaPrivate::attachFlickable(), QQuickTextAreaPrivate::detachFlickable(), resizeContent(), setContentHeight(), and QQuickScrollViewPrivate::setFlickable().

+ Here is the caller graph for this function:

◆ contentItem()

QQuickItem * QQuickFlickable::contentItem ( ) const

\qmlproperty Item QtQuick::Flickable::contentItem

The internal item that contains the Items to be moved in the Flickable.

Items declared as children of a Flickable are automatically parented to the Flickable's contentItem.

Items created dynamically need to be explicitly parented to the contentItem:

Flickable {
id: myFlickable
function addItem(file) {
var component = Qt.createComponent(file)
component.createObject(myFlickable.contentItem);
}
}
Definition qcompare.h:63
static qreal component(const QPointF &point, unsigned int i)
QFile file
[0]
scene addItem(form)

Definition at line 947 of file qquickflickable.cpp.

References d.

◆ contentWidth()

qreal QQuickFlickable::contentWidth ( ) const

\qmlproperty real QtQuick::Flickable::contentWidth \qmlproperty real QtQuick::Flickable::contentHeight

The dimensions of the content (the surface controlled by Flickable). This should typically be set to the combined size of the items placed in the Flickable.

The following snippet shows how these properties are used to display an image that is larger than the Flickable item itself:

import QtQuick
Flickable {
width: 200; height: 200
contentWidth: image.width; contentHeight: image.height
Image { id: image; source: "bigImage.png" }
}

In some cases, the content dimensions can be automatically set based on the \l {Item::childrenRect.width}{childrenRect.width} and \l {Item::childrenRect.height}{childrenRect.height} properties of the \l contentItem. For example, the previous snippet could be rewritten with:

QQuickItem * contentItem
QRectF childrenRect()
\qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect....
constexpr qreal height() const noexcept
Returns the height of the rectangle.
Definition qrect.h:718
constexpr qreal width() const noexcept
Returns the width of the rectangle.
Definition qrect.h:715

Though this assumes that the origin of the childrenRect is 0,0.

Definition at line 2339 of file qquickflickable.cpp.

References d.

◆ contentWidthChanged

void QQuickFlickable::contentWidthChanged ( )
signal

Referenced by QQuickTextAreaPrivate::attachFlickable(), QQuickTextAreaPrivate::detachFlickable(), resizeContent(), setContentWidth(), and QQuickScrollViewPrivate::setFlickable().

+ Here is the caller graph for this function:

◆ contentX()

qreal QQuickFlickable::contentX ( ) const

\qmlproperty real QtQuick::Flickable::contentX \qmlproperty real QtQuick::Flickable::contentY

These properties hold the surface coordinate currently at the top-left corner of the Flickable. For example, if you flick an image up 100 pixels, contentY will increase by 100.

Note
If you flick back to the origin (the top-left corner), after the rebound animation, contentX will settle to the same value as originX, and contentY to originY. These are usually (0,0), however ListView and GridView may have an arbitrary origin due to delegate size variation, or item insertion/removal outside the visible region. So if you want to implement something like a vertical scrollbar, one way is to use {y: (contentY - originY) * (height / contentHeight)} for the position; another way is to use the normalized values in \l {QtQuick::Flickable::visibleArea}{visibleArea}.
See also
{Examples of contentX and contentY}, originX, originY

Definition at line 798 of file qquickflickable.cpp.

References d.

◆ contentXChanged

void QQuickFlickable::contentXChanged ( )
signal

Referenced by QQuickTextAreaPrivate::attachFlickable(), and QQuickTextAreaPrivate::detachFlickable().

+ Here is the caller graph for this function:

◆ contentY()

qreal QQuickFlickable::contentY ( ) const

Definition at line 819 of file qquickflickable.cpp.

References d.

◆ contentYChanged

void QQuickFlickable::contentYChanged ( )
signal

Referenced by QQuickTextAreaPrivate::attachFlickable(), and QQuickTextAreaPrivate::detachFlickable().

+ Here is the caller graph for this function:

◆ dragEnded

void QQuickFlickable::dragEnded ( )
signal

◆ draggingChanged

void QQuickFlickable::draggingChanged ( )
signal

◆ draggingHorizontallyChanged

void QQuickFlickable::draggingHorizontallyChanged ( )
signal

◆ draggingVerticallyChanged

void QQuickFlickable::draggingVerticallyChanged ( )
signal

◆ dragStarted

void QQuickFlickable::dragStarted ( )
signal

◆ filterPointerEvent()

bool QQuickFlickable::filterPointerEvent ( QQuickItem * receiver,
QPointerEvent * event )
protected

QQuickFlickable::filterPointerEvent filters pointer events intercepted on the way to the child receiver, and potentially steals the exclusive grab.

This is how flickable takes over the handling of events from child items.

Returns true if the event will be stolen and should not be delivered to the receiver.

Definition at line 2667 of file qquickflickable.cpp.

References QQuickItem::acceptedMouseButtons(), button, QQuickDeliveryAgentPrivate::clonePointerEvent(), QQuickItem::contains(), d, QQuickItem::isEnabled(), QQuickDeliveryAgentPrivate::isMouseEvent(), QQuickDeliveryAgentPrivate::isTabletEvent(), QQuickDeliveryAgentPrivate::isTouchEvent(), QQuickItem::keepMouseGrab(), QQuickItem::keepTouchGrab(), QQuickItem::mapFromScene(), QObject::objectName, QEventPoint::Pressed, Q_ASSERT_X, qCDebug, QEventPoint::Released, returnToBounds(), QEventPoint::Stationary, testFlag(), QEventPoint::Unknown, and QEventPoint::Updated.

Referenced by childMouseEventFilter().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ flick()

void QQuickFlickable::flick ( qreal xVelocity,
qreal yVelocity )

\qmlmethod QtQuick::Flickable::flick(qreal xVelocity, qreal yVelocity)

Flicks the content with xVelocity horizontally and yVelocity vertically in pixels/sec.

Calling this method will update the corresponding moving and flicking properties and signals, just like a real touchscreen flick.

Definition at line 2112 of file qquickflickable.cpp.

References d, movementStarting(), qFuzzyIsNull(), QEvent::TouchUpdate, xflick(), and yflick().

+ Here is the call graph for this function:

◆ flickableChildren()

QQmlListProperty< QQuickItem > QQuickFlickable::flickableChildren ( )

◆ flickableData()

QQmlListProperty< QObject > QQuickFlickable::flickableData ( )

◆ flickableDirection()

QQuickFlickable::FlickableDirection QQuickFlickable::flickableDirection ( ) const

\qmlproperty enumeration QtQuick::Flickable::flickableDirection

This property determines which directions the view can be flicked.

\list

  • Flickable.AutoFlickDirection (default) - allows flicking vertically if the contentHeight is not equal to the height of the Flickable. Allows flicking horizontally if the contentWidth is not equal to the width of the Flickable.
  • Flickable.AutoFlickIfNeeded - allows flicking vertically if the contentHeight is greater than the height of the Flickable. Allows flicking horizontally if the contentWidth is greater than to the width of the Flickable. (since {QtQuick 2.7})
  • Flickable.HorizontalFlick - allows flicking horizontally.
  • Flickable.VerticalFlick - allows flicking vertically.
  • Flickable.HorizontalAndVerticalFlick - allows flicking in both directions. \endlist

Definition at line 982 of file qquickflickable.cpp.

References d.

◆ flickableDirectionChanged

void QQuickFlickable::flickableDirectionChanged ( )
signal

Referenced by setFlickableDirection().

+ Here is the caller graph for this function:

◆ flickDeceleration()

qreal QQuickFlickable::flickDeceleration ( ) const

\qmlproperty real QtQuick::Flickable::flickDeceleration This property holds the rate at which a flick will decelerate: the higher the number, the faster it slows down when the user stops flicking via touch.

For example 0.0001 is nearly "frictionless", and 10000 feels quite "sticky".

The default value is platform dependent. Values of zero or less are not allowed.

Definition at line 2838 of file qquickflickable.cpp.

References d.

◆ flickDecelerationChanged

void QQuickFlickable::flickDecelerationChanged ( )
signal

Referenced by setFlickDeceleration().

+ Here is the caller graph for this function:

◆ flickEnded

void QQuickFlickable::flickEnded ( )
signal

Referenced by movementEnding().

+ Here is the caller graph for this function:

◆ flickingChanged

void QQuickFlickable::flickingChanged ( )
signal

Referenced by movementEnding().

+ Here is the caller graph for this function:

◆ flickingHorizontallyChanged

void QQuickFlickable::flickingHorizontallyChanged ( )
signal

Referenced by movementEnding().

+ Here is the caller graph for this function:

◆ flickingVerticallyChanged

void QQuickFlickable::flickingVerticallyChanged ( )
signal

Referenced by movementEnding().

+ Here is the caller graph for this function:

◆ flickStarted

void QQuickFlickable::flickStarted ( )
signal

◆ geometryChange()

void QQuickFlickable::geometryChange ( const QRectF & newGeometry,
const QRectF & oldGeometry )
overrideprotectedvirtual
Since
6.0

This function is called to handle this item's changes in geometry from oldGeometry to newGeometry. If the two geometries are the same, it doesn't do anything.

Derived classes must call the base class method within their implementation.

Reimplemented from QQuickItem.

Reimplemented in QQuickGridView, QQuickItemView, QQuickListView, and QQuickTableView.

Definition at line 2072 of file qquickflickable.cpp.

References d, QQuickItem::geometryChange(), QRectF::height(), QQuickItem::height, QQuickFlickablePrivate::Immediate, QRectF::width(), and QQuickItem::width.

Referenced by QQuickItemView::geometryChange(), and QQuickTableView::geometryChange().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ horizontalOvershoot()

qreal QQuickFlickable::horizontalOvershoot ( ) const

\qmlproperty real QtQuick::Flickable::horizontalOvershoot

Since
5.9

This property holds the horizontal overshoot, that is, the horizontal distance by which the contents has been dragged or flicked past the bounds of the flickable. The value is negative when the content is dragged or flicked beyond the beginning, and positive when beyond the end; 0.0 otherwise.

Whether the values are reported for dragging and/or flicking is determined by \l boundsBehavior. The overshoot distance is reported even when \l boundsMovement is Flickable.StopAtBounds.

See also
verticalOvershoot, boundsBehavior, boundsMovement

Definition at line 3155 of file qquickflickable.cpp.

References d.

◆ horizontalVelocity()

qreal QQuickFlickable::horizontalVelocity ( ) const

\qmlproperty real QtQuick::Flickable::horizontalVelocity \qmlproperty real QtQuick::Flickable::verticalVelocity

The instantaneous velocity of movement along the x and y axes, in pixels/sec.

The reported velocity is smoothed to avoid erratic output.

Note that for views with a large content size (more than 10 times the view size), the velocity of the flick may exceed the velocity of the touch in the case of multiple quick consecutive flicks. This allows the user to flick faster through large content.

Definition at line 884 of file qquickflickable.cpp.

References d.

◆ horizontalVelocityChanged

void QQuickFlickable::horizontalVelocityChanged ( )
signal

◆ interactiveChanged

void QQuickFlickable::interactiveChanged ( )
signal

Referenced by QQuickSelectionRectanglePrivate::connectToTarget(), QQuickItemViewPrivate::init(), setInteractive(), and QQuickItemView::setKeyNavigationEnabled().

+ Here is the caller graph for this function:

◆ isAtBoundaryChanged

void QQuickFlickable::isAtBoundaryChanged ( )
signal

◆ isAtXBeginning()

bool QQuickFlickable::isAtXBeginning ( ) const

Definition at line 911 of file qquickflickable.cpp.

References d.

◆ isAtXEnd()

bool QQuickFlickable::isAtXEnd ( ) const

\qmlproperty bool QtQuick::Flickable::atXBeginning \qmlproperty bool QtQuick::Flickable::atXEnd \qmlproperty bool QtQuick::Flickable::atYBeginning \qmlproperty bool QtQuick::Flickable::atYEnd

These properties are true if the flickable view is positioned at the beginning, or end respectively.

Definition at line 905 of file qquickflickable.cpp.

References d.

◆ isAtYBeginning()

bool QQuickFlickable::isAtYBeginning ( ) const

Definition at line 923 of file qquickflickable.cpp.

References d.

◆ isAtYEnd()

bool QQuickFlickable::isAtYEnd ( ) const

Definition at line 917 of file qquickflickable.cpp.

References d.

◆ isDragging()

bool QQuickFlickable::isDragging ( ) const

\qmlproperty bool QtQuick::Flickable::dragging \qmlproperty bool QtQuick::Flickable::draggingHorizontally \qmlproperty bool QtQuick::Flickable::draggingVertically

These properties describe whether the view is currently moving horizontally, vertically or in either direction, due to the user dragging the view.

Definition at line 2887 of file qquickflickable.cpp.

References d.

◆ isDraggingHorizontally()

bool QQuickFlickable::isDraggingHorizontally ( ) const

Definition at line 2893 of file qquickflickable.cpp.

References d.

◆ isDraggingVertically()

bool QQuickFlickable::isDraggingVertically ( ) const

Definition at line 2899 of file qquickflickable.cpp.

References d.

◆ isFlicking()

bool QQuickFlickable::isFlicking ( ) const

Definition at line 2853 of file qquickflickable.cpp.

References d.

Referenced by QQuickItemView::resetPreferredHighlightBegin(), QQuickItemView::resetPreferredHighlightEnd(), setContentX(), setContentY(), QQuickItemView::setPreferredHighlightBegin(), and QQuickItemView::setPreferredHighlightEnd().

+ Here is the caller graph for this function:

◆ isFlickingHorizontally()

bool QQuickFlickable::isFlickingHorizontally ( ) const

\qmlproperty bool QtQuick::Flickable::flicking \qmlproperty bool QtQuick::Flickable::flickingHorizontally \qmlproperty bool QtQuick::Flickable::flickingVertically

These properties describe whether the view is currently moving horizontally, vertically or in either direction, due to the user flicking the view.

Definition at line 2867 of file qquickflickable.cpp.

References d.

◆ isFlickingVertically()

bool QQuickFlickable::isFlickingVertically ( ) const

Definition at line 2873 of file qquickflickable.cpp.

References d.

◆ isInteractive()

bool QQuickFlickable::isInteractive ( ) const

\qmlproperty bool QtQuick::Flickable::interactive

This property describes whether the user can interact with the Flickable. A user cannot drag or flick a Flickable that is not interactive.

By default, this property is true.

This property is useful for temporarily disabling flicking. This allows special interaction with Flickable's children; for example, you might want to freeze a flickable map while scrolling through a pop-up dialog that is a child of the Flickable.

Definition at line 853 of file qquickflickable.cpp.

References d.

Referenced by childMouseEventFilter().

+ Here is the caller graph for this function:

◆ isMoving()

bool QQuickFlickable::isMoving ( ) const

\qmlproperty bool QtQuick::Flickable::moving \qmlproperty bool QtQuick::Flickable::movingHorizontally \qmlproperty bool QtQuick::Flickable::movingVertically

These properties describe whether the view is currently moving horizontally, vertically or in either direction, due to the user either dragging or flicking the view.

Definition at line 2998 of file qquickflickable.cpp.

References d.

Referenced by movementEnding(), QQuickItemView::resetPreferredHighlightBegin(), QQuickItemView::resetPreferredHighlightEnd(), setContentX(), setContentY(), QQuickItemView::setPreferredHighlightBegin(), QQuickItemView::setPreferredHighlightEnd(), and QQuickTableViewResizeHandler::wantsEventPoint().

+ Here is the caller graph for this function:

◆ isMovingHorizontally()

bool QQuickFlickable::isMovingHorizontally ( ) const

Definition at line 3004 of file qquickflickable.cpp.

References d.

Referenced by QQuickScrollBarAttachedPrivate::activateHorizontal(), and QQuickScrollIndicatorAttachedPrivate::activateHorizontal().

+ Here is the caller graph for this function:

◆ isMovingVertically()

bool QQuickFlickable::isMovingVertically ( ) const

Definition at line 3010 of file qquickflickable.cpp.

References d.

Referenced by QQuickScrollBarAttachedPrivate::activateVertical(), and QQuickScrollIndicatorAttachedPrivate::activateVertical().

+ Here is the caller graph for this function:

◆ leftMargin()

qreal QQuickFlickable::leftMargin ( ) const

Definition at line 2450 of file qquickflickable.cpp.

References d.

◆ leftMarginChanged

void QQuickFlickable::leftMarginChanged ( )
signal

Referenced by setLeftMargin().

+ Here is the caller graph for this function:

◆ maximumFlickVelocity()

qreal QQuickFlickable::maximumFlickVelocity ( ) const

\qmlproperty real QtQuick::Flickable::maximumFlickVelocity This property holds the maximum velocity that the user can flick the view in pixels/second.

The default value is platform dependent.

Definition at line 2814 of file qquickflickable.cpp.

References d.

◆ maximumFlickVelocityChanged

void QQuickFlickable::maximumFlickVelocityChanged ( )
signal

Referenced by setMaximumFlickVelocity().

+ Here is the caller graph for this function:

◆ maxXExtent()

qreal QQuickFlickable::maxXExtent ( ) const
protectedvirtual

Reimplemented in QQuickItemView, QQuickListView, and QQuickTableView.

Definition at line 1989 of file qquickflickable.cpp.

References d, minXExtent(), vWidth(), and QQuickItem::width.

Referenced by QQuickItemView::maxXExtent(), QQuickListView::maxXExtent(), QQuickTableView::maxXExtent(), QQuickFlickableVisibleArea::updateVisible(), and viewportMoved().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ maxYExtent()

qreal QQuickFlickable::maxYExtent ( ) const
protectedvirtual

Reimplemented in QQuickItemView, QQuickListView, and QQuickTableView.

Definition at line 1995 of file qquickflickable.cpp.

References d, QQuickItem::height, minYExtent(), and vHeight().

Referenced by QQuickItemView::maxYExtent(), QQuickListView::maxYExtent(), QQuickTableView::maxYExtent(), QQuickFlickableVisibleArea::updateVisible(), and viewportMoved().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ minXExtent()

qreal QQuickFlickable::minXExtent ( ) const
protectedvirtual

Reimplemented in QQuickItemView, and QQuickTableView.

Definition at line 1982 of file qquickflickable.cpp.

References d.

Referenced by componentComplete(), maxXExtent(), QQuickItemView::minXExtent(), QQuickTableView::minXExtent(), originX(), QQuickFlickableVisibleArea::updateVisible(), and viewportMoved().

+ Here is the caller graph for this function:

◆ minYExtent()

qreal QQuickFlickable::minYExtent ( ) const
protectedvirtual

Reimplemented in QQuickItemView, and QQuickTableView.

Definition at line 1976 of file qquickflickable.cpp.

References d.

Referenced by componentComplete(), maxYExtent(), QQuickItemView::minYExtent(), QQuickTableView::minYExtent(), originY(), QQuickFlickableVisibleArea::updateVisible(), and viewportMoved().

+ Here is the caller graph for this function:

◆ mouseMoveEvent()

void QQuickFlickable::mouseMoveEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse move events for an item.

The event information is provided by the event parameter.

In order to receive mouse movement events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 1505 of file qquickflickable.cpp.

References d, and QQuickItem::mouseMoveEvent().

+ Here is the call graph for this function:

◆ mousePressEvent()

void QQuickFlickable::mousePressEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse press events for an item.

The event information is provided by the event parameter.

In order to receive mouse press events, \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 1493 of file qquickflickable.cpp.

References d, and QQuickItem::mousePressEvent().

+ Here is the call graph for this function:

◆ mouseReleaseEvent()

void QQuickFlickable::mouseReleaseEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse release events for an item.

The event information is provided by the event parameter.

In order to receive mouse release events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 1516 of file qquickflickable.cpp.

References d, QQuickItem::mouseReleaseEvent(), oldPosition, QCoreApplication::sendEvent(), and QQuickItem::window().

+ Here is the call graph for this function:

◆ mouseUngrabEvent()

void QQuickFlickable::mouseUngrabEvent ( )
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.

Reimplemented from QQuickItem.

Definition at line 2626 of file qquickflickable.cpp.

References d.

Referenced by childMouseEventFilter().

+ Here is the caller graph for this function:

◆ movementEnded

void QQuickFlickable::movementEnded ( )
signal

Referenced by movementEnding().

+ Here is the caller graph for this function:

◆ movementEnding [1/2]

void QQuickFlickable::movementEnding ( )
protectedslot

Definition at line 3068 of file qquickflickable.cpp.

References movementEnding().

Referenced by cancelFlick(), QQuickFlickableReboundTransition::finished(), movementEnding(), setContentX(), setContentY(), timelineCompleted(), and velocityTimelineCompleted().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ movementEnding [2/2]

void QQuickFlickable::movementEnding ( bool hMovementEnding,
bool vMovementEnding )
protectedslot

Definition at line 3073 of file qquickflickable.cpp.

References d, emit, flickEnded(), flickingChanged(), flickingHorizontallyChanged(), flickingVerticallyChanged(), isMoving(), movementEnded(), movingChanged(), movingHorizontallyChanged(), and movingVerticallyChanged().

+ Here is the call graph for this function:

◆ movementStarted

void QQuickFlickable::movementStarted ( )
signal

Referenced by movementStarting().

+ Here is the caller graph for this function:

◆ movementStarting

void QQuickFlickable::movementStarting ( )
protectedslot

Definition at line 3043 of file qquickflickable.cpp.

References d, emit, movementStarted(), movingChanged(), movingHorizontallyChanged(), and movingVerticallyChanged().

Referenced by flick().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ movingChanged

void QQuickFlickable::movingChanged ( )
signal

Referenced by movementEnding(), and movementStarting().

+ Here is the caller graph for this function:

◆ movingHorizontallyChanged

void QQuickFlickable::movingHorizontallyChanged ( )
signal

Referenced by QQuickScrollBarAttachedPrivate::cleanupHorizontal(), QQuickScrollBarAttachedPrivate::initHorizontal(), movementEnding(), movementStarting(), and QQuickScrollIndicatorAttached::setHorizontal().

+ Here is the caller graph for this function:

◆ movingVerticallyChanged

void QQuickFlickable::movingVerticallyChanged ( )
signal

Referenced by QQuickScrollBarAttachedPrivate::cleanupVertical(), QQuickScrollBarAttachedPrivate::initVertical(), movementEnding(), movementStarting(), and QQuickScrollIndicatorAttached::setVertical().

+ Here is the caller graph for this function:

◆ originX()

qreal QQuickFlickable::originX ( ) const
virtual

Reimplemented in QQuickItemView.

Definition at line 2512 of file qquickflickable.cpp.

References d, and minXExtent().

+ Here is the call graph for this function:

◆ originXChanged

void QQuickFlickable::originXChanged ( )
signal

◆ originY()

qreal QQuickFlickable::originY ( ) const
virtual

\qmlproperty real QtQuick::Flickable::originX \qmlproperty real QtQuick::Flickable::originY

These properties hold the origin of the content. This value always refers to the top-left position of the content regardless of layout direction.

This is usually (0,0), however ListView and GridView may have an arbitrary origin due to delegate size variation, or item insertion/removal outside the visible region.

See also
contentX, contentY

Reimplemented in QQuickItemView.

Definition at line 2506 of file qquickflickable.cpp.

References d, and minYExtent().

+ Here is the call graph for this function:

◆ originYChanged

void QQuickFlickable::originYChanged ( )
signal

◆ pixelAligned()

bool QQuickFlickable::pixelAligned ( ) const

\qmlproperty bool QtQuick::Flickable::pixelAligned

This property sets the alignment of \l contentX and \l contentY to pixels (true) or subpixels (false).

Enable pixelAligned to optimize for still content or moving content with high constrast edges, such as one-pixel-wide lines, text or vector graphics. Disable pixelAligned when optimizing for animation quality.

The default is false.

Definition at line 1009 of file qquickflickable.cpp.

References d.

◆ pixelAlignedChanged

void QQuickFlickable::pixelAlignedChanged ( )
signal

Referenced by setPixelAligned().

+ Here is the caller graph for this function:

◆ pressDelay()

int QQuickFlickable::pressDelay ( ) const

\qmlproperty int QtQuick::Flickable::pressDelay

This property holds the time to delay (ms) delivering a press to children of the Flickable. This can be useful where reacting to a press before a flicking action has undesirable effects.

If the flickable is dragged/flicked before the delay times out the press event will not be delivered. If the button is released within the timeout, both the press and release will be delivered.

Note that for nested Flickables with pressDelay set, the pressDelay of outer Flickables is overridden by the innermost Flickable. If the drag exceeds the platform drag threshold, the press event will be delivered regardless of this property.

See also
QStyleHints

Definition at line 2973 of file qquickflickable.cpp.

References d.

◆ pressDelayChanged

void QQuickFlickable::pressDelayChanged ( )
signal

Referenced by setPressDelay().

+ Here is the caller graph for this function:

◆ Q_REVISION [1/4]

QQuickFlickable::Q_REVISION ( 2 ,
10  )
signal

◆ Q_REVISION [2/4]

QQuickFlickable::Q_REVISION ( 2 ,
12  )
signal

◆ Q_REVISION [3/4]

QQuickFlickable::Q_REVISION ( 2 ,
9  )
signal

◆ Q_REVISION [4/4]

QQuickFlickable::Q_REVISION ( 2 ,
9  )
signal

◆ rebound()

QQuickTransition * QQuickFlickable::rebound ( ) const

\qmlproperty Transition QtQuick::Flickable::rebound

This holds the transition to be applied to the content view when it snaps back to the bounds of the flickable. The transition is triggered when the view is flicked or dragged past the edge of the content area, or when returnToBounds() is called.

\qml import QtQuick 2.0

Flickable { width: 150; height: 150 contentWidth: 300; contentHeight: 300

rebound: Transition { NumberAnimation { properties: "x,y" duration: 1000 easing.type: Easing.OutBounce } }

Rectangle { width: 300; height: 300 gradient: Gradient { GradientStop { position: 0.0; color: "lightsteelblue" } GradientStop { position: 1.0; color: "blue" } } } } \endqml

When the above view is flicked beyond its bounds, it will return to its bounds using the transition specified:

If this property is not set, a default animation is applied.

Definition at line 2294 of file qquickflickable.cpp.

References d.

◆ reboundChanged

void QQuickFlickable::reboundChanged ( )
signal

Referenced by setRebound().

+ Here is the caller graph for this function:

◆ resizeContent()

void QQuickFlickable::resizeContent ( qreal w,
qreal h,
QPointF center )

\qmlmethod QtQuick::Flickable::resizeContent(real width, real height, QPointF center)

Resizes the content to width x height about center.

This does not scale the contents of the Flickable - it only resizes the \l contentWidth and \l contentHeight.

Resizing the content may result in the content being positioned outside the bounds of the Flickable. Calling \l returnToBounds() will move the content back within legal bounds.

Definition at line 2531 of file qquickflickable.cpp.

References contentHeightChanged(), contentWidthChanged(), contentX, contentY, d, emit, pos, setContentX(), and setContentY().

+ Here is the call graph for this function:

◆ returnToBounds()

void QQuickFlickable::returnToBounds ( )

\qmlmethod QtQuick::Flickable::returnToBounds()

Ensures the content is within legal bounds.

This may be called to ensure that the content is within legal bounds after manually positioning the content.

Definition at line 2565 of file qquickflickable.cpp.

References d.

Referenced by filterPointerEvent().

+ Here is the caller graph for this function:

◆ rightMargin()

qreal QQuickFlickable::rightMargin ( ) const

Definition at line 2471 of file qquickflickable.cpp.

References d.

◆ rightMarginChanged

void QQuickFlickable::rightMarginChanged ( )
signal

Referenced by setRightMargin().

+ Here is the caller graph for this function:

◆ setBottomMargin()

void QQuickFlickable::setBottomMargin ( qreal m)

Definition at line 2435 of file qquickflickable.cpp.

References bottomMarginChanged(), d, emit, and QQuickFlickablePrivate::Immediate.

+ Here is the call graph for this function:

◆ setBoundsBehavior()

void QQuickFlickable::setBoundsBehavior ( BoundsBehavior b)

Definition at line 2245 of file qquickflickable.cpp.

References boundsBehaviorChanged(), d, and emit.

+ Here is the call graph for this function:

◆ setBoundsMovement()

void QQuickFlickable::setBoundsMovement ( BoundsMovement movement)

Definition at line 3234 of file qquickflickable.cpp.

References d, and emit.

◆ setContentHeight()

void QQuickFlickable::setContentHeight ( qreal h)

Definition at line 2374 of file qquickflickable.cpp.

References contentHeightChanged(), d, emit, QQuickFlickablePrivate::ExtentChanged, QQuickItem::height, and QQuickFlickablePrivate::Immediate.

Referenced by QQuickTextAreaPrivate::resizeFlickableContent(), QQuickTableView::setContentHeight(), QQuickScrollViewPrivate::setFlickable(), QQuickGridView::setFlow(), and QQuickListView::setOrientation().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setContentWidth()

void QQuickFlickable::setContentWidth ( qreal w)

Definition at line 2345 of file qquickflickable.cpp.

References contentWidthChanged(), d, emit, QQuickFlickablePrivate::ExtentChanged, QQuickFlickablePrivate::Immediate, and QQuickItem::width.

Referenced by QQuickTextAreaPrivate::resizeFlickableContent(), QQuickTableView::setContentWidth(), QQuickScrollViewPrivate::setFlickable(), QQuickGridView::setFlow(), and QQuickListView::setOrientation().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setContentX()

void QQuickFlickable::setContentX ( qreal pos)
virtual

Reimplemented in QQuickItemView.

Definition at line 804 of file qquickflickable.cpp.

References d, isFlicking(), isMoving(), movementEnding(), pos, and qFuzzyCompare().

Referenced by componentComplete(), QQuickTextAreaPrivate::ensureCursorVisible(), QQuickGridView::geometryChange(), resizeContent(), QQuickScrollBarAttachedPrivate::scrollHorizontal(), QQuickGridView::setCellWidth(), and QQuickItemView::setContentX().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setContentY()

void QQuickFlickable::setContentY ( qreal pos)
virtual

Reimplemented in QQuickItemView.

Definition at line 825 of file qquickflickable.cpp.

References d, isFlicking(), isMoving(), movementEnding(), pos, and qFuzzyCompare().

Referenced by componentComplete(), QQuickTextAreaPrivate::ensureCursorVisible(), QQuickGridView::geometryChange(), resizeContent(), QQuickScrollBarAttachedPrivate::scrollVertical(), QQuickGridView::setCellHeight(), and QQuickItemView::setContentY().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFlickableDirection()

void QQuickFlickable::setFlickableDirection ( FlickableDirection direction)

Definition at line 988 of file qquickflickable.cpp.

References d, direction, emit, and flickableDirectionChanged().

Referenced by QQuickHorizontalHeaderView::QQuickHorizontalHeaderView(), QQuickVerticalHeaderView::QQuickVerticalHeaderView(), QQuickGridView::setFlow(), and QQuickListView::setOrientation().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFlickDeceleration()

void QQuickFlickable::setFlickDeceleration ( qreal deceleration)

Definition at line 2844 of file qquickflickable.cpp.

References d, emit, flickDecelerationChanged(), and qMax().

+ Here is the call graph for this function:

◆ setInteractive()

void QQuickFlickable::setInteractive ( bool interactive)

Definition at line 859 of file qquickflickable.cpp.

References d, emit, interactive, and interactiveChanged().

+ Here is the call graph for this function:

◆ setLeftMargin()

void QQuickFlickable::setLeftMargin ( qreal m)

Definition at line 2456 of file qquickflickable.cpp.

References d, emit, QQuickFlickablePrivate::Immediate, and leftMarginChanged().

+ Here is the call graph for this function:

◆ setMaximumFlickVelocity()

void QQuickFlickable::setMaximumFlickVelocity ( qreal v)

Definition at line 2820 of file qquickflickable.cpp.

References d, emit, and maximumFlickVelocityChanged().

+ Here is the call graph for this function:

◆ setPixelAligned()

void QQuickFlickable::setPixelAligned ( bool align)

Definition at line 1015 of file qquickflickable.cpp.

References d, emit, and pixelAlignedChanged().

Referenced by QQuickScrollViewPrivate::ensureFlickable().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setPressDelay()

void QQuickFlickable::setPressDelay ( int delay)

Definition at line 2979 of file qquickflickable.cpp.

References d, emit, and pressDelayChanged().

+ Here is the call graph for this function:

◆ setRebound()

void QQuickFlickable::setRebound ( QQuickTransition * transition)

Definition at line 2300 of file qquickflickable.cpp.

References d, emit, QQuickFlickableReboundTransition, and reboundChanged().

+ Here is the call graph for this function:

◆ setRightMargin()

void QQuickFlickable::setRightMargin ( qreal m)

Definition at line 2477 of file qquickflickable.cpp.

References d, emit, QQuickFlickablePrivate::Immediate, and rightMarginChanged().

+ Here is the call graph for this function:

◆ setSynchronousDrag()

void QQuickFlickable::setSynchronousDrag ( bool v)

Definition at line 1042 of file qquickflickable.cpp.

References d, and emit.

◆ setTopMargin()

void QQuickFlickable::setTopMargin ( qreal m)

Definition at line 2414 of file qquickflickable.cpp.

References d, emit, QQuickFlickablePrivate::Immediate, and topMarginChanged().

+ Here is the call graph for this function:

◆ synchronousDrag()

bool QQuickFlickable::synchronousDrag ( ) const

\qmlproperty bool QtQuick::Flickable::synchronousDrag

Since
5.12

If this property is set to true, then when the mouse or touchpoint moves far enough to begin dragging the content, the content will jump, such that the content pixel which was under the cursor or touchpoint when pressed remains under that point.

The default is false, which provides a smoother experience (no jump) at the cost that some of the drag distance is "lost" at the beginning.

Definition at line 1036 of file qquickflickable.cpp.

References d.

◆ timelineCompleted

void QQuickFlickable::timelineCompleted ( )
protectedslot

Definition at line 3032 of file qquickflickable.cpp.

References d, and movementEnding().

+ Here is the call graph for this function:

◆ timerEvent()

void QQuickFlickable::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 1965 of file qquickflickable.cpp.

References d.

◆ topMargin()

qreal QQuickFlickable::topMargin ( ) const

\qmlproperty real QtQuick::Flickable::topMargin \qmlproperty real QtQuick::Flickable::leftMargin \qmlproperty real QtQuick::Flickable::bottomMargin \qmlproperty real QtQuick::Flickable::rightMargin

These properties hold the margins around the content. This space is reserved in addition to the contentWidth and contentHeight.

Definition at line 2408 of file qquickflickable.cpp.

References d.

◆ topMarginChanged

void QQuickFlickable::topMarginChanged ( )
signal

Referenced by setTopMargin().

+ Here is the caller graph for this function:

◆ touchEvent()

void QQuickFlickable::touchEvent ( QTouchEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive touch events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 1546 of file qquickflickable.cpp.

References QQuickDeliveryAgentPrivate::clonePointerEvent(), d, QEventPoint::Pressed, QEventPoint::Released, QCoreApplication::sendEvent(), QEventPoint::Stationary, QEvent::TouchCancel, QQuickItem::touchEvent(), QEventPoint::Unknown, QEventPoint::Updated, and QQuickItem::window().

+ Here is the call graph for this function:

◆ velocityTimelineCompleted

void QQuickFlickable::velocityTimelineCompleted ( )
protectedslot

Definition at line 3016 of file qquickflickable.cpp.

References d, and movementEnding().

+ Here is the call graph for this function:

◆ verticalOvershoot()

qreal QQuickFlickable::verticalOvershoot ( ) const

\qmlproperty real QtQuick::Flickable::verticalOvershoot

Since
5.9

This property holds the vertical overshoot, that is, the vertical distance by which the contents has been dragged or flicked past the bounds of the flickable. The value is negative when the content is dragged or flicked beyond the beginning, and positive when beyond the end; 0.0 otherwise.

Whether the values are reported for dragging and/or flicking is determined by \l boundsBehavior. The overshoot distance is reported even when \l boundsMovement is Flickable.StopAtBounds.

See also
horizontalOvershoot, boundsBehavior, boundsMovement

Definition at line 3176 of file qquickflickable.cpp.

References d.

◆ verticalVelocity()

qreal QQuickFlickable::verticalVelocity ( ) const

Definition at line 890 of file qquickflickable.cpp.

References d.

◆ verticalVelocityChanged

void QQuickFlickable::verticalVelocityChanged ( )
signal

◆ vHeight()

qreal QQuickFlickable::vHeight ( ) const
protected

Definition at line 2581 of file qquickflickable.cpp.

References d, and QQuickItem::height.

Referenced by maxYExtent().

+ Here is the caller graph for this function:

◆ viewportMoved()

void QQuickFlickable::viewportMoved ( Qt::Orientations orient)
protectedvirtual

Reimplemented in QQuickListView, QQuickTableView, and QQuickGridView.

Definition at line 2015 of file qquickflickable.cpp.

References d, Qt::Horizontal, maxXExtent(), maxYExtent(), minXExtent(), minYExtent(), and Qt::Vertical.

Referenced by QQuickListView::viewportMoved(), QQuickTableView::viewportMoved(), and QQuickGridView::viewportMoved().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ visibleArea()

QQuickFlickableVisibleArea * QQuickFlickable::visibleArea ( )
protected

◆ vWidth()

qreal QQuickFlickable::vWidth ( ) const
protected

Definition at line 2572 of file qquickflickable.cpp.

References d, and QQuickItem::width.

Referenced by maxXExtent().

+ Here is the caller graph for this function:

◆ xflick()

bool QQuickFlickable::xflick ( ) const
protected

The setFlickableDirection function can be used to set constraints on which axis the contentItem can be flicked along.

Returns
true if the flickable is allowed to flick in the horizontal direction, otherwise returns false

Definition at line 2597 of file qquickflickable.cpp.

References AutoFlickDirection, AutoFlickIfNeeded, d, HorizontalFlick, qAbs(), and QQuickItem::width.

Referenced by flick(), and QQuickListView::viewportMoved().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ yflick()

bool QQuickFlickable::yflick ( ) const
protected

The setFlickableDirection function can be used to set constraints on which axis the contentItem can be flicked along.

Returns
true if the flickable is allowed to flick in the vertical direction, otherwise returns false.

Definition at line 2615 of file qquickflickable.cpp.

References AutoFlickDirection, AutoFlickIfNeeded, d, QQuickItem::height, qAbs(), and VerticalFlick.

Referenced by flick(), QQuickListView::viewportMoved(), and QQuickGridView::viewportMoved().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QQuickFlickableReboundTransition

friend class QQuickFlickableReboundTransition
friend

Definition at line 285 of file qquickflickable_p.h.

Referenced by setRebound().

◆ QQuickFlickableVisibleArea

friend class QQuickFlickableVisibleArea
friend

Definition at line 284 of file qquickflickable_p.h.

Property Documentation

◆ atXBeginning

bool QQuickFlickable::atXBeginning
read

Definition at line 67 of file qquickflickable_p.h.

◆ atXEnd

bool QQuickFlickable::atXEnd
read

Definition at line 65 of file qquickflickable_p.h.

◆ atYBeginning

bool QQuickFlickable::atYBeginning
read

Definition at line 68 of file qquickflickable_p.h.

◆ atYEnd

bool QQuickFlickable::atYEnd
read

Definition at line 66 of file qquickflickable_p.h.

◆ bottomMargin

qreal QQuickFlickable::bottomMargin
readwrite

Definition at line 36 of file qquickflickable_p.h.

Referenced by QQuickTableViewPrivate::syncSyncView().

◆ boundsBehavior

BoundsBehavior QQuickFlickable::boundsBehavior
readwrite

Definition at line 46 of file qquickflickable_p.h.

◆ boundsMovement

BoundsMovement QQuickFlickable::boundsMovement
readwrite

Definition at line 47 of file qquickflickable_p.h.

◆ contentHeight

◆ contentItem

◆ contentWidth

◆ contentX

◆ contentY

◆ dragging

bool QQuickFlickable::dragging
read

Definition at line 57 of file qquickflickable_p.h.

◆ draggingHorizontally

bool QQuickFlickable::draggingHorizontally
read

Definition at line 58 of file qquickflickable_p.h.

◆ draggingVertically

bool QQuickFlickable::draggingVertically
read

Definition at line 59 of file qquickflickable_p.h.

◆ flickableChildren

QQmlListProperty< QQuickItem > QQuickFlickable::flickableChildren
read

Definition at line 79 of file qquickflickable_p.h.

Referenced by QQuickScrollViewPrivate::contentChildren_append().

◆ flickableData

◆ flickableDirection

FlickableDirection QQuickFlickable::flickableDirection
readwrite

Definition at line 60 of file qquickflickable_p.h.

◆ flickDeceleration

qreal QQuickFlickable::flickDeceleration
readwrite

Definition at line 50 of file qquickflickable_p.h.

◆ flicking

bool QQuickFlickable::flicking
read

Definition at line 54 of file qquickflickable_p.h.

◆ flickingHorizontally

bool QQuickFlickable::flickingHorizontally
read

Definition at line 55 of file qquickflickable_p.h.

◆ flickingVertically

bool QQuickFlickable::flickingVertically
read

Definition at line 56 of file qquickflickable_p.h.

◆ horizontalOvershoot

qreal QQuickFlickable::horizontalOvershoot
read

Definition at line 75 of file qquickflickable_p.h.

◆ horizontalVelocity

qreal QQuickFlickable::horizontalVelocity
read

Definition at line 43 of file qquickflickable_p.h.

◆ interactive

bool QQuickFlickable::interactive
readwrite

Definition at line 62 of file qquickflickable_p.h.

Referenced by setInteractive().

◆ leftMargin

qreal QQuickFlickable::leftMargin
readwrite

Definition at line 39 of file qquickflickable_p.h.

Referenced by QQuickTableViewPrivate::syncSyncView().

◆ maximumFlickVelocity

qreal QQuickFlickable::maximumFlickVelocity
readwrite

Definition at line 49 of file qquickflickable_p.h.

◆ moving

bool QQuickFlickable::moving
read

Definition at line 51 of file qquickflickable_p.h.

◆ movingHorizontally

bool QQuickFlickable::movingHorizontally
read

Definition at line 52 of file qquickflickable_p.h.

◆ movingVertically

bool QQuickFlickable::movingVertically
read

Definition at line 53 of file qquickflickable_p.h.

◆ originX

qreal QQuickFlickable::originX
read

Definition at line 41 of file qquickflickable_p.h.

Referenced by QQuickItemView::originX().

◆ originY

qreal QQuickFlickable::originY
read

Definition at line 37 of file qquickflickable_p.h.

Referenced by QQuickItemView::originY().

◆ pixelAligned

bool QQuickFlickable::pixelAligned
readwrite

Definition at line 72 of file qquickflickable_p.h.

◆ pressDelay

int QQuickFlickable::pressDelay
readwrite

Definition at line 63 of file qquickflickable_p.h.

◆ rebound

QQuickTransition * QQuickFlickable::rebound
readwrite

Definition at line 48 of file qquickflickable_p.h.

◆ rightMargin

qreal QQuickFlickable::rightMargin
readwrite

Definition at line 40 of file qquickflickable_p.h.

Referenced by QQuickTableViewPrivate::syncSyncView().

◆ synchronousDrag

bool QQuickFlickable::synchronousDrag
readwrite

Definition at line 73 of file qquickflickable_p.h.

◆ topMargin

qreal QQuickFlickable::topMargin
readwrite

Definition at line 35 of file qquickflickable_p.h.

Referenced by QQuickTableViewPrivate::syncSyncView().

◆ verticalOvershoot

qreal QQuickFlickable::verticalOvershoot
read

Definition at line 76 of file qquickflickable_p.h.

◆ verticalVelocity

qreal QQuickFlickable::verticalVelocity
read

Definition at line 44 of file qquickflickable_p.h.

◆ visibleArea

QQuickFlickableVisibleArea * QQuickFlickable::visibleArea
read

Definition at line 70 of file qquickflickable_p.h.


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