QQmlListReference Class

QQmlListReference ref1(object, "children");

const QVariant var = object->property("children");
QQmlListReference ref2(var);

Member Function Documentation

QQmlListReference::QQmlListReference()

Constructs an invalid instance.

[explicit, since 6.1] QQmlListReference::QQmlListReference(const QVariant &variant)

Constructs a QQmlListReference from a QVariant variant containing a QQmlListProperty. If variant does not contain a list property, an invalid QQmlListReference is created. If the object owning the list property is destroyed after the reference is constructed, it will automatically become invalid. That is, it is safe to hold QQmlListReference instances even after the object is deleted.

This function was introduced in Qt 6.1.

QQmlListReference::QQmlListReference(QObject *object, const char *property)

Constructs a QQmlListReference for object's property. If property is not a list property, an invalid QQmlListReference is created. If object is destroyed after the reference is constructed, it will automatically become invalid. That is, it is safe to hold QQmlListReference instances even after object is deleted.

bool QQmlListReference::append(QObject *object) const

Appends object to the list. Returns true if the operation succeeded, otherwise false.

See also canAppend().

QObject *QQmlListReference::at(qsizetype index) const

Returns the list element at index, or nullptr if the operation failed.

See also canAt().

bool QQmlListReference::canAppend() const

Returns true if the list property can be appended to, otherwise false. Returns false if the reference is invalid.

See also append().

bool QQmlListReference::canAt() const

Returns true if the list property can queried by index, otherwise false. Returns false if the reference is invalid.

See also at().

bool QQmlListReference::canClear() const

Returns true if the list property can be cleared, otherwise false. Returns false if the reference is invalid.

See also clear().

bool QQmlListReference::canCount() const

Returns true if the list property can be queried for its element count, otherwise false. Returns false if the reference is invalid.

See also count().

bool QQmlListReference::canRemoveLast() const

Returns true if the last item can be removed from the list property, otherwise false. Returns false if the reference is invalid.

See also removeLast().

bool QQmlListReference::canReplace() const

Returns true if items in the list property can be replaced, otherwise false. Returns false if the reference is invalid.

See also replace().

bool QQmlListReference::clear() const

Clears the list. Returns true if the operation succeeded, otherwise false.

See also canClear().

qsizetype QQmlListReference::count() const

Returns the number of items in the list, or 0 if the operation failed.

bool QQmlListReference::isManipulable() const

Return true if at(), count(), append(), and either clear() or removeLast() are implemented, so you can manipulate the list.

Mind that replace() and removeLast() can be emulated by stashing all items and rebuilding the list using clear() and append(). Therefore, they are not required for the list to be manipulable. Furthermore, clear() can be emulated using removeLast().

See also isReadable(), at(), count(), append(), clear(), replace(), and removeLast().

bool QQmlListReference::isReadable() const

Return true if at() and count() are implemented, so you can access the elements.

See also isManipulable(), at(), and count().

bool QQmlListReference::isValid() const

Returns true if the instance refers to a valid list property, otherwise false.

const QMetaObject *QQmlListReference::listElementType() const

Returns the QMetaObject for the elements stored in the list property, or nullptr if the reference is invalid.

The QMetaObject can be used ahead of time to determine whether a given instance can be added to a list. If you didn't pass an engine on construction this may return nullptr.

QObject *QQmlListReference::object() const

Returns the list property's object. Returns nullptr if the reference is invalid.

bool QQmlListReference::removeLast() const

Removes the last item in the list. Returns true if the operation succeeded, otherwise false.

See also canRemoveLast().

bool QQmlListReference::replace(qsizetype index, QObject *object) const

Replaces the item at index in the list with object. Returns true if the operation succeeded, otherwise false.

See also canReplace().

[since 6.2] qsizetype QQmlListReference::size() const

Returns the number of items in the list, or 0 if the operation failed.

This function was introduced in Qt 6.2.

bool QQmlListReference::operator==(const QQmlListReference &other) const

Compares this QQmlListReference to other, and returns true if they are equal. The two are only considered equal if one was created from the other via copy assignment or copy construction.