docs/latex/wx/scopedptr.tex

   1 \section{\class{wxScopedPtr<T>}}\label{wxscopedptrtemplate}
   2
   3 A scoped pointer template class. It is the template version of
   4 the old-style \helpref{scoped pointer macros}{wxscopedptr}.
   5
   6 \wxheading{Derived from}
   7
   8 No base class
   9
  10 \wxheading{Include files}
  11
  12 <ptr\_scpd.h>
  13
  14 \wxheading{Data structures}
  15
  16 {\small%
  17 \begin{verbatim}
  18 typedef T element_type
  19 \end{verbatim}
  20 }%
  21
  22 \wxheading{See also}
  23
  24 \helpref{wxSharedPtr}{wxsharedptr}, \helpref{wxWeakRef}{wxweakref}
  25
  26
  27 \latexignore{\rtfignore{\wxheading{Members}}}
  28
  29 \membersection{wxScopedPtr<T>::wxScopedPtr<T>}\label{wxscopedptrtemplatewxscopedptrtemplate}
  30
  31 \func{wxEXPLICIT}{wxScopedPtr<T>}{\param{T * }{ptr = NULL}}
  32
  33 Constructor.
  34
  35 \membersection{wxScopedPtr<T>::\destruct{wxScopedPtr<T>}}\label{wxscopedptrtemplatedtor}
  36
  37 \func{}{\destruct{wxScopedPtr<T>}}{\void}
  38
  39 Destructor.
  40
  41 \membersection{wxScopedPtr<T>::get}\label{wxscopedptrtemplateget}
  42
  43 \constfunc{T *}{get}{\void}
  44
  45 Returns pointer to object or NULL.
  46
  47 \membersection{wxScopedPtr<T>::operator unspecified\_bool\_type}\label{wxscopedptrtemplateoperatorbool}
  48
  49 \constfunc{}{operator unspecified\_bool\_type}{\void}
  50
  51 Conversion to a boolean expression (in a variant which is not
  52 convertable to anything but a boolean expression). If this class
  53 contains a valid pointer it will return {\it true}, if it contains
  54 a NULL pointer it will return {\it false}.
  55
  56 \membersection{wxScopedPtr<T>::operator*}\label{wxscopedptrtemplateoperatorreft}
  57
  58 \constfunc{T \&}{operator*}{\void}
  59
  60 Returns a reference to the object. If the internal pointer is NULL
  61 this method will cause an assert in debug mode.
  62
  63 \membersection{wxScopedPtr<T>::operator->}\label{wxscopedptrtemplateoperatorderef}
  64
  65 \constfunc{T *}{operator->}{\void}
  66
  67 Returns pointer to object. If the pointer is NULL this method will
  68 cause an assert in debug mode.
  69
  70 \membersection{wxScopedPtr<T>::release}\label{wxscopedptrtemplaterelease}
  71
  72 \func{T*}{release}{\void}
  73
  74 Releases the current pointer and returns it.
  75 Afterwards the caller is responsible for deleting
  76 the data contained in the scoped pointer before.
  77
  78 \membersection{wxScopedPtr<T>::reset}\label{wxscopedptrtemplatereset}
  79
  80 \func{void}{reset}{\param{T * }{ptr = NULL}}
  81
  82 Reset pointer to the value of {\it ptr}. The
  83 previous pointer will be deleted.
  84
  85 \membersection{wxScopedPtr<T>::swap}\label{wxscopedptrtemplateswap}
  86
  87 \func{void}{swap}{\param{wxScopedPtr<T> \& }{ot}}
  88
  89 Swaps pointers.
  90