X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..8a094d7ba9913333b49f8561d97b8309d0023663:/docs/latex/wx/hash.tex diff --git a/docs/latex/wx/hash.tex b/docs/latex/wx/hash.tex index 6e45cab36e..7c60031e91 100644 --- a/docs/latex/wx/hash.tex +++ b/docs/latex/wx/hash.tex @@ -1,5 +1,8 @@ \section{\class{wxHashTable}}\label{wxhashtable} +{\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 wxWindows, and for an application if it wishes. Data can be hashed on an integer or string key. @@ -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} @@ -127,7 +131,7 @@ Inserts data into the hash table, using an integer or string key (depending on w has table constructor was used). The key string is copied and stored by the hash table implementation. -\membersection{wxList::GetCount} +\membersection{wxHashTable::GetCount} \constfunc{size\_t}{GetCount}{\void}