#include <qquickitemanimation_p.h>

Inheritance diagram for QQuickParentAnimation:

Collaboration diagram for QQuickParentAnimation:

Signals
void	targetChanged ()
void	newParentChanged ()
void	viaChanged ()
Signals inherited from QQuickAbstractAnimation
void	started ()
void	stopped ()
void	runningChanged (bool)
void	pausedChanged (bool)
void	alwaysRunToEndChanged (bool)
void	loopCountChanged (int)
	Q_REVISION (2, 12) void finished()
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
	QQuickParentAnimation (QObject *parent=nullptr)
	\qmltype ParentAnimation \nativetype QQuickParentAnimation \inqmlmodule QtQuick
QQuickItem *	target () const
	\qmlproperty Item QtQuick::ParentAnimation::target The item to reparent.
void	setTargetObject (QQuickItem *)
QQuickItem *	newParent () const
	\qmlproperty Item QtQuick::ParentAnimation::newParent The new parent to animate to.
void	setNewParent (QQuickItem *)
QQuickItem *	via () const
void	setVia (QQuickItem *)
Public Member Functions inherited from QQuickAnimationGroup
	QQuickAnimationGroup (QObject *parent)
	~QQuickAnimationGroup () override
QQmlListProperty< QQuickAbstractAnimation >	animations ()
Public Member Functions inherited from QQuickAbstractAnimation
	QQuickAbstractAnimation (QObject *parent=nullptr)
	\qmltype Animation \nativetype QQuickAbstractAnimation \inqmlmodule QtQuick
	~QQuickAbstractAnimation () override
bool	isRunning () const
	\qmlproperty bool QtQuick::Animation::running This property holds whether the animation is currently running.
void	setRunning (bool)
	\qmlsignal QtQuick::Animation::started()
bool	isPaused () const
	\qmlproperty bool QtQuick::Animation::paused This property holds whether the animation is currently paused.
void	setPaused (bool)
bool	alwaysRunToEnd () const
	\qmlproperty bool QtQuick::Animation::alwaysRunToEnd This property holds whether the animation should run to completion when it is stopped.
void	setAlwaysRunToEnd (bool)
int	loops () const
	\qmlproperty int QtQuick::Animation::loops This property holds the number of times the animation should play.
void	setLoops (int)
int	duration () const
int	currentTime ()
void	setCurrentTime (int)
QQuickAnimationGroup *	group () const
void	setGroup (QQuickAnimationGroup *, int index=-1)
void	setDefaultTarget (const QQmlProperty &)
void	setDisableUserControl ()
void	setEnableUserControl ()
bool	userControlDisabled () const
void	classBegin () override
	Invoked after class creation, but before any properties have been set.
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
virtual ThreadingModel	threadingModel () const
QAbstractAnimationJob *	qtAnimation ()
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.
Public Member Functions inherited from QQmlPropertyValueSource
	QQmlPropertyValueSource ()
	Constructs a QQmlPropertyValueSource.
virtual	~QQmlPropertyValueSource ()
	Destroys the value source.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()

Protected Member Functions
QAbstractAnimationJob *	transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr) override
Protected Member Functions inherited from QQuickAnimationGroup
	QQuickAnimationGroup (QQuickAnimationGroupPrivate &dd, QObject *parent)
Protected Member Functions inherited from QQuickAbstractAnimation
	QQuickAbstractAnimation (QQuickAbstractAnimationPrivate &dd, QObject *parent)
QAbstractAnimationJob *	initInstance (QAbstractAnimationJob *animation)
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
QQuickItem *	target
QQuickItem *	newParent
QQuickItem *	via
Properties inherited from QQuickAnimationGroup
QQmlListProperty< QQuickAbstractAnimation >	animations
Properties inherited from QQuickAbstractAnimation
bool	running
bool	paused
bool	alwaysRunToEnd
int	loops
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QQuickAbstractAnimation
enum	ThreadingModel { GuiThread , RenderThread , AnyThread }
enum	Loops { Infinite = -2 }
enum	TransitionDirection { Forward , Backward }
Public Slots inherited from QQuickAbstractAnimation
void	restart ()
	\qmlmethod QtQuick::Animation::restart()
void	start ()
	\qmlmethod QtQuick::Animation::start()
void	pause ()
	\qmlmethod QtQuick::Animation::pause()
void	resume ()
	\qmlmethod QtQuick::Animation::resume()
void	stop ()
	\qmlmethod QtQuick::Animation::stop()
void	complete ()
	\qmlmethod QtQuick::Animation::complete()
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 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 26 of file qquickitemanimation_p.h.

Constructor & Destructor Documentation

◆ QQuickParentAnimation()

QT_BEGIN_NAMESPACE QQuickParentAnimation::QQuickParentAnimation ( QObject * parent = nullptr )

\qmltype ParentAnimation \nativetype QQuickParentAnimation \inqmlmodule QtQuick

Since: 5.0 \inherits Animation

Animates changes in parent values.

ParentAnimation is used to animate a parent change for an \l Item.

For example, the following ParentChange changes blueRect to become a child of redRect when it is clicked. The inclusion of the ParentAnimation, which defines a NumberAnimation to be applied during the transition, ensures the item animates smoothly as it moves to its new parent:

import QtQuick
 
Item {
    width: 200; height: 100
 
    Rectangle {
        id: redRect
        width: 100; height: 100
        color: "red"
    }
 
    Rectangle {
        id: blueRect
        x: redRect.width
        width: 50; height: 50
        color: "blue"
 
        states: State {
            name: "reparented"
            ParentChange { target: blueRect; parent: redRect; x: 10; y: 10 }
        }
 
        transitions: Transition {
            ParentAnimation {
                NumberAnimation { properties: "x,y"; duration: 1000 }
            }
        }
 
        MouseArea { anchors.fill: parent; onClicked: blueRect.state = "reparented" }
    }
}

A ParentAnimation can contain any number of animations. These animations will be run in parallel; to run them sequentially, define them within a SequentialAnimation.

In some cases, such as when reparenting between items with clipping enabled, it is useful to animate the parent change via another item that does not have clipping enabled. Such an item can be set using the \l via property.

ParentAnimation is typically used within a \l Transition in conjunction with a ParentChange. When used in this manner, it animates any ParentChange that has occurred during the state change. This can be overridden by setting a specific target item using the \l target property.

See also: {Animation and Transitions in Qt Quick}, {Qt Quick Examples - Animation}

Definition at line 56 of file qquickitemanimation.cpp.

Member Function Documentation

◆ newParent()

QQuickItem * QQuickParentAnimation::newParent ( ) const

\qmlproperty Item QtQuick::ParentAnimation::newParent The new parent to animate to.

If the ParentAnimation is defined within a \l Transition, this value defaults to the value defined in the end state of the \l Transition.

Definition at line 92 of file qquickitemanimation.cpp.

◆ newParentChanged

void QQuickParentAnimation::newParentChanged ( )

signal

◆ setNewParent()

void QQuickParentAnimation::setNewParent ( QQuickItem * newParent )

Definition at line 98 of file qquickitemanimation.cpp.

◆ setTargetObject()

void QQuickParentAnimation::setTargetObject ( QQuickItem * target )

Definition at line 74 of file qquickitemanimation.cpp.

◆ setVia()

void QQuickParentAnimation::setVia ( QQuickItem * via )

Definition at line 130 of file qquickitemanimation.cpp.

◆ target()

QQuickItem * QQuickParentAnimation::target ( ) const

\qmlproperty Item QtQuick::ParentAnimation::target The item to reparent.

When used in a transition, if no target is specified, all ParentChange occurrences are animated by the ParentAnimation.

Definition at line 68 of file qquickitemanimation.cpp.

◆ targetChanged

void QQuickParentAnimation::targetChanged ( )

signal

◆ transition()

QAbstractAnimationJob * QQuickParentAnimation::transition	(	QQuickStateActions &	actions,
		QQmlProperties &	modified,
		TransitionDirection	direction,
		QObject *	defaultTarget = nullptr )

overrideprotectedvirtual

Reimplemented from QQuickAbstractAnimation.

Definition at line 187 of file qquickitemanimation.cpp.

◆ via()

QQuickItem * QQuickParentAnimation::via ( ) const

\qmlproperty Item QtQuick::ParentAnimation::via
The item to reparent via. This provides a way to do an unclipped animation
when both the old parent and new parent are clipped.

\qml
ParentAnimation {
    target: myItem
    via: topLevelItem

... } \endqml

Note: This only works when the ParentAnimation is used in a \l Transition in conjunction with a ParentChange.

Definition at line 124 of file qquickitemanimation.cpp.

◆ viaChanged

void QQuickParentAnimation::viaChanged ( )

signal

Property Documentation

◆ newParent

QQuickItem * QQuickParentAnimation::newParent

readwrite

Definition at line 32 of file qquickitemanimation_p.h.

◆ target

QQuickItem * QQuickParentAnimation::target

readwrite

Definition at line 31 of file qquickitemanimation_p.h.

◆ via

QQuickItem * QQuickParentAnimation::via

readwrite

Definition at line 33 of file qquickitemanimation_p.h.

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

qtdeclarative/src/quick/items/qquickitemanimation_p.h (01cd43d30e3ca2c4dd94a4a4711604adb9417517)
qtdeclarative/src/quick/items/qquickitemanimation.cpp (01cd43d30e3ca2c4dd94a4a4711604adb9417517)

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickParentAnimation()

Member Function Documentation

◆ newParent()

◆ newParentChanged

◆ setNewParent()

◆ setTargetObject()

◆ setVia()

◆ target()

◆ targetChanged

◆ transition()

◆ via()

◆ viaChanged

Property Documentation

◆ newParent

◆ target

◆ via