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 \begin{verbatim}
  16 typedef T element\_type
  17 \end{verbatim}}
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21
  22 \membersection{wxSharedPtr<T>::wxSharedPtr<T>}\label{wxsharedptrwxsharedptr}
  23
  24 \func{wxEXPLICIT}{wxSharedPtr<T>}{\param{T* }{ptr = NULL}}
  25
  26 \func{}{wxSharedPtr<T>}{\param{const wxSharedPtr<T>\& }{tocopy}}
  27
  28 Constructors.
  29
  30 \membersection{wxSharedPtr<T>::\destruct{wxSharedPtr<T>}}\label{wxsharedptrdtor}
  31
  32 \func{}{\destruct{wxSharedPtr<T>}}{\void}
  33
  34 Destructor.
  35
  36 \membersection{wxSharedPtr<T>::get}\label{wxsharedptrget}
  37
  38 \constfunc{T*}{get}{\void}
  39
  40 Returns pointer to its object or NULL.
  41
  42 \membersection{wxSharedPtr<T>::operator*}\label{wxsharedptroperatorptrt}
  43
  44 \constfunc{T\&}{operator*}{\void}
  45
  46 Returns pointer to its object or NULL.
  47
  48 \membersection{wxSharedPtr<T>::operator->}\label{wxsharedptroperatorderef}
  49
  50 \constfunc{T*}{operator->}{\void}
  51
  52 Returns pointer to its object or NULL.
  53
  54 \membersection{wxSharedPtr<T>::operator=}\label{wxsharedptroperatorassign}
  55
  56 \func{wxSharedPtr<T>\& operator}{operator=}{\param{const wxSharedPtr<T>\& }{tocopy}}
  57
  58 Assignment operator.
  59
  60 \membersection{wxSharedPtr<T>::unique}\label{wxsharedptrunique}
  61
  62 \constfunc{bool}{unique}{\void}
  63
  64 Returns true if this is the only pointer pointing to its object.
  65
  66 \membersection{wxSharedPtr<T>::use\_count}\label{wxsharedptruse\_count}
  67
  68 \constfunc{long}{use\_count}{\void}
  69
  70 Returns the number of pointers pointing to its object.
  71