]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/node.tex
fixed MSLU check
[wxWidgets.git] / docs / latex / wx / node.tex
... / ...
CommitLineData
1\section{\class{wxNodeBase}}\label{wxnode}
2
3A node structure used in linked lists (see \helpref{wxList}{wxlist}) and
4derived classes. You should never use wxNodeBase class directly because it
5works with untyped (void *) data and this is unsafe. Use wxNode-derived classes
6which are defined by WX\_DECLARE\_LIST and WX\_DEFINE\_LIST macros instead as
7described in \helpref{wxList}{wxlist} documentation (see example there). wxNode
8is defined for compatibility as wxNodeBase containing "wxObject *" pointer, but
9usage of this class is deprecated.
10
11\wxheading{Derived from}
12
13None.
14
15\wxheading{Include files}
16
17<wx/list.h>
18
19\wxheading{See also}
20
21\helpref{wxList}{wxlist}, \helpref{wxHashTable}{wxhashtable}
22
23\latexignore{\rtfignore{\wxheading{Members}}}
24
25\membersection{wxNodeBase::GetData}
26
27\func{void *}{Data}{\void}
28
29Retrieves the client data pointer associated with the node.
30
31\membersection{wxNodeBase::GetNext}
32
33\func{wxNodeBase *}{Next}{\void}
34
35Retrieves the next node (NULL if at end of list).
36
37\membersection{wxNodeBase::GetPrevious}
38
39\func{wxNodeBase *}{GetPrevious}{\void}
40
41Retrieves the previous node (NULL if at start of list).
42
43\membersection{wxNodeBase::SetData}
44
45\func{void}{SetData}{\param{void *}{data}}
46
47Sets the data associated with the node (usually the pointer will have been
48set when the node was created).
49
50\membersection{wxNodeBase::IndexOf}
51
52\func{int}{IndexOf}{\void}
53
54Returns the zero-based index of this node within the list. The return value
55will be NOT\_FOUND if the node has not been added to a list yet.
56