#include <qquickanimationcontroller_p.h>

Inheritance diagram for QQuickAnimationController:

Collaboration diagram for QQuickAnimationController:

Public Slots
void	reload ()
	\qmlmethod QtQuick::AnimationController::reload()

void	completeToBeginning ()
	\qmlmethod QtQuick::AnimationController::completeToBeginning()

void	completeToEnd ()
	\qmlmethod QtQuick::AnimationController::completeToEnd()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	progressChanged ()

void	animationChanged ()

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
	QQuickAnimationController (QObject *parent=nullptr)
	\qmltype AnimationController \instantiates QQuickAnimationController \inqmlmodule QtQuick

	~QQuickAnimationController ()

qreal	progress () const
	\qmlproperty real QtQuick::AnimationController::progress This property holds the animation progress value.

void	setProgress (qreal progress)

QQuickAbstractAnimation *	animation () const
	\qmlproperty Animation QtQuick::AnimationController::animation \qmldefault

void	setAnimation (QQuickAbstractAnimation *animation)

void	componentFinalized () override
	The customization point provided by this interface.

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

Public Member Functions inherited from QQmlFinalizerHook
virtual	~QQmlFinalizerHook ()

virtual void	componentFinalized ()=0
	The customization point provided by this interface.

Properties
qreal	progress

QQuickAbstractAnimation *	animation

Properties inherited from QObject
QString	objectName
	the name of this object

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

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

Definition at line 25 of file qquickanimationcontroller_p.h.

Constructor & Destructor Documentation

◆ QQuickAnimationController()

QQuickAnimationController::QQuickAnimationController ( QObject * parent = nullptr )

\qmltype AnimationController \instantiates QQuickAnimationController \inqmlmodule QtQuick

Enables manual control of animations.

Normally animations are driven by an internal timer, but the AnimationController allows the given animation to be driven by a progress value explicitly.

Definition at line 70 of file qquickanimationcontroller.cpp.

◆ ~QQuickAnimationController()

QQuickAnimationController::~QQuickAnimationController ( )

Definition at line 75 of file qquickanimationcontroller.cpp.

References d.

Member Function Documentation

◆ animation()

QQuickAbstractAnimation * QQuickAnimationController::animation ( ) const

\qmlproperty Animation QtQuick::AnimationController::animation \qmldefault

This property holds the animation to be controlled by the AnimationController.

Note:An animation controlled by AnimationController will always have its running and paused properties set to true. It can not be manually started or stopped (much like an animation in a Behavior can not be manually started or stopped).

Definition at line 116 of file qquickanimationcontroller.cpp.

References d.

◆ animationChanged

void QQuickAnimationController::animationChanged ( )

signal

Referenced by setAnimation().

Here is the caller graph for this function:

◆ completeToBeginning

void QQuickAnimationController::completeToBeginning ( )

slot

\qmlmethod QtQuick::AnimationController::completeToBeginning()

Finishes running the controlled animation in a backwards direction.

After calling this method, the animation runs normally from the current progress point in a backwards direction to the beginning state.

The animation controller's progress value will be automatically updated while the animation is running.

See also: completeToEnd(), progress

Definition at line 205 of file qquickanimationcontroller.cpp.

References QAbstractAnimationJob::Backward, QAbstractAnimationJob::Completion, QAbstractAnimationJob::CurrentTime, and d.

◆ completeToEnd

void QQuickAnimationController::completeToEnd ( )

slot

\qmlmethod QtQuick::AnimationController::completeToEnd()

Finishes running the controlled animation in a forwards direction.

After calling this method, the animation runs normally from the current progress point in a forwards direction to the end state.

The animation controller's progress value will be automatically updated while the animation is running.

See also: completeToBeginning(), progress

Definition at line 234 of file qquickanimationcontroller.cpp.

References QAbstractAnimationJob::Completion, QAbstractAnimationJob::CurrentTime, d, and QAbstractAnimationJob::Forward.

◆ componentFinalized()

void QQuickAnimationController::componentFinalized ( )

overridevirtual

The customization point provided by this interface.

See the class description for why it is useful and how it compares to componentComplete.

See also: QQmlParserStatus::componentComplete

Implements QQmlFinalizerHook.

Definition at line 187 of file qquickanimationcontroller.cpp.

References d, and reload().

Here is the call graph for this function:

◆ progress()

qreal QQuickAnimationController::progress ( ) const

\qmlproperty real QtQuick::AnimationController::progress This property holds the animation progress value.

The valid progress value is 0.0 to 1.0, setting values less than 0 will be converted to 0, setting values great than 1 will be converted to 1.

Definition at line 88 of file qquickanimationcontroller.cpp.

References d.

◆ progressChanged

void QQuickAnimationController::progressChanged ( )

signal

Referenced by setProgress().

Here is the caller graph for this function:

◆ reload

void QQuickAnimationController::reload ( )

slot

\qmlmethod QtQuick::AnimationController::reload()

Reloads the animation properties

If the animation properties changed, calling this method to reload the animation definations.

Definition at line 150 of file qquickanimationcontroller.cpp.

References d, QQuickAbstractAnimation::Forward, and properties.

Referenced by componentFinalized(), and setAnimation().

Here is the caller graph for this function:

◆ setAnimation()

void QQuickAnimationController::setAnimation ( QQuickAbstractAnimation * animation )

Definition at line 122 of file qquickanimationcontroller.cpp.

References animation, animationChanged(), d, emit, qmlWarning(), reload(), QQuickAbstractAnimation::setDisableUserControl(), and QQuickAbstractAnimation::userControlDisabled().

Here is the call graph for this function:

◆ setProgress()

void QQuickAnimationController::setProgress ( qreal progress )

Definition at line 94 of file qquickanimationcontroller.cpp.

References d, emit, progress, progressChanged(), and qBound().

Here is the call graph for this function:

Property Documentation

◆ animation

QQuickAbstractAnimation * QQuickAnimationController::animation

readwrite

Definition at line 61 of file qquickanimationcontroller_p.h.

Referenced by setAnimation().

◆ progress

qreal QQuickAnimationController::progress

readwrite

Definition at line 61 of file qquickanimationcontroller_p.h.

Referenced by setProgress().

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

qtdeclarative/src/quick/util/qquickanimationcontroller_p.h
qtdeclarative/src/quick/util/qquickanimationcontroller.cpp

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickAnimationController()

◆ ~QQuickAnimationController()

Member Function Documentation

◆ animation()

◆ animationChanged

◆ completeToBeginning

◆ completeToEnd

◆ componentFinalized()

◆ progress()

◆ progressChanged

◆ reload

◆ setAnimation()

◆ setProgress()

Property Documentation

◆ animation

◆ progress