]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/scopedptr.tex
removed unneeded wxWeakRefDynamic::AssignCopy() (last part of patch 1870445)
[wxWidgets.git] / docs / latex / wx / scopedptr.tex
index ede1e09c17c7e4a2926abf204d3c84e96b473c1e..34b9430796b71a149123c9a2d307ac7dcbdba668 100644 (file)
@@ -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<T>::wxScopedPtr<T>}\label{wxscopedptrtemplatewxscopedptrtemplate}
 
@@ -38,12 +44,21 @@ Destructor.
 
 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}
 
-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}
 
@@ -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<T>::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<T>::swap}\label{wxscopedptrtemplateswap}