#include <qquicktransition_p.h>

Inheritance diagram for QQuickTransition:

Collaboration diagram for QQuickTransition:

Signals
void	fromChanged ()

void	toChanged ()

void	reversibleChanged ()

void	enabledChanged ()

void	runningChanged ()

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
	QQuickTransition (QObject *parent=nullptr)

	~QQuickTransition ()

QString	fromState () const
	\qmlproperty string QtQuick::Transition::from \qmlproperty string QtQuick::Transition::to

void	setFromState (const QString &)

QString	toState () const

void	setToState (const QString &)

bool	reversible () const
	\qmlproperty bool QtQuick::Transition::reversible This property holds whether the transition should be automatically reversed when the conditions that triggered this transition are reversed.

void	setReversible (bool)

bool	enabled () const

void	setEnabled (bool enabled)

bool	running () const
	\qmlproperty bool QtQuick::Transition::running \readonly

QQmlListProperty< QQuickAbstractAnimation >	animations ()

QQuickTransitionInstance *	prepare (QQuickStateOperation::ActionList &actions, QList< QQmlProperty > &after, QQuickTransitionManager end, QObject defaultTarget)

void	setReversed (bool r)

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.

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

Properties
QString	from

QString	to

bool	reversible

bool	running

QQmlListProperty< QQuickAbstractAnimation >	animations
	\qmlproperty list<Animation> QtQuick::Transition::animations \qmldefault

bool	enabled

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 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 58 of file qquicktransition_p.h.

Constructor & Destructor Documentation

◆ QQuickTransition()

QQuickTransition::QQuickTransition ( QObject * parent = nullptr )

Definition at line 212 of file qquicktransition.cpp.

◆ ~QQuickTransition()

QQuickTransition::~QQuickTransition ( )

Definition at line 217 of file qquicktransition.cpp.

Member Function Documentation

◆ animations()

QQmlListProperty< QQuickAbstractAnimation > QQuickTransition::animations ( )

◆ enabled()

bool QQuickTransition::enabled ( ) const

\qmlproperty bool QtQuick::Transition::enabled

This property holds whether the Transition will be run when moving
from the \c from state to the \c to state.

By default a Transition is enabled.

Note that in some circumstances disabling a Transition may cause an
alternative Transition to be used in its place. In the following
example, although the first Transition has been set to animate changes
from "state1" to "state2", this transition has been disabled by setting
\c enabled to \c false, so any such state change will actually be animated
by the second Transition instead.

\qml
Item {
    states: [
        State { name: "state1" },
        State { name: "state2" }
    ]
    transitions: [
        Transition { from: "state1"; to: "state2"; enabled: false },
        Transition {

... } ] } \endqml

Definition at line 390 of file qquicktransition.cpp.

References d.

◆ enabledChanged

void QQuickTransition::enabledChanged ( )

signal

Referenced by setEnabled().

Here is the caller graph for this function:

◆ fromChanged

void QQuickTransition::fromChanged ( )

signal

Referenced by setFromState().

Here is the caller graph for this function:

◆ fromState()

QString QQuickTransition::fromState ( ) const

\qmlproperty string QtQuick::Transition::from \qmlproperty string QtQuick::Transition::to

These properties indicate the state changes that trigger the transition.

The default values for these properties is "*" (that is, any state).

For example, the following transition has not set the to and from properties, so the animation is always applied when changing between the two states (i.e. when the mouse is pressed and released).

Rectangle {
    id: rect
    width: 100; height: 100
    color: "red"
 
    MouseArea { id: mouseArea; anchors.fill: parent }
 
    states: State {
        name: "brighter"; when: mouseArea.pressed
        PropertyChanges { target: rect; color: "yellow" }
    }
 
    transitions: Transition {
        ColorAnimation { duration: 1000 }
    }
}

If the transition was changed to this:

    transitions: Transition {
        to: "brighter"
        ColorAnimation { duration: 1000 }
    }

The animation would only be applied when changing from the default state to the "brighter" state (i.e. when the mouse is pressed, but not on release).

Multiple to and from values can be set by using a comma-separated string.

See also: reversible

Definition at line 286 of file qquicktransition.cpp.

References d.

Referenced by QQuickStateGroupPrivate::setCurrentStateInternal().

Here is the caller graph for this function:

◆ prepare()

QQuickTransitionInstance * QQuickTransition::prepare	(	QQuickStateOperation::ActionList &	actions,
		QList< QQmlProperty > &	after,
		QQuickTransitionManager *	end,
		QObject *	defaultTarget )

Definition at line 227 of file qquicktransition.cpp.

References QAbstractAnimationJob::Backward, QQuickAbstractAnimation::Backward, d, direction, QAbstractAnimationJob::Forward, QQuickAbstractAnimation::Forward, i, manager, qmlExecuteDeferred(), QQuickAbstractAnimation::RenderThread, and wrapper().

Here is the call graph for this function:

◆ reversible()

bool QQuickTransition::reversible ( ) const

\qmlproperty bool QtQuick::Transition::reversible This property holds whether the transition should be automatically reversed when the conditions that triggered this transition are reversed.

The default value is false.

By default, transitions run in parallel and are applied to all state changes if the \l from and \l to states have not been set. In this situation, the transition is automatically applied when a state change is reversed, and it is not necessary to set this property to reverse the transition.

However, if a SequentialAnimation is used, or if the \l from or \l to properties have been set, this property will need to be set to reverse a transition when a state change is reverted. For example, the following transition applies a sequential animation when the mouse is pressed, and reverses the sequence of the animation when the mouse is released:

Rectangle {
    id: rect
    width: 100; height: 100
    color: "steelblue"
 
    TapHandler { id: tapHandler }
 
    states: State {
        name: "brighter"
        when: tapHandler.pressed
        PropertyChanges { target: rect; color: "lightsteelblue"; x: 50 }
    }
 
    //! [sequential animations]
    transitions: Transition {
        to: "brighter"
        reversible: true
        SequentialAnimation {
            PropertyAnimation { property: "x"; duration: 1000 }
            ColorAnimation { duration: 1000 }
        }
    }
    //! [sequential animations]
}

If the transition did not set the to and reversible values, then on the mouse release, the transition would play the PropertyAnimation before the ColorAnimation instead of reversing the sequence.

Definition at line 327 of file qquicktransition.cpp.

References d.

◆ reversibleChanged

void QQuickTransition::reversibleChanged ( )

signal

Referenced by setReversible().

Here is the caller graph for this function:

◆ running()

bool QQuickTransition::running ( ) const

\qmlproperty bool QtQuick::Transition::running \readonly

This property holds whether the transition is currently running.

Note: Unlike Animation::running, this property is read only, and can not be used to control the transition.

Definition at line 414 of file qquicktransition.cpp.

References d.

◆ runningChanged

void QQuickTransition::runningChanged ( )

signal

◆ setEnabled()

void QQuickTransition::setEnabled ( bool enabled )

Definition at line 396 of file qquicktransition.cpp.

References d, emit, enabled, and enabledChanged().

Here is the call graph for this function:

◆ setFromState()

void QQuickTransition::setFromState ( const QString & f )

Definition at line 292 of file qquicktransition.cpp.

References d, emit, and fromChanged().

Referenced by QQuickDesignerSupportItems::disableTransition(), and stopAnimation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReversed()

void QQuickTransition::setReversed ( bool r )

Definition at line 221 of file qquicktransition.cpp.

References d.

◆ setReversible()

void QQuickTransition::setReversible ( bool r )

Definition at line 333 of file qquicktransition.cpp.

References d, emit, and reversibleChanged().

Here is the call graph for this function:

◆ setToState()

void QQuickTransition::setToState ( const QString & t )

Definition at line 349 of file qquicktransition.cpp.

References d, emit, and toChanged().

Referenced by QQuickDesignerSupportItems::disableTransition(), and stopAnimation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toChanged

void QQuickTransition::toChanged ( )

signal

Referenced by setToState().

Here is the caller graph for this function:

◆ toState()

QString QQuickTransition::toState ( ) const

Definition at line 343 of file qquicktransition.cpp.

References d.

Referenced by QQuickStateGroupPrivate::setCurrentStateInternal().

Here is the caller graph for this function:

Property Documentation

◆ animations

QQmlListProperty< QQuickAbstractAnimation > QQuickTransition::animations

read

\qmlproperty list<Animation> QtQuick::Transition::animations \qmldefault

This property holds a list of the animations to be run for this transition.

    transitions: Transition {
        PropertyAnimation { duration: 3000 }
        ColorAnimation { duration: 3000 }
    }

The top-level animations are run in parallel. To run them sequentially, define them within a SequentialAnimation:

    transitions: Transition {
        to: "brighter"
        reversible: true
        SequentialAnimation {
            PropertyAnimation { property: "x"; duration: 1000 }
            ColorAnimation { duration: 1000 }
        }
    }

Definition at line 67 of file qquicktransition_p.h.

Referenced by QDeclarativeGeoMapItemView::QDeclarativeGeoMapItemView(), QQuickTransitionPrivate::animation_at(), QQuickTransitionPrivate::animation_count(), QQuickTransitionPrivate::append_animation(), and prepareTransition().

◆ enabled

bool QQuickTransition::enabled

readwrite

Definition at line 68 of file qquicktransition_p.h.

Referenced by QQuickItemViewTransitioner::canTransition(), prepareTransition(), setEnabled(), and QQuickItemViewTransitioner::transitionObject().

◆ from

QString QQuickTransition::from

readwrite

Definition at line 63 of file qquicktransition_p.h.

◆ reversible

bool QQuickTransition::reversible

readwrite

Definition at line 65 of file qquicktransition_p.h.

◆ running

bool QQuickTransition::running

read

Definition at line 66 of file qquicktransition_p.h.

◆ to

QString QQuickTransition::to

readwrite

Definition at line 64 of file qquicktransition_p.h.

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

qtdeclarative/src/quick/util/qquicktransition_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/util/qquicktransition.cpp (72c825e685229a2b747f1d79216ef3c6d3304de8)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickTransition()

◆ ~QQuickTransition()

Member Function Documentation

◆ animations()

◆ enabled()

◆ enabledChanged

◆ fromChanged

◆ fromState()

◆ prepare()

◆ reversible()

◆ reversibleChanged

◆ running()

◆ runningChanged

◆ setEnabled()

◆ setFromState()

◆ setReversed()

◆ setReversible()

◆ setToState()

◆ toChanged

◆ toState()

Property Documentation

◆ animations

◆ enabled

◆ from

◆ reversible

◆ running

◆ to