Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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 25 of file qquickpropertychanges_p.h.

Constructor & Destructor Documentation

◆ QQuickPropertyChanges()

QQuickPropertyChanges::QQuickPropertyChanges ( )

Definition at line 362 of file qquickpropertychanges.cpp.

◆ ~QQuickPropertyChanges()

QQuickPropertyChanges::~QQuickPropertyChanges ( )

Definition at line 367 of file qquickpropertychanges.cpp.

Member Function Documentation

◆ actions()

QQuickPropertyChanges::ActionList QQuickPropertyChanges::actions ( )
overridevirtual

Reimplemented from QQuickStateOperation.

Definition at line 431 of file qquickpropertychanges.cpp.

◆ attachToState()

void QQuickPropertyChanges::attachToState ( )

Definition at line 783 of file qquickpropertychanges.cpp.

◆ changeExpression()

void QQuickPropertyChanges::changeExpression ( const QString & name,
const QString & expression )

Definition at line 629 of file qquickpropertychanges.cpp.

◆ changeValue()

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

Definition at line 584 of file qquickpropertychanges.cpp.

◆ containsExpression()

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

Definition at line 565 of file qquickpropertychanges.cpp.

◆ containsProperty()

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

Definition at line 579 of file qquickpropertychanges.cpp.

◆ containsValue()

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

Definition at line 551 of file qquickpropertychanges.cpp.

◆ detachFromState()

void QQuickPropertyChanges::detachFromState ( )

Definition at line 777 of file qquickpropertychanges.cpp.

◆ expression()

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

Definition at line 763 of file qquickpropertychanges.cpp.

◆ isExplicit()

bool QQuickPropertyChanges::isExplicit ( ) const

\qmlproperty bool QtQuick::PropertyChanges::explicit

If explicit is set to true, bindings will be interpreted as assignments. The expression will only be evaluated once, and no updates happen, even if dependencies change.

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 536 of file qquickpropertychanges.cpp.

◆ isExplicitChanged

void QQuickPropertyChanges::isExplicitChanged ( )
signal

◆ object()

QObject * QQuickPropertyChanges::object ( ) const

Definition at line 374 of file qquickpropertychanges.cpp.

◆ objectChanged

void QQuickPropertyChanges::objectChanged ( )
signal

◆ property()

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

Definition at line 707 of file qquickpropertychanges.cpp.

◆ removeProperty()

void QQuickPropertyChanges::removeProperty ( const QString & name)

Definition at line 728 of file qquickpropertychanges.cpp.

◆ 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 398 of file qquickpropertychanges.cpp.

◆ restoreEntryValuesChanged

void QQuickPropertyChanges::restoreEntryValuesChanged ( )
signal

◆ setIsExplicit()

void QQuickPropertyChanges::setIsExplicit ( bool e)

Definition at line 542 of file qquickpropertychanges.cpp.

◆ setObject()

void QQuickPropertyChanges::setObject ( QObject * o)

Definition at line 380 of file qquickpropertychanges.cpp.

◆ setRestoreEntryValues()

void QQuickPropertyChanges::setRestoreEntryValues ( bool v)

Definition at line 404 of file qquickpropertychanges.cpp.

◆ value()

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

Definition at line 749 of file qquickpropertychanges.cpp.

Property Documentation

◆ explicit

bool QQuickPropertyChanges::explicit
readwrite

Definition at line 32 of file qquickpropertychanges_p.h.

◆ restoreEntryValues

bool QQuickPropertyChanges::restoreEntryValues
readwrite

Definition at line 30 of file qquickpropertychanges_p.h.

◆ target

QObject * QQuickPropertyChanges::target
readwrite

Definition at line 29 of file qquickpropertychanges_p.h.


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