]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/list.tex
use wxChar correctly in wxString docs; mark wx1 compatibility functions
[wxWidgets.git] / docs / latex / wx / list.tex
index 1bce91d35e3abb45f0bf87c0b51a026a150f7f0f..5144cf38d35fb3afac4cad196bbb0148045a2a51 100644 (file)
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        list.tex
+%% Purpose:     wxList
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{\class{wxList}}\label{wxlist}
 
 wxList classes provide linked list functionality for wxWidgets, and for an
@@ -51,7 +62,7 @@ macros):
     // also have MyList::Node type which is the type-safe version of wxNode.
     MyList list;
     MyListElement element;
-    list.Append(element);      // ok
+    list.Append(&element);     // ok
     list.Append(17);           // error: incorrect type
 
     // let's iterate over the list
@@ -66,7 +77,7 @@ macros):
 For compatibility with previous versions wxList and wxStringList classes are
 still defined, but their usage is deprecated and they will disappear in the
 future versions completely. The use of the latter is especially discouraged as
-it is not only unsafe but is also much less efficient than 
+it is not only unsafe but is also much less efficient than
 \helpref{wxArrayString}{wxarraystring} class.
 
 In the documentation of the list classes below, the template notations are
@@ -216,7 +227,7 @@ Removes element at given position.
 
 \func{wxNode<T> *}{Find}{\param{T *}{ object}}
 
-Returns the node whose client date is {\it object} or NULL if none found.
+Returns the node whose client data is {\it object} or NULL if none found.
 
 {\bf Note}: keyed lists are deprecated and should not be used in new code.
 
@@ -248,7 +259,7 @@ Returns the last node in the list (NULL if the list is empty).
 
 \func{int}{IndexOf}{\param{T*}{ obj }}
 
-Returns the index of {\it obj} within the list or {\tt wxNOT\_FOUND} if {\it obj} 
+Returns the index of {\it obj} within the list or {\tt wxNOT\_FOUND} if {\it obj}
 is not found in the list.
 
 \membersection{wxList::Insert}\label{wxlistinsert}
@@ -330,7 +341,7 @@ Example:
   int listcompare(const void *arg1, const void *arg2)
   {
     return(compare(**(wxString **)arg1,    // use the wxString 'compare'
-                   **(wxString **)arg2));  // function 
+                   **(wxString **)arg2));  // function
   }
 
   void main()
@@ -343,4 +354,3 @@ Example:
     list.Sort(listcompare);
   }
 \end{verbatim}
-