#include <qquickbehavior_p.h>

Inheritance diagram for QQuickBehavior:

Collaboration diagram for QQuickBehavior:

Signals
void	enabledChanged ()

void	targetValueChanged ()

void	targetPropertyChanged ()

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

	~QQuickBehavior ()

void	setTarget (const QQmlProperty &) override
	Set the target property for the value interceptor.

void	write (const QVariant &value) override
	This method will be called when a new value is assigned to the property being intercepted.

bool	bindable (QUntypedBindable *untypedBindable, QUntypedBindable target) override

QQuickAbstractAnimation *	animation ()

void	setAnimation (QQuickAbstractAnimation *)

bool	enabled () const
	\qmlproperty bool QtQuick::Behavior::enabled

void	setEnabled (bool enabled)

QVariant	targetValue () const
	\qmlproperty Variant QtQuick::Behavior::targetValue

QQmlProperty	targetProperty () const

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.

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

Public Member Functions inherited from QQmlPropertyValueInterceptor
	QQmlPropertyValueInterceptor ()
	Constructs a QQmlPropertyValueInterceptor.

virtual	~QQmlPropertyValueInterceptor ()

Public Member Functions inherited from QQmlFinalizerHook
virtual	~QQmlFinalizerHook ()

Properties
QQuickAbstractAnimation *	animation
	\qmlproperty Animation QtQuick::Behavior::animation \qmldefault

bool	enabled

QVariant	targetValue

QQmlProperty	targetProperty

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 29 of file qquickbehavior_p.h.

Constructor & Destructor Documentation

◆ QQuickBehavior()

QQuickBehavior::QQuickBehavior ( QObject * parent = nullptr )

\qmltype Behavior \instantiates QQuickBehavior \inqmlmodule QtQuick

Defines a default animation for a property change.

A Behavior defines the default animation to be applied whenever a particular property value changes.

For example, the following Behavior defines a NumberAnimation to be run whenever the \l Rectangle's width value changes. When the MouseArea is clicked, the width is changed, triggering the behavior's animation:

import QtQuick
 
Rectangle {
    id: rect
    width: 100; height: 100
    color: "red"
 
    Behavior on width {
        NumberAnimation { duration: 1000 }
    }
 
    MouseArea {
        anchors.fill: parent
        onClicked: rect.width = 50
    }
}

Note that a property cannot have more than one assigned Behavior. To provide multiple animations within a Behavior, use ParallelAnimation or SequentialAnimation.

If a \l{Qt Quick States}{state change} has a \l Transition that matches the same property as a Behavior, the \l Transition animation overrides the Behavior for that state change. For general advice on using Behaviors to animate state changes, see \l{Using Qt Quick Behaviors with States}.

See also: {Animation and Transitions in Qt Quick}, {Qt Quick Examples - Animation::Behaviors}{Behavior example}, {Qt Qml}

Definition at line 190 of file qquickbehavior.cpp.

◆ ~QQuickBehavior()

QQuickBehavior::~QQuickBehavior ( )

Definition at line 195 of file qquickbehavior.cpp.

References d.

Member Function Documentation

◆ animation()

QQuickAbstractAnimation * QQuickBehavior::animation ( )

◆ bindable()

bool QQuickBehavior::bindable	(	QUntypedBindable *	bindable,
		QUntypedBindable	target )

overridevirtual

Called when a BindableProperty metacall gets intercepted. The default implementation does nothing and simply returns false. A subclass which can properly intercept the metacall should return true after doing its work. bindable is the pointer to the QUntypedBindable passed through the metacall target is the QUntypedBindable of the intercepted property

Reimplemented from QQmlPropertyValueInterceptor.

Definition at line 427 of file qquickbehavior.cpp.

References d.

◆ componentFinalized()

void QQuickBehavior::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 354 of file qquickbehavior.cpp.

References d.

◆ enabled()

bool QQuickBehavior::enabled ( ) const

\qmlproperty bool QtQuick::Behavior::enabled

This property holds whether the behavior will be triggered when the tracked property changes value.

By default a Behavior is enabled.

Definition at line 251 of file qquickbehavior.cpp.

References d.

◆ enabledChanged

void QQuickBehavior::enabledChanged ( )

signal

Referenced by setEnabled().

Here is the caller graph for this function:

◆ setAnimation()

void QQuickBehavior::setAnimation ( QQuickAbstractAnimation * animation )

Definition at line 214 of file qquickbehavior.cpp.

References animation, d, qmlWarning(), QQuickAbstractAnimation::setDefaultTarget(), and tr.

Here is the call graph for this function:

◆ setEnabled()

void QQuickBehavior::setEnabled ( bool enabled )

Definition at line 257 of file qquickbehavior.cpp.

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

Here is the call graph for this function:

◆ setTarget()

void QQuickBehavior::setTarget ( const QQmlProperty & property )

overridevirtual

Set the target property for the value interceptor.

This method will be called by the QML engine when assigning a value interceptor.

Implements QQmlPropertyValueInterceptor.

Definition at line 436 of file qquickbehavior.cpp.

References UntypedProxyProperty::bindingSetter(), d, property, Q_EMIT, and targetPropertyChanged().

Here is the call graph for this function:

◆ targetProperty()

QQmlProperty QQuickBehavior::targetProperty ( ) const

\readonly
\qmlpropertygroup QtQuick::Behavior::targetProperty
\qmlproperty string QtQuick::Behavior::targetProperty.name
\qmlproperty QtObject QtQuick::Behavior::targetProperty.object

\table
\header
    \li Property
    \li Description
\row
    \li name
    \li This property holds the name of the property being controlled by this Behavior.
\row
    \li object
    \li This property holds the object of the property being controlled by this Behavior.
\endtable

This property can be used to define custom behaviors based on the name or the object of
the property being controlled.

The following example defines a Behavior fading out and fading in its target object
when the property it controls changes:
\qml

FadeBehavior.qml import QtQuick 2.15

Behavior { id: root property Item fadeTarget: targetProperty.object SequentialAnimation { NumberAnimation { target: root.fadeTarget property: "opacity" to: 0 easing.type: Easing.InQuad } PropertyAction { } // actually change the controlled property between the 2 other animations NumberAnimation { target: root.fadeTarget property: "opacity" to: 1 easing.type: Easing.OutQuad } } } \endqml

This can be used to animate a text when it changes: \qml import QtQuick 2.15

Text { id: root property int counter text: counter FadeBehavior on text {} Timer { running: true repeat: true interval: 1000 onTriggered: ++root.counter } } \endqml

Since: QtQuick 2.15

Definition at line 348 of file qquickbehavior.cpp.

References d.

◆ targetPropertyChanged

void QQuickBehavior::targetPropertyChanged ( )

signal

Referenced by setTarget().

Here is the caller graph for this function:

◆ targetValue()

QVariant QQuickBehavior::targetValue ( ) const

\qmlproperty Variant QtQuick::Behavior::targetValue

This property holds the target value of the property being controlled by the Behavior. This value is set by the Behavior before the animation is started.

Since: QtQuick 2.13

Definition at line 274 of file qquickbehavior.cpp.

References d.

◆ targetValueChanged

void QQuickBehavior::targetValueChanged ( )

signal

Referenced by write().

Here is the caller graph for this function:

◆ write()

void QQuickBehavior::write ( const QVariant & value )

overridevirtual

This method will be called when a new value is assigned to the property being intercepted.

Implements QQmlPropertyValueInterceptor.

Definition at line 360 of file qquickbehavior.cpp.

References QQmlPropertyData::BypassInterceptor, currentValue, d, QQmlEnginePrivate::designerMode(), QQmlPropertyData::DontRemoveBinding, emit, QQuickAbstractAnimation::Forward, QQuickStateAction::fromValue, QQmlProperty::property(), QQuickStateAction::property, Q_ASSERT, qmlExecuteDeferred(), QQuickAbstractAnimation::RenderThread, QAbstractAnimationJob::StateChange, targetValueChanged(), QQuickStateAction::toValue, QQmlData::wasDeleted(), and QQmlPropertyPrivate::write().

Here is the call graph for this function:

Property Documentation

◆ animation

QQuickAbstractAnimation * QQuickBehavior::animation

readwrite

\qmlproperty Animation QtQuick::Behavior::animation \qmldefault

This property holds the animation to run when the behavior is triggered.

Definition at line 37 of file qquickbehavior_p.h.

Referenced by setAnimation().

◆ enabled

bool QQuickBehavior::enabled

readwrite

Definition at line 38 of file qquickbehavior_p.h.

Referenced by setEnabled().

◆ targetProperty

QQmlProperty QQuickBehavior::targetProperty

read

Definition at line 40 of file qquickbehavior_p.h.

◆ targetValue

QVariant QQuickBehavior::targetValue

read

Definition at line 39 of file qquickbehavior_p.h.

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

qtdeclarative/src/quick/util/qquickbehavior_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/util/qquickbehavior.cpp (72c825e685229a2b747f1d79216ef3c6d3304de8)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickBehavior()

◆ ~QQuickBehavior()

Member Function Documentation

◆ animation()

◆ bindable()

◆ componentFinalized()

◆ enabled()

◆ enabledChanged

◆ setAnimation()

◆ setEnabled()

◆ setTarget()

◆ targetProperty()

◆ targetPropertyChanged

◆ targetValue()

◆ targetValueChanged

◆ write()

Property Documentation

◆ animation

◆ enabled

◆ targetProperty

◆ targetValue