docs/latex/wx/sharedptr.tex

   1 \section{\class{wxSharedPtr<T>}}\label{wxsharedptr}
   2
   3 A smart pointer with non-intrusive reference counting.
   4
   5 \wxheading{Derived from}
   6
   7 No base class
   8
   9 \wxheading{Include files}
  10
  11 <ptr\_shrd.h>
  12
  13 \wxheading{Data structures}
  14
  15 {\small%
  16 \begin{verbatim}
  17 typedef T element_type
  18 \end{verbatim}
  19 }%
  20
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23
  24 \membersection{wxSharedPtr<T>::wxSharedPtr<T>}\label{wxsharedptrwxsharedptr}
  25
  26 \func{wxEXPLICIT}{wxSharedPtr<T>}{\param{T* }{ptr = NULL}}
  27
  28 \func{}{wxSharedPtr<T>}{\param{const wxSharedPtr<T>\& }{tocopy}}
  29
  30 Constructors.
  31
  32 \membersection{wxSharedPtr<T>::\destruct{wxSharedPtr<T>}}\label{wxsharedptrdtor}
  33
  34 \func{}{\destruct{wxSharedPtr<T>}}{\void}
  35
  36 Destructor.
  37
  38 \membersection{wxSharedPtr<T>::get}\label{wxsharedptrget}
  39
  40 \constfunc{T*}{get}{\void}
  41
  42 Returns pointer to its object or NULL.
  43
  44 \membersection{wxSharedPtr<T>::operator*}\label{wxsharedptroperatorptrt}
  45
  46 \constfunc{T\&}{operator*}{\void}
  47
  48 Returns pointer to its object or NULL.
  49
  50 \membersection{wxSharedPtr<T>::operator->}\label{wxsharedptroperatorderef}
  51
  52 \constfunc{T*}{operator->}{\void}
  53
  54 Returns pointer to its object or NULL.
  55
  56 \membersection{wxSharedPtr<T>::operator=}\label{wxsharedptroperatorassign}
  57
  58 \func{wxSharedPtr<T>\& operator}{operator=}{\param{const wxSharedPtr<T>\& }{tocopy}}
  59
  60 Assignment operator.
  61
  62 \membersection{wxSharedPtr<T>::unique}\label{wxsharedptrunique}
  63
  64 \constfunc{bool}{unique}{\void}
  65
  66 Returns true if this is the only pointer pointing to its object.
  67
  68 \membersection{wxSharedPtr<T>::use\_count}\label{wxsharedptruse\_count}
  69
  70 \constfunc{long}{use\_count}{\void}
  71
  72 Returns the number of pointers pointing to its object.
  73