real LaTeX fix to last commit

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

diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex
index 6073e3a2ef7c852ac04c2c6ae9fc0a5ed4705e2a..5144cf38d35fb3afac4cad196bbb0148045a2a51 100644 (file)
--- a/docs/latex/wx/list.tex
+++ b/docs/latex/wx/list.tex
@@ -1,18 +1,30 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% 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 wxWindows, and for an
+wxList classes provide linked list functionality for wxWidgets, and for an
 application if it wishes.  Depending on the form of constructor used, a list
-can be keyed on integer or string keys to provide a primitive look-up ability.
+can be keyed on integer or string keys to provide a primitive look-up ability,
+but please note that this feature is {\bf deprecated}.
 See \helpref{wxHashMap}{wxhashmap}\rtfsp for a faster method of storage
 when random access is required.
 
-While wxList class in the previous versions of wxWindows only could contain
+While wxList class in the previous versions of wxWidgets only could contain
 elements of type wxObject and had essentially untyped interface (thus allowing
 you to put apples in the list and read back oranges from it), the new wxList
 classes family may contain elements of any type and has much more strict type
 checking. Unfortunately, it also requires an additional line to be inserted in
 your program for each list class you use (which is the only solution short of
-using templates which is not done in wxWindows because of portability issues).
+using templates which is not done in wxWidgets because of portability issues).
 
 The general idea is to have the base class wxListBase working with {\it void *}
 data but make all of its dangerous (because untyped) functions protected, so
@@ -50,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
@@ -65,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
@@ -129,21 +141,23 @@ members for getting to the next or previous node.
 
 \wxheading{See also}
 
-\helpref{wxNode}{wxnode}, \helpref{wxStringList}{wxstringlist},
+\helpref{wxNode}{wxnode},
 \helpref{wxArray}{wxarray}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxList::wxList}
+\membersection{wxList::wxList}\label{wxlistctor}
 
 \func{}{wxList}{\void}
 
-\func{}{wxList}{\param{unsigned int}{ key\_type}}
-
 \func{}{wxList}{\param{int}{ n}, \param{T *}{objects[]}}
 
 \func{}{wxList}{\param{T *}{object}, ...}
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
+\func{}{wxList}{\param{unsigned int}{ key\_type}}
+
 Constructors. {\it key\_type} is one of wxKEY\_NONE, wxKEY\_INTEGER, or wxKEY\_STRING,
 and indicates what sort of keying is required (if any).
 
@@ -152,7 +166,7 @@ and indicates what sort of keying is required (if any).
 The variable-length argument list constructor must be supplied with a
 terminating NULL.
 
-\membersection{wxList::\destruct{wxList}}
+\membersection{wxList::\destruct{wxList}}\label{wxlistdtor}
 
 \func{}{\destruct{wxList}}{\void}
 
@@ -163,6 +177,8 @@ client data held in the nodes.
 
 \func{wxNode<T> *}{Append}{\param{T *}{object}}
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
 \func{wxNode<T> *}{Append}{\param{long}{ key}, \param{T *}{object}}
 
 \func{wxNode<T> *}{Append}{\param{const wxString\& }{key}, \param{T *}{object}}
@@ -201,11 +217,19 @@ Deletes the given node from the list, returning {\tt true} if successful.
 Finds the given client {\it object} and deletes the appropriate node from the list, returning
 {\tt true} if successful. The application must delete the actual object separately.
 
+\membersection{wxList::Erase}\label{wxlisterase}
+
+\func{void}{Erase}{\param{wxNode<T> *}{node}}
+
+Removes element at given position.
+
 \membersection{wxList::Find}\label{wxlistfind}
 
 \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.
 
 \func{wxNode<T> *}{Find}{\param{long}{ key}}
 
@@ -235,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 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}
@@ -317,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()
@@ -330,4 +354,3 @@ Example:
     list.Sort(listcompare);
   }
 \end{verbatim}
-