[wxWidgets.git] / docs / latex / wx / node.tex

\section{\class{wxNodeBase}}\label{wxnode}

A node structure used in linked lists (see \helpref{wxList}{wxlist}) and
derived classes. You should never use wxNodeBase class directly because it
works with untyped (void *) data and this is unsafe. Use wxNode-derived classes
which are defined by WX\_DECLARE\_LIST and WX\_DEFINE\_LIST macros instead as
described in \helpref{wxList}{wxlist} documentation (see example there). wxNode
is defined for compatibility as wxNodeBase containing "wxObject *" pointer, but
usage of this class is deprecated.

\wxheading{Derived from}

None.

\wxheading{Include files}

<wx/list.h>

\wxheading{See also}

\helpref{wxList}{wxlist}, \helpref{wxHashTable}{wxhashtable}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxNodeBase::GetData}

\func{void *}{Data}{\void}

Retrieves the client data pointer associated with the node.

\membersection{wxNodeBase::GetNext}

\func{wxNodeBase *}{Next}{\void}

Retrieves the next node (NULL if at end of list).

\membersection{wxNodeBase::GetPrevious}

\func{wxNodeBase *}{GetPrevious}{\void}

Retrieves the previous node (NULL if at start of list).

\membersection{wxNodeBase::SetData}

\func{void}{SetData}{\param{void *}{data}}

Sets the data associated with the node (usually the pointer will have been
set when the node was created).

\membersection{wxNodeBase::IndexOf}

\func{int}{IndexOf}{\void}

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