QWeakPointer Class

Member Function Documentation

Returns true if and only if this smart pointer precedes other in an implementation-defined owner-based ordering. The ordering is such that two smart pointers are considered equivalent if they are both empty or if they both own the same object (even if their apparent type and pointer are different).

This function was introduced in Qt 6.7.

See also owner_equal.

Returns true if and only if this smart pointer and other share ownership.

This function was introduced in Qt 6.7.

See also owner_before and owner_hash.

[noexcept, since 6.7] size_t QWeakPointer::owner_hash() const

Returns a owner-based hash value for this smart pointer object. Smart pointers that compare equal (as per owner_equal) will have an identical owner-based hash.

This function was introduced in Qt 6.7.

See also owner_equal.

QWeakPointer::QWeakPointer()

Creates a QWeakPointer that points to nothing.

QWeakPointer::QWeakPointer(const QSharedPointer<T> &other)

Creates a QWeakPointer that holds a weak reference to the pointer referenced by other.

If T is a derived type of the template parameter of this class, QWeakPointer will perform an automatic cast. Otherwise, you will get a compiler error.

[noexcept] QWeakPointer::QWeakPointer(const QWeakPointer<T> &other)

Creates a QWeakPointer that holds a weak reference to the pointer referenced by other.

If T is a derived type of the template parameter of this class, QWeakPointer will perform an automatic cast. Otherwise, you will get a compiler error.

QWeakPointer::~QWeakPointer()

Destroys this QWeakPointer object. The pointer referenced by this object will not be deleted.

void QWeakPointer::clear()

Clears this QWeakPointer object, dropping the reference that it may have had to the pointer.

bool QWeakPointer::isNull() const

Returns true if this object refers to nullptr.

Note that, due to the nature of weak references, the pointer that QWeakPointer references can become nullptr at any moment, so the value returned from this function can change from false to true from one call to the next.

QSharedPointer<T> QWeakPointer::lock() const

Same as toStrongRef().

This function is provided for API compatibility with std::weak_ptr.

[noexcept] void QWeakPointer::swap(QWeakPointer<T> &other)

Swaps this weak pointer instance with other. This function is very fast and never fails.

QSharedPointer<T> QWeakPointer::toStrongRef() const

Promotes this weak reference to a strong one and returns a QSharedPointer object holding that reference. When promoting to QSharedPointer, this function verifies if the object has been deleted already or not. If it hasn't, this function increases the reference count to the shared object, thus ensuring that it will not get deleted.

Since this function can fail to obtain a valid strong reference to the shared object, you should always verify if the conversion succeeded, by calling QSharedPointer::isNull() on the returned object.

For example, the following code promotes a QWeakPointer that was held to a strong reference and, if it succeeded, it prints the value of the integer that was held:

    QWeakPointer<int> weakref;

    // ...

    QSharedPointer<int> strong = weakref.toStrongRef();
    if (strong)
        qDebug() << "The value is:" << *strong;
    else
        qDebug() << "The value has already been deleted";

See also QSharedPointer::QSharedPointer().

bool QWeakPointer::operator bool() const

Returns true if the contained pointer is not nullptr. This function is suitable for use in if-constructs, like:

    if (weakref) { ... }

Note that, due to the nature of weak references, the pointer that QWeakPointer references can become nullptr at any moment, so the value returned from this function can change from true to false from one call to the next.

See also isNull().

bool QWeakPointer::operator!() const

Returns true if this object refers to nullptr. This function is suitable for use in if-constructs, like:

    if (!weakref) { ... }

Note that, due to the nature of weak references, the pointer that QWeakPointer references can become nullptr at any moment, so the value returned from this function can change from false to true from one call to the next.

See also isNull().

[noexcept] QWeakPointer<T> &QWeakPointer::operator=(const QWeakPointer<T> &other)

Makes this object share other's pointer. The current pointer reference is discarded but is not deleted.

If T is a derived type of the template parameter of this class, QWeakPointer will perform an automatic cast. Otherwise, you will get a compiler error.

QWeakPointer<T> &QWeakPointer::operator=(const QSharedPointer<T> &other)

Makes this object share other's pointer. The current pointer reference is discarded but is not deleted.

If T is a derived type of the template parameter of this class, QWeakPointer will perform an automatic cast. Otherwise, you will get a compiler error.