Doc tweaks

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

diff --git a/docs/latex/wx/node.tex b/docs/latex/wx/node.tex
index 417329092f5f3bb3b82bf6a7ccd61896353ca83a..c718a7220efa18c1a8859293e8b5dcd537d43e2e 100644 (file)
--- a/docs/latex/wx/node.tex
+++ b/docs/latex/wx/node.tex
@@ -1,10 +1,20 @@
-\section{\class{wxNode}}\label{wxnode}
+\section{\class{wxNodeBase}}\label{wxnode}

 
 

-A node structure used in linked lists (see \helpref{wxList}{wxlist}).
+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\_DEFIBE\_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}
 
 
 \wxheading{Derived from}
 

-\helpref{wxObject}{wxobject}
+None.
+
+\wxheading{Include files}
+
+<wx/list.h>

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -12,30 +22,35 @@ A node structure used in linked lists (see \helpref{wxList}{wxlist}).
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxNode::Data}
+\membersection{wxNodeBase::GetData}

 
 

-\func{wxObject *}{Data}{\void}
+\func{void *}{Data}{\void}

 
 

-Retrieves the client data pointer associated with the node. This will
-have to be cast to the correct type.
+Retrieves the client data pointer associated with the node.

 
 

-\membersection{wxNode::Next}
+\membersection{wxNodeBase::GetNext}

 
 

-\func{wxNode *}{Next}{\void}
+\func{wxNodeBase *}{Next}{\void}

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

-\membersection{wxNode::Previous}
+\membersection{wxNodeBase::GetPrevious}

 
 

-\func{wxNode *}{Previous}{\void}
+\func{wxNodeBase *}{GetPrevious}{\void}

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

-\membersection{wxNode::SetData}
+\membersection{wxNodeBase::SetData}

 
 

-\func{void}{SetData}{\param{wxObject *}{data}}
+\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).
 
 
 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.