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
QQuickParentChange Class Reference

#include <qquickstateoperations_p.h>

Inheritance diagram for QQuickParentChange:
Collaboration diagram for QQuickParentChange:

Public Member Functions

 QQuickParentChange (QObject *parent=nullptr)
 \qmltype ParentChange \nativetype QQuickParentChange \inqmlmodule QtQuick
QQuickItemobject () const
 \qmlproperty Item QtQuick::ParentChange::target This property holds the item to be reparented
void setObject (QQuickItem *)
QQuickItemparent () const
 \qmlproperty Item QtQuick::ParentChange::parent This property holds the new parent for the item in this state.
void setParent (QQuickItem *)
QQuickItemoriginalParent () const
QQmlScriptString x () const
 \qmlproperty real QtQuick::ParentChange::x \qmlproperty real QtQuick::ParentChange::y \qmlproperty real QtQuick::ParentChange::width \qmlproperty real QtQuick::ParentChange::height \qmlproperty real QtQuick::ParentChange::scale \qmlproperty real QtQuick::ParentChange::rotation These properties hold the new position, size, scale, and rotation for the item in this state.
void setX (const QQmlScriptString &x)
bool xIsSet () const
QQmlScriptString y () const
void setY (const QQmlScriptString &y)
bool yIsSet () const
QQmlScriptString width () const
void setWidth (const QQmlScriptString &width)
bool widthIsSet () const
QQmlScriptString height () const
void setHeight (const QQmlScriptString &height)
bool heightIsSet () const
QQmlScriptString scale () const
void setScale (const QQmlScriptString &scale)
bool scaleIsSet () const
QQmlScriptString rotation () const
void setRotation (const QQmlScriptString &rotation)
bool rotationIsSet () const
ActionList actions () override
void saveOriginals () override
void execute () override
bool isReversable () override
void reverse () override
EventType type () const override
bool mayOverride (QQuickStateActionEvent *other) override
void rewind () override
void saveCurrentValues () override
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.
Public Member Functions inherited from QQuickStateActionEvent
virtual ~QQuickStateActionEvent ()
virtual bool needsCopy ()
virtual void copyOriginals (QQuickStateActionEvent *)
virtual bool isRewindable ()
virtual void saveTargetValues ()
virtual bool changesBindings ()
virtual void clearBindings ()

Properties

QQuickItemtarget
QQuickItemparent
QQmlScriptString x
QQmlScriptString y
QQmlScriptString width
QQmlScriptString height
QQmlScriptString scale
QQmlScriptString rotation
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Types inherited from QQuickStateOperation
typedef QList< QQuickStateActionActionList
Public Types inherited from QQuickStateActionEvent
enum  EventType { Script , SignalHandler , ParentChange , AnchorChanges }
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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.
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 29 of file qquickstateoperations_p.h.

Constructor & Destructor Documentation

◆ QQuickParentChange()

QQuickParentChange::QQuickParentChange ( QObject * parent = nullptr)

\qmltype ParentChange \nativetype QQuickParentChange \inqmlmodule QtQuick

Specifies how to reparent an Item in a state change.

ParentChange reparents an item while preserving its visual appearance (position, size, rotation, and scale) on screen. You can then specify a transition to move/resize/rotate/scale the item to its final intended appearance.

ParentChange can only preserve visual appearance if no complex transforms are involved. More specifically, it will not work if the transform property has been set for any items involved in the reparenting (i.e. items in the common ancestor tree for the original and new parent).

The example below displays a large red rectangle and a small blue rectangle, side by side. When the blueRect is clicked, it changes to the "reparented" state: its parent is changed to redRect and it is positioned at (10, 10) within the red rectangle, as specified in the ParentChange.

import QtQuick
Item {
width: 200; height: 100
Rectangle {
id: redRect
width: 100; height: 100
color: "red"
}
Rectangle {
id: blueRect
x: redRect.width
width: 50; height: 50
color: "blue"
states: State {
name: "reparented"
ParentChange { target: blueRect; parent: redRect; x: 10; y: 10 }
}
MouseArea { anchors.fill: parent; onClicked: blueRect.state = "reparented" }
}
}

You can specify at which point in a transition you want a ParentChange to occur by using a ParentAnimation.

Note that unlike PropertyChanges, ParentChange expects an Item-based target; it will not work with arbitrary objects (for example, you couldn't use it to reparent a Timer).

Definition at line 145 of file qquickstateoperations.cpp.

Member Function Documentation

◆ actions()

QQuickStateOperation::ActionList QQuickParentChange::actions ( )
overridevirtual

Reimplemented from QQuickStateOperation.

Definition at line 306 of file qquickstateoperations.cpp.

◆ execute()

void QQuickParentChange::execute ( )
overridevirtual

Reimplemented from QQuickStateActionEvent.

Definition at line 442 of file qquickstateoperations.cpp.

◆ height()

QQmlScriptString QQuickParentChange::height ( ) const

Definition at line 214 of file qquickstateoperations.cpp.

◆ heightIsSet()

bool QQuickParentChange::heightIsSet ( ) const

Definition at line 226 of file qquickstateoperations.cpp.

◆ isReversable()

bool QQuickParentChange::isReversable ( )
overridevirtual

Reimplemented from QQuickStateActionEvent.

Definition at line 448 of file qquickstateoperations.cpp.

◆ mayOverride()

bool QQuickParentChange::mayOverride ( QQuickStateActionEvent * other)
overridevirtual

Reimplemented from QQuickStateActionEvent.

Definition at line 482 of file qquickstateoperations.cpp.

◆ object()

QQuickItem * QQuickParentChange::object ( ) const

\qmlproperty Item QtQuick::ParentChange::target This property holds the item to be reparented

Definition at line 278 of file qquickstateoperations.cpp.

◆ originalParent()

QQuickItem * QQuickParentChange::originalParent ( ) const

Definition at line 268 of file qquickstateoperations.cpp.

◆ parent()

QQuickItem * QQuickParentChange::parent ( ) const

\qmlproperty Item QtQuick::ParentChange::parent This property holds the new parent for the item in this state.

Definition at line 294 of file qquickstateoperations.cpp.

◆ reverse()

void QQuickParentChange::reverse ( )
overridevirtual

Reimplemented from QQuickStateActionEvent.

Definition at line 471 of file qquickstateoperations.cpp.

◆ rewind()

void QQuickParentChange::rewind ( )
overridevirtual

Reimplemented from QQuickStateActionEvent.

Definition at line 523 of file qquickstateoperations.cpp.

◆ rotation()

QQmlScriptString QQuickParentChange::rotation ( ) const

Definition at line 250 of file qquickstateoperations.cpp.

◆ rotationIsSet()

bool QQuickParentChange::rotationIsSet ( ) const

Definition at line 262 of file qquickstateoperations.cpp.

◆ saveCurrentValues()

void QQuickParentChange::saveCurrentValues ( )
overridevirtual

Reimplemented from QQuickStateActionEvent.

Definition at line 492 of file qquickstateoperations.cpp.

◆ saveOriginals()

void QQuickParentChange::saveOriginals ( )
overridevirtual

Reimplemented from QQuickStateActionEvent.

Definition at line 433 of file qquickstateoperations.cpp.

◆ scale()

QQmlScriptString QQuickParentChange::scale ( ) const

Definition at line 232 of file qquickstateoperations.cpp.

◆ scaleIsSet()

bool QQuickParentChange::scaleIsSet ( ) const

Definition at line 244 of file qquickstateoperations.cpp.

◆ setHeight()

void QQuickParentChange::setHeight ( const QQmlScriptString & height)

Definition at line 220 of file qquickstateoperations.cpp.

◆ setObject()

void QQuickParentChange::setObject ( QQuickItem * target)

Definition at line 284 of file qquickstateoperations.cpp.

◆ setParent()

void QQuickParentChange::setParent ( QQuickItem * parent)

Definition at line 300 of file qquickstateoperations.cpp.

◆ setRotation()

void QQuickParentChange::setRotation ( const QQmlScriptString & rotation)

Definition at line 256 of file qquickstateoperations.cpp.

◆ setScale()

void QQuickParentChange::setScale ( const QQmlScriptString & scale)

Definition at line 238 of file qquickstateoperations.cpp.

◆ setWidth()

void QQuickParentChange::setWidth ( const QQmlScriptString & width)

Definition at line 202 of file qquickstateoperations.cpp.

◆ setX()

void QQuickParentChange::setX ( const QQmlScriptString & x)

Definition at line 166 of file qquickstateoperations.cpp.

◆ setY()

void QQuickParentChange::setY ( const QQmlScriptString & y)

Definition at line 184 of file qquickstateoperations.cpp.

◆ type()

QQuickStateActionEvent::EventType QQuickParentChange::type ( ) const
overridevirtual

Implements QQuickStateActionEvent.

Definition at line 477 of file qquickstateoperations.cpp.

◆ width()

QQmlScriptString QQuickParentChange::width ( ) const

Definition at line 196 of file qquickstateoperations.cpp.

◆ widthIsSet()

bool QQuickParentChange::widthIsSet ( ) const

Definition at line 208 of file qquickstateoperations.cpp.

◆ x()

QQmlScriptString QQuickParentChange::x ( ) const

\qmlproperty real QtQuick::ParentChange::x \qmlproperty real QtQuick::ParentChange::y \qmlproperty real QtQuick::ParentChange::width \qmlproperty real QtQuick::ParentChange::height \qmlproperty real QtQuick::ParentChange::scale \qmlproperty real QtQuick::ParentChange::rotation These properties hold the new position, size, scale, and rotation for the item in this state.

Definition at line 160 of file qquickstateoperations.cpp.

◆ xIsSet()

bool QQuickParentChange::xIsSet ( ) const

Definition at line 172 of file qquickstateoperations.cpp.

◆ y()

QQmlScriptString QQuickParentChange::y ( ) const

Definition at line 178 of file qquickstateoperations.cpp.

◆ yIsSet()

bool QQuickParentChange::yIsSet ( ) const

Definition at line 190 of file qquickstateoperations.cpp.

Property Documentation

◆ height

QQmlScriptString QQuickParentChange::height
readwrite

Definition at line 39 of file qquickstateoperations_p.h.

◆ parent

QQuickItem * QQuickParentChange::parent
readwrite

Definition at line 35 of file qquickstateoperations_p.h.

◆ rotation

QQmlScriptString QQuickParentChange::rotation
readwrite

Definition at line 41 of file qquickstateoperations_p.h.

◆ scale

QQmlScriptString QQuickParentChange::scale
readwrite

Definition at line 40 of file qquickstateoperations_p.h.

◆ target

QQuickItem * QQuickParentChange::target
readwrite

Definition at line 34 of file qquickstateoperations_p.h.

◆ width

QQmlScriptString QQuickParentChange::width
readwrite

Definition at line 38 of file qquickstateoperations_p.h.

◆ x

QQmlScriptString QQuickParentChange::x
readwrite

Definition at line 36 of file qquickstateoperations_p.h.

◆ y

QQmlScriptString QQuickParentChange::y
readwrite

Definition at line 37 of file qquickstateoperations_p.h.


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