docs/latex/wx/node.tex

   1 \section{\class{wxNode}}\label{wxnode}
   2
   3 A node structure used in linked lists (see \helpref{wxList}{wxlist}).
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxObject}{wxobject}
   8
   9 \wxheading{See also}
  10
  11 \helpref{wxList}{wxlist}, \helpref{wxHashTable}{wxhashtable}
  12
  13 \latexignore{\rtfignore{\wxheading{Members}}}
  14
  15 \membersection{wxNode::Data}
  16
  17 \func{wxObject *}{Data}{\void}
  18
  19 Retrieves the client data pointer associated with the node. This will
  20 have to be cast to the correct type.
  21
  22 \membersection{wxNode::Next}
  23
  24 \func{wxNode *}{Next}{\void}
  25
  26 Retrieves the next node (NULL if at end of list).
  27
  28 \membersection{wxNode::Previous}
  29
  30 \func{wxNode *}{Previous}{\void}
  31
  32 Retrieves the previous node (NULL if at start of list).
  33
  34 \membersection{wxNode::SetData}
  35
  36 \func{void}{SetData}{\param{wxObject *}{data}}
  37
  38 Sets the data associated with the node (usually the pointer will have been
  39 set when the node was created).
  40
  41 \membersection{wxNode::IndexOf}
  42
  43 \func{int}{IndexOf}{\void}
  44
  45 Returns the zero-based index of this node within the list. The return value
  46 will be NOT\_FOUND if the node has not been added to a list yet.
  47