X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/064998bf8b7b683d964f07a71b5c5d1d32565ef1..750cefbca2741b1be65adcd5480dd85a2d049a6c:/docs/latex/wx/list.tex diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex index 293b412d60..b87233dda4 100644 --- a/docs/latex/wx/list.tex +++ b/docs/latex/wx/list.tex @@ -3,13 +3,13 @@ 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 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). @@ -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,11 +61,12 @@ 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 -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 @@ -176,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} @@ -228,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} @@ -248,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}}