Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
QQuickPropertyAction Class Reference

#include <qquickanimation_p.h>

+ Inheritance diagram for QQuickPropertyAction:
+ Collaboration diagram for QQuickPropertyAction:

Signals

void valueChanged (const QVariant &)
 
void propertiesChanged (const QString &)
 
void targetChanged ()
 
void propertyChanged ()
 
- Signals inherited from QQuickAbstractAnimation
void started ()
 
void stopped ()
 
void runningChanged (bool)
 
void pausedChanged (bool)
 
void alwaysRunToEndChanged (bool)
 
void loopCountChanged (int)
 
 Q_REVISION (2, 12) void finished()
 
- 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

 QQuickPropertyAction (QObject *parent=nullptr)
 \qmltype PropertyAction \instantiates QQuickPropertyAction \inqmlmodule QtQuick\inherits Animation
 
 ~QQuickPropertyAction () override
 
QObject * target () const
 
void setTargetObject (QObject *)
 
QString property () const
 
void setProperty (const QString &)
 
QString properties () const
 \qmlproperty QtObject QtQuick::PropertyAction::target \qmlproperty list<QtObject> QtQuick::PropertyAction::targets \qmlproperty string QtQuick::PropertyAction::property \qmlproperty string QtQuick::PropertyAction::properties
 
void setProperties (const QString &)
 
QQmlListProperty< QObject > targets ()
 
QQmlListProperty< QObject > exclude ()
 
QVariant value () const
 \qmlproperty var QtQuick::PropertyAction::value This property holds the value to be set on the property.
 
void setValue (const QVariant &)
 
- Public Member Functions inherited from QQuickAbstractAnimation
 QQuickAbstractAnimation (QObject *parent=nullptr)
 \qmltype Animation \instantiates QQuickAbstractAnimation \inqmlmodule QtQuick
 
 ~QQuickAbstractAnimation () override
 
bool isRunning () const
 \qmlproperty bool QtQuick::Animation::running This property holds whether the animation is currently running.
 
void setRunning (bool)
 \qmlsignal QtQuick::Animation::started()
 
bool isPaused () const
 \qmlproperty bool QtQuick::Animation::paused This property holds whether the animation is currently paused.
 
void setPaused (bool)
 
bool alwaysRunToEnd () const
 \qmlproperty bool QtQuick::Animation::alwaysRunToEnd This property holds whether the animation should run to completion when it is stopped.
 
void setAlwaysRunToEnd (bool)
 
int loops () const
 \qmlproperty int QtQuick::Animation::loops This property holds the number of times the animation should play.
 
void setLoops (int)
 
int duration () const
 
int currentTime ()
 
void setCurrentTime (int)
 
QQuickAnimationGroup * group () const
 
void setGroup (QQuickAnimationGroup *, int index=-1)
 
void setDefaultTarget (const QQmlProperty &)
 
void setDisableUserControl ()
 
void setEnableUserControl ()
 
bool userControlDisabled () const
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
virtual ThreadingModel threadingModel () const
 
virtual QAbstractAnimationJob * transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr)
 
QAbstractAnimationJob * qtAnimation ()
 
- 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 QQmlPropertyValueSource
 QQmlPropertyValueSource ()
 Constructs a QQmlPropertyValueSource.
 
virtual ~QQmlPropertyValueSource ()
 Destroys the value source.
 
virtual void setTarget (const QQmlProperty &)=0
 Set the target property for the value source.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 
virtual void classBegin ()=0
 Invoked after class creation, but before any properties have been set.
 
virtual void componentComplete ()=0
 Invoked after the root component that caused this instantiation has completed construction.
 

Protected Member Functions

QAbstractAnimationJob * transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr) override
 
- Protected Member Functions inherited from QQuickAbstractAnimation
 QQuickAbstractAnimation (QQuickAbstractAnimationPrivate &dd, QObject *parent)
 
QAbstractAnimationJob * initInstance (QAbstractAnimationJob *animation)
 
- 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)
 

Properties

QObject * target
 
QString property
 
QString properties
 
QQmlListProperty< QObject > targets
 
QQmlListProperty< QObject > exclude
 \qmlproperty list<QtObject> QtQuick::PropertyAction::exclude This property holds the objects that should not be affected by this action.
 
QVariant value
 
- Properties inherited from QQuickAbstractAnimation
bool running
 
bool paused
 
bool alwaysRunToEnd
 
int loops
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QQuickAbstractAnimation
enum  ThreadingModel { GuiThread , RenderThread , AnyThread }
 
enum  Loops { Infinite = -2 }
 
enum  TransitionDirection { Forward , Backward }
 
- Public Slots inherited from QQuickAbstractAnimation
void restart ()
 \qmlmethod QtQuick::Animation::restart()
 
void start ()
 \qmlmethod QtQuick::Animation::start()
 
void pause ()
 \qmlmethod QtQuick::Animation::pause()
 
void resume ()
 \qmlmethod QtQuick::Animation::resume()
 
void stop ()
 \qmlmethod QtQuick::Animation::stop()
 
void complete ()
 \qmlmethod QtQuick::Animation::complete()
 
- 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< 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 183 of file qquickanimation_p.h.

Constructor & Destructor Documentation

◆ QQuickPropertyAction()

QQuickPropertyAction::QQuickPropertyAction ( QObject *  parent = nullptr)

\qmltype PropertyAction \instantiates QQuickPropertyAction \inqmlmodule QtQuick\inherits Animation

Specifies immediate property changes during animation.

PropertyAction is used to specify an immediate property change during an animation. The property change is not animated.

It is useful for setting non-animated property values during an animation.

For example, here is a SequentialAnimation that sets the image's \l {Item::}{opacity} property to .5, animates the width of the image, then sets \l {Item::}{opacity} back to 1:

SequentialAnimation {
PropertyAction { target: img; property: "opacity"; value: .5 }
NumberAnimation { target: img; property: "width"; to: 300; duration: 1000 }
PropertyAction { target: img; property: "opacity"; value: 1 }
}

PropertyAction is also useful for setting the exact point at which a property change should occur during a \l Transition. For example, if PropertyChanges was used in a \l State to rotate an item around a particular \l {Item::}{transformOrigin}, it might be implemented like this:

Item {
width: 400; height: 400
Rectangle {
id: rect
width: 200; height: 100
color: "red"
states: State {
name: "rotated"
PropertyChanges { target: rect; rotation: 180; transformOrigin: Item.BottomRight }
}
transitions: Transition {
RotationAnimation { duration: 1000; direction: RotationAnimation.Counterclockwise }
}
MouseArea {
anchors.fill: parent
onClicked: rect.state = "rotated"
}
}
}

However, with this code, the transformOrigin is not set until after the animation, as a \l State is taken to define the values at the end of a transition. The animation would rotate at the default transformOrigin, then jump to Item.BottomRight. To fix this, insert a PropertyAction before the RotationAnimation begins:

transitions: Transition {
SequentialAnimation {
PropertyAction { target: rect; property: "transformOrigin" }
RotationAnimation { duration: 1000; direction: RotationAnimation.Counterclockwise }
}
}

This immediately sets the transformOrigin property to the value defined in the end state of the \l Transition (i.e. the value defined in the PropertyAction object) so that the rotation animation begins with the correct transform origin.

See also
{Animation and Transitions in Qt Quick}, {Qt QML}

Definition at line 1080 of file qquickanimation.cpp.

◆ ~QQuickPropertyAction()

QQuickPropertyAction::~QQuickPropertyAction ( )
override

Definition at line 1085 of file qquickanimation.cpp.

Member Function Documentation

◆ exclude()

QQmlListProperty< QObject > QQuickPropertyAction::exclude ( )

◆ properties()

QString QQuickPropertyAction::properties ( ) const

\qmlproperty QtObject QtQuick::PropertyAction::target \qmlproperty list<QtObject> QtQuick::PropertyAction::targets \qmlproperty string QtQuick::PropertyAction::property \qmlproperty string QtQuick::PropertyAction::properties

These properties determine the items and their properties that are affected by this action.

The details of how these properties are interpreted in different situations is covered in the \l{PropertyAnimation::properties}{corresponding} PropertyAnimation documentation.

See also
exclude

Definition at line 1138 of file qquickanimation.cpp.

References d.

◆ propertiesChanged

void QQuickPropertyAction::propertiesChanged ( const QString &  )
signal

Referenced by setProperties().

+ Here is the caller graph for this function:

◆ property()

QString QQuickPropertyAction::property ( ) const

Definition at line 1106 of file qquickanimation.cpp.

References d.

◆ propertyChanged

void QQuickPropertyAction::propertyChanged ( )
signal

Referenced by setProperty().

+ Here is the caller graph for this function:

◆ setProperties()

void QQuickPropertyAction::setProperties ( const QString &  p)

Definition at line 1144 of file qquickanimation.cpp.

References d, emit, and propertiesChanged().

+ Here is the call graph for this function:

◆ setProperty()

void QQuickPropertyAction::setProperty ( const QString &  n)

Definition at line 1112 of file qquickanimation.cpp.

References d, emit, and propertyChanged().

+ Here is the call graph for this function:

◆ setTargetObject()

void QQuickPropertyAction::setTargetObject ( QObject *  o)

Definition at line 1095 of file qquickanimation.cpp.

References d, emit, o, and targetChanged().

+ Here is the call graph for this function:

◆ setValue()

void QQuickPropertyAction::setValue ( const QVariant &  v)

Definition at line 1188 of file qquickanimation.cpp.

References d, emit, and valueChanged().

+ Here is the call graph for this function:

◆ target()

QObject * QQuickPropertyAction::target ( ) const

Definition at line 1089 of file qquickanimation.cpp.

References d.

◆ targetChanged

void QQuickPropertyAction::targetChanged ( )
signal

Referenced by setTargetObject().

+ Here is the caller graph for this function:

◆ targets()

QQmlListProperty< QObject > QQuickPropertyAction::targets ( )

◆ transition()

QAbstractAnimationJob * QQuickPropertyAction::transition ( QQuickStateActions &  actions,
QQmlProperties &  modified,
TransitionDirection  direction,
QObject *  defaultTarget = nullptr 
)
overrideprotectedvirtual

Reimplemented from QQuickAbstractAnimation.

Definition at line 1197 of file qquickanimation.cpp.

References QQmlListProperty< T >::append, QList< T >::at(), QQmlListProperty< T >::at, QQmlPropertyData::BypassInterceptor, QByteArray::constData(), QQuickPropertyAnimationPrivate::convertVariant(), d, direction, QQmlPropertyData::DontRemoveBinding, QQuickStateAction::fromValue, i, QQuickAbstractAnimation::initInstance(), QVariant::isValid(), j, myAction, QQmlProperty::name, QQmlProperty::object, QObject::property(), QQuickStateAction::property, Q_UNUSED, QActionAnimation::setAnimAction(), QList< T >::size(), QQuickStateAction::specifiedObject, QQuickStateAction::specifiedProperty, targets, QQuickStateAction::toValue, and QQmlPropertyPrivate::write().

+ Here is the call graph for this function:

◆ value()

QVariant QQuickPropertyAction::value ( ) const

\qmlproperty var QtQuick::PropertyAction::value This property holds the value to be set on the property.

If the PropertyAction is defined within a \l Transition or \l Behavior, this value defaults to the value defined in the end state of the \l Transition, or the value of the property change that triggered the \l Behavior.

Definition at line 1182 of file qquickanimation.cpp.

References d.

◆ valueChanged

void QQuickPropertyAction::valueChanged ( const QVariant &  )
signal

Referenced by setValue().

+ Here is the caller graph for this function:

Property Documentation

◆ exclude

QQmlListProperty< QObject > QQuickPropertyAction::exclude
read

\qmlproperty list<QtObject> QtQuick::PropertyAction::exclude This property holds the objects that should not be affected by this action.

See also
targets

Definition at line 176 of file qquickanimation_p.h.

◆ properties

QString QQuickPropertyAction::properties
readwrite

Definition at line 176 of file qquickanimation_p.h.

◆ property

QString QQuickPropertyAction::property
readwrite

Definition at line 176 of file qquickanimation_p.h.

◆ target

QObject * QQuickPropertyAction::target
readwrite

Definition at line 176 of file qquickanimation_p.h.

◆ targets

QQmlListProperty< QObject > QQuickPropertyAction::targets
read

Definition at line 176 of file qquickanimation_p.h.

Referenced by transition().

◆ value

QVariant QQuickPropertyAction::value
readwrite

Definition at line 176 of file qquickanimation_p.h.

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