X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..b72979e918a07a9c4860bac4aea5c216cabbf21e:/docs/latex/wx/list.tex diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex index 66912bb97a..5144cf38d3 100644 --- a/docs/latex/wx/list.tex +++ b/docs/latex/wx/list.tex @@ -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 @@ -130,12 +141,12 @@ 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} @@ -155,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} @@ -206,11 +217,17 @@ 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 *}{node}} + +Removes element at given position. + \membersection{wxList::Find}\label{wxlistfind} \func{wxNode *}{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. @@ -242,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} @@ -324,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() @@ -337,4 +354,3 @@ Example: list.Sort(listcompare); } \end{verbatim} -