The QPropertyAnimation class animates Qt properties. More...

#include <qpropertyanimation.h>

Inheritance diagram for QPropertyAnimation:

Collaboration diagram for QPropertyAnimation:

Public Member Functions
	QPropertyAnimation (QObject *parent=nullptr)

	QPropertyAnimation (QObject target, const QByteArray &propertyName, QObject parent=nullptr)

	~QPropertyAnimation ()

QObject *	targetObject () const

void	setTargetObject (QObject *target)

QBindable< QObject * >	bindableTargetObject ()

QByteArray	propertyName () const

void	setPropertyName (const QByteArray &propertyName)

QBindable< QByteArray >	bindablePropertyName ()

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

	~QVariantAnimation ()

QVariant	startValue () const

void	setStartValue (const QVariant &value)

QVariant	endValue () const

void	setEndValue (const QVariant &value)

QVariant	keyValueAt (qreal step) const

void	setKeyValueAt (qreal step, const QVariant &value)

KeyValues	keyValues () const

void	setKeyValues (const KeyValues &values)

QVariant	currentValue () const

int	duration () const override

void	setDuration (int msecs)

QBindable< int >	bindableDuration ()

QEasingCurve	easingCurve () const

void	setEasingCurve (const QEasingCurve &easing)

QBindable< QEasingCurve >	bindableEasingCurve ()

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

virtual	~QAbstractAnimation ()

State	state () const

QBindable< QAbstractAnimation::State >	bindableState () const

QAnimationGroup *	group () const

Direction	direction () const

void	setDirection (Direction direction)

QBindable< Direction >	bindableDirection ()

int	currentTime () const

QBindable< int >	bindableCurrentTime ()

int	currentLoopTime () const

int	loopCount () const

void	setLoopCount (int loopCount)

QBindable< int >	bindableLoopCount ()

int	currentLoop () const

QBindable< int >	bindableCurrentLoop () const

int	totalDuration () const

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

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Protected Member Functions
bool	event (QEvent *event) override

void	updateCurrentValue (const QVariant &value) override

void	updateState (QAbstractAnimation::State newState, QAbstractAnimation::State oldState) override

Protected Member Functions inherited from QVariantAnimation
	QVariantAnimation (QVariantAnimationPrivate &dd, QObject *parent=nullptr)

bool	event (QEvent *event) override

void	updateCurrentTime (int) override

void	updateState (QAbstractAnimation::State newState, QAbstractAnimation::State oldState) override

virtual QVariant	interpolated (const QVariant &from, const QVariant &to, qreal progress) const

Protected Member Functions inherited from QAbstractAnimation
	QAbstractAnimation (QAbstractAnimationPrivate &dd, QObject *parent=nullptr)

virtual void	updateDirection (QAbstractAnimation::Direction direction)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

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

Properties
QByteArray	propertyName
	the target property name for this animation More...

QObject *	targetObject
	the target QObject for this animation. More...

Properties inherited from QVariantAnimation
QVariant	startValue
	the optional start value of the animation More...

QVariant	endValue
	the end value of the animation More...

QVariant	currentValue
	the current value of the animation. More...

int	duration
	the duration of the animation More...

QEasingCurve	easingCurve
	the easing curve of the animation More...

Properties inherited from QAbstractAnimation
State	state
	state of the animation. More...

int	loopCount
	the loop count of the animation More...

int	currentTime
	the current time and progress of the animation More...

int	currentLoop
	the current loop of the animation More...

Direction	direction
	the direction of the animation when it is in \l Running state. More...

int	duration
	the duration of the animation. More...

Properties inherited from QObject
QString	objectName
	the name of this object More...

Additional Inherited Members
Public Types inherited from QVariantAnimation
typedef QPair< qreal, QVariant >	KeyValue

typedef QList< KeyValue >	KeyValues

typedef QVariant(*	Interpolator) (const void from, const void to, qreal progress)

Public Types inherited from QAbstractAnimation
enum	Direction { Forward , Backward }

enum	State { Stopped , Paused , Running }

enum	DeletionPolicy { KeepWhenStopped = 0 , DeleteWhenStopped }

Public Slots inherited from QAbstractAnimation
void	start (QAbstractAnimation::DeletionPolicy policy=KeepWhenStopped)

void	pause ()

void	resume ()

void	setPaused (bool)

void	stop ()

void	setCurrentTime (int msecs)

Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QVariantAnimation
void	valueChanged (const QVariant &value)

Signals inherited from QAbstractAnimation
void	finished ()

void	stateChanged (QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

void	currentLoopChanged (int currentLoop)

void	directionChanged (QAbstractAnimation::Direction)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

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)

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::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::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 Functions inherited from QVariantAnimation
template< typename T > void	qRegisterAnimationInterpolator (QVariant(*func)(const T &from, const T &to, qreal progress))

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

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

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

	QObjectList

Detailed Description

The QPropertyAnimation class animates Qt properties.

\inmodule QtCore

Since: 4.6

QPropertyAnimation interpolates over \l{Qt's Property System}{Qt properties}. As property values are stored in \l{QVariant}s, the class inherits QVariantAnimation, and supports animation of the same \l{QMetaType::Type}{meta types} as its super class.

A class declaring properties must be a QObject. To make it possible to animate a property, it must provide a setter (so that QPropertyAnimation can set the property's value). Note that this makes it possible to animate many of Qt's widgets. Let's look at an example:

The property name and the QObject instance of which property should be animated are passed to the constructor. You can then specify the start and end value of the property. The procedure is equal for properties in classes you have implemented yourself–just check with QVariantAnimation that your QVariant type is supported.

The QVariantAnimation class description explains how to set up the animation in detail. Note, however, that if a start value is not set, the property will start at the value it had when the QPropertyAnimation instance was created.

QPropertyAnimation works like a charm on its own. For complex animations that, for instance, contain several objects, QAnimationGroup is provided. An animation group is an animation that can contain other animations, and that can manage when its animations are played. Look at QParallelAnimationGroup for an example.

See also: QVariantAnimation, QAnimationGroup, {The Animation Framework}

Definition at line 50 of file qpropertyanimation.h.

Constructor & Destructor Documentation

◆ QPropertyAnimation() [1/2]

QPropertyAnimation::QPropertyAnimation ( QObject * parent = nullptr )

Construct a QPropertyAnimation object. parent is passed to QObject's constructor.

Definition at line 145 of file qpropertyanimation.cpp.

Here is the caller graph for this function:

◆ QPropertyAnimation() [2/2]

QPropertyAnimation::QPropertyAnimation	(	QObject *	target,
		const QByteArray &	propertyName,
		QObject *	parent = `nullptr`
	)

Construct a QPropertyAnimation object. parent is passed to QObject's constructor. The animation changes the property propertyName on target. The default duration is 250ms.

See also: targetObject, propertyName

Definition at line 157 of file qpropertyanimation.cpp.

Here is the call graph for this function:

◆ ~QPropertyAnimation()

QPropertyAnimation::~QPropertyAnimation ( )

Destroys the QPropertyAnimation instance.

Definition at line 167 of file qpropertyanimation.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ bindablePropertyName()

QBindable< QByteArray > QPropertyAnimation::bindablePropertyName ( )

Definition at line 243 of file qpropertyanimation.cpp.

◆ bindableTargetObject()

QBindable< QObject * > QPropertyAnimation::bindableTargetObject ( )

Definition at line 183 of file qpropertyanimation.cpp.

◆ event()

bool QPropertyAnimation::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractAnimation.

Definition at line 251 of file qpropertyanimation.cpp.

Here is the call graph for this function:

◆ propertyName()

QByteArray QPropertyAnimation::propertyName ( ) const

Definition at line 219 of file qpropertyanimation.cpp.

◆ setPropertyName()

void QPropertyAnimation::setPropertyName ( const QByteArray & propertyName )

Definition at line 225 of file qpropertyanimation.cpp.

Here is the caller graph for this function:

◆ setTargetObject()

void QPropertyAnimation::setTargetObject ( QObject * target )

Definition at line 188 of file qpropertyanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ targetObject()

QObject * QPropertyAnimation::targetObject ( ) const

Definition at line 178 of file qpropertyanimation.cpp.

◆ updateCurrentValue()

void QPropertyAnimation::updateCurrentValue ( const QVariant & value )

overrideprotectedvirtual

This virtual function is called by QVariantAnimation whenever the current value changes. value is the new, updated value. It updates the current value of the property on the target object.

See also: currentValue, currentTime

Reimplemented from QVariantAnimation.

Definition at line 263 of file qpropertyanimation.cpp.

Here is the caller graph for this function:

◆ updateState()

void QPropertyAnimation::updateState	(	QAbstractAnimation::State	newState,
		QAbstractAnimation::State	oldState
	)

overrideprotectedvirtual

\reimp

If the startValue is not defined when the state of the animation changes from Stopped to Running, the current property value is used as the initial value for the animation.

Reimplemented from QAbstractAnimation.

Reimplemented in MyComposedAnimation.

Definition at line 275 of file qpropertyanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

◆ propertyName

QPropertyAnimation::propertyName

readwrite

the target property name for this animation

This property defines the target property name for this animation. The property name is required for the animation to operate.

Definition at line 81 of file qpropertyanimation.h.

◆ targetObject

QPropertyAnimation::targetObject

readwrite

the target QObject for this animation.

This property defines the target QObject for this animation.

Definition at line 81 of file qpropertyanimation.h.

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

src/corelib/animation/qpropertyanimation.h
src/corelib/animation/qpropertyanimation.cpp

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QPropertyAnimation() [1/2]

◆ QPropertyAnimation() [2/2]

◆ ~QPropertyAnimation()

Member Function Documentation

◆ bindablePropertyName()

◆ bindableTargetObject()

◆ event()

◆ propertyName()

◆ setPropertyName()

◆ setTargetObject()

◆ targetObject()

◆ updateCurrentValue()

◆ updateState()

Property Documentation

◆ propertyName

◆ targetObject