]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/node.tex
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / latex / wx / node.tex
... / ...
CommitLineData
1\section{\class{wxNode}}\label{wxnode}
2
3wxNodeBase is the node structure used in linked lists (see
4\helpref{wxList}{wxlist}) and derived classes. You should never use wxNodeBase
5class directly, however, because it works with untyped ({\tt void *}) data and
6this is unsafe. Use wxNodeBase-derived classes which are automatically defined
7by WX\_DECLARE\_LIST and WX\_DEFINE\_LIST macros instead as described in
8\helpref{wxList}{wxlist} documentation (see example there). Also note that
9although there is a class called wxNode, it is defined for backwards
10compatibility only and usage of this class is strongly deprecated.
11
12In 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,
14in other words, the first argument of WX\_DECLARE\_LIST macro. Also, wxNode is
15written as wxNode<T> even though it isn't really a template class -- but it
16helps to think of it as if it were.
17
18\wxheading{Derived from}
19
20None.
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
36Retrieves the client data pointer associated with the node.
37
38\membersection{wxNode<T>::GetNext}
39
40\constfunc{wxNode<T> *}{GetNext}{\void}
41
42Retrieves 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
48Retrieves 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
54Sets the data associated with the node (usually the pointer will have been
55set when the node was created).
56
57\membersection{wxNode<T>::IndexOf}
58
59\func{int}{IndexOf}{\void}
60
61Returns the zero-based index of this node within the list. The return value
62will be NOT\_FOUND if the node has not been added to a list yet.
63