X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b222f1c9e0acb63c781675555c76f6129316eb1..9c72cf7619064969b5c7f59cece74013789db4cf:/docs/latex/wx/scpdarry.tex diff --git a/docs/latex/wx/scpdarry.tex b/docs/latex/wx/scpdarry.tex index 9164885ea7..6853c443c4 100644 --- a/docs/latex/wx/scpdarry.tex +++ b/docs/latex/wx/scpdarry.tex @@ -1,4 +1,4 @@ -\section{wxScopedArray}\label{wxscopedarray} +\section{\class{wxScopedArray}}\label{wxscopedarray} This is a simple scoped smart pointer array implementation that is similar to the \urlref{Boost}{http://www.boost.org} smart pointers but rewritten to @@ -6,7 +6,7 @@ use macros instead. \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} @@ -47,7 +47,7 @@ pointer array. \end{verbatim} A smart pointer holds a pointer to an object (which must be complete -when wxDEFINE_SCOPED_ARRAY() is called). The memory used by the object is +when wxDEFINE\_SCOPED\_ARRAY() is called). The memory used by the object is deleted when the smart pointer goes out of scope. The first argument of the macro is the pointer type, the second is the name of the new smart pointer class being created. Below we will use wxScopedArray to @@ -64,14 +64,14 @@ with any legal name. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxScopedArray::wxScopedArray} +\membersection{wxScopedArray::wxScopedArray}\label{wxscopedarrayctor} \func{}{wxScopedArray}{\param{type}{ * T = NULL}} Creates the smart pointer with the given pointer or none if NULL. On compilers that support it, this uses the explicit keyword. -\membersection{wxScopedArray::reset} +\membersection{wxScopedArray::reset}\label{wxscopedarrayreset} \func{\void}{reset}{\param{T}{ p * = NULL}} @@ -79,21 +79,21 @@ Deletes the currently held pointer and sets it to 'p' or to NULL if no 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{wxScopedArray::operator []} +\membersection{wxScopedArray::operator []}\label{wxscopedarraybracket} \func{const T \&}{operator []}{\param{long int}{i}} This operator acts like the standard [] indexing operator for C++ arrays. The function does not do bounds checking. -\membersection{wxScopedArray::get} +\membersection{wxScopedArray::get}\label{wxscopedarrayget} \func{const T*}{get}{\void} This operator gets the pointer stored in the smart pointer or returns NULL if there is none. -\membersection{wxScopedArray::swap} +\membersection{wxScopedArray::swap}\label{wxscopedarrayswap} \func{\void}{swap}{\param{wxScopedPtr}{ \& ot}}