Apply patch [ 1554736 ] wxXmlDocument::DetachRoot

[wxWidgets.git] / docs / latex / wx / scpdptr.tex

diff --git a/docs/latex/wx/scpdptr.tex b/docs/latex/wx/scpdptr.tex
index 87b69270d6a64423b6599d3742dc01acfd68826b..1a5b04bc25dc23968360bc2ce61cb07fdcc09812 100644 (file)
--- a/docs/latex/wx/scpdptr.tex
+++ b/docs/latex/wx/scpdptr.tex
@@ -1,4 +1,4 @@
-{\section{\class{wxScopedPtr}}\label{wxscopedptr}
+\section{\class{wxScopedPtr}}\label{wxscopedptr}

 
 This is a simple scoped smart pointer implementation that is similar to 
 the \urlref{Boost}{http://www.boost.org/} smart pointers but rewritten to
 
 This is a simple scoped smart pointer implementation that is similar to 
 the \urlref{Boost}{http://www.boost.org/} smart pointers but rewritten to


@@ -12,7 +12,7 @@ surprizing than the ``destructive copy'' behaviour of the standard class.
 
 \wxheading{Example}
 
 
 \wxheading{Example}
 

-Below is an example of using a wxWindows scoped smart pointer and 
+Below is an example of using a wxWidgets scoped smart pointer and 

 pointer array.
 
 \begin{verbatim}
 pointer array.
 
 \begin{verbatim}


@@ -49,12 +49,14 @@ pointer array.
 
 To declare the smart pointer class \texttt{CLASSNAME} containing pointes to a
 (possibly incomplete) type \texttt{TYPE} you should use
 
 To declare the smart pointer class \texttt{CLASSNAME} containing pointes to a
 (possibly incomplete) type \texttt{TYPE} you should use

+

 \begin{verbatim}
     wxDECLARE_SCOPED_PTR( TYPE,     // type of the values
                                 CLASSNAME ); // name of the class
 \end{verbatim}
 
 And later, when \texttt{TYPE} is fully defined, you must also use
 \begin{verbatim}
     wxDECLARE_SCOPED_PTR( TYPE,     // type of the values
                                 CLASSNAME ); // name of the class
 \end{verbatim}
 
 And later, when \texttt{TYPE} is fully defined, you must also use

+

 \begin{verbatim}
     wxDEFINE_SCOPED_PTR( TYPE, CLASSNAME );
 \end{verbatim}
 \begin{verbatim}
     wxDEFINE_SCOPED_PTR( TYPE, CLASSNAME );
 \end{verbatim}


@@ -69,9 +71,11 @@ Alternatively, if you don't have to separate the point of declaration and
 definition of this class and if you accept the standard naming convention, that
 is that the scoped pointer for the class \texttt{Foo} is called 
 \texttt{FooPtr}, you can use a single macro which replaces two macros above:
 definition of this class and if you accept the standard naming convention, that
 is that the scoped pointer for the class \texttt{Foo} is called 
 \texttt{FooPtr}, you can use a single macro which replaces two macros above:

+

 \begin{verbatim}
     wxDEFINE_SCOPED_PTR_TYPE( TYPE );
 \end{verbatim}
 \begin{verbatim}
     wxDEFINE_SCOPED_PTR_TYPE( TYPE );
 \end{verbatim}

+

 Once again, in this cass \texttt{CLASSNAME} will be \texttt{TYPEPtr}.
 
 \wxheading{Include files}
 Once again, in this cass \texttt{CLASSNAME} will be \texttt{TYPEPtr}.
 
 \wxheading{Include files}


@@ -84,7 +88,7 @@ Once again, in this cass \texttt{CLASSNAME} will be \texttt{TYPEPtr}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxScopedPtr::wxScopedPtr}
+\membersection{wxScopedPtr::wxScopedPtr}\label{wxscopedptrctor}

 
 \func{}{explicit wxScopedPtr}{\param{type}{ * T = NULL}}
 
 
 \func{}{explicit wxScopedPtr}{\param{type}{ * T = NULL}}
 


@@ -92,14 +96,14 @@ Creates the smart pointer with the given pointer or none if {\tt NULL}.  On
 compilers that support it, this uses the explicit keyword.
 
 
 compilers that support it, this uses the explicit keyword.
 
 

-\membersection{wxScopedPtr::\destruct{wxScopedPtr}}
+\membersection{wxScopedPtr::\destruct{wxScopedPtr}}\label{wxscopedptrdtor}

 
 \func{}{\destruct{wxScopedPtr}}{\void}
 
 Destructor frees the pointer help by this object if it is not {\tt NULL}.
 
 
 
 \func{}{\destruct{wxScopedPtr}}{\void}
 
 Destructor frees the pointer help by this object if it is not {\tt NULL}.
 
 

-\membersection{wxScopedPtr::release}
+\membersection{wxScopedPtr::release}\label{wxscopedptrrelease}

 
 \func{T *}{release}{\void}
 
 
 \func{T *}{release}{\void}
 


@@ -108,7 +112,7 @@ Returns the currently hold pointer and resets the smart pointer object to
 deleting the pointer.
 
 
 deleting the pointer.
 
 

-\membersection{wxScopedPtr::reset}
+\membersection{wxScopedPtr::reset}\label{wxscopedptrreset}

 
 \func{\void}{reset}{\param{T}{ p * = NULL}}
 
 
 \func{\void}{reset}{\param{T}{ p * = NULL}}
 


@@ -117,7 +121,7 @@ arguments are specified. This function does check to make sure that the
 pointer you are assigning is not the same pointer that is already stored.
 
 
 pointer you are assigning is not the same pointer that is already stored.
 
 

-\membersection{wxScopedPtr::operator *}
+\membersection{wxScopedPtr::operator *}\label{wxscopedptrptr}

 
 \func{const T\&}{operator *}{\void}
 
 
 \func{const T\&}{operator *}{\void}
 


@@ -126,7 +130,7 @@ being pointed to by the pointer.  If the pointer is NULL or invalid this will
 crash.
 
 
 crash.
 
 

-\membersection{wxScopedPtr::operator -$>$} % TODO
+\membersection{wxScopedPtr::operator -$>$}\label{wxscopedptrref}

 
 \func{const T*}{operator -$>$}{\void} % TODO
 
 
 \func{const T*}{operator -$>$}{\void} % TODO
 


@@ -134,7 +138,7 @@ This operator works like the standard C++ pointer operator to return the pointer
 in the smart pointer or NULL if it is empty.
 
 
 in the smart pointer or NULL if it is empty.
 
 

-\membersection{wxScopedPtr::get}
+\membersection{wxScopedPtr::get}\label{wxscopedptrget}

 
 \func{const T*}{get}{\void}
 
 
 \func{const T*}{get}{\void}
 


@@ -142,7 +146,7 @@ This operator gets the pointer stored in the smart pointer or returns NULL if
 there is none.
 
 
 there is none.
 
 

-\membersection{wxScopedPtr::swap}
+\membersection{wxScopedPtr::swap}\label{wxscopedptrswap}

 
 \func{\void}{swap}{\param{wxScopedPtr}{ \& other}}
 
 
 \func{\void}{swap}{\param{wxScopedPtr}{ \& other}}