X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6d0f32ddb8e1aec3b8707db31ed244758c242672..42d9ad7949254ed53f89ad6306dcb2a266bfffb3:/docs/latex/wx/scopedptr.tex?ds=sidebyside diff --git a/docs/latex/wx/scopedptr.tex b/docs/latex/wx/scopedptr.tex index ede1e09c17..34b9430796 100644 --- a/docs/latex/wx/scopedptr.tex +++ b/docs/latex/wx/scopedptr.tex @@ -13,12 +13,18 @@ No base class \wxheading{Data structures} -{\small \begin{verbatim} -typedef T element\_type -\end{verbatim}} +{\small% +\begin{verbatim} +typedef T element_type +\end{verbatim} +}% + +\wxheading{See also} + +\helpref{wxSharedPtr}{wxsharedptr}, \helpref{wxWeakRef}{wxweakref} -\latexignore{\rtfignore{\wxheading{Members}}} +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxScopedPtr::wxScopedPtr}\label{wxscopedptrtemplatewxscopedptrtemplate} @@ -38,12 +44,21 @@ Destructor. Returns pointer to object or NULL. -\membersection{wxScopedPtr::operator*}\label{wxscopedptrtemplateoperatorptrt} +\membersection{wxScopedPtr::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::operator*}\label{wxscopedptrtemplateoperatorreft} \constfunc{T \&}{operator*}{\void} -Returns pointer to object. If the pointer is NULL this method will -cause an assert in debug mode. +Returns a reference to the object. If the internal pointer is NULL +this method will cause an assert in debug mode. \membersection{wxScopedPtr::operator->}\label{wxscopedptrtemplateoperatorderef} @@ -56,14 +71,16 @@ cause an assert in debug mode. \func{T*}{release}{\void} -Returns pointer to object or NULL. +Releases the current pointer and returns it. +Afterwards the caller is responsible for deleting +the data contained in the scoped pointer before. \membersection{wxScopedPtr::reset}\label{wxscopedptrtemplatereset} \func{void}{reset}{\param{T * }{ptr = NULL}} -Reset pointer. Afterwards the caller is responsible for deleting -the data contained in the scoped pointer before. +Reset pointer to the value of {\it ptr}. The +previous pointer will be deleted. \membersection{wxScopedPtr::swap}\label{wxscopedptrtemplateswap}