]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/scpdptr.tex
Sort of autoresize if only 1 column is there
[wxWidgets.git] / docs / latex / wx / scpdptr.tex
index 87b69270d6a64423b6599d3742dc01acfd68826b..47c36fcf5047e35ded4e18c818d238110032eb39 100644 (file)
@@ -1,9 +1,12 @@
-{\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
 use macros instead.
 
+Since wxWidgets 2.9.0 there is also a templated version of this class
+with the same name. See \helpref{wxScopedPtr<T>}{wxscopedptrtemplate}.
+
 A smart pointer holds a pointer to an object. The memory used by the object is
 deleted when the smart pointer goes out of scope. This class is different from
 the \texttt{std::auto\_ptr<>} in so far as it doesn't provide copy constructor
@@ -12,7 +15,7 @@ surprizing than the ``destructive copy'' behaviour of the standard class.
 
 \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}
@@ -49,12 +52,14 @@ pointer array.
 
 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}
     wxDEFINE_SCOPED_PTR( TYPE, CLASSNAME );
 \end{verbatim}
@@ -69,9 +74,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:
+
 \begin{verbatim}
     wxDEFINE_SCOPED_PTR_TYPE( TYPE );
 \end{verbatim}
+
 Once again, in this cass \texttt{CLASSNAME} will be \texttt{TYPEPtr}.
 
 \wxheading{Include files}
@@ -84,7 +91,7 @@ Once again, in this cass \texttt{CLASSNAME} will be \texttt{TYPEPtr}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxScopedPtr::wxScopedPtr}
+\membersection{wxScopedPtr::wxScopedPtr}\label{wxscopedptrctor}
 
 \func{}{explicit wxScopedPtr}{\param{type}{ * T = NULL}}
 
@@ -92,14 +99,14 @@ Creates the smart pointer with the given pointer or none if {\tt NULL}.  On
 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}.
 
 
-\membersection{wxScopedPtr::release}
+\membersection{wxScopedPtr::release}\label{wxscopedptrrelease}
 
 \func{T *}{release}{\void}
 
@@ -108,7 +115,7 @@ Returns the currently hold pointer and resets the smart pointer object to
 deleting the pointer.
 
 
-\membersection{wxScopedPtr::reset}
+\membersection{wxScopedPtr::reset}\label{wxscopedptrreset}
 
 \func{\void}{reset}{\param{T}{ p * = NULL}}
 
@@ -117,7 +124,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.
 
 
-\membersection{wxScopedPtr::operator *}
+\membersection{wxScopedPtr::operator *}\label{wxscopedptrptr}
 
 \func{const T\&}{operator *}{\void}
 
@@ -126,7 +133,7 @@ being pointed to by the pointer.  If the pointer is NULL or invalid this will
 crash.
 
 
-\membersection{wxScopedPtr::operator -$>$} % TODO
+\membersection{wxScopedPtr::operator -$>$}\label{wxscopedptrref}
 
 \func{const T*}{operator -$>$}{\void} % TODO
 
@@ -134,7 +141,7 @@ This operator works like the standard C++ pointer operator to return the pointer
 in the smart pointer or NULL if it is empty.
 
 
-\membersection{wxScopedPtr::get}
+\membersection{wxScopedPtr::get}\label{wxscopedptrget}
 
 \func{const T*}{get}{\void}
 
@@ -142,7 +149,7 @@ This operator gets the pointer stored in the smart pointer or returns NULL if
 there is none.
 
 
-\membersection{wxScopedPtr::swap}
+\membersection{wxScopedPtr::swap}\label{wxscopedptrswap}
 
 \func{\void}{swap}{\param{wxScopedPtr}{ \& other}}