X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c8499e53d820ed68ad6a1e9b25d963107641af14..801d040762d0d875126935b79d660d4e2fe1b177:/docs/latex/wx/hash.tex diff --git a/docs/latex/wx/hash.tex b/docs/latex/wx/hash.tex index 8bfc618b94..37cd59f4d7 100644 --- a/docs/latex/wx/hash.tex +++ b/docs/latex/wx/hash.tex @@ -1,6 +1,9 @@ \section{\class{wxHashTable}}\label{wxhashtable} -This class provides hash table functionality for wxWindows, and for an +{\bf Please note} that this class is retained for backward compatibility +reasons; you should use \helpref{wxHashMap}{wxhashmap}. + +This class provides hash table functionality for wxWidgets, and for an application if it wishes. Data can be hashed on an integer or string key. @@ -17,7 +20,7 @@ key. Below is an example of using a hash table. \begin{verbatim} - wxHashTable table(KEY_STRING); + wxHashTable table(wxKEY_STRING); wxPoint *point = new wxPoint(100, 200); table.Put("point 1", point); @@ -87,7 +90,7 @@ Deletes entry in hash table and returns the user's data (if found). \func{void}{DeleteContents}{\param{bool}{ flag}} -If set to TRUE data stored in hash table will be deleted when hash table object +If set to true data stored in hash table will be deleted when hash table object is destroyed. @@ -109,13 +112,14 @@ explicitly (for instance when combining two data values to form a key). \membersection{wxHashTable::Next} -\func{wxNode *}{Next}{\void} +\func{wxHashTable::Node *}{Next}{\void} If the application wishes to iterate through all the data in the hash table, it can call {\it BeginFind} and then loop on {\it Next}. This function -returns a {\bf wxNode} pointer (or NULL if there are no more nodes). See the -description for \helpref{wxNode}{wxnode}. The user will probably only wish to use the -{\bf wxNode::Data} function to retrieve the data; the node may also be deleted. +returns a {\bf wxHashTable::Node} pointer (or NULL if there are no more nodes). +The return value is functionally equivalent to \textbf{wxNode} but might not be +implemented as a \textbf{wxNode}. The user will probably only wish to use the +\textbf{GetData} method to retrieve the data; the node may also be deleted. \membersection{wxHashTable::Put}