Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QSequentialAnimationGroup Class Reference

\inmodule QtCore More...

#include <qsequentialanimationgroup.h>

+ Inheritance diagram for QSequentialAnimationGroup:
+ Collaboration diagram for QSequentialAnimationGroup:

Signals

void currentAnimationChanged (QAbstractAnimation *current)
 QSequentialAnimationGroup emits this signal when currentAnimation has been changed.
 
- 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.
 

Public Member Functions

 QSequentialAnimationGroup (QObject *parent=nullptr)
 Constructs a QSequentialAnimationGroup.
 
 ~QSequentialAnimationGroup ()
 Destroys the animation group.
 
QPauseAnimationaddPause (int msecs)
 Adds a pause of msecs to this animation group.
 
QPauseAnimationinsertPause (int index, int msecs)
 Inserts a pause of msecs milliseconds at index in this animation group.
 
QAbstractAnimationcurrentAnimation () const
 
QBindable< QAbstractAnimation * > bindableCurrentAnimation () const
 
int duration () const override
 \reimp
 
- Public Member Functions inherited from QAnimationGroup
 QAnimationGroup (QObject *parent=nullptr)
 Constructs a QAnimationGroup.
 
 ~QAnimationGroup ()
 Destroys the animation group.
 
QAbstractAnimationanimationAt (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.
 
QAbstractAnimationtakeAnimation (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::StatebindableState () const
 
QAnimationGroupgroup () 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< DirectionbindableDirection ()
 
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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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

 QSequentialAnimationGroup (QSequentialAnimationGroupPrivate &dd, QObject *parent)
 
bool event (QEvent *event) override
 \reimp
 
void updateCurrentTime (int) override
 \reimp
 
void updateState (QAbstractAnimation::State newState, QAbstractAnimation::State oldState) override
 \reimp
 
void updateDirection (QAbstractAnimation::Direction direction) override
 \reimp
 
- Protected Member Functions inherited from QAnimationGroup
 QAnimationGroup (QAnimationGroupPrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QAbstractAnimation
 QAbstractAnimation (QAbstractAnimationPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObjectsender () 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

QAbstractAnimationcurrentAnimation
 the animation in the current time.
 
- 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 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
 
- 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< QObjectDatad_ptr
 

Detailed Description

\inmodule QtCore

The QSequentialAnimationGroup class provides a sequential group of animations.

Since
4.6

QSequentialAnimationGroup is a QAnimationGroup that runs its animations in sequence, i.e., it starts one animation after another has finished playing. The animations are played in the order they are added to the group (using \l{QAnimationGroup::}{addAnimation()} or \l{QAnimationGroup::}{insertAnimation()}). The animation group finishes when its last animation has finished.

At each moment there is at most one animation that is active in the group; it is returned by currentAnimation(). An empty group has no current animation.

A sequential animation group can be treated as any other animation, i.e., it can be started, stopped, and added to other groups. You can also call addPause() or insertPause() to add a pause to a sequential animation group.

group->addAnimation(anim2);
group->start();

In this example, anim1 and anim2 are two already set up \l{QPropertyAnimation}s.

See also
QAnimationGroup, QAbstractAnimation, {The Animation Framework}

Definition at line 16 of file qsequentialanimationgroup.h.

Constructor & Destructor Documentation

◆ QSequentialAnimationGroup() [1/2]

QSequentialAnimationGroup::QSequentialAnimationGroup ( QObject * parent = nullptr)

Constructs a QSequentialAnimationGroup.

parent is passed to QObject's constructor.

Definition at line 201 of file qsequentialanimationgroup.cpp.

◆ ~QSequentialAnimationGroup()

QSequentialAnimationGroup::~QSequentialAnimationGroup ( )

Destroys the animation group.

It will also destroy all its animations.

Definition at line 218 of file qsequentialanimationgroup.cpp.

◆ QSequentialAnimationGroup() [2/2]

QSequentialAnimationGroup::QSequentialAnimationGroup ( QSequentialAnimationGroupPrivate & dd,
QObject * parent )
protected

Definition at line 209 of file qsequentialanimationgroup.cpp.

Member Function Documentation

◆ addPause()

QPauseAnimation * QSequentialAnimationGroup::addPause ( int msecs)

Adds a pause of msecs to this animation group.

The pause is considered as a special type of animation, thus \l{QAnimationGroup::animationCount()}{animationCount} will be increased by one.

See also
insertPause(), QAnimationGroup::addAnimation()

Definition at line 230 of file qsequentialanimationgroup.cpp.

References QAnimationGroup::addAnimation(), and QAbstractAnimation::pause().

+ Here is the call graph for this function:

◆ bindableCurrentAnimation()

QBindable< QAbstractAnimation * > QSequentialAnimationGroup::bindableCurrentAnimation ( ) const

Definition at line 268 of file qsequentialanimationgroup.cpp.

◆ currentAnimation()

QAbstractAnimation * QSequentialAnimationGroup::currentAnimation ( ) const

Definition at line 262 of file qsequentialanimationgroup.cpp.

References d.

◆ currentAnimationChanged

QSequentialAnimationGroup::currentAnimationChanged ( QAbstractAnimation * current)
signal

QSequentialAnimationGroup emits this signal when currentAnimation has been changed.

current is the current animation.

See also
currentAnimation()

◆ duration()

int QSequentialAnimationGroup::duration ( ) const
overridevirtual

\reimp

Implements QAbstractAnimation.

Definition at line 276 of file qsequentialanimationgroup.cpp.

References QSet< T >::constBegin(), d, it, and ret.

+ Here is the call graph for this function:

◆ event()

bool QSequentialAnimationGroup::event ( QEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QAnimationGroup.

Definition at line 388 of file qsequentialanimationgroup.cpp.

References QAnimationGroup::event().

+ Here is the call graph for this function:

◆ insertPause()

QPauseAnimation * QSequentialAnimationGroup::insertPause ( int index,
int msecs )

Inserts a pause of msecs milliseconds at index in this animation group.

See also
addPause(), QAnimationGroup::insertAnimation()

Definition at line 243 of file qsequentialanimationgroup.cpp.

References d, QAnimationGroup::insertAnimation(), QAbstractAnimation::pause(), and qWarning.

+ Here is the call graph for this function:

◆ updateCurrentTime()

void QSequentialAnimationGroup::updateCurrentTime ( int currentTime)
overrideprotectedvirtual

\reimp

Implements QAbstractAnimation.

Definition at line 295 of file qsequentialanimationgroup.cpp.

References QAbstractAnimation::currentTime, d, QAbstractAnimationPrivate::get(), Q_ASSERT, QAbstractAnimation::stop(), and QSequentialAnimationGroupPrivate::AnimationIndex::timeOffset.

+ Here is the call graph for this function:

◆ updateDirection()

void QSequentialAnimationGroup::updateDirection ( QAbstractAnimation::Direction direction)
overrideprotectedvirtual

◆ updateState()

void QSequentialAnimationGroup::updateState ( QAbstractAnimation::State newState,
QAbstractAnimation::State oldState )
overrideprotectedvirtual

\reimp

Reimplemented from QAbstractAnimation.

Definition at line 343 of file qsequentialanimationgroup.cpp.

References d, newState(), QAbstractAnimation::Paused, QAbstractAnimation::Running, QAbstractAnimation::Stopped, and QAbstractAnimation::updateState().

+ Here is the call graph for this function:

Property Documentation

◆ currentAnimation

QSequentialAnimationGroup::currentAnimation
read

the animation in the current time.

Definition at line 19 of file qsequentialanimationgroup.h.


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