]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/node.tex
Doc mods, sash window bug
[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\_DEFIBE\_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{See also}
16
17\helpref{wxList}{wxlist}, \helpref{wxHashTable}{wxhashtable}
18
19\latexignore{\rtfignore{\wxheading{Members}}}
20
21\membersection{wxNodeBase::GetData}
22
23\func{void *}{Data}{\void}
24
25Retrieves the client data pointer associated with the node.
26
27\membersection{wxNodeBase::GetNext}
28
29\func{wxNodeBase *}{Next}{\void}
30
31Retrieves the next node (NULL if at end of list).
32
33\membersection{wxNodeBase::Previous}
34
35\func{wxNodeBase *}{GetPrevious}{\void}
36
37Retrieves the previous node (NULL if at start of list).
38
39\membersection{wxNodeBase::SetData}
40
41\func{void}{SetData}{\param{void *}{data}}
42
43Sets the data associated with the node (usually the pointer will have been
44set when the node was created).
45
46\membersection{wxNodeBase::IndexOf}
47
48\func{int}{IndexOf}{\void}
49
50Returns the zero-based index of this node within the list. The return value
51will be NOT\_FOUND if the node has not been added to a list yet.
52