Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickPropertyChanges Class Reference

#include <qquickpropertychanges_p.h>

+ Inheritance diagram for QQuickPropertyChanges:
+ Collaboration diagram for QQuickPropertyChanges:

Signals

void objectChanged ()
 
void restoreEntryValuesChanged ()
 
void isExplicitChanged ()
 
- 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

 QQuickPropertyChanges ()
 
 ~QQuickPropertyChanges ()
 
QObjectobject () const
 
void setObject (QObject *)
 
bool restoreEntryValues () const
 \qmlproperty bool QtQuick::PropertyChanges::restoreEntryValues
 
void setRestoreEntryValues (bool)
 
bool isExplicit () const
 \qmlproperty bool QtQuick::PropertyChanges::explicit
 
void setIsExplicit (bool)
 
ActionList actions () override
 
bool containsProperty (const QString &name) const
 
bool containsValue (const QString &name) const
 
bool containsExpression (const QString &name) const
 
void changeValue (const QString &name, const QVariant &value)
 
void changeExpression (const QString &name, const QString &expression)
 
void removeProperty (const QString &name)
 
QVariant value (const QString &name) const
 
QString expression (const QString &name) const
 
void detachFromState ()
 
void attachToState ()
 
QVariant property (const QString &name) const
 
- Public Member Functions inherited from QQuickStateOperation
 QQuickStateOperation (QObject *parent=nullptr)
 
QQuickStatestate () const
 
void setState (QQuickState *state)
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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

QObjecttarget
 
bool restoreEntryValues
 
bool explicit
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QQuickStateOperation
typedef QList< QQuickStateActionActionList
 
- 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 QQuickStateOperation
 QQuickStateOperation (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObjectsender () 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< QObjectDatad_ptr
 

Detailed Description

Definition at line 24 of file qquickpropertychanges_p.h.

Constructor & Destructor Documentation

◆ QQuickPropertyChanges()

QQuickPropertyChanges::QQuickPropertyChanges ( )

Definition at line 355 of file qquickpropertychanges.cpp.

◆ ~QQuickPropertyChanges()

QQuickPropertyChanges::~QQuickPropertyChanges ( )

Definition at line 360 of file qquickpropertychanges.cpp.

References d.

Member Function Documentation

◆ actions()

◆ attachToState()

void QQuickPropertyChanges::attachToState ( )

Definition at line 775 of file qquickpropertychanges.cpp.

References actions(), QQuickState::addEntriesToRevertList(), and QQuickStateOperation::state().

Referenced by QQuickDesignerSupportPropertyChanges::attachToState().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ changeExpression()

◆ changeValue()

void QQuickPropertyChanges::changeValue ( const QString & name,
const QVariant & value )

Definition at line 576 of file qquickpropertychanges.cpp.

References QQuickState::addEntryToRevertList(), QSet< T >::begin(), QQmlPropertyPrivate::binding(), QQmlPropertyData::BypassInterceptor, d, QQmlPropertyData::DontRemoveBinding, QQuickStateAction::fromValue, QQuickState::isStateActive(), it, object(), QQmlProperty::property(), QQuickStateAction::property, QQmlProperty::read(), QQmlPropertyPrivate::removeBinding(), QQuickStateAction::restore, restoreEntryValues, QQuickStateAction::specifiedObject, QQuickStateAction::specifiedProperty, QQuickStateOperation::state(), and QQuickStateAction::toValue.

Referenced by QQuickDesignerSupportPropertyChanges::changeValue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ containsExpression()

bool QQuickPropertyChanges::containsExpression ( const QString & name) const

Definition at line 557 of file qquickpropertychanges.cpp.

References d.

Referenced by containsProperty().

+ Here is the caller graph for this function:

◆ containsProperty()

bool QQuickPropertyChanges::containsProperty ( const QString & name) const

Definition at line 571 of file qquickpropertychanges.cpp.

References containsExpression(), and containsValue().

+ Here is the call graph for this function:

◆ containsValue()

bool QQuickPropertyChanges::containsValue ( const QString & name) const

Definition at line 543 of file qquickpropertychanges.cpp.

References d.

Referenced by containsProperty().

+ Here is the caller graph for this function:

◆ detachFromState()

void QQuickPropertyChanges::detachFromState ( )

Definition at line 769 of file qquickpropertychanges.cpp.

References QQuickState::removeAllEntriesFromRevertList(), and QQuickStateOperation::state().

Referenced by QQuickDesignerSupportPropertyChanges::detachFromState().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ expression()

QString QQuickPropertyChanges::expression ( const QString & name) const

Definition at line 755 of file qquickpropertychanges.cpp.

References d, and QQuickPropertyChangesPrivate::ExpressionChange::expression.

Referenced by changeExpression().

+ Here is the caller graph for this function:

◆ isExplicit()

bool QQuickPropertyChanges::isExplicit ( ) const

\qmlproperty bool QtQuick::PropertyChanges::explicit

If explicit is set to true, any potential bindings will be interpreted as once-off assignments that occur when the state is entered.

In the following example, the addition of explicit prevents myItem.width from being bound to parent.width. Instead, it is assigned the value of parent.width at the time of the state change. \qml PropertyChanges { target: myItem explicit: true width: parent.width } \endqml

By default, explicit is false.

Definition at line 528 of file qquickpropertychanges.cpp.

References d.

◆ isExplicitChanged

void QQuickPropertyChanges::isExplicitChanged ( )
signal

Referenced by setIsExplicit().

+ Here is the caller graph for this function:

◆ object()

QObject * QQuickPropertyChanges::object ( ) const

Definition at line 367 of file qquickpropertychanges.cpp.

References d.

Referenced by changeExpression(), changeValue(), and QQuickDesignerSupportPropertyChanges::targetObject().

+ Here is the caller graph for this function:

◆ objectChanged

void QQuickPropertyChanges::objectChanged ( )
signal

Referenced by setObject().

+ Here is the caller graph for this function:

◆ property()

QVariant QQuickPropertyChanges::property ( const QString & name) const

Definition at line 699 of file qquickpropertychanges.cpp.

References d.

Referenced by QQuickDesignerSupportPropertyChanges::getProperty().

+ Here is the caller graph for this function:

◆ removeProperty()

void QQuickPropertyChanges::removeProperty ( const QString & name)

Definition at line 720 of file qquickpropertychanges.cpp.

References QSet< T >::begin(), d, it, QQuickState::removeEntryFromRevertList(), and QQuickStateOperation::state().

Referenced by QQuickDesignerSupportPropertyChanges::removeProperty().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ restoreEntryValues()

bool QQuickPropertyChanges::restoreEntryValues ( ) const

\qmlproperty bool QtQuick::PropertyChanges::restoreEntryValues

This property holds whether the previous values should be restored when leaving the state.

The default value is true. Setting this value to false creates a temporary state that has permanent effects on property values.

Definition at line 391 of file qquickpropertychanges.cpp.

References d.

◆ restoreEntryValuesChanged

void QQuickPropertyChanges::restoreEntryValuesChanged ( )
signal

Referenced by setRestoreEntryValues().

+ Here is the caller graph for this function:

◆ setIsExplicit()

void QQuickPropertyChanges::setIsExplicit ( bool e)

Definition at line 534 of file qquickpropertychanges.cpp.

References d, emit, and isExplicitChanged().

+ Here is the call graph for this function:

◆ setObject()

void QQuickPropertyChanges::setObject ( QObject * o)

Definition at line 373 of file qquickpropertychanges.cpp.

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

+ Here is the call graph for this function:

◆ setRestoreEntryValues()

void QQuickPropertyChanges::setRestoreEntryValues ( bool v)

Definition at line 397 of file qquickpropertychanges.cpp.

References d, emit, and restoreEntryValuesChanged().

+ Here is the call graph for this function:

◆ value()

QVariant QQuickPropertyChanges::value ( const QString & name) const

Definition at line 741 of file qquickpropertychanges.cpp.

References d.

Property Documentation

◆ explicit

bool QQuickPropertyChanges::explicit
readwrite

Definition at line 31 of file qquickpropertychanges_p.h.

◆ restoreEntryValues

bool QQuickPropertyChanges::restoreEntryValues
readwrite

Definition at line 29 of file qquickpropertychanges_p.h.

Referenced by actions(), changeExpression(), and changeValue().

◆ target

QObject * QQuickPropertyChanges::target
readwrite

Definition at line 28 of file qquickpropertychanges_p.h.


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