#include <qquickpath_p.h>

Inheritance diagram for QQuickPathAttribute:

Collaboration diagram for QQuickPathAttribute:

Signals
void	nameChanged ()

void	valueChanged ()

Signals inherited from QQuickPathElement
void	changed ()

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
	QQuickPathAttribute (QObject *parent=nullptr)

QString	name () const
	\qmltype PathAttribute \instantiates QQuickPathAttribute \inqmlmodule QtQuick

void	setName (const QString &name)

qreal	value () const
	\qmlproperty real QtQuick::PathAttribute::value This property holds the value for the attribute.

void	setValue (qreal value)

Public Member Functions inherited from QQuickPathElement
	QQuickPathElement (QObject *parent=nullptr)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

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

Properties
QString	name

qreal	value

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

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 54 of file qquickpath_p.h.

Constructor & Destructor Documentation

◆ QQuickPathAttribute()

QQuickPathAttribute::QQuickPathAttribute ( QObject * parent = nullptr )

inline

Definition at line 63 of file qquickpath_p.h.

Member Function Documentation

◆ name()

QString QQuickPathAttribute::name ( ) const

\qmltype PathAttribute \instantiates QQuickPathAttribute \inqmlmodule QtQuick

Specifies how to set an attribute at a given position in a Path.

The PathAttribute object allows attributes consisting of a name and a value to be specified for various points along a path. The attributes are exposed to the delegate as \l{Attached Properties and Attached Signal Handlers} {Attached Properties}. The value of an attribute at any particular point along the path is interpolated from the PathAttributes bounding that point.

The example below shows a path with the items scaled to 30% with opacity 50% at the top of the path and scaled 100% with opacity 100% at the bottom. Note the use of the PathView.iconScale and PathView.iconOpacity attached properties to set the scale and opacity of the delegate.

\table \row

import QtQuick

Rectangle {

width: 240; height: 200

//! [1]

Component {

id: delegate

Item {

width: 80; height: 80

scale: PathView.iconScale

opacity: PathView.iconOpacity

Column {

Image { anchors.horizontalCenter: nameText.horizontalCenter; width: 64; height: 64; source: icon }

Text { id: nameText; text: name; font.pointSize: 16 }

}

}

}

//! [1]

//! [2]

PathView {

anchors.fill: parent

model: ContactModel {}

delegate: delegate

path: Path {

startX: 120; startY: 100

PathAttribute { name: "iconScale"; value: 1.0 }

PathAttribute { name: "iconOpacity"; value: 1.0 }

PathQuad { x: 120; y: 25; controlX: 260; controlY: 75 }

PathAttribute { name: "iconScale"; value: 0.3 }

PathAttribute { name: "iconOpacity"; value: 0.5 }

PathQuad { x: 120; y: 100; controlX: -20; controlY: 75 }

}

}

//! [2]

}

(see the PathView documentation for the specification of ContactModel.qml used for ContactModel above.) \endtable

See also: Path

\qmlproperty string QtQuick::PathAttribute::name This property holds the name of the attribute to change.

This attribute will be available to the delegate as PathView.<name>

Note that using an existing Item property name such as "opacity" as an attribute is allowed. This is because path attributes add a new \l{Attached Properties and Attached Signal Handlers} {Attached Property} which in no way clashes with existing properties.

the name of the attribute to change.

Definition at line 1109 of file qquickpath.cpp.

◆ nameChanged

void QQuickPathAttribute::nameChanged ( )

signal

Referenced by setName().

Here is the caller graph for this function:

◆ setName()

void QQuickPathAttribute::setName ( const QString & name )

Definition at line 1114 of file qquickpath.cpp.

References emit, name, and nameChanged().

Here is the call graph for this function:

◆ setValue()

void QQuickPathAttribute::setValue ( qreal value )

Definition at line 1166 of file qquickpath.cpp.

References QQuickPathElement::changed(), emit, value, and valueChanged().

Here is the call graph for this function:

◆ value()

qreal QQuickPathAttribute::value ( ) const

\qmlproperty real QtQuick::PathAttribute::value This property holds the value for the attribute.

The value specified can be used to influence the visual appearance of an item along the path. For example, the following Path specifies an attribute named itemRotation, which has the value 0 at the beginning of the path, and the value 90 at the end of the path.

\qml Path { startX: 0 startY: 0 PathAttribute { name: "itemRotation"; value: 0 } PathLine { x: 100; y: 100 } PathAttribute { name: "itemRotation"; value: 90 } } \endqml

In our delegate, we can then bind the rotation property to the \l{Attached Properties and Attached Signal Handlers} {Attached Property} PathView.itemRotation created for this attribute.

\qml Rectangle { width: 10; height: 10 rotation: PathView.itemRotation } \endqml

As each item is positioned along the path, it will be rotated accordingly: an item at the beginning of the path with be not be rotated, an item at the end of the path will be rotated 90 degrees, and an item mid-way along the path will be rotated 45 degrees.

the new value of the attribute.

Definition at line 1161 of file qquickpath.cpp.

◆ valueChanged

void QQuickPathAttribute::valueChanged ( )

signal

Referenced by setValue().

Here is the caller graph for this function:

Property Documentation

◆ name

QString QQuickPathAttribute::name

readwrite

Definition at line 58 of file qquickpath_p.h.

Referenced by setName().

◆ value

qreal QQuickPathAttribute::value