aaf4caeedc
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51125 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
91 lines
2.3 KiB
TeX
91 lines
2.3 KiB
TeX
\section{\class{wxScopedPtr<T>}}\label{wxscopedptrtemplate}
|
|
|
|
A scoped pointer template class. It is the template version of
|
|
the old-style \helpref{scoped pointer macros}{wxscopedptr}.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
No base class
|
|
|
|
\wxheading{Include files}
|
|
|
|
<ptr\_scpd.h>
|
|
|
|
\wxheading{Data structures}
|
|
|
|
{\small%
|
|
\begin{verbatim}
|
|
typedef T element_type
|
|
\end{verbatim}
|
|
}%
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxSharedPtr}{wxsharedptr}, \helpref{wxWeakRef}{wxweakref}
|
|
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxScopedPtr<T>::wxScopedPtr<T>}\label{wxscopedptrtemplatewxscopedptrtemplate}
|
|
|
|
\func{wxEXPLICIT}{wxScopedPtr<T>}{\param{T * }{ptr = NULL}}
|
|
|
|
Constructor.
|
|
|
|
\membersection{wxScopedPtr<T>::\destruct{wxScopedPtr<T>}}\label{wxscopedptrtemplatedtor}
|
|
|
|
\func{}{\destruct{wxScopedPtr<T>}}{\void}
|
|
|
|
Destructor.
|
|
|
|
\membersection{wxScopedPtr<T>::get}\label{wxscopedptrtemplateget}
|
|
|
|
\constfunc{T *}{get}{\void}
|
|
|
|
Returns pointer to object or NULL.
|
|
|
|
\membersection{wxScopedPtr<T>::operator unspecified\_bool\_type}\label{wxscopedptrtemplateoperatorbool}
|
|
|
|
\constfunc{}{operator unspecified\_bool\_type}{\void}
|
|
|
|
Conversion to a boolean expression (in a variant which is not
|
|
convertable to anything but a boolean expression). If this class
|
|
contains a valid pointer it will return {\it true}, if it contains
|
|
a NULL pointer it will return {\it false}.
|
|
|
|
\membersection{wxScopedPtr<T>::operator*}\label{wxscopedptrtemplateoperatorreft}
|
|
|
|
\constfunc{T \&}{operator*}{\void}
|
|
|
|
Returns a reference to the object. If the internal pointer is NULL
|
|
this method will cause an assert in debug mode.
|
|
|
|
\membersection{wxScopedPtr<T>::operator->}\label{wxscopedptrtemplateoperatorderef}
|
|
|
|
\constfunc{T *}{operator->}{\void}
|
|
|
|
Returns pointer to object. If the pointer is NULL this method will
|
|
cause an assert in debug mode.
|
|
|
|
\membersection{wxScopedPtr<T>::release}\label{wxscopedptrtemplaterelease}
|
|
|
|
\func{T*}{release}{\void}
|
|
|
|
Releases the current pointer and returns it.
|
|
Afterwards the caller is responsible for deleting
|
|
the data contained in the scoped pointer before.
|
|
|
|
\membersection{wxScopedPtr<T>::reset}\label{wxscopedptrtemplatereset}
|
|
|
|
\func{void}{reset}{\param{T * }{ptr = NULL}}
|
|
|
|
Reset pointer to the value of {\it ptr}. The
|
|
previous pointer will be deleted.
|
|
|
|
\membersection{wxScopedPtr<T>::swap}\label{wxscopedptrtemplateswap}
|
|
|
|
\func{void}{swap}{\param{wxScopedPtr<T> \& }{ot}}
|
|
|
|
Swaps pointers.
|
|
|