]> 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 952c0d451f1b4871a42b2a8263c4688ef88f7f7e..34b9430796b71a149123c9a2d307ac7dcbdba668 100644 (file)
@@ -19,9 +19,13 @@ typedef T element_type
 \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}}
@@ -40,6 +44,15 @@ Destructor.
 
 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}
@@ -58,14 +71,16 @@ cause an assert in debug mode.
 
 \func{T*}{release}{\void}
 
-Releases the current pointer and returns 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}