\inmodule QtCore More...

#include <qsharedpointer_impl.h>

Collaboration diagram for QSharedPointer< T >:

Public Types
typedef T	Type

typedef T	element_type

typedef T	value_type

typedef value_type *	pointer

typedef const value_type *	const_pointer

typedef value_type &	reference

typedef const value_type &	const_reference

typedef qptrdiff	difference_type

Public Member Functions
T *	data () const noexcept
	Returns the value of the pointer referenced by this object.

T *	get () const noexcept

bool	isNull () const noexcept
	Returns `true` if this object refers to \nullptr.

	operator bool () const noexcept
	Returns `true` if the contained pointer is not \nullptr.

bool	operator! () const noexcept
	Returns `true` if this object refers to \nullptr.

T &	operator* () const
	Provides access to the shared pointer's members.

T *	operator-> () const noexcept
	Provides access to the shared pointer's members.

Q_NODISCARD_CTOR constexpr	QSharedPointer () noexcept

	~QSharedPointer ()
	Destroys this QSharedPointer object.

Q_NODISCARD_CTOR constexpr	QSharedPointer (std::nullptr_t) noexcept

template<class X , IfCompatible< X > = true>
Q_NODISCARD_CTOR	QSharedPointer (X *ptr)
	Creates a QSharedPointer that points to ptr.

template<class X , typename Deleter , IfCompatible< X > = true>
Q_NODISCARD_CTOR	QSharedPointer (X *ptr, Deleter deleter)
	Creates a QSharedPointer that points to ptr.

template<typename Deleter >
Q_NODISCARD_CTOR	QSharedPointer (std::nullptr_t, Deleter deleter)

Q_NODISCARD_CTOR	QSharedPointer (const QSharedPointer &other) noexcept
	Creates a QSharedPointer object that shares other's pointer.

QSharedPointer &	operator= (const QSharedPointer &other) noexcept
	Makes this object share other's pointer.

Q_NODISCARD_CTOR	QSharedPointer (QSharedPointer &&other) noexcept
	Move-constructs a QSharedPointer instance, making it point at the same object that other was pointing to.

template<class X , IfCompatible< X > = true>
Q_NODISCARD_CTOR	QSharedPointer (QSharedPointer< X > &&other) noexcept
	Move-constructs a QSharedPointer instance, making it point at the same object that other was pointing to.

template<class X , IfCompatible< X > = true>
QSharedPointer &	operator= (QSharedPointer< X > &&other) noexcept
	Move-assigns other to this QSharedPointer instance.

template<class X , IfCompatible< X > = true>
Q_NODISCARD_CTOR	QSharedPointer (const QSharedPointer< X > &other) noexcept

template<class X , IfCompatible< X > = true>
QSharedPointer &	operator= (const QSharedPointer< X > &other)

template<class X , IfCompatible< X > = true>
Q_NODISCARD_CTOR	QSharedPointer (const QWeakPointer< X > &other)

template<class X , IfCompatible< X > = true>
QSharedPointer< T > &	operator= (const QWeakPointer< X > &other)

void	swap (QSharedPointer &other) noexcept

void	reset ()

void	reset (T *t)

template<typename Deleter >
void	reset (T *t, Deleter deleter)

template<class X >
QSharedPointer< X >	staticCast () const
	Performs a static cast from this pointer's type to \tt X and returns a QSharedPointer that shares the reference.

template<class X >
QSharedPointer< X >	dynamicCast () const
	Performs a dynamic cast from this pointer's type to \tt X and returns a QSharedPointer that shares the reference.

template<class X >
QSharedPointer< X >	constCast () const
	Performs a \tt const_cast from this pointer's type to \tt X and returns a QSharedPointer that shares the reference.

template<class X >
QSharedPointer< X >	objectCast () const

void	clear ()
	Clears this QSharedPointer object, dropping the reference that it may have had to the pointer.

QWeakPointer< T >	toWeakRef () const
	Returns a weak reference object that shares the pointer referenced by this object.

	DECLARE_TEMPLATE_COMPARE_SET (const QSharedPointer &p1, p1.data(), const QSharedPointer< X > &p2, p2.data()) private

void	deref () noexcept

template<class X >
void	enableSharedFromThis (const QEnableSharedFromThis< X > *ptr)

void	enableSharedFromThis (...)

template<typename X , typename Deleter >
void	internalConstruct (X *ptr, Deleter deleter)

void	internalSwap (QSharedPointer &other) noexcept

void	ref () const noexcept

void	internalSet (Data o, T actual)

Static Public Member Functions
template<typename... Args>
static QSharedPointer	create (Args &&...arguments)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

static void	deref (Data *dd) noexcept

Public Attributes
Type *	value

Data *	d

Friends
template<class X >
class	QSharedPointer
	Creates a QSharedPointer that is null (the object is holding a reference to \nullptr).

template<class X >
class	QWeakPointer

template<class X , class Y >
QSharedPointer< X >	QtSharedPointer::copyAndSetPointer (X *ptr, const QSharedPointer< Y > &src)

Related Symbols
(Note that these are not member symbols.)
template< typename T > QDebug	operator<< (QDebug debug, const QSharedPointer< T > &ptr)

template< class T >	qHash (const QSharedPointer< T > &key, size_t seed)
	Returns the hash value for key, using seed to seed the calculation.

template< class T > template< class X > bool	operator== (const QSharedPointer< T > &ptr1, const QSharedPointer< X > &ptr2)
	Returns `true` if ptr1 and ptr2 refer to the same pointer.

template< class T > template< class X > bool	operator!= (const QSharedPointer< T > &ptr1, const QSharedPointer< X > &ptr2)
	Returns `true` if ptr1 and ptr2 refer to distinct pointers.

template< class T > template< class X > bool	operator== (const QSharedPointer< T > &ptr1, const X *ptr2)
	Returns `true` if ptr1 and ptr2 refer to the same pointer.

template< class T > template< class X > bool	operator!= (const QSharedPointer< T > &ptr1, const X *ptr2)
	Returns `true` if ptr1 and ptr2 refer to distinct pointers.

template< class T > template< class X > bool	operator== (const T *ptr1, const QSharedPointer< X > &ptr2)
	Returns `true` if the pointer ptr1 is the same pointer as that referenced by ptr2.

template< class T > template< class X > bool	operator!= (const T *ptr1, const QSharedPointer< X > &ptr2)
	Returns `true` if the pointer ptr1 is not the same pointer as that referenced by ptr2.

template< class T > bool	operator== (const QSharedPointer< T > &lhs, std::nullptr_t)

template< class T > bool	operator== (std::nullptr_t, const QSharedPointer< T > &rhs)

template< class T > bool	operator!= (const QSharedPointer< T > &lhs, std::nullptr_t)

template< class T > bool	operator!= (std::nullptr_t, const QSharedPointer< T > &rhs)

template< class X > template< class T > QSharedPointer< X >	qSharedPointerCast (const QSharedPointer< T > &other)
	Returns a shared pointer to the pointer held by other, cast to type \tt X.

template< class X > template< class T > QSharedPointer< X >	qSharedPointerDynamicCast (const QSharedPointer< T > &src)
	Returns a shared pointer to the pointer held by src, using a dynamic cast to type \tt X to obtain an internal pointer of the appropriate type.

template< class X > template< class T > QSharedPointer< X >	qSharedPointerConstCast (const QSharedPointer< T > &src)
	Returns a shared pointer to the pointer held by src, cast to type \tt X.

template< class X > template< class T > QSharedPointer< X >	qSharedPointerObjectCast (const QSharedPointer< T > &src)
	The qSharedPointerObjectCast function is for casting a shared pointer.

template< class X, class T > std::shared_ptr< X >	qSharedPointerObjectCast (const std::shared_ptr< T > &src)

template< class X, class T > std::shared_ptr< X >	qobject_pointer_cast (const std::shared_ptr< T > &src)

template< class X, class T > std::shared_ptr< X >	qSharedPointerObjectCast (std::shared_ptr< T > &&src)

template< class X, class T > std::shared_ptr< X >	qobject_pointer_cast (std::shared_ptr< T > &&src)

Detailed Description

template<class T>
class QSharedPointer< T >

\inmodule QtCore

The QSharedPointer class holds a strong reference to a shared pointer.

Since: 4.5

\reentrant

The QSharedPointer is an automatic, shared pointer in C++. It behaves exactly like a normal pointer for normal purposes, including respect for constness.

QSharedPointer will delete the pointer it is holding when it goes out of scope, provided no other QSharedPointer objects are referencing it.

A QSharedPointer object can be created from a normal pointer, another QSharedPointer object or by promoting a QWeakPointer object to a strong reference.

Definition at line 255 of file qsharedpointer_impl.h.

Member Typedef Documentation

◆ const_pointer

template<class T >

typedef const value_type* QSharedPointer< T >::const_pointer

Definition at line 266 of file qsharedpointer_impl.h.

◆ const_reference

template<class T >

typedef const value_type& QSharedPointer< T >::const_reference

Definition at line 268 of file qsharedpointer_impl.h.

◆ difference_type

template<class T >

typedef qptrdiff QSharedPointer< T >::difference_type

Definition at line 269 of file qsharedpointer_impl.h.

◆ element_type

template<class T >

typedef T QSharedPointer< T >::element_type

Definition at line 263 of file qsharedpointer_impl.h.

◆ pointer

template<class T >

typedef value_type* QSharedPointer< T >::pointer

Definition at line 265 of file qsharedpointer_impl.h.

◆ reference

template<class T >

typedef value_type& QSharedPointer< T >::reference

Definition at line 267 of file qsharedpointer_impl.h.

◆ Type

template<class T >

typedef T QSharedPointer< T >::Type

Definition at line 262 of file qsharedpointer_impl.h.

◆ value_type

template<class T >

typedef T QSharedPointer< T >::value_type

Definition at line 264 of file qsharedpointer_impl.h.

Constructor & Destructor Documentation

◆ QSharedPointer() [1/10]

template<class T >

Q_NODISCARD_CTOR constexpr QSharedPointer< T >::QSharedPointer ( )

inlineconstexprnoexcept

Definition at line 280 of file qsharedpointer_impl.h.

◆ ~QSharedPointer()

template<class T >

template< class T > QSharedPointer< T >::~QSharedPointer ( )

inline

Destroys this QSharedPointer object.

If it is the last reference to the pointer stored, this will delete the pointer as well.

Definition at line 281 of file qsharedpointer_impl.h.

References QSharedPointer< T >::deref().

Here is the call graph for this function:

◆ QSharedPointer() [2/10]

template<class T >

template< class T > QSharedPointer< T >::QSharedPointer ( std::nullptr_t )

inlineconstexprnoexcept

Since: 5.8

Creates a QSharedPointer that is null. This is equivalent to the QSharedPointer default constructor.

Definition at line 284 of file qsharedpointer_impl.h.

◆ QSharedPointer() [3/10]

template<class T >

template<class X , IfCompatible< X > = true>

template< class T > template< typename X > QSharedPointer< T >::QSharedPointer ( X * ptr )

inlineexplicit

Creates a QSharedPointer that points to ptr.

The pointer ptr becomes managed by this QSharedPointer and must not be passed to another QSharedPointer object or deleted outside this object.

Since Qt 5.8, when the last reference to this QSharedPointer gets destroyed, ptr will be deleted by calling X's destructor (even if X is not the same as QSharedPointer's template parameter T). Previously, the destructor for T was called.

Definition at line 288 of file qsharedpointer_impl.h.

References QSharedPointer< T >::internalConstruct(), and ptr().

Here is the call graph for this function:

◆ QSharedPointer() [4/10]

template<class T >

template<class X , typename Deleter , IfCompatible< X > = true>

template< class T > template< typename X, typename Deleter > QSharedPointer< T >::QSharedPointer	(	X *	ptr,
		Deleter	d
	)

inline

Creates a QSharedPointer that points to ptr.

The pointer ptr becomes managed by this QSharedPointer and must not be passed to another QSharedPointer object or deleted outside this object.

The deleter parameter d specifies the custom deleter for this object. The custom deleter is called, instead of the operator delete(), when the strong reference count drops to 0. This is useful, for instance, for calling \l {QObject::}{deleteLater()} on a QObject instead:

    static void doDeleteLater(MyObject *obj)
    {
        obj->deleteLater();
    }
 
    void otherFunction()
    {
        QSharedPointer<MyObject> obj =
            QSharedPointer<MyObject>(new MyObject, doDeleteLater);
 
        // continue using obj
        obj.clear();    // calls obj->deleteLater();
    }

Note that the custom deleter function will be called with a pointer to type X, even if the QSharedPointer template parameter T is not the same.

It is also possible to specify a member function directly, as in:

QSharedPointer<MyObject> obj =

QSharedPointer<MyObject>(new MyObject, &QObject::deleteLater);

QObject::deleteLater

void deleteLater()

\threadsafe

Definition qobject.cpp:2352

See also: clear()

Definition at line 293 of file qsharedpointer_impl.h.

References QSharedPointer< T >::internalConstruct(), and ptr().

Here is the call graph for this function:

◆ QSharedPointer() [5/10]

template<class T >

template<typename Deleter >

template< class T > template< typename Deleter > QSharedPointer< T >::QSharedPointer	(	std::nullptr_t	,
		Deleter	d
	)

inline

Since: 5.8

Creates a QSharedPointer that is null. This is equivalent to the QSharedPointer default constructor.

The deleter parameter d specifies the custom deleter for this object. The custom deleter is called, instead of the operator delete(), when the strong reference count drops to 0.

Definition at line 298 of file qsharedpointer_impl.h.

References QSharedPointer< T >::internalConstruct().

Here is the call graph for this function:

◆ QSharedPointer() [6/10]

template<class T >

template< class T > QSharedPointer< T >::QSharedPointer ( const QSharedPointer< T > & other )

inlinenoexcept

Creates a QSharedPointer object that shares other's pointer.

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

Definition at line 302 of file qsharedpointer_impl.h.

References QSharedPointer< T >::d, and QSharedPointer< T >::ref().

Here is the call graph for this function:

◆ QSharedPointer() [7/10]

template<class T >

template< class T > QSharedPointer< T >::QSharedPointer ( QSharedPointer< T > && other )

inlinenoexcept

Move-constructs a QSharedPointer instance, making it point at the same object that other was pointing to.

Since: 5.4

Definition at line 311 of file qsharedpointer_impl.h.

References other().

Here is the call graph for this function:

◆ QSharedPointer() [8/10]

template<class T >

template<class X , IfCompatible< X > = true>

template< class T > template< class X > QSharedPointer< T >::QSharedPointer ( QSharedPointer< X > && other )

inlinenoexcept

Move-constructs a QSharedPointer instance, making it point at the same object that other was pointing to.

This constructor participates in overload resolution only if {X*} implicitly converts to {T*}.

Since: 5.6

Definition at line 321 of file qsharedpointer_impl.h.

References other().

Here is the call graph for this function:

◆ QSharedPointer() [9/10]

template<class T >

template<class X , IfCompatible< X > = true>

Q_NODISCARD_CTOR QSharedPointer< T >::QSharedPointer ( const QSharedPointer< X > & other )

inlinenoexcept

Definition at line 338 of file qsharedpointer_impl.h.

References QSharedPointer< T >::d, and QSharedPointer< T >::ref().

Here is the call graph for this function:

◆ QSharedPointer() [10/10]

template<class T >

template<class X , IfCompatible< X > = true>

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

inline

Definition at line 351 of file qsharedpointer_impl.h.

References other().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

template<class T >

template< class T > void QSharedPointer< T >::clear ( )

inline

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

If this was the last reference, then the pointer itself will be deleted.

Definition at line 394 of file qsharedpointer_impl.h.

References copy(), and QSharedPointer< T >::swap().

Referenced by QLowEnergyControllerPrivateBluez::discoverServiceDetails(), QLowEnergyControllerPrivateBluezDBus::discoverServiceDetails(), and QSharedPointer< T >::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constCast()

template<class T >

template<class X >

template< class T > template< class X > QSharedPointer< X > QSharedPointer< T >::constCast ( ) const

inline

Performs a \tt const_cast from this pointer's type to \tt X and returns a QSharedPointer that shares the reference.

This function can be used for up- and for down-casting, but is more useful for up-casting.

See also: isNull(), qSharedPointerConstCast()

Definition at line 381 of file qsharedpointer_impl.h.

Referenced by QSharedPointer< T >::enableSharedFromThis().

Here is the caller graph for this function:

◆ create()

template<class T >

template<typename... Args>

template< class T > template< typename... Args > QSharedPointer< T > QSharedPointer< T >::create ( Args &&... args )

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 5.1

Creates a QSharedPointer object and allocates a new item of type \tt T. The QSharedPointer internals and the object are allocated in one single memory allocation, which could help reduce memory fragmentation in a long-running application.

This function will attempt to call a constructor for type \tt T that can accept all the arguments passed (args). Arguments will be perfectly-forwarded.

Definition at line 399 of file qsharedpointer_impl.h.

References arguments, ptr(), and Qt::Uninitialized.

Referenced by QLowEnergyControllerPrivate::addServiceHelper(), QFontDialogOptions::clone(), QFileDialogOptions::clone(), QMessageDialogOptions::clone(), QFontDialogOptions::create(), QFileDialogOptions::create(), QMessageDialogOptions::create(), QLowEnergyControllerPrivateBluezDBus::discoverServiceDetails(), QLowEnergyControllerPrivateBluezDBus::discoverServices(), AVFImageCapture::doCapture(), QQuickTheme::setFont(), and QQuickTheme::setPalette().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data()

template<class T >

template< class T > T * QSharedPointer< T >::data ( ) const

inlinenoexcept

Returns the value of the pointer referenced by this object.

Note: do not delete the pointer returned by this function or pass it to another function that could delete it, including creating QSharedPointer or QWeakPointer objects.

Definition at line 271 of file qsharedpointer_impl.h.

References QSharedPointer< T >::value.

Referenced by QDtlsPrivateOpenSSL::continueHandshake(), QDeferredSharedPointer< T >::data(), QDtlsPrivateOpenSSL::decryptDatagram(), QQuickTheme::font(), QDtlsPrivateOpenSSL::handleTimeout(), QSharedPointer< T >::isNull(), QSharedPointer< T >::operator*(), operator-(), operator-(), operator-(), QSharedPointer< T >::operator->(), operator<(), operator<(), operator<(), QQuickTheme::palette(), QNetworkReplyHttpImplPrivate::replyDownloadMetaData(), QDtlsPrivateOpenSSL::sendShutdownAlert(), QNetworkReplyImplPrivate::setDownloadBuffer(), QQuickAnimatorController::start(), QDtlsPrivateOpenSSL::startHandshake(), QWindowsMouseHandler::translateMouseEvent(), QWindowsPointerHandler::translateMouseEvent(), QWindowsTabletSupport::translateTabletPacketEvent(), QWindowsTabletSupport::translateTabletProximityEvent(), QWindowsMouseHandler::translateTouchEvent(), QDtlsClientVerifierOpenSSL::verifyClient(), and QDtlsPrivateOpenSSL::writeDatagramEncrypted().

Here is the caller graph for this function:

◆ DECLARE_TEMPLATE_COMPARE_SET()

template<class T >

QSharedPointer< T >::DECLARE_TEMPLATE_COMPARE_SET	(	const QSharedPointer< T > &	p1,
		p1.	data(),
		const QSharedPointer< X > &	p2,
		p2.	data()
	)

inline

Definition at line 438 of file qsharedpointer_impl.h.

◆ deref() [1/2]

template<class T >

void QSharedPointer< T >::deref ( )

inlinenoexcept

Definition at line 450 of file qsharedpointer_impl.h.

References QSharedPointer< T >::d, and QSharedPointer< T >::deref().

Referenced by QSharedPointer< T >::~QSharedPointer(), QSharedPointer< T >::deref(), and QSharedPointer< T >::internalSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deref() [2/2]

template<class T >

static void QSharedPointer< T >::deref ( Data * dd )

inlinestaticnoexcept

Definition at line 452 of file qsharedpointer_impl.h.

◆ dynamicCast()

template<class T >

template<class X >

template< class T > template< class X > QSharedPointer< X > QSharedPointer< T >::dynamicCast ( ) const

inline

Performs a dynamic cast from this pointer's type to \tt X and returns a QSharedPointer that shares the reference.

If this function is used to up-cast, then QSharedPointer will perform a \tt dynamic_cast, which means that if the object being pointed by this QSharedPointer is not of type \tt X, the returned object will be null.

Note: the template type X must have the same const and volatile qualifiers as the template of this object, or the cast will fail. Use constCast() if you need to drop those qualifiers.

See also: qSharedPointerDynamicCast()

Definition at line 375 of file qsharedpointer_impl.h.

◆ enableSharedFromThis() [1/2]

template<class T >

void QSharedPointer< T >::enableSharedFromThis ( ... )

inline

Definition at line 468 of file qsharedpointer_impl.h.

◆ enableSharedFromThis() [2/2]

template<class T >

template<class X >

void QSharedPointer< T >::enableSharedFromThis ( const QEnableSharedFromThis< X > * ptr )

inline

Definition at line 463 of file qsharedpointer_impl.h.

References QSharedPointer< T >::constCast(), and ptr().

Referenced by QSharedPointer< T >::internalConstruct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get()

template<class T >

template< class T > T * QSharedPointer< T >::get ( ) const

inlinenoexcept

Since: 5.11

Same as data().

This function is provided for API compatibility with {std::shared_ptr}.

Definition at line 272 of file qsharedpointer_impl.h.

References QSharedPointer< T >::value.

Referenced by QCocoaWindow::createNSWindow(), and createPixmapDataSync().

Here is the caller graph for this function:

◆ internalConstruct()

template<class T >

template<typename X , typename Deleter >

void QSharedPointer< T >::internalConstruct	(	X *	ptr,
		Deleter	deleter
	)

inline

Definition at line 471 of file qsharedpointer_impl.h.

References QSharedPointer< T >::d, QSharedPointer< T >::enableSharedFromThis(), ptr(), and QtSharedPointer::ExternalRefCountData::setQObjectShared().

Referenced by QSharedPointer< T >::QSharedPointer(), QSharedPointer< T >::QSharedPointer(), and QSharedPointer< T >::QSharedPointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ internalSet()

template<class T >

void QSharedPointer< T >::internalSet	(	Data *	o,
		T *	actual
	)

inline

Definition at line 499 of file qsharedpointer_impl.h.

References QSharedPointer< T >::d, QSharedPointer< T >::deref(), QBasicAtomicInteger< T >::loadRelaxed(), o, qt_ptr_swap(), and QtSharedPointer::ExternalRefCountData::strongref.

Referenced by QSharedPointer< T >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ internalSwap()

template<class T >

void QSharedPointer< T >::internalSwap ( QSharedPointer< T > & other )

inlinenoexcept

Definition at line 488 of file qsharedpointer_impl.h.

References QSharedPointer< T >::d, other(), and qt_ptr_swap().

Referenced by QSharedPointer< T >::swap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNull()

template<class T >

template< class T > bool QSharedPointer< T >::isNull ( ) const

inlinenoexcept

Returns true if this object refers to \nullptr.

Definition at line 273 of file qsharedpointer_impl.h.

References QSharedPointer< T >::data().

Referenced by QLowEnergyControllerPrivateBluezDBus::addToGenericAttributeList(), QLowEnergyService::contains(), QLowEnergyService::contains(), QHttpThreadDelegate::dataReadProgressSlot(), QLowEnergyCharacteristic::descriptor(), QLowEnergyCharacteristic::descriptors(), QLowEnergyControllerPrivateAndroid::discoverServiceDetails(), QSSGShaderLibraryManager::getIncludeContents(), QWindowsDialogHelperBase< BaseClass >::hasNativeDialog(), QLowEnergyCharacteristic::isValid(), QLowEnergyDescriptor::isValid(), NmeaSource::isValid(), NmeaSatelliteSource::isValid(), QSharedPointer< T >::operator bool(), QSharedPointer< T >::operator!(), QLowEnergyCharacteristic::properties(), QHttpThreadDelegate::readyReadSlot(), QGeoTileRequestManagerPrivate::requestTiles(), QCocoaMessageDialog::show(), QWindowsMouseHandler::translateMouseEvent(), QWindowsPointerHandler::translateMouseEvent(), QWindowsTabletSupport::translateTabletPacketEvent(), QWindowsTabletSupport::translateTabletProximityEvent(), QGeoTiledMapPrivate::updateTile(), QLowEnergyCharacteristic::uuid(), QLowEnergyDescriptor::uuid(), QLowEnergyCharacteristic::value(), QLowEnergyDescriptor::value(), and QWindowsContext::windowsProc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ objectCast()

template<class T >

template<class X >

template< class T > template< class X > QSharedPointer< X > QSharedPointer< T >::objectCast ( ) const

inline

Since: 4.6

Performs a \l qobject_cast() from this pointer's type to \tt X and returns a QSharedPointer that shares the reference. If this function is used to up-cast, then QSharedPointer will perform a \tt qobject_cast, which means that if the object being pointed by this QSharedPointer is not of type \tt X, the returned object will be null.

Note: the template type X must have the same const and volatile qualifiers as the template of this object, or the cast will fail. Use constCast() if you need to drop those qualifiers.

See also: qSharedPointerObjectCast()

Definition at line 388 of file qsharedpointer_impl.h.

◆ operator bool()

template<class T >

template< class T > QSharedPointer< T >::operator bool ( ) const

inlineexplicitnoexcept

Returns true if the contained pointer is not \nullptr.

This function is suitable for use in \tt if-constructs, like:

if (sharedptr) { ... }

See also: isNull()

Definition at line 274 of file qsharedpointer_impl.h.

References QSharedPointer< T >::isNull().

Here is the call graph for this function:

◆ operator!()

template<class T >

template< class T > bool QSharedPointer< T >::operator! ( ) const

inlinenoexcept

Returns true if this object refers to \nullptr.

This function is suitable for use in \tt if-constructs, like:

if (!sharedptr) { ... }

See also: isNull()

Definition at line 275 of file qsharedpointer_impl.h.

References QSharedPointer< T >::isNull().

Here is the call graph for this function:

◆ operator*()

template<class T >

template< class T > T & QSharedPointer< T >::operator* ( ) const

inline

Provides access to the shared pointer's members.

If the contained pointer is \nullptr, behavior is undefined.

See also: isNull()

Definition at line 276 of file qsharedpointer_impl.h.

References QSharedPointer< T >::data().

Here is the call graph for this function:

◆ operator->()

template<class T >

template< class T > T * QSharedPointer< T >::operator-> ( ) const

inlinenoexcept

Provides access to the shared pointer's members.

If the contained pointer is \nullptr, behavior is undefined.

See also: isNull()

Definition at line 277 of file qsharedpointer_impl.h.

References QSharedPointer< T >::data().

Here is the call graph for this function:

◆ operator=() [1/4]

template<class T >

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

inlinenoexcept

Makes this object share other's pointer.

The current pointer reference is discarded and, if it was the last, the pointer will be deleted.

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

Definition at line 304 of file qsharedpointer_impl.h.

References copy(), other(), and QSharedPointer< T >::swap().

Here is the call graph for this function:

◆ operator=() [2/4]

template<class T >

template<class X , IfCompatible< X > = true>

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

inline

Definition at line 342 of file qsharedpointer_impl.h.

References copy(), other(), and QSharedPointer< T >::swap().

Here is the call graph for this function:

◆ operator=() [3/4]

template<class T >

template<class X , IfCompatible< X > = true>

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

inline

Definition at line 355 of file qsharedpointer_impl.h.

References QSharedPointer< T >::internalSet(), and other().

Here is the call graph for this function:

◆ operator=() [4/4]

template<class T >

template<class X , IfCompatible< X > = true>

template< class T > template< class X > QSharedPointer< T >::operator= ( QSharedPointer< X > && other )

inlinenoexcept

Move-assigns other to this QSharedPointer instance.

This assignment operator participates in overload resolution only if {X*} implicitly converts to {T*}.

Since: 5.6

Definition at line 329 of file qsharedpointer_impl.h.

References other(), and QSharedPointer< T >::swap().

Here is the call graph for this function:

◆ ref()

template<class T >

void QSharedPointer< T >::ref ( ) const

inlinenoexcept

Definition at line 497 of file qsharedpointer_impl.h.

References QSharedPointer< T >::d, QBasicAtomicInteger< T >::ref(), QtSharedPointer::ExternalRefCountData::strongref, and QtSharedPointer::ExternalRefCountData::weakref.

Referenced by QSharedPointer< T >::QSharedPointer(), and QSharedPointer< T >::QSharedPointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset() [1/3]

template<class T >

template< class T > void QSharedPointer< T >::reset ( )

inline

Since: 5.0

Same as clear(). For std::shared_ptr compatibility.

Definition at line 361 of file qsharedpointer_impl.h.

References QSharedPointer< T >::clear().

Referenced by QQuickAnimatorProxyJob::QQuickAnimatorProxyJob(), QQuickAnimatorProxyJob::~QQuickAnimatorProxyJob(), requestPermissionsInternal(), and QWindowsTabletSupport::translateTabletProximityEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset() [2/3]

template<class T >

template< class T > void QSharedPointer< T >::reset ( T * t )

inline

Since: 5.0

Resets this QSharedPointer object to point to t instead. Equivalent to:

QSharedPointer<T> other(t); this->swap(other);

QSharedPointer::swap

void swap(QSharedPointer &other) noexcept

Definition qsharedpointer_impl.h:358

t

GLdouble GLdouble t

Definition qopenglext.h:243

other

QSharedPointer< T > other(t)

[5]

Definition at line 362 of file qsharedpointer_impl.h.

References copy(), and QSharedPointer< T >::swap().

Here is the call graph for this function:

◆ reset() [3/3]

template<class T >

template<typename Deleter >

template< class T > template< typename Deleter > void QSharedPointer< T >::reset	(	T *	t,
		Deleter	deleter
	)

inline

Since: 5.0

Resets this QSharedPointer object to point to t instead, with the Deleter deleter. Equivalent to:

QSharedPointer<T> other(t, deleter); this->swap(other);

Definition at line 365 of file qsharedpointer_impl.h.

References copy(), and QSharedPointer< T >::swap().

Here is the call graph for this function:

◆ staticCast()

template<class T >

template<class X >

template< class T > template< class X > QSharedPointer< X > QSharedPointer< T >::staticCast ( ) const

inline

Performs a static cast from this pointer's type to \tt X and returns a QSharedPointer that shares the reference.

This function can be used for up- and for down-casting, but is more useful for up-casting.

Note: the template type X must have the same const and volatile qualifiers as the template of this object, or the cast will fail. Use constCast() if you need to drop those qualifiers.

See also: dynamicCast(), constCast(), qSharedPointerCast()

Definition at line 369 of file qsharedpointer_impl.h.

◆ swap()

template<class T >

template< class T > void QSharedPointer< T >::swap ( QSharedPointer< T > & other )

inlinenoexcept

Since: 5.3

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

Definition at line 358 of file qsharedpointer_impl.h.

References QSharedPointer< T >::internalSwap(), and other().

Referenced by QSharedPointer< T >::clear(), QSharedPointer< T >::operator=(), QSharedPointer< T >::operator=(), QSharedPointer< T >::operator=(), QSharedPointer< T >::reset(), and QSharedPointer< T >::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toWeakRef()

template<class T >

Q_INLINE_TEMPLATE QWeakPointer< T > QSharedPointer< T >::toWeakRef

Returns a weak reference object that shares the pointer referenced by this object.

See also: QWeakPointer::QWeakPointer()

Definition at line 797 of file qsharedpointer_impl.h.

Friends And Related Symbol Documentation

◆ QSharedPointer

template<class T >

template<class X >

template< class T > QSharedPointer< T >::QSharedPointer

friend

Creates a QSharedPointer that is null (the object is holding a reference to \nullptr).

Definition at line 494 of file qsharedpointer_impl.h.

◆ operator!=() [1/5]

template<class T >

template< class T > bool operator!=	(	const QSharedPointer< T > &	lhs,
		std::nullptr_t
	)

Since: 5.8

Returns true if lhs refers to a valid (i.e. non-null) pointer.

See also: QSharedPointer::isNull()

◆ operator!=() [2/5]

template<class T >

template< class T > template< class X > bool operator!=	(	const QSharedPointer< T > &	ptr1,
		const QSharedPointer< X > &	ptr2
	)

If ptr2's template parameter is different from ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast to ensure that the pointers being compared are equal. If ptr2's template parameter is not a base or a derived type from ptr1's, you will get a compiler error.

◆ operator!=() [3/5]

template<class T >

template< class T > template< class X > bool operator!=	(	const QSharedPointer< T > &	ptr1,
		const X *	ptr2
	)

If ptr2's type is different from ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast to ensure that the pointers being compared are equal. If ptr2's type is not a base or a derived type from this ptr1's, you will get a compiler error.

◆ operator!=() [4/5]

template<class T >

template< class T > template< class X > bool operator!=	(	const T *	ptr1,
		const QSharedPointer< X > &	ptr2
	)

If ptr2's template parameter is different from ptr1's type, QSharedPointer will attempt to perform an automatic \tt static_cast to ensure that the pointers being compared are equal. If ptr2's template parameter is not a base or a derived type from ptr1's type, you will get a compiler error.

◆ operator!=() [5/5]

template<class T >

template< class T > bool operator!=	(	std::nullptr_t	,
		const QSharedPointer< T > &	rhs
	)

Since: 5.8

Returns true if rhs refers to a valid (i.e. non-null) pointer.

See also: QSharedPointer::isNull()

◆ operator<<()

template<class T >

template< typename T > QDebug operator<<	(	QDebug	debug,
		const QSharedPointer< T > &	ptr
	)

Since: 5.7

Writes the pointer tracked by ptr into the debug object debug for debugging purposes.

See also: {Debugging Techniques}

Definition at line 438 of file qdebug.h.

References debug, and ptr().

Here is the call graph for this function:

◆ operator==() [1/5]

template<class T >

template< class T > bool operator==	(	const QSharedPointer< T > &	lhs,
		std::nullptr_t
	)

Since: 5.8

Returns true if lhs refers to \nullptr.

See also: QSharedPointer::isNull()

◆ operator==() [2/5]

template<class T >

template< class T > template< class X > bool operator==	(	const QSharedPointer< T > &	ptr1,
		const QSharedPointer< X > &	ptr2
	)

If ptr2's template parameter is different from ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast to ensure that the pointers being compared are equal. If ptr2's template parameter is not a base or a derived type from ptr1's, you will get a compiler error.

◆ operator==() [3/5]

template<class T >

template< class T > template< class X > bool operator==	(	const QSharedPointer< T > &	ptr1,
		const X *	ptr2
	)

If ptr2's type is different from ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast to ensure that the pointers being compared are equal. If ptr2's type is not a base or a derived type from this ptr1's, you will get a compiler error.

◆ operator==() [4/5]

template<class T >

template< class T > template< class X > bool operator==	(	const T *	ptr1,
		const QSharedPointer< X > &	ptr2
	)

If ptr2's template parameter is different from ptr1's type, QSharedPointer will attempt to perform an automatic \tt static_cast to ensure that the pointers being compared are equal. If ptr2's template parameter is not a base or a derived type from ptr1's type, you will get a compiler error.

◆ operator==() [5/5]

template<class T >

template< class T > bool operator==	(	std::nullptr_t	,
		const QSharedPointer< T > &	rhs
	)

Since: 5.8

Returns true if rhs refers to \nullptr.

See also: QSharedPointer::isNull()

◆ qHash()

template<class T >

template< class T > qHash	(	const QSharedPointer< T > &	key,
		size_t	seed
	)

Since: 5.0

Definition at line 790 of file qsharedpointer_impl.h.

References ptr(), qHash(), and seed.

Here is the call graph for this function:

◆ qobject_pointer_cast() [1/2]

template<class T >

template< class X, class T > std::shared_ptr< X > qobject_pointer_cast ( const std::shared_ptr< T > & src )

Since: 5.14

Returns a shared pointer to the pointer held by src.

Same as qSharedPointerObjectCast(). This function is provided for STL compatibility.

Definition at line 911 of file qsharedpointer_impl.h.

◆ qobject_pointer_cast() [2/2]

template<class T >

template< class X, class T > std::shared_ptr< X > qobject_pointer_cast ( std::shared_ptr< T > && src )

Since: 5.14

Same as qSharedPointerObjectCast(). This function is provided for STL compatibility.

Definition at line 918 of file qsharedpointer_impl.h.

◆ qSharedPointerCast()

template<class T >

template< class X > template< class T > QSharedPointer< X > qSharedPointerCast ( const QSharedPointer< T > & other )

The types \tt T and \tt X must belong to one hierarchy for the \tt static_cast to succeed.

Note that \tt X must have the same cv-qualifiers (\tt const and \tt volatile) that \tt T has, or the code will fail to compile. Use qSharedPointerConstCast to cast away the constness.

See also: QSharedPointer::staticCast(), qSharedPointerDynamicCast(), qSharedPointerConstCast()

◆ qSharedPointerConstCast()

template<class T >

template< class X > template< class T > QSharedPointer< X > qSharedPointerConstCast ( const QSharedPointer< T > & src )

The types \tt T and \tt X must belong to one hierarchy for the \tt const_cast to succeed. The \tt const and \tt volatile differences between \tt T and \tt X are ignored.

See also: QSharedPointer::constCast(), qSharedPointerCast(), qSharedPointerDynamicCast()

◆ qSharedPointerDynamicCast()

template<class T >

template< class X > template< class T > QSharedPointer< X > qSharedPointerDynamicCast ( const QSharedPointer< T > & src )

If the \tt dynamic_cast fails, the object returned will be null.

Note that \tt X must have the same cv-qualifiers (\tt const and \tt volatile) that \tt T has, or the code will fail to compile. Use qSharedPointerConstCast to cast away the constness.

See also: QSharedPointer::dynamicCast(), qSharedPointerCast(), qSharedPointerConstCast()

◆ qSharedPointerObjectCast() [1/3]

template<class T >

template< class X > template< class T > QSharedPointer< X > qSharedPointerObjectCast ( const QSharedPointer< T > & src )

Since: 4.6

Returns a shared pointer to the pointer held by src, using a \l qobject_cast() to type \tt X to obtain an internal pointer of the appropriate type. If the \tt qobject_cast fails, the object returned will be null.

Note that \tt X must have the same cv-qualifiers (\tt const and \tt volatile) that \tt T has, or the code will fail to compile. Use qSharedPointerConstCast to cast away the constness.

See also: QSharedPointer::objectCast(), qSharedPointerCast(), qSharedPointerConstCast()

◆ qSharedPointerObjectCast() [2/3]

template<class T >

template< class X, class T > std::shared_ptr< X > qSharedPointerObjectCast ( const std::shared_ptr< T > & src )

Since: 5.14

Returns a shared pointer to the pointer held by src, using a \l qobject_cast() to type \tt X to obtain an internal pointer of the appropriate type. If the \tt qobject_cast fails, the object returned will be null.

Note that \tt X must have the same cv-qualifiers (\tt const and \tt volatile) that \tt T has, or the code will fail to compile. Use const_pointer_cast to cast away the constness.

Definition at line 933 of file qsharedpointer_impl.h.

◆ qSharedPointerObjectCast() [3/3]

template<class T >

template< class X, class T > std::shared_ptr< X > qSharedPointerObjectCast ( std::shared_ptr< T > && src )

Since: 5.14

Returns a shared pointer to the pointer held by src, using a \l qobject_cast() to type \tt X to obtain an internal pointer of the appropriate type.

If the \tt qobject_cast succeeds, the function will return a valid shared pointer, and src is reset to null. If the \tt qobject_cast fails, the object returned will be null, and src will not be modified.

Note that \tt X must have the same cv-qualifiers (\tt const and \tt volatile) that \tt T has, or the code will fail to compile. Use const_pointer_cast to cast away the constness.

Definition at line 939 of file qsharedpointer_impl.h.

◆ QtSharedPointer::copyAndSetPointer

template<class T >

template<class X , class Y >

QSharedPointer< X > QtSharedPointer::copyAndSetPointer	(	X *	ptr,
		const QSharedPointer< Y > &	src
	)

friend

◆ QWeakPointer

template<class T >

template<class X >

friend class QWeakPointer

friend

Definition at line 495 of file qsharedpointer_impl.h.

Member Data Documentation

◆ d

template<class T >

Data* QSharedPointer< T >::d

Definition at line 530 of file qsharedpointer_impl.h.

Referenced by QSharedPointer< T >::QSharedPointer(), QSharedPointer< T >::QSharedPointer(), QSharedPointer< T >::deref(), QSharedPointer< T >::internalConstruct(), QSharedPointer< T >::internalSet(), QSharedPointer< T >::internalSwap(), and QSharedPointer< T >::ref().

◆ value

template<class T >

Type* QSharedPointer< T >::value

Definition at line 529 of file qsharedpointer_impl.h.

Referenced by QSharedPointer< T >::data(), and QSharedPointer< T >::get().

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

qtbase/src/corelib/tools/qsharedpointer_impl.h
qtbase/src/corelib/io/qdebug.cpp
qtbase/src/corelib/tools/qsharedpointer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Related Symbols

Detailed Description

Member Typedef Documentation

◆ const_pointer

◆ const_reference

◆ difference_type

◆ element_type

◆ pointer

◆ reference

◆ Type

◆ value_type

Constructor & Destructor Documentation

◆ QSharedPointer() [1/10]

◆ ~QSharedPointer()

◆ QSharedPointer() [2/10]

◆ QSharedPointer() [3/10]

◆ QSharedPointer() [4/10]

◆ QSharedPointer() [5/10]

◆ QSharedPointer() [6/10]

◆ QSharedPointer() [7/10]

◆ QSharedPointer() [8/10]

◆ QSharedPointer() [9/10]

◆ QSharedPointer() [10/10]

Member Function Documentation

◆ clear()

◆ constCast()

◆ create()

◆ data()

◆ DECLARE_TEMPLATE_COMPARE_SET()

◆ deref() [1/2]

◆ deref() [2/2]

◆ dynamicCast()

◆ enableSharedFromThis() [1/2]

◆ enableSharedFromThis() [2/2]

◆ get()

◆ internalConstruct()

◆ internalSet()

◆ internalSwap()

◆ isNull()

◆ objectCast()

◆ operator bool()

◆ operator!()

◆ operator*()

◆ operator->()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ ref()

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ staticCast()

◆ swap()

◆ toWeakRef()

Friends And Related Symbol Documentation

◆ QSharedPointer

◆ operator!=() [1/5]

◆ operator!=() [2/5]

◆ operator!=() [3/5]

◆ operator!=() [4/5]

◆ operator!=() [5/5]

◆ operator<<()

◆ operator==() [1/5]

◆ operator==() [2/5]

◆ operator==() [3/5]

◆ operator==() [4/5]

◆ operator==() [5/5]

◆ qHash()

◆ qobject_pointer_cast() [1/2]

◆ qobject_pointer_cast() [2/2]

◆ qSharedPointerCast()

◆ qSharedPointerConstCast()

◆ qSharedPointerDynamicCast()

◆ qSharedPointerObjectCast() [1/3]