1. GetCwd() now has the volume argument, Normalize() works correctly for the

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

diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex
index f3fd9c8e1bb6ef41f2d950e7fda242be09be71bd..92259d14ae7809415aefda9ecca084b08c9c043a 100644 (file)
--- a/docs/latex/wx/list.tex
+++ b/docs/latex/wx/list.tex
@@ -9,7 +9,7 @@ when random access is required.
 While wxList class in the previous versions of wxWindows 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
 While wxList class in the previous versions of wxWindows 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 stricter type
+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).
 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).


@@ -19,13 +19,12 @@ data but make all of its dangerous (because untyped) functions protected, so
 that they can only be used from derived classes which, in turn, expose a type
 safe interface. With this approach a new wxList-like class must be defined for
 each list type (i.e. list of ints, of wxStrings or of MyObjects). This is done
 that they can only be used from derived classes which, in turn, expose a type
 safe interface. With this approach a new wxList-like class must be defined for
 each list type (i.e. list of ints, of wxStrings or of MyObjects). This is done

-with {\it WX\_DECLARE\_LIST} and {\it WX\_IMPLEMENT\_LIST} macros like this
+with {\it WX\_DECLARE\_LIST} and {\it WX\_DEFINE\_LIST} macros like this

 (notice the similarity with WX\_DECLARE\_OBJARRAY and WX\_IMPLEMENT\_OBJARRAY
 macros):
 
 \wxheading{Example}
 
 (notice the similarity with WX\_DECLARE\_OBJARRAY and WX\_IMPLEMENT\_OBJARRAY
 macros):
 
 \wxheading{Example}
 

-{\small%

 \begin{verbatim}
     // this part might be in a header or source (.cpp) file
     class MyListElement
 \begin{verbatim}
     // this part might be in a header or source (.cpp) file
     class MyListElement


@@ -51,8 +50,8 @@ macros):
     // also have MyList::Node type which is the type-safe version of wxNode.
     MyList list;
     MyListElement element;
     // also have MyList::Node type which is the type-safe version of wxNode.
     MyList list;
     MyListElement element;

-    list.Add(element);      // ok
-    list.Add(17);           // error: incorrect type
+    list.Append(element);      // ok
+    list.Append(17);           // error: incorrect type

 
     // let's iterate over the list
     for ( MyList::Node *node = list.GetFirst(); node; node = node->GetNext() )
 
     // let's iterate over the list
     for ( MyList::Node *node = list.GetFirst(); node; node = node->GetNext() )


@@ -62,11 +61,12 @@ macros):
         ...process the current element...
     }
 \end{verbatim}
         ...process the current element...
     }
 \end{verbatim}

-}

 
 For compatibility with previous versions wxList and wxStringList classes are
 still defined, but their usage is deprecated and they will disappear in the
 
 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.
+future versions completely. The use of the latter is especially discouraged as
+it is not only unsafe but is also much less efficient than 
+\helpref{wxArrayString}{wxarraystring} class.

 
 In the documentation of the list classes below, you should replace wxNode with
 wxListName::Node and wxObject with the list element type (i.e. the first
 
 In the documentation of the list classes below, you should replace wxNode with
 wxListName::Node and wxObject with the list element type (i.e. the first


@@ -157,7 +157,7 @@ terminating NULL.
 Destroys the list.  Also destroys any remaining nodes, but does not destroy
 client data held in the nodes.
 
 Destroys the list.  Also destroys any remaining nodes, but does not destroy
 client data held in the nodes.
 

-\membersection{wxList::Append}
+\membersection{wxList::Append}\label{wxlistappend}

 
 \func{wxNode *}{Append}{\param{wxObject *}{object}}
 
 
 \func{wxNode *}{Append}{\param{wxObject *}{object}}
 


@@ -171,11 +171,12 @@ later retrieval using the key. The new node is returned in each case.
 
 The key string is copied and stored by the list implementation.
 
 
 The key string is copied and stored by the list implementation.
 

-\membersection{wxList::Clear}
+\membersection{wxList::Clear}\label{wxlistclear}

 
 \func{void}{Clear}{\void}
 
 
 \func{void}{Clear}{\void}
 

-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
+unless you called DeleteContents(TRUE), in which case it deletes data).

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


@@ -184,20 +185,20 @@ Clears the list (but does not delete the client data stored with each node).
 If {\it destroy} is TRUE, instructs the list to call {\it delete} on the client contents of
 a node whenever the node is destroyed. The default is FALSE.
 
 If {\it destroy} is TRUE, instructs the list to call {\it delete} on the client contents of
 a node whenever the node is destroyed. The default is FALSE.
 

-\membersection{wxList::DeleteNode}
+\membersection{wxList::DeleteNode}\label{wxlistdeletenode}

 
 \func{bool}{DeleteNode}{\param{wxNode *}{node}}
 
 Deletes the given node from the list, returning TRUE if successful.
 
 
 \func{bool}{DeleteNode}{\param{wxNode *}{node}}
 
 Deletes the given node from the list, returning TRUE if successful.
 

-\membersection{wxList::DeleteObject}
+\membersection{wxList::DeleteObject}\label{wxlistdeleteobject}

 
 \func{bool}{DeleteObject}{\param{wxObject *}{object}}
 
 Finds the given client {\it object} and deletes the appropriate node from the list, returning
 TRUE if successful. The application must delete the actual object separately.
 
 
 \func{bool}{DeleteObject}{\param{wxObject *}{object}}
 
 Finds the given client {\it object} and deletes the appropriate node from the list, returning
 TRUE if successful. The application must delete the actual object separately.
 

-\membersection{wxList::Find}
+\membersection{wxList::Find}\label{wxlistfind}

 
 \func{wxNode *}{Find}{\param{long}{ key}}
 
 
 \func{wxNode *}{Find}{\param{long}{ key}}
 


@@ -211,26 +212,26 @@ Returns the node whose stored key matches {\it key}. Use on a keyed list only.
 
 Returns the number of elements in the list.
 
 
 Returns the number of elements in the list.
 

-\membersection{wxList::GetFirst}
+\membersection{wxList::GetFirst}\label{wxlistgetfirst}

 
 \func{wxNode *}{GetFirst}{\void}
 
 Returns the first node in the list (NULL if the list is empty).
 
 
 \func{wxNode *}{GetFirst}{\void}
 
 Returns the first node in the list (NULL if the list is empty).
 

-\membersection{wxList::GetLast}
+\membersection{wxList::GetLast}\label{wxlistgetlast}

 
 \func{wxNode *}{GetLast}{\void}
 
 Returns the last node in the list (NULL if the list is empty).
 
 
 \func{wxNode *}{GetLast}{\void}
 
 Returns the last node in the list (NULL if the list is empty).
 

-\membersection{wxList::IndexOf}
+\membersection{wxList::IndexOf}\label{wxlistindexof}

 
 \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 wxNOT\_FOUND if {\it obj} 

 is not found in the list.
 
 is not found in the list.
 

-\membersection{wxList::Insert}
+\membersection{wxList::Insert}\label{wxlistinsert}

 
 \func{wxNode *}{Insert}{\param{wxObject *}{object}}
 
 
 \func{wxNode *}{Insert}{\param{wxObject *}{object}}
 


@@ -253,7 +254,7 @@ Inserts the object before the given {\it node}.
 
 Returns the node at given position in the list.
 
 
 Returns the node at given position in the list.
 

-\membersection{wxList::Member}
+\membersection{wxList::Member}\label{wxlistmember}

 
 \func{wxNode *}{Member}{\param{wxObject *}{object}}
 
 
 \func{wxNode *}{Member}{\param{wxObject *}{object}}
 


@@ -261,7 +262,7 @@ Returns the node at given position in the list.
 
 Returns the node associated with {\it object} if it is in the list, NULL otherwise.
 
 
 Returns the node associated with {\it object} if it is in the list, NULL otherwise.
 

-\membersection{wxList::Nth}
+\membersection{wxList::Nth}\label{wxlistnth}

 
 \func{wxNode *}{Nth}{\param{int}{ n}}
 
 
 \func{wxNode *}{Nth}{\param{int}{ n}}
 


@@ -270,7 +271,7 @@ Returns the node associated with {\it object} if it is in the list, NULL otherwi
 Returns the {\it nth} node in the list, indexing from zero (NULL if the list is empty
 or the nth node could not be found).
 
 Returns the {\it nth} node in the list, indexing from zero (NULL if the list is empty
 or the nth node could not be found).
 

-\membersection{wxList::Number}
+\membersection{wxList::Number}\label{wxlistnumber}

 
 \func{int}{Number}{\void}
 
 
 \func{int}{Number}{\void}
 


@@ -278,7 +279,7 @@ or the nth node could not be found).
 
 Returns the number of elements in the list.
 
 
 Returns the number of elements in the list.
 

-\membersection{wxList::Sort}
+\membersection{wxList::Sort}\label{wxlistsort}

 
 \func{void}{Sort}{\param{wxSortCompareFunction}{ compfunc}}
 
 
 \func{void}{Sort}{\param{wxSortCompareFunction}{ compfunc}}
 


@@ -289,8 +290,12 @@ Returns the number of elements in the list.
 
 Allows the sorting of arbitrary lists by giving
 a function to compare two list elements. We use the system {\bf qsort} function
 
 Allows the sorting of arbitrary lists by giving
 a function to compare two list elements. We use the system {\bf qsort} function

-for the actual sorting process. The sort function receives pointers to wxObject pointers (wxObject **),
-so be careful to dereference appropriately.
+for the actual sorting process.
+
+If you use untyped wxList the sort function receives pointers to wxObject
+pointers (wxObject **), so be careful to dereference appropriately - but,
+of course, a better solution is to use list of appropriate type defined with
+{\tt WX\_DECLARE\_LIST}.

 
 Example:
 
 
 Example:
 


@@ -312,4 +317,3 @@ Example:
   }
 \end{verbatim}
 
   }
 \end{verbatim}
 

-