The QPauseAnimation class provides a pause for QSequentialAnimationGroup. More...

#include <qpauseanimation.h>

Inheritance diagram for QPauseAnimation:

Collaboration diagram for QPauseAnimation:

Public Member Functions
	QPauseAnimation (QObject *parent=nullptr)

	QPauseAnimation (int msecs, QObject *parent=nullptr)

	~QPauseAnimation ()

int	duration () const override

void	setDuration (int msecs)

QBindable< int >	bindableDuration ()

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 *e) override

void	updateCurrentTime (int) override

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

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

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
int	duration
	the duration of the pause. 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 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 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 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 QPauseAnimation class provides a pause for QSequentialAnimationGroup.

\inmodule QtCore

Since: 4.6

If you wish to introduce a delay between animations in a QSequentialAnimationGroup, you can insert a QPauseAnimation. This class does not animate anything, but does not \l{QAbstractAnimation::finished()}{finish} before a specified number of milliseconds have elapsed from when it was started. You specify the duration of the pause in the constructor. It can also be set directly with setDuration().

It is not necessary to construct a QPauseAnimation yourself. QSequentialAnimationGroup provides the convenience functions \l{QSequentialAnimationGroup::}{addPause()} and \l{QSequentialAnimationGroup::}{insertPause()}. These functions simply take the number of milliseconds the pause should last.

See also: QSequentialAnimationGroup

Definition at line 51 of file qpauseanimation.h.

Constructor & Destructor Documentation

◆ QPauseAnimation() [1/2]

QPauseAnimation::QPauseAnimation ( QObject * parent = nullptr )

Constructs a QPauseAnimation. parent is passed to QObject's constructor. The default duration is 0.

Definition at line 90 of file qpauseanimation.cpp.

◆ QPauseAnimation() [2/2]

QPauseAnimation::QPauseAnimation	(	int	msecs,
		QObject *	parent = `nullptr`
	)

Constructs a QPauseAnimation. msecs is the duration of the pause. parent is passed to QObject's constructor.

Definition at line 100 of file qpauseanimation.cpp.

Here is the call graph for this function:

◆ ~QPauseAnimation()

QPauseAnimation::~QPauseAnimation ( )

Destroys the pause animation.

Definition at line 108 of file qpauseanimation.cpp.

Member Function Documentation

◆ bindableDuration()

QBindable< int > QPauseAnimation::bindableDuration ( )

Definition at line 141 of file qpauseanimation.cpp.

◆ duration()

int QPauseAnimation::duration ( ) const

overridevirtual

This pure virtual function returns the duration of the animation, and defines for how long QAbstractAnimation should update the current time. This duration is local, and does not include the loop count.

A return value of -1 indicates that the animation has no defined duration; the animation should run forever until stopped. This is useful for animations that are not time driven, or where you cannot easily predict its duration (e.g., event driven audio playback in a game).

If the animation is a parallel QAnimationGroup, the duration will be the longest duration of all its animations. If the animation is a sequential QAnimationGroup, the duration will be the sum of the duration of all its animations.

See also: loopCount

Implements QAbstractAnimation.

Definition at line 119 of file qpauseanimation.cpp.

◆ event()

bool QPauseAnimation::event ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractAnimation.

Definition at line 150 of file qpauseanimation.cpp.

Here is the call graph for this function:

◆ setDuration()

void QPauseAnimation::setDuration ( int msecs )

Definition at line 125 of file qpauseanimation.cpp.

Here is the caller graph for this function:

◆ updateCurrentTime()

void QPauseAnimation::updateCurrentTime ( int )

overrideprotectedvirtual

\reimp

Implements QAbstractAnimation.

Reimplemented in TestablePauseAnimation.

Definition at line 158 of file qpauseanimation.cpp.

Here is the caller graph for this function:

Property Documentation

◆ duration

QPauseAnimation::duration

readwrite

the duration of the pause.

The duration of the pause. The duration should not be negative. The default duration is 250 milliseconds.

Definition at line 73 of file qpauseanimation.h.

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

src/corelib/animation/qpauseanimation.h
src/corelib/animation/qpauseanimation.cpp

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members