\inmodule QtCore More...

#include <qpropertyanimation.h>

Inheritance diagram for QPropertyAnimation:

Collaboration diagram for QPropertyAnimation:

Public Member Functions
	QPropertyAnimation (QObject *parent=nullptr)
	Construct a QPropertyAnimation object.

	QPropertyAnimation (QObject target, const QByteArray &propertyName, QObject parent=nullptr)
	Construct a QPropertyAnimation object.

	~QPropertyAnimation ()
	Destroys the QPropertyAnimation instance.

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)
	Construct a QVariantAnimation object.

	~QVariantAnimation ()
	Destroys the animation.

QVariant	startValue () const

void	setStartValue (const QVariant &value)

QVariant	endValue () const

void	setEndValue (const QVariant &value)

QVariant	keyValueAt (qreal step) const
	Returns the key frame value for the given step.

void	setKeyValueAt (qreal step, const QVariant &value)
	Creates a key frame at the given step with the given value.

KeyValues	keyValues () const
	Returns the key frames of this animation.

void	setKeyValues (const KeyValues &values)
	Replaces the current set of key frames with the given keyValues.

QVariant	currentValue () const

int	duration () const override
	This pure virtual function returns the duration of the animation, and defines for how long QAbstractAnimation should update the current time.

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)
	Constructs the QAbstractAnimation base class, and passes parent to QObject's constructor.

virtual	~QAbstractAnimation ()
	Stops the animation if it's running, then destroys the QAbstractAnimation.

State	state () const

QBindable< QAbstractAnimation::State >	bindableState () const

QAnimationGroup *	group () const
	If this animation is part of a QAnimationGroup, this function returns a pointer to the group; otherwise, it returns \nullptr.

Direction	direction () const

void	setDirection (Direction direction)

QBindable< Direction >	bindableDirection ()

int	currentTime () const

QBindable< int >	bindableCurrentTime ()

int	currentLoopTime () const
	Returns the current time inside the current loop.

int	loopCount () const

void	setLoopCount (int loopCount)

QBindable< int >	bindableLoopCount ()

int	currentLoop () const

QBindable< int >	bindableCurrentLoop () const

int	totalDuration () const
	Returns the total and effective duration of the animation, including the loop count.

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

Protected Member Functions
bool	event (QEvent *event) override
	\reimp

void	updateCurrentValue (const QVariant &value) override
	This virtual function is called by QVariantAnimation whenever the current value changes.

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

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

bool	event (QEvent *event) override
	\reimp

void	updateCurrentTime (int) override
	\reimp

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

virtual QVariant	interpolated (const QVariant &from, const QVariant &to, qreal progress) const
	This virtual function returns the linear interpolation between variants from and to, at progress, usually a value between 0 and 1.

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

virtual void	updateDirection (QAbstractAnimation::Direction direction)
	This virtual function is called by QAbstractAnimation when the direction of the animation is changed.

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
QByteArray	propertyName
	the target property name for this animation

QObject *	targetObject
	the target QObject for this animation.

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

QVariant	endValue
	the end value of the animation

QVariant	currentValue
	the current value of the animation.

int	duration
	the duration of the animation

QEasingCurve	easingCurve
	the easing curve of the animation

Properties inherited from QAbstractAnimation
State	state
	state of the animation.

int	loopCount
	the loop count of the animation

int	currentTime
	the current time and progress of the animation

int	currentLoop
	the current loop of the animation

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

int	duration
	the duration of the animation.

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QVariantAnimation
using	KeyValue = std::pair<qreal, QVariant>
	This is a typedef for std::pair<qreal, QVariant>.

typedef QList< KeyValue >	KeyValues
	This is a typedef for QList<KeyValue>

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

Public Types inherited from QAbstractAnimation
enum	Direction { Forward , Backward }
	This enum describes the direction of the animation when in \l Running state. More...

enum	State { Stopped , Paused , Running }
	This enum describes the state of the animation. More...

enum	DeletionPolicy { KeepWhenStopped = 0 , DeleteWhenStopped }
	\value KeepWhenStopped The animation will not be deleted when stopped. More...

Public Slots inherited from QAbstractAnimation
void	start (QAbstractAnimation::DeletionPolicy policy=KeepWhenStopped)
	Starts the animation.

void	pause ()
	Pauses the animation.

void	resume ()
	Resumes the animation after it was paused.

void	setPaused (bool)
	If paused is true, the animation is paused.

void	stop ()
	Stops the animation.

void	setCurrentTime (int msecs)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QVariantAnimation
void	valueChanged (const QVariant &value)
	QVariantAnimation emits this signal whenever the current value changes.

Signals inherited from QAbstractAnimation
void	finished ()
	QAbstractAnimation emits this signal after the animation has stopped and has reached the end.

void	stateChanged (QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
	QAbstractAnimation emits this signal whenever the state of the animation has changed from oldState to newState.

void	currentLoopChanged (int currentLoop)
	QAbstractAnimation emits this signal whenever the current loop changes.

void	directionChanged (QAbstractAnimation::Direction)
	QAbstractAnimation emits this signal whenever the direction has been 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.

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

\inmodule QtCore

The QPropertyAnimation class animates Qt properties.

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:

#include <QApplication>
#include <QPushButton>
#include <QPropertyAnimation>
 
class MyButtonWidget : public QWidget
{
public:
    MyButtonWidget(QWidget *parent = nullptr);
};
 
MyButtonWidget::MyButtonWidget(QWidget *parent) : QWidget(parent)
{
    QPushButton *button = new QPushButton(tr("Animated Button"), this);
    QPropertyAnimation *anim = new QPropertyAnimation(button, "pos", this);
    anim->setDuration(10000);
    anim->setStartValue(QPoint(0, 0));
    anim->setEndValue(QPoint(100, 250));
    anim->start();
}
 
int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
    MyButtonWidget buttonAnimWidget;
    buttonAnimWidget.resize(QSize(800, 600));
    buttonAnimWidget.show();
    return a.exec();
}

Note: You can also control an animation's lifespan by choosing a \l{QAbstractAnimation::DeletionPolicy}{delete policy} while starting the animation.

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 14 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 118 of file qpropertyanimation.cpp.

◆ 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 130 of file qpropertyanimation.cpp.

◆ ~QPropertyAnimation()

QPropertyAnimation::~QPropertyAnimation ( )

Destroys the QPropertyAnimation instance.

Definition at line 140 of file qpropertyanimation.cpp.

Member Function Documentation

◆ bindablePropertyName()

QBindable< QByteArray > QPropertyAnimation::bindablePropertyName ( )

Definition at line 217 of file qpropertyanimation.cpp.

◆ bindableTargetObject()

QBindable< QObject * > QPropertyAnimation::bindableTargetObject ( )

Definition at line 156 of file qpropertyanimation.cpp.

◆ event()

bool QPropertyAnimation::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractAnimation.

Definition at line 225 of file qpropertyanimation.cpp.

◆ propertyName()

QByteArray QPropertyAnimation::propertyName ( ) const

Definition at line 193 of file qpropertyanimation.cpp.

◆ setPropertyName()

void QPropertyAnimation::setPropertyName ( const QByteArray & propertyName )

Definition at line 199 of file qpropertyanimation.cpp.

◆ setTargetObject()

void QPropertyAnimation::setTargetObject ( QObject * target )

Definition at line 161 of file qpropertyanimation.cpp.

◆ targetObject()

QObject * QPropertyAnimation::targetObject ( ) const

Definition at line 151 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 237 of file qpropertyanimation.cpp.

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

Definition at line 249 of file qpropertyanimation.cpp.

Property Documentation

◆ propertyName

QByteArray 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 17 of file qpropertyanimation.h.

◆ targetObject

QObject* QPropertyAnimation::targetObject

readwrite

the target QObject for this animation.

This property defines the target QObject for this animation.

Definition at line 19 of file qpropertyanimation.h.

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

qtbase/src/corelib/animation/qpropertyanimation.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/corelib/animation/qpropertyanimation.cpp (3af20bd8eb8c75017c5d6d138d7c42914ee5bee3)

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