]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/scopedptr.tex
avoid undefined behavior from token paste resulting in more than one token
[wxWidgets.git] / docs / latex / wx / scopedptr.tex
index 1da69e6dfeae9aae50850e409cfe771123e0a54e..2ceddcf6ef6c6f4a8c96944a8a605fd72f147350 100644 (file)
@@ -19,9 +19,13 @@ typedef T element_type
 \end{verbatim}
 }%
 
 \end{verbatim}
 }%
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+\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}}
 \membersection{wxScopedPtr<T>::wxScopedPtr<T>}\label{wxscopedptrtemplatewxscopedptrtemplate}
 
 \func{wxEXPLICIT}{wxScopedPtr<T>}{\param{T * }{ptr = NULL}}
@@ -40,12 +44,21 @@ Destructor.
 
 Returns pointer to object or NULL.
 
 
 Returns pointer to object or NULL.
 
-\membersection{wxScopedPtr<T>::operator*}\label{wxscopedptrtemplateoperatorptrt}
+\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}
 
 
 \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<T>::operator->}\label{wxscopedptrtemplateoperatorderef}
 
 
 \membersection{wxScopedPtr<T>::operator->}\label{wxscopedptrtemplateoperatorderef}
 
@@ -58,7 +71,7 @@ cause an assert in debug mode.
 
 \func{T*}{release}{\void}
 
 
 \func{T*}{release}{\void}
 
-Returns pointer to object or NULL.
+Releases the current pointer and returns it.
 
 \membersection{wxScopedPtr<T>::reset}\label{wxscopedptrtemplatereset}
 
 
 \membersection{wxScopedPtr<T>::reset}\label{wxscopedptrtemplatereset}