\inmodule QtCore More...

#include <qanimationgroup.h>

Inheritance diagram for QAnimationGroup:

Collaboration diagram for QAnimationGroup:

Public Member Functions
	QAnimationGroup (QObject *parent=nullptr)
	Constructs a QAnimationGroup.

	~QAnimationGroup ()
	Destroys the animation group.

QAbstractAnimation *	animationAt (int index) const
	Returns a pointer to the animation at index in this group.

int	animationCount () const
	Returns the number of animations managed by this group.

int	indexOfAnimation (QAbstractAnimation *animation) const
	Returns the index of animation.

void	addAnimation (QAbstractAnimation *animation)
	Adds animation to this group.

void	insertAnimation (int index, QAbstractAnimation *animation)
	Inserts animation into this animation group at index.

void	removeAnimation (QAbstractAnimation *animation)
	Removes animation from this group.

QAbstractAnimation *	takeAnimation (int index)
	Returns the animation at index and removes it from the animation group.

void	clear ()
	Removes and deletes all animations in this animation group, and resets the current time to 0.

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

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

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

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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
	QAnimationGroup (QAnimationGroupPrivate &dd, QObject *parent)

bool	event (QEvent *event) override
	\reimp

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

bool	event (QEvent *event) override
	\reimp

virtual void	updateCurrentTime (int currentTime)=0
	This pure virtual function is called every time the animation's currentTime changes.

virtual void	updateState (QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
	This virtual function is called by QAbstractAnimation when the state of the animation is changed from oldState to newState.

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)

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

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

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 QAnimationGroup class is an abstract base class for groups of animations.

Since: 4.6

An animation group is a container for animations (subclasses of QAbstractAnimation). A group is usually responsible for managing the \l{QAbstractAnimation::State}{state} of its animations, i.e., it decides when to start, stop, resume, and pause them. Currently, Qt provides two such groups: QParallelAnimationGroup and QSequentialAnimationGroup. Look up their class descriptions for details.

Since QAnimationGroup inherits from QAbstractAnimation, you can combine groups, and easily construct complex animation graphs. You can query QAbstractAnimation for the group it belongs to (using the \l{QAbstractAnimation::}{group()} function).

To start a top-level animation group, you simply use the \l{QAbstractAnimation::}{start()} function from QAbstractAnimation. By a top-level animation group, we think of a group that itself is not contained within another group. Starting sub groups directly is not supported, and may lead to unexpected behavior.

\omit OK, we'll put in a snippet on this here \endomit

QAnimationGroup provides methods for adding and retrieving animations. Besides that, you can remove animations by calling \l removeAnimation(), and clear the animation group by calling clear(). You may keep track of changes in the group's animations by listening to QEvent::ChildAdded and QEvent::ChildRemoved events.

\omit OK, let's find a snippet here as well. \endomit

QAnimationGroup takes ownership of the animations it manages, and ensures that they are deleted when the animation group is deleted.