Contents

• Public Functions
• Reimplemented Protected Functions
• Detailed Description

Detailed Description

TheQAnimationGroup class is an abstract base class for groups of animations.

An animation group is a container for animations (subclasses ofQAbstractAnimation). A group is usually responsible for managing thestate of its animations, i.e., it decides when to start, stop, resume, and pause them. Currently, Qt provides two such groups:QParallelAnimationGroup andQSequentialAnimationGroup. Look up their class descriptions for details.

SinceQAnimationGroup inherits fromQAbstractAnimation, you can combine groups, and easily construct complex animation graphs. You can queryQAbstractAnimation for the group it belongs to (using thegroup() function).

To start a top-level animation group, you simply use thestart() function fromQAbstractAnimation. 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.

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

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

Member Function Documentation

QAnimationGroup::QAnimationGroup(QObject * parent = 0)

Constructs aQAnimationGroup.parent is passed toQObject's constructor.

QAnimationGroup::~QAnimationGroup()

Destroys the animation group. It will also destroy all its animations.

void QAnimationGroup::addAnimation(QAbstractAnimation * animation)

Addsanimation to this group. This will callinsertAnimation with index equals toanimationCount().

Note:The group takes ownership of the animation.

See alsoremoveAnimation().

QAbstractAnimation * QAnimationGroup::animationAt(int index) const

Returns a pointer to the animation atindex in this group. This function is useful when you need access to a particular animation.index is between 0 andanimationCount() - 1.

See alsoanimationCount() andindexOfAnimation().

int QAnimationGroup::animationCount() const

Returns the number of animations managed by this group.

See alsoindexOfAnimation(),addAnimation(), andanimationAt().

void QAnimationGroup::clear()

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

See alsoaddAnimation() andremoveAnimation().

[virtual protected]bool QAnimationGroup::event(QEvent * event)

Reimplemented fromQObject::event().

int QAnimationGroup::indexOfAnimation(QAbstractAnimation * animation) const

Returns the index ofanimation. The returned index can be passed to the other functions that take an index as an argument.

See alsoinsertAnimation(),animationAt(), andtakeAnimation().

void QAnimationGroup::insertAnimation(int index,QAbstractAnimation * animation)

Insertsanimation into this animation group atindex. Ifindex is 0 the animation is inserted at the beginning. Ifindex isanimationCount(), the animation is inserted at the end.

Note:The group takes ownership of the animation.

See alsotakeAnimation(),addAnimation(),indexOfAnimation(), andremoveAnimation().

void QAnimationGroup::removeAnimation(QAbstractAnimation * animation)

Removesanimation from this group. The ownership ofanimation is transferred to the caller.

See alsotakeAnimation(),insertAnimation(), andaddAnimation().

QAbstractAnimation * QAnimationGroup::takeAnimation(int index)

Returns the animation atindex and removes it from the animation group.

Note:The ownership of the animation is transferred to the caller.

See alsoremoveAnimation(),addAnimation(),insertAnimation(), andindexOfAnimation().