Doc updates.

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

diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex
index 80abf3d7b70b99d86b0012b02af1672acf36dd36..91c439dfa9635d81de61bd621a72b42de9b8c594 100644 (file)
--- a/docs/latex/wx/list.tex
+++ b/docs/latex/wx/list.tex
@@ -72,7 +72,9 @@ future versions completely.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

-{\bf WARNING: } the rest of documentation may be out-of-date.
+\wxheading{Include files}
+
+<wx/list.h>

 
 \wxheading{Example}
 
 
 \wxheading{Example}
 


@@ -80,19 +82,19 @@ It is very common to iterate on a list as follows:
 
 \begin{verbatim}
   ...
 
 \begin{verbatim}
   ...

-  wxPoint *point1 = new wxPoint(100, 100);
-  wxPoint *point2 = new wxPoint(200, 200);
+  wxWindow *win1 = new wxWindow(...);
+  wxWindow *win2 = new wxWindow(...);

 
   wxList SomeList;
 
   wxList SomeList;

-  SomeList.Append(point1);
-  SomeList.Append(point2);
+  SomeList.Append(win1);
+  SomeList.Append(win2);

 
   ...
 
 
   ...
 

-  wxNode *node = SomeList.First();
+  wxNode *node = SomeList.GetFirst();

   while (node)
   {
   while (node)
   {

-    wxPoint *point = (wxPoint *)node->Data();
+    wxWindow *win = (wxWindow *)node->Data();

     ...
     node = node->Next();
   }
     ...
     node = node->Next();
   }


@@ -110,9 +112,9 @@ with
 
 \begin{verbatim}
     ...
 
 \begin{verbatim}
     ...

-    delete point;
+    delete win;

     delete node;
     delete node;

-    node = SomeList.First();
+    node = SomeList.GetFirst();

     ...
 \end{verbatim}
 
     ...
 \end{verbatim}
 


@@ -175,7 +177,7 @@ The key string is copied and stored by the list implementation.
 
 Clears the list (but does not delete the client data stored with each node).
 
 
 Clears the list (but does not delete the client data stored with each node).
 

-\membersection{wxList::DeleteContents}
+\membersection{wxList::DeleteContents}\label{wxlistdeletecontents}

 
 \func{void}{DeleteContents}{\param{bool}{ destroy}}
 
 
 \func{void}{DeleteContents}{\param{bool}{ destroy}}
 


@@ -203,9 +205,9 @@ TRUE if successful. The application must delete the actual object separately.
 
 Returns the node whose stored key matches {\it key}. Use on a keyed list only.
 
 
 Returns the node whose stored key matches {\it key}. Use on a keyed list only.
 

-\membersection{wxList::First}
+\membersection{wxList::GetFirst}

 
 

-\func{wxNode *}{First}{\void}
+\func{wxNode *}{GetFirst}{\void}

 
 Returns the first node in the list (NULL if the list is empty).
 
 
 Returns the first node in the list (NULL if the list is empty).
 


@@ -213,7 +215,7 @@ Returns the first node in the list (NULL if the list is empty).
 
 \func{int}{IndexOf}{\param{wxObject*}{ obj }}
 
 
 \func{int}{IndexOf}{\param{wxObject*}{ obj }}
 

-Returns the index of {\it obj} within the list or NOT\_FOUND if {\it obj}
+Returns the index of {\it obj} within the list or NOT\_FOUND if {\it obj} 

 is not found in the list.
 
 \membersection{wxList::Insert}
 is not found in the list.
 
 \membersection{wxList::Insert}


@@ -227,9 +229,9 @@ Insert object at front of list.
 Insert object before {\it position}.
 
 
 Insert object before {\it position}.
 
 

-\membersection{wxList::Last}
+\membersection{wxList::GetLast}

 
 

-\func{wxNode *}{Last}{\void}
+\func{wxNode *}{GetLast}{\void}

 
 Returns the last node in the list (NULL if the list is empty).
 
 
 Returns the last node in the list (NULL if the list is empty).