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

#include <qquickitemviewtransition_p.h>

+ Inheritance diagram for QQuickViewTransitionAttached:
+ Collaboration diagram for QQuickViewTransitionAttached:

Signals

void indexChanged ()
 
void itemChanged ()
 
void destinationChanged ()
 
void targetIndexesChanged ()
 
void targetItemsChanged ()
 
- 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

 QQuickViewTransitionAttached (QObject *parent)
 
int index () const
 
QQuickItemitem () const
 
QPointF destination () const
 
QList< int > targetIndexes () const
 
QQmlListProperty< QObjecttargetItems ()
 
- 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.
 

Static Public Member Functions

static QQuickViewTransitionAttachedqmlAttachedProperties (QObject *)
 
- 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)
 

Properties

int index
 
QQuickItemitem
 
QPointF destination
 
QList< int > targetIndexes
 
QQmlListProperty< QObjecttargetItems
 \qmltype ViewTransition \nativetype QQuickViewTransitionAttached \inqmlmodule QtQuick
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QQuickItemViewTransitionJob
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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 153 of file qquickitemviewtransition_p.h.

Constructor & Destructor Documentation

◆ QQuickViewTransitionAttached()

QQuickViewTransitionAttached::QQuickViewTransitionAttached ( QObject * parent)

Definition at line 556 of file qquickitemviewtransition.cpp.

Member Function Documentation

◆ destination()

QPointF QQuickViewTransitionAttached::destination ( ) const
inline

Definition at line 174 of file qquickitemviewtransition_p.h.

◆ destinationChanged

void QQuickViewTransitionAttached::destinationChanged ( )
signal

◆ index()

int QQuickViewTransitionAttached::index ( ) const
inline

Definition at line 172 of file qquickitemviewtransition_p.h.

◆ indexChanged

void QQuickViewTransitionAttached::indexChanged ( )
signal

◆ item()

QQuickItem * QQuickViewTransitionAttached::item ( ) const
inline

Definition at line 173 of file qquickitemviewtransition_p.h.

◆ itemChanged

void QQuickViewTransitionAttached::itemChanged ( )
signal

◆ qmlAttachedProperties()

QQuickViewTransitionAttached * QQuickViewTransitionAttached::qmlAttachedProperties ( QObject * obj)
static

Definition at line 930 of file qquickitemviewtransition.cpp.

◆ targetIndexes()

QList< int > QQuickViewTransitionAttached::targetIndexes ( ) const
inline

Definition at line 176 of file qquickitemviewtransition_p.h.

◆ targetIndexesChanged

void QQuickViewTransitionAttached::targetIndexesChanged ( )
signal

◆ targetItems()

QQmlListProperty< QObject > QQuickViewTransitionAttached::targetItems ( )

◆ targetItemsChanged

void QQuickViewTransitionAttached::targetItemsChanged ( )
signal

Friends And Related Symbol Documentation

◆ QQuickItemViewTransitionJob

friend class QQuickItemViewTransitionJob
friend

Definition at line 190 of file qquickitemviewtransition_p.h.

Property Documentation

◆ destination

QPointF QQuickViewTransitionAttached::destination
read

Definition at line 159 of file qquickitemviewtransition_p.h.

◆ index

int QQuickViewTransitionAttached::index
read

Definition at line 157 of file qquickitemviewtransition_p.h.

◆ item

QQuickItem* QQuickViewTransitionAttached::item
read

Definition at line 158 of file qquickitemviewtransition_p.h.

◆ targetIndexes

QList<int> QQuickViewTransitionAttached::targetIndexes
read

Definition at line 161 of file qquickitemviewtransition_p.h.

◆ targetItems

QQmlListProperty< QObject > QQuickViewTransitionAttached::targetItems
read

\qmltype ViewTransition \nativetype QQuickViewTransitionAttached \inqmlmodule QtQuick

Specifies items under transition in a view.

With ListView and GridView, it is possible to specify transitions that should be applied whenever the items in the view change as a result of modifications to the view's model. They both have the following properties that can be set to the appropriate transitions to be run for various operations:

\list

  • populate - the transition to apply to the items created initially for the view, or when the model changes
  • add - the transition to apply to items that are added to the view after it has been created
  • remove - the transition to apply to items that are removed from the view
  • move - the transition to apply to items that are moved within the view (i.e. as a result of a move operation in the model)
  • displaced - the generic transition to be applied to any items that are displaced by an add, move or remove operation
  • addDisplaced, removeDisplaced and moveDisplaced - the transitions to be applied when items are displaced by add, move, or remove operations, respectively (these override the generic displaced transition if specified) \endlist

For the \l Row, \l Column, \l Grid and \l Flow positioner types, which operate with collections of child items rather than data models, the following properties are used instead:

\list

  • populate - the transition to apply to items that have been added to the positioner at the time of its creation
  • add - the transition to apply to items that are added to or reparented to the positioner, or items that have become \l {Item::}{visible}
  • move - the transition to apply to items that have moved within the positioner, including when they are displaced due to the addition or removal of other items, or when items are otherwise rearranged within the positioner, or when items are repositioned due to the resizing of other items in the positioner \endlist

View transitions have access to a ViewTransition attached property that provides details of the items that are under transition and the operation that triggered the transition. Since view transitions are run once per item, these details can be used to customize each transition for each individual item.

The ViewTransition attached property provides the following properties specific to the item to which the transition is applied:

\list

  • ViewTransition.item - the item that is under transition
  • ViewTransition.index - the index of this item
  • ViewTransition.destination - the (x,y) point to which this item is moving for the relevant view operation \endlist

In addition, ViewTransition provides properties specific to the items which are the target of the operation that triggered the transition:

\list

  • ViewTransition.targetIndexes - the indexes of the target items
  • ViewTransition.targetItems - the target items themselves \endlist

(Note that for the \l Row, \l Column, \l Grid and \l Flow positioner types, the move transition only provides these two additional details when the transition is triggered by the addition of items to a positioner.)

View transitions can be written without referring to any of the attributes listed above. These attributes merely provide extra details that are useful for customising view transitions.

Following is an introduction to view transitions and the ways in which the ViewTransition attached property can be used to augment view transitions.

Definition at line 162 of file qquickitemviewtransition_p.h.


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