wxScopedPtr< T > Class Template Reference

#include <wx/scopedptr.h>

Detailed Description

template<typename T>
class wxScopedPtr< T >

A scoped pointer template class.

It is the template version of the old-style scoped pointer macros.

Notice that objects of this class intentionally cannot be copied.

Library:  wxBase

Category:  Smart Pointers

See also

wxSharedPtr<T>, wxWeakRef<T>

Public Member Functions
	wxScopedPtr (T *ptr=nullptr)
	Constructor takes ownership of the pointer.
	~wxScopedPtr ()
	Destructor deletes the pointer.
T *	get () const
	Returns pointer to object or nullptr.
	operator unspecified_bool_type () const
	Conversion to a boolean expression (in a variant which is not convertible to anything but a boolean expression).
T &	operator* () const
	Returns a reference to the object.
T *	operator-> () const
	Smart pointer member access.
T *	release ()
	Releases the current pointer and returns it.
void	reset (T *ptr=nullptr)
	Reset pointer to the value of ptr.
void	swap (wxScopedPtr< T > &ot)
	Swaps pointers.
	wxScopedPtr (type *T=nullptr)
	Creates the smart pointer with the given pointer or none if nullptr.
	~wxScopedPtr ()
	Destructor frees the pointer help by this object if it is not nullptr.
T *	get () const
	This operator gets the pointer stored in the smart pointer or returns nullptr if there is none.
T &	operator* () const
	This operator works like the standard C++ pointer operator to return the object being pointed to by the pointer.
T *	operator-> () const
	Smart pointer member access.
T *	release ()
	Returns the currently hold pointer and resets the smart pointer object to nullptr.
	reset (T *p=nullptr)
	Deletes the currently held pointer and sets it to p or to nullptr if no arguments are specified.
	swap (wxScopedPtr &other)
	Swap the pointer inside the smart pointer with other.

Constructor & Destructor Documentation

wxScopedPtr() [1/2]

template<typename T>

wxScopedPtr< T >::wxScopedPtr

(

T *

ptr = nullptr

)

Constructor takes ownership of the pointer.

Parameters

ptr	Pointer allocated with new or nullptr.

~wxScopedPtr() [1/2]

template<typename T>

wxScopedPtr< T >::~wxScopedPtr

(

)

Destructor deletes the pointer.

wxScopedPtr() [2/2]

wxScopedPtr::wxScopedPtr ( type * T = nullptr )

explicit

Creates the smart pointer with the given pointer or none if nullptr.

On compilers that support it, this uses the explicit keyword.

~wxScopedPtr() [2/2]

wxScopedPtr::~wxScopedPtr

(

)

Destructor frees the pointer help by this object if it is not nullptr.

Member Function Documentation

get() [1/2]

T * wxScopedPtr::get

(

)

const

This operator gets the pointer stored in the smart pointer or returns nullptr if there is none.

get() [2/2]

template<typename T>

T * wxScopedPtr< T >::get

(

)

const

Returns pointer to object or nullptr.

operator unspecified_bool_type()

template<typename T>

wxScopedPtr< T >::operator unspecified_bool_type

(

)

const

Conversion to a boolean expression (in a variant which is not convertible to anything but a boolean expression).

If this class contains a valid pointer it will return true, if it contains a nullptr pointer it will return false.

operator*() [1/2]

T & wxScopedPtr::operator*

(

)

const

This operator works like the standard C++ pointer operator to return the object being pointed to by the pointer.

If the internal pointer is nullptr this method will cause an assert in debug mode.

operator*() [2/2]

template<typename T>

T & wxScopedPtr< T >::operator*

(

)

const

Returns a reference to the object.

If the internal pointer is nullptr this method will cause an assert in debug mode.

operator->() [1/2]

T * wxScopedPtr::operator->

(

)

const

Smart pointer member access.

Returns pointer to its object.

If the internal pointer is nullptr this method will cause an assert in debug mode.

operator->() [2/2]

template<typename T>

T * wxScopedPtr< T >::operator->

(

)

const

Smart pointer member access.

Returns pointer to object.

If the internal pointer is nullptr this method will cause an assert in debug mode.

release() [1/2]

T * wxScopedPtr::release

(

)

Returns the currently hold pointer and resets the smart pointer object to nullptr.

Remarks

After a call to this function the caller is responsible for deleting the pointer.

release() [2/2]

template<typename T>

T * wxScopedPtr< T >::release

(

)

Releases the current pointer and returns it.

Remarks

Afterwards the caller is responsible for deleting the data contained in the scoped pointer before.

reset() [1/2]

wxScopedPtr::reset

(

T *

p = nullptr

)

Deletes the currently held pointer and sets it to p or to nullptr if no arguments are specified.

Note

This function does check to make sure that the pointer you are assigning is not the same pointer that is already stored.

reset() [2/2]

template<typename T>

void wxScopedPtr< T >::reset

(

T *

ptr = nullptr

)

Reset pointer to the value of ptr.

The previous pointer will be deleted.

swap() [1/2]

wxScopedPtr::swap

(

wxScopedPtr< T > &

other

)

Swap the pointer inside the smart pointer with other.

The pointer being swapped must be of the same type (hence the same class name).

swap() [2/2]

template<typename T>

void wxScopedPtr< T >::swap

(

wxScopedPtr< T > &

ot

)

Swaps pointers.