docs/latex/wx/node.tex

   1 \section{\class{wxNode}}\label{wxnode}
   2
   3 wxNodeBase is the node structure used in linked lists (see
   4 \helpref{wxList}{wxlist}) and derived classes. You should never use wxNodeBase
   5 class directly, however, because it works with untyped ({\tt void *}) data and
   6 this is unsafe. Use wxNodeBase-derived classes which are automatically defined
   7 by WX\_DECLARE\_LIST and WX\_DEFINE\_LIST macros instead as described in
   8 \helpref{wxList}{wxlist} documentation (see example there). Also note that
   9 although there is a class called wxNode, it is defined for backwards
  10 compatibility only and usage of this class is strongly deprecated.
  11
  12 In the documentation below, the type {\tt T} should be thought of as a
  13 ``template'' parameter: this is the type of data stored in the linked list or,
  14 in other words, the first argument of WX\_DECLARE\_LIST macro. Also, wxNode is
  15 written as wxNode<T> even though it isn't really a template class -- but it
  16 helps to think of it as if it were.
  17
  18 \wxheading{Derived from}
  19
  20 None.
  21
  22 \wxheading{Include files}
  23
  24 <wx/list.h>
  25
  26 \wxheading{See also}
  27
  28 \helpref{wxList}{wxlist}, \helpref{wxHashTable}{wxhashtable}
  29
  30 \latexignore{\rtfignore{\wxheading{Members}}}
  31
  32 \membersection{wxNode<T>::GetData}
  33
  34 \constfunc{T *}{GetData}{\void}
  35
  36 Retrieves the client data pointer associated with the node.
  37
  38 \membersection{wxNode<T>::GetNext}
  39
  40 \constfunc{wxNode<T> *}{GetNext}{\void}
  41
  42 Retrieves the next node or NULL if this node is the last one.
  43
  44 \membersection{wxNode<T>::GetPrevious}
  45
  46 \func{wxNode<T> *}{GetPrevious}{\void}
  47
  48 Retrieves the previous node or NULL if this node is the first one in the list.
  49
  50 \membersection{wxNode<T>::SetData}
  51
  52 \func{void}{SetData}{\param{T *}{data}}
  53
  54 Sets the data associated with the node (usually the pointer will have been
  55 set when the node was created).
  56
  57 \membersection{wxNode<T>::IndexOf}
  58
  59 \func{int}{IndexOf}{\void}
  60
  61 Returns the zero-based index of this node within the list. The return value
  62 will be NOT\_FOUND if the node has not been added to a list yet.
  63