]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/list.tex
deprecated static wxWizard::Create()
[wxWidgets.git] / docs / latex / wx / list.tex
index 1b96da6cd662610afff752450b724dbb13df27d0..b87233dda410c9777b8291c836c5cfb16509f0fb 100644 (file)
@@ -3,7 +3,7 @@
 wxList classes provide linked list functionality for wxWindows, 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.
-See \helpref{wxHashTable}{wxhashtable}\rtfsp for a faster method of storage
+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
@@ -25,7 +25,6 @@ macros):
 
 \wxheading{Example}
 
-{\small%
 \begin{verbatim}
     // this part might be in a header or source (.cpp) file
     class MyListElement
@@ -39,7 +38,7 @@ macros):
 
     ...
 
-    // the only requirment for the rest is to be AFTER the full declaration of
+    // the only requirement for the rest is to be AFTER the full declaration of
     // MyListElement (for WX_DECLARE_LIST forward declaration is enough), but
     // usually it will be found in the source file and not in the header
 
@@ -62,7 +61,6 @@ macros):
         ...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
@@ -178,27 +176,27 @@ The key string is copied and stored by the list implementation.
 \func{void}{Clear}{\void}
 
 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).
+unless you called DeleteContents({\tt TRUE}), in which case it deletes data).
 
 \membersection{wxList::DeleteContents}\label{wxlistdeletecontents}
 
 \func{void}{DeleteContents}{\param{bool}{ destroy}}
 
-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 {\tt TRUE}, instructs the list to call {\it delete} on the client contents of
+a node whenever the node is destroyed. The default is {\tt FALSE}.
 
 \membersection{wxList::DeleteNode}\label{wxlistdeletenode}
 
 \func{bool}{DeleteNode}{\param{wxNode *}{node}}
 
-Deletes the given node from the list, returning TRUE if successful.
+Deletes the given node from the list, returning {\tt TRUE} if successful.
 
 \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.
+{\tt TRUE} if successful. The application must delete the actual object separately.
 
 \membersection{wxList::Find}\label{wxlistfind}
 
@@ -230,7 +228,7 @@ Returns the last node in the list (NULL if the list is empty).
 
 \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.
 
 \membersection{wxList::Insert}\label{wxlistinsert}
@@ -250,6 +248,12 @@ same as calling \helpref{Append}{wxlistappend}.
 
 Inserts the object before the given {\it node}.
 
+\membersection{wxList::IsEmpty}\label{wxlistisempty}
+
+\constfunc{bool}{IsEmpty}{\void}
+
+Returns {\tt TRUE} if the list is empty, {\tt FALSE} otherwise.
+
 \membersection{wxList::Item}\label{wxlistitem}
 
 \constfunc{wxNode *}{Item}{\param{size\_t }{index}}