#include <qquickpathview_p.h>

Inheritance diagram for QQuickPathView:

Collaboration diagram for QQuickPathView:

Public Types
enum	HighlightRangeMode { NoHighlightRange , ApplyRange , StrictlyEnforceRange }

enum	SnapMode { NoSnap , SnapToItem , SnapOneItem }

enum	MovementDirection { Shortest , Negative , Positive }

enum	PositionMode { Beginning , Center , End , Contain =4 , SnapPosition }

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...

Public Slots
void	incrementCurrentIndex ()
	\qmlmethod QtQuick::PathView::incrementCurrentIndex()

void	decrementCurrentIndex ()
	\qmlmethod QtQuick::PathView::decrementCurrentIndex()

Public Slots inherited from QQuickItem
void	update ()
	Schedules a call to updatePaintNode() for this item.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	currentIndexChanged ()

void	currentItemChanged ()

void	offsetChanged ()

void	modelChanged ()

void	countChanged ()

void	pathChanged ()

void	preferredHighlightBeginChanged ()

void	preferredHighlightEndChanged ()

void	highlightRangeModeChanged ()

void	dragMarginChanged ()

void	snapPositionChanged ()

void	delegateChanged ()

void	pathItemCountChanged ()

void	maximumFlickVelocityChanged ()

void	flickDecelerationChanged ()

void	interactiveChanged ()

void	movingChanged ()

void	flickingChanged ()

void	draggingChanged ()

void	highlightChanged ()

void	highlightItemChanged ()

void	highlightMoveDurationChanged ()

void	movementStarted ()

void	movementEnded ()

	Q_REVISION (2, 7) void movementDirectionChanged()

void	flickStarted ()

void	flickEnded ()

void	dragStarted ()

void	dragEnded ()

void	snapModeChanged ()

void	cacheItemCountChanged ()

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
	QQuickPathView (QQuickItem *parent=nullptr)

virtual	~QQuickPathView ()

QVariant	model () const
	\qmlattachedproperty PathView QtQuick::PathView::view \readonly

void	setModel (const QVariant &)

QQuickPath *	path () const
	\qmlproperty Path QtQuick::PathView::path This property holds the path used to lay out the items.

void	setPath (QQuickPath *)

int	currentIndex () const
	\qmlproperty int QtQuick::PathView::currentIndex This property holds the index of the current item.

void	setCurrentIndex (int idx)

QQuickItem *	currentItem () const
	\qmlproperty Item QtQuick::PathView::currentItem This property holds the current item in the view.

qreal	offset () const
	\qmlproperty real QtQuick::PathView::offset

void	setOffset (qreal offset)

QQmlComponent *	highlight () const

void	setHighlight (QQmlComponent *highlight)

QQuickItem *	highlightItem () const
	\qmlproperty Item QtQuick::PathView::highlightItem

HighlightRangeMode	highlightRangeMode () const

void	setHighlightRangeMode (HighlightRangeMode mode)

qreal	preferredHighlightBegin () const
	\qmlproperty real QtQuick::PathView::preferredHighlightBegin \qmlproperty real QtQuick::PathView::preferredHighlightEnd \qmlproperty enumeration QtQuick::PathView::highlightRangeMode

void	setPreferredHighlightBegin (qreal)

qreal	preferredHighlightEnd () const

void	setPreferredHighlightEnd (qreal)

int	highlightMoveDuration () const
	\qmlproperty int QtQuick::PathView::highlightMoveDuration This property holds the move animation duration of the highlight delegate.

void	setHighlightMoveDuration (int)

qreal	dragMargin () const
	\qmlproperty real QtQuick::PathView::dragMargin This property holds the maximum distance from the path that initiates mouse dragging.

void	setDragMargin (qreal margin)

qreal	flickDeceleration () const
	\qmlproperty real QtQuick::PathView::flickDeceleration This property holds the rate at which a flick will decelerate.

void	setFlickDeceleration (qreal dec)

qreal	maximumFlickVelocity () const
	\qmlproperty real QtQuick::PathView::maximumFlickVelocity This property holds the approximate maximum velocity that the user can flick the view in pixels/second.

void	setMaximumFlickVelocity (qreal)

bool	isInteractive () const
	\qmlproperty bool QtQuick::PathView::interactive

void	setInteractive (bool)

bool	isMoving () const
	\qmlproperty bool QtQuick::PathView::moving

bool	isFlicking () const
	\qmlproperty bool QtQuick::PathView::flicking

bool	isDragging () const
	\qmlproperty bool QtQuick::PathView::dragging

int	count () const
	\qmlproperty int QtQuick::PathView::count This property holds the number of items in the model.

QQmlComponent *	delegate () const
	\qmlsignal QtQuick::PathView::movementStarted()

void	setDelegate (QQmlComponent *)

int	pathItemCount () const
	\qmlproperty int QtQuick::PathView::pathItemCount This property holds the number of items visible on the path at any one time.

void	setPathItemCount (int)

void	resetPathItemCount ()

int	cacheItemCount () const
	\qmlproperty int QtQuick::PathView::cacheItemCount This property holds the maximum number of items to cache off the path.

void	setCacheItemCount (int)

SnapMode	snapMode () const
	\qmlproperty enumeration QtQuick::PathView::snapMode

void	setSnapMode (SnapMode mode)

MovementDirection	movementDirection () const
	\qmlproperty enumeration QtQuick::PathView::movementDirection

void	setMovementDirection (MovementDirection dir)

Q_INVOKABLE void	positionViewAtIndex (int index, int mode)
	\qmlmethod QtQuick::PathView::positionViewAtIndex(int index, PositionMode mode)

Q_INVOKABLE int	indexAt (qreal x, qreal y) const
	\qmlmethod int QtQuick::PathView::indexAt(real x, real y)

Q_INVOKABLE QQuickItem *	itemAt (qreal x, qreal y) const
	\qmlmethod Item QtQuick::PathView::itemAt(real x, real y)

	Q_REVISION (2, 13) Q_INVOKABLE QQuickItem *itemAtIndex(int index) const

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent=nullptr)
	Constructs a QQuickItem with the given parent.

	~QQuickItem () override
	Destroys the QQuickItem.

QQuickWindow *	window () const
	Returns the window in which this item is rendered.

QQuickItem *	parentItem () 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< QQuickTransform >	transform ()

qreal	x () const

qreal	y () const

QPointF	position () const

void	setX (qreal)

void	setY (qreal)

void	setPosition (const QPointF &)

QBindable< qreal >	bindableX ()

QBindable< qreal >	bindableY ()

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< qreal >	bindableWidth ()

qreal	height () const

void	setHeight (qreal)

void	resetHeight ()

void	setImplicitHeight (qreal)

qreal	implicitHeight () const

QBindable< qreal >	bindableHeight ()

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().

QQuickItem *	viewportItem () 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.

QQuickItem *	scopedFocusItem () 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< QQuickItemGrabResult >	grabToImage (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)

QObject *	containmentMask () 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 QQuickItem *	childAt (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 QSGTextureProvider *	textureProvider () 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< 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	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`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Static Public Member Functions
static QQuickPathViewAttached *	qmlAttachedProperties (QObject *)

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)

Protected Member Functions
void	updatePolish () override
	This function should perform any layout as required for this item.

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 *) override
	This event handler can be reimplemented in a subclass to receive mouse release events for an item.

bool	childMouseEventFilter (QQuickItem , QEvent ) override
	Reimplement this method to filter the pointer events that are received by this item's children.

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.

void	componentComplete () override
	\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.

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.

virtual void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry)

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.

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	touchEvent (QTouchEvent *event)
	This event handler can be reimplemented in a subclass to receive touch events for an 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 QSGNode *	updatePaintNode (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().

	QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)

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)

Properties
QVariant	model

QQuickPath *	path

int	currentIndex

QQuickItem *	currentItem

qreal	offset

QQmlComponent *	highlight

QQuickItem *	highlightItem

qreal	preferredHighlightBegin

qreal	preferredHighlightEnd

HighlightRangeMode	highlightRangeMode

int	highlightMoveDuration

qreal	dragMargin

qreal	maximumFlickVelocity

qreal	flickDeceleration

bool	interactive

bool	moving

bool	flicking

bool	dragging

int	count

QQmlComponent *	delegate

int	pathItemCount

SnapMode	snapMode

MovementDirection	movementDirection

int	cacheItemCount

Properties inherited from QQuickItem
QQuickItem *	parent
	\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< QQuickTransform >	transform
	\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

QObject *	containmentMask
	\qmlproperty QObject* QtQuick::Item::containmentMask

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QQuickPathViewAttached

Additional Inherited Members
Public Attributes inherited from QQuickItem
const QSize &	targetSize = QSize())

qreal y	const

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 33 of file qquickpathview_p.h.

Member Enumeration Documentation

◆ HighlightRangeMode

enum QQuickPathView::HighlightRangeMode

Enumerator
NoHighlightRange
ApplyRange
StrictlyEnforceRange

Definition at line 93 of file qquickpathview_p.h.

◆ MovementDirection

enum QQuickPathView::MovementDirection

Enumerator
Shortest
Negative
Positive

Definition at line 140 of file qquickpathview_p.h.

◆ PositionMode

enum QQuickPathView::PositionMode

Enumerator
Beginning
Center
End
Contain
SnapPosition

Definition at line 145 of file qquickpathview_p.h.

◆ SnapMode

enum QQuickPathView::SnapMode

Enumerator
NoSnap
SnapToItem
SnapOneItem

Definition at line 135 of file qquickpathview_p.h.

Constructor & Destructor Documentation

◆ QQuickPathView()

QQuickPathView::QQuickPathView ( QQuickItem * parent = nullptr )

\qmltype PathView
\instantiates QQuickPathView
\inqmlmodule QtQuick
\ingroup qtquick-paths
\ingroup qtquick-views
\inherits Item
\brief Lays out model-provided items on a path.

A PathView displays data from models created from built-in QML types like ListModel
and XmlListModel, or custom model classes defined in C++ that inherit from
QAbstractListModel.

The view has a \l model, which defines the data to be displayed, and
a \l delegate, which defines how the data should be displayed.
The \l delegate is instantiated for each item on the \l path.
The items may be flicked to move them along the path.

For example, if there is a simple list model defined in a file \c ContactModel.qml like this:

\snippet qml/pathview/ContactModel.qml 0

This data can be represented as a PathView, like this:

\snippet qml/pathview/pathview.qml 0

\image pathview.gif

(Note the above example uses PathAttribute to scale and modify the
opacity of the items as they rotate. This additional code can be seen in the
PathAttribute documentation.)

PathView does not automatically handle keyboard navigation.  This is because
the keys to use for navigation will depend upon the shape of the path.  Navigation
can be added quite simply by setting \c focus to \c true and calling
\l decrementCurrentIndex() or \l incrementCurrentIndex(), for example to navigate
using the left and right arrow keys:

\qml
PathView {

... focus: true Keys.onLeftPressed: decrementCurrentIndex() Keys.onRightPressed: incrementCurrentIndex() } \endqml

The path view itself is a focus scope (see \l{Keyboard Focus in Qt Quick} for more details).

Delegates are instantiated as needed and may be destroyed at any time. State should never be stored in a delegate.

PathView attaches a number of properties to the root item of the delegate, for example {PathView.isCurrentItem}. In the following example, the root delegate item can access this attached property directly as PathView.isCurrentItem, while the child nameText object must refer to this property as wrapper.PathView.isCurrentItem.

    Component {
        id: delegate
        Column {
            id: wrapper
 
            required property url icon
            required property string name
 
            opacity: PathView.isCurrentItem ? 1 : 0.5
 
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: wrapper.icon
            }
            Text {
                id: nameText
                text: wrapper.name
                font.pointSize: 16
            }
        }
    }

Note that views do not enable clip automatically. If the view is not clipped by another item or the screen, it will be necessary to set {clip: true} in order to have the out of view items clipped nicely.

See also: Path, {QML Data Models}, ListView, GridView, {Qt Quick Examples - Views}

Definition at line 521 of file qquickpathview.cpp.

References d.

◆ ~QQuickPathView()

QQuickPathView::~QQuickPathView ( )

virtual

Definition at line 528 of file qquickpathview.cpp.

References d.

Member Function Documentation

◆ cacheItemCount()

int QQuickPathView::cacheItemCount ( ) const

\qmlproperty int QtQuick::PathView::cacheItemCount This property holds the maximum number of items to cache off the path.

For example, a PathView with a model containing 20 items, a pathItemCount of 10, and an cacheItemCount of 4 will create up to 14 items, with 10 visible on the path and 4 invisible cached items.

The cached delegates are created asynchronously, allowing creation to occur across multiple frames and reducing the likelihood of skipping frames.

Note: Setting this property is not a replacement for creating efficient delegates. It can improve the smoothness of scrolling behavior at the expense of additional memory usage. The fewer objects and bindings in a delegate, the faster a view can be scrolled. It is important to realize that setting cacheItemCount will only postpone issues caused by slow-loading delegates, it is not a solution for this scenario.

See also: pathItemCount

Definition at line 1302 of file qquickpathview.cpp.

References d.

◆ cacheItemCountChanged

void QQuickPathView::cacheItemCountChanged ( )

signal

Referenced by setCacheItemCount().

Here is the caller graph for this function:

◆ childMouseEventFilter()

bool QQuickPathView::childMouseEventFilter	(	QQuickItem *	item,
		QEvent *	event )

overrideprotectedvirtual

Reimplement this method to filter the pointer events that are received by this item's children.

This method will only be called if filtersChildMouseEvents() is true.

Return true if the specified event should not be passed on to the specified child item, and false otherwise. If you return true, you should also \l {QEvent::accept()}{accept} or \l {QEvent::ignore()}{ignore} the event, to signal if event propagation should stop or continue. The event will, however, always be sent to all childMouseEventFilters up the parent chain.

Note: Despite the name, this function filters all QPointerEvent instances during delivery to all children (typically mouse, touch, and tablet events). When overriding this function in a subclass, we suggest writing generic event-handling code using only the accessors found in QPointerEvent. Alternatively you can switch on event->type() and/or event->device()->type() to handle different event types in different ways.; Filtering is just one way to share responsibility in case of gestural ambiguity (for example on press, you don't know whether the user will tap or drag). Another way is to call QPointerEvent::addPassiveGrabber() on press, so as to non-exclusively monitor the progress of the QEventPoint. In either case, the item or pointer handler that is monitoring can steal the exclusive grab later on, when it becomes clear that the gesture fits the pattern that it is expecting.

See also: setFiltersChildMouseEvents()

Reimplemented from QQuickItem.

Definition at line 1824 of file qquickpathview.cpp.

References QQuickItem::childMouseEventFilter(), QQuickItem::contains(), d, QList< T >::first(), i, QQuickDeliveryAgentPrivate::isMouseEvent(), QEvent::isPointerEvent(), QQuickItem::isVisible(), QQuickItem::mapFromScene(), QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseMove, QPointerEvent::points(), and qmlobject_cast< QQuickItem * >().

Here is the call graph for this function:

◆ componentComplete()

void QQuickPathView::componentComplete ( )

overrideprotectedvirtual

\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.

Reimplemented from QQuickItem.

Definition at line 1917 of file qquickpathview.cpp.

References QQuickItem::componentComplete(), componentComplete(), countChanged(), currentIndexRemainder(), d, and emit.

Referenced by componentComplete(), setDelegate(), and setModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ count()

int QQuickPathView::count ( ) const

\qmlproperty int QtQuick::PathView::count This property holds the number of items in the model.

Definition at line 670 of file qquickpathview.cpp.

References d.

◆ countChanged

void QQuickPathView::countChanged ( )

signal

Referenced by componentComplete(), setDelegate(), and setModel().

Here is the caller graph for this function:

◆ currentIndex()

int QQuickPathView::currentIndex ( ) const

\qmlproperty int QtQuick::PathView::currentIndex This property holds the index of the current item.

Definition at line 720 of file qquickpathview.cpp.

References d.

◆ currentIndexChanged

void QQuickPathView::currentIndexChanged ( )

signal

Referenced by setCurrentIndex(), and setModel().

Here is the caller graph for this function:

◆ currentItem()

QQuickItem * QQuickPathView::currentItem ( ) const

\qmlproperty Item QtQuick::PathView::currentItem This property holds the current item in the view.

Definition at line 769 of file qquickpathview.cpp.

References d.

◆ currentItemChanged

void QQuickPathView::currentItemChanged ( )

signal

Referenced by setCurrentIndex().

Here is the caller graph for this function:

◆ decrementCurrentIndex

void QQuickPathView::decrementCurrentIndex ( )

slot

\qmlmethod QtQuick::PathView::decrementCurrentIndex()

Decrements the current index.

Note: methods should only be called after the Component has completed.

Definition at line 796 of file qquickpathview.cpp.

References currentIndex, d, Negative, and setCurrentIndex().

Here is the call graph for this function:

◆ delegate()

QQmlComponent * QQuickPathView::delegate ( ) const

\qmlsignal QtQuick::PathView::movementStarted()

This signal is emitted when the view begins moving due to user interaction.

\qmlsignal QtQuick::PathView::movementEnded()

This signal is emitted when the view stops moving due to user interaction. If a flick was generated, this signal will be emitted once the flick stops. If a flick was not generated, this signal will be emitted when the user stops dragging - i.e. a mouse or touch release.

\qmlsignal QtQuick::PathView::flickStarted()

This signal is emitted when the view is flicked. A flick starts from the point that the mouse or touch is released, while still in motion.

\qmlsignal QtQuick::PathView::flickEnded()

This signal is emitted when the view stops moving due to a flick.

\qmlsignal QtQuick::PathView::dragStarted()

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

\qmlsignal QtQuick::PathView::dragEnded()

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

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

\qmlproperty Component QtQuick::PathView::delegate

The delegate provides a template defining each item instantiated by the view. The index is exposed as an accessible index property. Properties of the model are also available depending upon the type of \l {qml-data-models}{Data Model}.

The number of objects and bindings in the delegate has a direct effect on the flicking performance of the view when pathItemCount is specified. If at all possible, place functionality that is not needed for the normal display of the delegate in a \l Loader which can load additional components when needed.

Note that the PathView will layout the items based on the size of the root item in the delegate.

Here is an example delegate:

    Component {
        id: delegate
        Column {
            id: wrapper
 
            required property url icon
            required property string name
 
            opacity: PathView.isCurrentItem ? 1 : 0.5
 
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: wrapper.icon
            }
            Text {
                id: nameText
                text: wrapper.name
                font.pointSize: 16
            }
        }
    }

Definition at line 1208 of file qquickpathview.cpp.

References d.

◆ delegateChanged

void QQuickPathView::delegateChanged ( )

signal

Referenced by setDelegate().

Here is the caller graph for this function:

◆ dragEnded

void QQuickPathView::dragEnded ( )

signal

◆ draggingChanged

void QQuickPathView::draggingChanged ( )

signal

◆ dragMargin()

qreal QQuickPathView::dragMargin ( ) const

\qmlproperty real QtQuick::PathView::dragMargin This property holds the maximum distance from the path that initiates mouse dragging.

By default the path can only be dragged by clicking on an item. If dragMargin is greater than zero, a drag can be initiated by clicking within dragMargin pixels of the path.

Definition at line 1024 of file qquickpathview.cpp.

References d.

◆ dragMarginChanged

void QQuickPathView::dragMarginChanged ( )

signal

Referenced by setDragMargin().

Here is the caller graph for this function:

◆ dragStarted

void QQuickPathView::dragStarted ( )

signal

◆ flickDeceleration()

qreal QQuickPathView::flickDeceleration ( ) const

\qmlproperty real QtQuick::PathView::flickDeceleration This property holds the rate at which a flick will decelerate.

The default is 100.

Definition at line 1045 of file qquickpathview.cpp.

References d.

◆ flickDecelerationChanged

void QQuickPathView::flickDecelerationChanged ( )

signal

Referenced by setFlickDeceleration().

Here is the caller graph for this function:

◆ flickEnded

void QQuickPathView::flickEnded ( )

signal

◆ flickingChanged

void QQuickPathView::flickingChanged ( )

signal

◆ flickStarted

void QQuickPathView::flickStarted ( )

signal

◆ highlight()

QQmlComponent * QQuickPathView::highlight ( ) const

\qmlproperty Component QtQuick::PathView::highlight
This property holds the component to use as the highlight.

An instance of the highlight component will be created for each view.
The geometry of the resultant component instance will be managed by the view
so as to stay with the current item.

The below example demonstrates how to make a simple highlight.  Note the use
of the \l{PathView::onPath}{PathView.onPath} attached property to ensure that
the highlight is hidden when flicked away from the path.

\qml
Component {
    Rectangle {
        visible: PathView.onPath

... } } \endqml

See also: highlightItem, highlightRangeMode

Definition at line 869 of file qquickpathview.cpp.

References d.

◆ highlightChanged

void QQuickPathView::highlightChanged ( )

signal

Referenced by setHighlight().

Here is the caller graph for this function:

◆ highlightItem()

QQuickItem * QQuickPathView::highlightItem ( ) const

\qmlproperty Item QtQuick::PathView::highlightItem

highlightItem holds the highlight item, which was created from the \l highlight component.

See also: highlight

Definition at line 894 of file qquickpathview.cpp.

References d.

◆ highlightItemChanged

void QQuickPathView::highlightItemChanged ( )

signal

◆ highlightMoveDuration()

int QQuickPathView::highlightMoveDuration ( ) const

\qmlproperty int QtQuick::PathView::highlightMoveDuration This property holds the move animation duration of the highlight delegate.

If the highlightRangeMode is StrictlyEnforceRange then this property determines the speed that the items move along the path.

The default value for the duration is 300ms.

Definition at line 1001 of file qquickpathview.cpp.

References d.

◆ highlightMoveDurationChanged

void QQuickPathView::highlightMoveDurationChanged ( )

signal

Referenced by setHighlightMoveDuration().

Here is the caller graph for this function:

◆ highlightRangeMode()

QQuickPathView::HighlightRangeMode QQuickPathView::highlightRangeMode ( ) const

Definition at line 970 of file qquickpathview.cpp.

References d.

◆ highlightRangeModeChanged

void QQuickPathView::highlightRangeModeChanged ( )

signal

Referenced by setHighlightRangeMode().

Here is the caller graph for this function:

◆ incrementCurrentIndex

void QQuickPathView::incrementCurrentIndex ( )

slot

\qmlmethod QtQuick::PathView::incrementCurrentIndex()

Increments the current index.

Note: methods should only be called after the Component has completed.

Definition at line 782 of file qquickpathview.cpp.

References currentIndex, d, Positive, and setCurrentIndex().

Here is the call graph for this function:

◆ indexAt()

int QQuickPathView::indexAt	(	qreal	x,
		qreal	y ) const

\qmlmethod int QtQuick::PathView::indexAt(real x, real y)

Returns the index of the item containing the point x, y in content coordinates. If there is no item at the point specified, -1 is returned.

Note: methods should only be called after the Component has completed.

Definition at line 1487 of file qquickpathview.cpp.

References d, item, and itemAt().

Here is the call graph for this function:

◆ interactiveChanged

void QQuickPathView::interactiveChanged ( )

signal

Referenced by setInteractive().

Here is the caller graph for this function:

◆ isDragging()

bool QQuickPathView::isDragging ( ) const

\qmlproperty bool QtQuick::PathView::dragging

This property holds whether the view is currently moving due to the user dragging the view.

Definition at line 1137 of file qquickpathview.cpp.

References d.

◆ isFlicking()

bool QQuickPathView::isFlicking ( ) const

\qmlproperty bool QtQuick::PathView::flicking

This property holds whether the view is currently moving due to the user flicking the view.

Definition at line 1125 of file qquickpathview.cpp.

References d.

◆ isInteractive()

bool QQuickPathView::isInteractive ( ) const

\qmlproperty bool QtQuick::PathView::interactive

A user cannot drag or flick a PathView that is not interactive.

This property is useful for temporarily disabling flicking. This allows special interaction with PathView's children.

Definition at line 1090 of file qquickpathview.cpp.

References d.

◆ isMoving()

bool QQuickPathView::isMoving ( ) const

\qmlproperty bool QtQuick::PathView::moving

This property holds whether the view is currently moving due to the user either dragging or flicking the view.

Definition at line 1113 of file qquickpathview.cpp.

References d.

◆ itemAt()

QQuickItem * QQuickPathView::itemAt	(	qreal	x,
		qreal	y ) const

\qmlmethod Item QtQuick::PathView::itemAt(real x, real y)

Returns the item containing the point x, y in content coordinates. If there is no item at the point specified, null is returned.

Note: methods should only be called after the Component has completed.

Definition at line 1502 of file qquickpathview.cpp.

References QGraphicsItem::contains(), d, item, and QGraphicsItem::mapFromItem().

Referenced by indexAt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maximumFlickVelocity()

qreal QQuickPathView::maximumFlickVelocity ( ) const

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

The default value is platform dependent.

Definition at line 1066 of file qquickpathview.cpp.

References d.

◆ maximumFlickVelocityChanged

void QQuickPathView::maximumFlickVelocityChanged ( )

signal

Referenced by setMaximumFlickVelocity().

Here is the caller graph for this function:

◆ model()

QVariant QQuickPathView::model ( ) const

\qmlattachedproperty PathView QtQuick::PathView::view \readonly

This attached property holds the view that manages this delegate instance.

It is attached to each instance of the delegate.

\qmlattachedproperty bool QtQuick::PathView::onPath
\readonly

This attached property holds whether the item is currently on the path.

If a pathItemCount has been set, it is possible that some items may
be instantiated, but not considered to be currently on the path.
Usually, these items would be set invisible, for example:

\qml
Component {
    Rectangle {
        visible: PathView.onPath

... } } \endqml

It is attached to each instance of the delegate.

\qmlattachedproperty bool QtQuick::PathView::isCurrentItem \readonly

This attached property is true if this delegate is the current item; otherwise false.

It is attached to each instance of the delegate.

This property may be used to adjust the appearance of the current item.

    Component {
        id: delegate
        Column {
            id: wrapper
 
            required property url icon
            required property string name
 
            opacity: PathView.isCurrentItem ? 1 : 0.5
 
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: wrapper.icon
            }
            Text {
                id: nameText
                text: wrapper.name
                font.pointSize: 16
            }
        }
    }

\qmlproperty model QtQuick::PathView::model This property holds the model providing data for the view.

The model provides a set of data that is used to create the items for the view. For large or dynamic datasets the model is usually provided by a C++ model object. Models can also be created directly in QML, using the ListModel type.

Note: changing the model will reset the offset and currentIndex to 0.

See also: {qml-data-models}{Data Models}

Definition at line 594 of file qquickpathview.cpp.

References d.

◆ modelChanged

void QQuickPathView::modelChanged ( )

signal

Referenced by setModel().

Here is the caller graph for this function:

◆ mouseMoveEvent()

void QQuickPathView::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 1670 of file qquickpathview.cpp.

References d, and QQuickItem::mouseMoveEvent().

Here is the call graph for this function:

◆ mousePressEvent()

void QQuickPathView::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 1623 of file qquickpathview.cpp.

References d, and QQuickItem::mousePressEvent().

Here is the call graph for this function:

◆ mouseReleaseEvent()

void QQuickPathView::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 1732 of file qquickpathview.cpp.

References d, QQuickItem::mouseReleaseEvent(), and QQuickItem::ungrabMouse().

Here is the call graph for this function:

◆ mouseUngrabEvent()

void QQuickPathView::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 1886 of file qquickpathview.cpp.

References d, NoSnap, qFuzzyCompare(), qRound(), and QQuickItem::setKeepMouseGrab().

Here is the call graph for this function:

◆ movementDirection()

QQuickPathView::MovementDirection QQuickPathView::movementDirection ( ) const

\qmlproperty enumeration QtQuick::PathView::movementDirection

Since: 5.7

This property determines the direction in which items move when setting the current index. The possible values are:

\value PathView.Shortest (default) the items move in the direction that requires the least movement, which could be either Negative or Positive. \value PathView.Negative the items move backwards towards their destination. \value PathView.Positive the items move forwards towards their destination.

For example, suppose that there are 5 items in the model, and \l currentIndex is 0. If currentIndex is set to 2,

\list

a Positive movement direction will result in the following order: 0, 1, 2
a Negative movement direction will result in the following order: 0, 5, 4, 3, 2
a Shortest movement direction will result in same order with Positive . \endlist

Note: this property doesn't affect the movement of \l incrementCurrentIndex() and \l decrementCurrentIndex().

Definition at line 1376 of file qquickpathview.cpp.

References d.

◆ movementEnded

void QQuickPathView::movementEnded ( )

signal

◆ movementStarted

void QQuickPathView::movementStarted ( )

signal

◆ movingChanged

void QQuickPathView::movingChanged ( )

signal

◆ offset()

qreal QQuickPathView::offset ( ) const

\qmlproperty real QtQuick::PathView::offset

The offset specifies how far along the path the items are from their initial positions. This is a real number that ranges from 0 to the count of items in the model.

Definition at line 809 of file qquickpathview.cpp.

References d.

◆ offsetChanged

void QQuickPathView::offsetChanged ( )

signal

Referenced by setModel().

Here is the caller graph for this function:

◆ path()

QQuickPath * QQuickPathView::path ( ) const

\qmlproperty Path QtQuick::PathView::path This property holds the path used to lay out the items.

For more information see the \l Path documentation.

Definition at line 681 of file qquickpathview.cpp.

References d.

◆ pathChanged

void QQuickPathView::pathChanged ( )

signal

Referenced by setPath().

Here is the caller graph for this function:

◆ pathItemCount()

int QQuickPathView::pathItemCount ( ) const

\qmlproperty int QtQuick::PathView::pathItemCount This property holds the number of items visible on the path at any one time.

Setting pathItemCount to undefined will show all items on the path.

Definition at line 1248 of file qquickpathview.cpp.

References d.

◆ pathItemCountChanged

void QQuickPathView::pathItemCountChanged ( )

signal

Referenced by resetPathItemCount(), and setPathItemCount().

Here is the caller graph for this function:

◆ positionViewAtIndex()

void QQuickPathView::positionViewAtIndex	(	int	index,
		int	mode )

\qmlmethod QtQuick::PathView::positionViewAtIndex(int index, PositionMode mode)

Positions the view such that the index is at the position specified by mode:

\value PathView.Beginning position item at the beginning of the path. \value PathView.Center position item in the center of the path. \value PathView.End position item at the end of the path. \value PathView.Contain ensure the item is positioned on the path. \value PathView.SnapPosition position the item at \l preferredHighlightBegin. This mode is only valid if \l highlightRangeMode is StrictlyEnforceRange or snapping is enabled via \l snapMode.

Note: methods should only be called after the Component has completed. To position the view at startup, this method should be called by Component.onCompleted. For example, to position the view at the end:

Component.onCompleted: positionViewAtIndex(count - 1, PathView.End)

QQuickPathView::positionViewAtIndex

Q_INVOKABLE void positionViewAtIndex(int index, int mode)

\qmlmethod QtQuick::PathView::positionViewAtIndex(int index, PositionMode mode)

Definition qquickpathview.cpp:1415

count

GLenum GLenum GLsizei count

Definition qopengles2ext.h:150

Definition at line 1415 of file qquickpathview.cpp.

References Beginning, Center, Contain, d, End, NoHighlightRange, NoSnap, qFloor(), qMin(), qRound(), setOffset(), and SnapPosition.

Here is the call graph for this function:

◆ preferredHighlightBegin()

qreal QQuickPathView::preferredHighlightBegin ( ) const

\qmlproperty real QtQuick::PathView::preferredHighlightBegin \qmlproperty real QtQuick::PathView::preferredHighlightEnd \qmlproperty enumeration QtQuick::PathView::highlightRangeMode

These properties set the preferred range of the highlight (current item) within the view. The preferred values must be in the range from 0 to 1.

Valid values for highlightRangeMode are:

\value PathView.NoHighlightRange no range is applied: the highlight will move freely within the view. \value PathView.ApplyRange the view will attempt to maintain the highlight within the range, however the highlight can move outside of the range at the ends of the path or due to a mouse interaction. \value PathView.StrictlyEnforceRange the highlight will never move outside of the range. This means that the current item will change if a keyboard or mouse action would cause the highlight to move outside of the range.

The default value is PathView.StrictlyEnforceRange.

Defining a highlight range is the correct way to influence where the current item ends up when the view moves. For example, if you want the currently selected item to be in the middle of the path, then set the highlight range to be 0.5,0.5 and highlightRangeMode to PathView.StrictlyEnforceRange. Then, when the path scrolls, the currently selected item will be the item at that position. This also applies to when the currently selected item changes - it will scroll to within the preferred highlight range. Furthermore, the behaviour of the current item index will occur whether or not a highlight exists.

Note: A valid range requires preferredHighlightEnd to be greater than or equal to preferredHighlightBegin.

Definition at line 936 of file qquickpathview.cpp.

References d.

◆ preferredHighlightBeginChanged

void QQuickPathView::preferredHighlightBeginChanged ( )

signal

Referenced by setPreferredHighlightBegin().

Here is the caller graph for this function:

◆ preferredHighlightEnd()

qreal QQuickPathView::preferredHighlightEnd ( ) const

Definition at line 953 of file qquickpathview.cpp.

References d.

◆ preferredHighlightEndChanged

void QQuickPathView::preferredHighlightEndChanged ( )

signal

Referenced by setPreferredHighlightEnd().

Here is the caller graph for this function:

◆ Q_REVISION() [1/2]

QQuickPathView::Q_REVISION	(	2	,
		13	) const

◆ Q_REVISION [2/2]

QQuickPathView::Q_REVISION	(	2	,
		7	)

signal

◆ qmlAttachedProperties()

QQuickPathViewAttached * QQuickPathView::qmlAttachedProperties ( QObject * obj )

static

Definition at line 2434 of file qquickpathview.cpp.

References QQuickPathViewAttached.

◆ resetPathItemCount()

void QQuickPathView::resetPathItemCount ( )

Definition at line 1269 of file qquickpathview.cpp.

References d, emit, QQuickItem::isComponentComplete(), and pathItemCountChanged().

Here is the call graph for this function:

◆ setCacheItemCount()

void QQuickPathView::setCacheItemCount ( int i )

Definition at line 1308 of file qquickpathview.cpp.

References cacheItemCountChanged(), d, emit, and i.

Here is the call graph for this function:

◆ setCurrentIndex()

void QQuickPathView::setCurrentIndex ( int idx )

Definition at line 726 of file qquickpathview.cpp.

References currentIndexChanged(), currentItemChanged(), d, emit, QQuickItem::isComponentComplete(), QQuickPathViewPrivate::SetIndex, QQuickPathViewAttached::setIsCurrentItem(), and StrictlyEnforceRange.

Referenced by decrementCurrentIndex(), and incrementCurrentIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDelegate()

void QQuickPathView::setDelegate ( QQmlComponent * delegate )

Definition at line 1219 of file qquickpathview.cpp.

References componentComplete(), QQmlDelegateModel::count(), countChanged(), d, delegate, delegateChanged(), emit, QQuickItem::isComponentComplete(), and qmlContext().

Here is the call graph for this function:

◆ setDragMargin()

void QQuickPathView::setDragMargin ( qreal margin )

Definition at line 1030 of file qquickpathview.cpp.

References d, dragMargin, dragMarginChanged(), emit, and qFuzzyCompare().

Here is the call graph for this function:

◆ setFlickDeceleration()

void QQuickPathView::setFlickDeceleration ( qreal dec )

Definition at line 1051 of file qquickpathview.cpp.

References d, dec, emit, flickDecelerationChanged(), and qFuzzyCompare().

Here is the call graph for this function:

◆ setHighlight()

void QQuickPathView::setHighlight ( QQmlComponent * highlight )

Definition at line 875 of file qquickpathview.cpp.

References d, emit, highlight, and highlightChanged().

Here is the call graph for this function:

◆ setHighlightMoveDuration()

void QQuickPathView::setHighlightMoveDuration ( int duration )

Definition at line 1007 of file qquickpathview.cpp.

References d, emit, and highlightMoveDurationChanged().

Here is the call graph for this function:

◆ setHighlightRangeMode()

void QQuickPathView::setHighlightRangeMode ( HighlightRangeMode mode )

Definition at line 976 of file qquickpathview.cpp.

References d, emit, highlightRangeModeChanged(), NoHighlightRange, and QQuickPathViewPrivate::Other.

Here is the call graph for this function:

◆ setInteractive()

void QQuickPathView::setInteractive ( bool interactive )

Definition at line 1096 of file qquickpathview.cpp.

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

Here is the call graph for this function:

◆ setMaximumFlickVelocity()

void QQuickPathView::setMaximumFlickVelocity ( qreal vel )

Definition at line 1072 of file qquickpathview.cpp.

References d, emit, maximumFlickVelocityChanged(), and qFuzzyCompare().

Here is the call graph for this function:

◆ setModel()

void QQuickPathView::setModel ( const QVariant & m )

Definition at line 600 of file qquickpathview.cpp.

References componentComplete(), countChanged(), currentIndexChanged(), d, emit, QQuickItem::isComponentComplete(), model, modelChanged(), offsetChanged(), qFuzzyIsNull(), qmlContext(), qmlobject_connect, qmlobject_disconnect, QQmlDelegateModel::setModel(), SIGNAL, SLOT, toVariant(), QVariant::userType(), and QVariant::value().

Here is the call graph for this function:

◆ setMovementDirection()

void QQuickPathView::setMovementDirection ( QQuickPathView::MovementDirection dir )

Definition at line 1382 of file qquickpathview.cpp.

References d, dir, and emit.

◆ setOffset()

void QQuickPathView::setOffset ( qreal offset )

Definition at line 815 of file qquickpathview.cpp.

References d, and QQuickPathViewPrivate::Other.

Referenced by positionViewAtIndex().

Here is the caller graph for this function:

◆ setPath()

void QQuickPathView::setPath ( QQuickPath * path )

Definition at line 687 of file qquickpathview.cpp.

References d, emit, QQuickItem::isComponentComplete(), path, pathChanged(), qmlobject_connect, qmlobject_disconnect, SIGNAL, and SLOT.

Here is the call graph for this function:

◆ setPathItemCount()

void QQuickPathView::setPathItemCount ( int i )

Definition at line 1254 of file qquickpathview.cpp.

References d, emit, i, QQuickItem::isComponentComplete(), and pathItemCountChanged().

Here is the call graph for this function:

◆ setPreferredHighlightBegin()

void QQuickPathView::setPreferredHighlightBegin ( qreal start )

Definition at line 942 of file qquickpathview.cpp.

References d, emit, preferredHighlightBeginChanged(), and qFuzzyCompare().

Here is the call graph for this function:

◆ setPreferredHighlightEnd()

void QQuickPathView::setPreferredHighlightEnd ( qreal end )

Definition at line 959 of file qquickpathview.cpp.

References d, emit, preferredHighlightEndChanged(), and qFuzzyCompare().

Here is the call graph for this function:

◆ setSnapMode()

void QQuickPathView::setSnapMode ( SnapMode mode )

Definition at line 1344 of file qquickpathview.cpp.

References d, emit, and snapModeChanged().

Here is the call graph for this function:

◆ snapMode()

QQuickPathView::SnapMode QQuickPathView::snapMode ( ) const

\qmlproperty enumeration QtQuick::PathView::snapMode

This property determines how the items will settle following a drag or flick. The possible values are:

\value PathView.NoSnap (default) the items stop anywhere along the path. \value PathView.SnapToItem the items settle with an item aligned with the \l preferredHighlightBegin. \value PathView.SnapOneItem the items settle no more than one item away from the item nearest \l preferredHighlightBegin at the time the press is released. This mode is particularly useful for moving one page at a time.

snapMode does not affect the \l currentIndex. To update the \l currentIndex as the view is moved, set \l highlightRangeMode to PathView.StrictlyEnforceRange (default for PathView).

See also: highlightRangeMode

Definition at line 1338 of file qquickpathview.cpp.

References d.

◆ snapModeChanged

void QQuickPathView::snapModeChanged ( )

signal

Referenced by setSnapMode().

Here is the caller graph for this function:

◆ snapPositionChanged

void QQuickPathView::snapPositionChanged ( )

signal

◆ updatePolish()

void QQuickPathView::updatePolish ( )

overrideprotectedvirtual

This function should perform any layout as required for this item.

When polish() is called, the scene graph schedules a polish event for this item. When the scene graph is ready to render this item, it calls updatePolish() to do any item layout as required before it renders the next frame.

See also: ensurePolished()

Reimplemented from QQuickItem.

Definition at line 1903 of file qquickpathview.cpp.

References QQuickItem::updatePolish().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QQuickPathViewAttached

friend class QQuickPathViewAttached

friend

Definition at line 211 of file qquickpathview_p.h.

Referenced by qmlAttachedProperties().

Property Documentation

◆ cacheItemCount

int QQuickPathView::cacheItemCount

readwrite

Definition at line 66 of file qquickpathview_p.h.

◆ count

int QQuickPathView::count

read

Definition at line 60 of file qquickpathview_p.h.

◆ currentIndex

int QQuickPathView::currentIndex

readwrite

Definition at line 39 of file qquickpathview_p.h.

Referenced by decrementCurrentIndex(), and incrementCurrentIndex().

◆ currentItem

QQuickItem * QQuickPathView::currentItem

read

Definition at line 40 of file qquickpathview_p.h.

◆ delegate

QQmlComponent * QQuickPathView::delegate

readwrite

Definition at line 61 of file qquickpathview_p.h.

Referenced by setDelegate().

◆ dragging

bool QQuickPathView::dragging

read

Definition at line 58 of file qquickpathview_p.h.

◆ dragMargin

qreal QQuickPathView::dragMargin

readwrite

Definition at line 51 of file qquickpathview_p.h.

Referenced by setDragMargin().

◆ flickDeceleration

qreal QQuickPathView::flickDeceleration

readwrite

Definition at line 53 of file qquickpathview_p.h.

◆ flicking

bool QQuickPathView::flicking

read

Definition at line 57 of file qquickpathview_p.h.

◆ highlight

QQmlComponent * QQuickPathView::highlight

readwrite

Definition at line 43 of file qquickpathview_p.h.

Referenced by setHighlight().

◆ highlightItem

QQuickItem * QQuickPathView::highlightItem

read

Definition at line 44 of file qquickpathview_p.h.

◆ highlightMoveDuration

int QQuickPathView::highlightMoveDuration

readwrite

Definition at line 49 of file qquickpathview_p.h.

◆ highlightRangeMode

HighlightRangeMode QQuickPathView::highlightRangeMode

readwrite

Definition at line 48 of file qquickpathview_p.h.

◆ interactive

bool QQuickPathView::interactive

readwrite

Definition at line 54 of file qquickpathview_p.h.

Referenced by setInteractive().

◆ maximumFlickVelocity

qreal QQuickPathView::maximumFlickVelocity

readwrite

Definition at line 52 of file qquickpathview_p.h.

◆ model

QVariant QQuickPathView::model

readwrite

Definition at line 37 of file qquickpathview_p.h.

Referenced by setModel().

◆ movementDirection

MovementDirection QQuickPathView::movementDirection

readwrite

Definition at line 64 of file qquickpathview_p.h.

◆ moving

bool QQuickPathView::moving

read

Definition at line 56 of file qquickpathview_p.h.

◆ offset

qreal QQuickPathView::offset

readwrite

Definition at line 41 of file qquickpathview_p.h.

◆ path

QQuickPath * QQuickPathView::path

readwrite

Definition at line 38 of file qquickpathview_p.h.

Referenced by setPath().

◆ pathItemCount

int QQuickPathView::pathItemCount

readwrite

Definition at line 62 of file qquickpathview_p.h.

◆ preferredHighlightBegin

qreal QQuickPathView::preferredHighlightBegin

readwrite

Definition at line 46 of file qquickpathview_p.h.

◆ preferredHighlightEnd

qreal QQuickPathView::preferredHighlightEnd

readwrite

Definition at line 47 of file qquickpathview_p.h.

◆ snapMode

SnapMode QQuickPathView::snapMode

readwrite

Definition at line 63 of file qquickpathview_p.h.

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

qtdeclarative/src/quick/items/qquickpathview_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/items/qquickpathview.cpp (b31bfde4bd840a94cdd4b2223e8f7c345850bd66)

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HighlightRangeMode

◆ MovementDirection

◆ PositionMode

◆ SnapMode

Constructor & Destructor Documentation

◆ QQuickPathView()

◆ ~QQuickPathView()

Member Function Documentation

◆ cacheItemCount()

◆ cacheItemCountChanged

◆ childMouseEventFilter()

◆ componentComplete()

◆ count()

◆ countChanged

◆ currentIndex()

◆ currentIndexChanged

◆ currentItem()

◆ currentItemChanged

◆ decrementCurrentIndex

◆ delegate()

◆ delegateChanged

◆ dragEnded

◆ draggingChanged

◆ dragMargin()

◆ dragMarginChanged

◆ dragStarted

◆ flickDeceleration()

◆ flickDecelerationChanged

◆ flickEnded

◆ flickingChanged

◆ flickStarted

◆ highlight()

◆ highlightChanged

◆ highlightItem()

◆ highlightItemChanged

◆ highlightMoveDuration()

◆ highlightMoveDurationChanged

◆ highlightRangeMode()

◆ highlightRangeModeChanged

◆ incrementCurrentIndex

◆ indexAt()

◆ interactiveChanged

◆ isDragging()

◆ isFlicking()

◆ isInteractive()

◆ isMoving()

◆ itemAt()

◆ maximumFlickVelocity()

◆ maximumFlickVelocityChanged

◆ model()

◆ modelChanged

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ mouseUngrabEvent()

◆ movementDirection()

◆ movementEnded

◆ movementStarted

◆ movingChanged

◆ offset()

◆ offsetChanged

◆ path()

◆ pathChanged

◆ pathItemCount()

◆ pathItemCountChanged

◆ positionViewAtIndex()

◆ preferredHighlightBegin()

◆ preferredHighlightBeginChanged

◆ preferredHighlightEnd()