typo fix

[wxWidgets.git] / docs / latex / wx / hash.tex

diff --git a/docs/latex/wx/hash.tex b/docs/latex/wx/hash.tex
index 6e45cab36e76322b04d055a6c7190835875a8c33..83ba35780edc5d87070dd0eebab6ef5eab7ea9c8 100644 (file)
--- 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.
 
@@ -12,12 +15,16 @@ key.
 
 <wx/hash.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{Example}
 
 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);
@@ -48,20 +55,20 @@ the size of the hash table.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxHashTable::wxHashTable}
+\membersection{wxHashTable::wxHashTable}\label{wxhashtablector}
 
 \func{}{wxHashTable}{\param{unsigned int}{ key\_type}, \param{int}{ size = 1000}}
 
 Constructor. {\it key\_type} is one of wxKEY\_INTEGER, or wxKEY\_STRING,
 and indicates what sort of keying is required. {\it size} is optional.
 
-\membersection{wxHashTable::\destruct{wxHashTable}}
+\membersection{wxHashTable::\destruct{wxHashTable}}\label{wxhashtabledtor}
 
 \func{}{\destruct{wxHashTable}}{\void}
 
 Destroys the hash table.
 
-\membersection{wxHashTable::BeginFind}
+\membersection{wxHashTable::BeginFind}\label{wxhashtablebeginfind}
 
 \func{void}{BeginFind}{\void}
 
@@ -69,13 +76,13 @@ The counterpart of {\it Next}.  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}.
 
-\membersection{wxHashTable::Clear}
+\membersection{wxHashTable::Clear}\label{wxhashtableclear}
 
 \func{void}{Clear}{\void}
 
 Clears the hash table of all nodes (but as usual, doesn't delete user data).
 
-\membersection{wxHashTable::Delete}
+\membersection{wxHashTable::Delete}\label{wxhashtabledelete}
 
 \func{wxObject *}{Delete}{\param{long}{ key}}
 
@@ -83,15 +90,15 @@ Clears the hash table of all nodes (but as usual, doesn't delete user data).
 
 Deletes entry in hash table and returns the user's data (if found).
 
-\membersection{wxHashTable::DeleteContents}
+\membersection{wxHashTable::DeleteContents}\label{wxhashtabledeletecontents}
 
 \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.
 
 
-\membersection{wxHashTable::Get}
+\membersection{wxHashTable::Get}\label{wxhashtableget}
 
 \func{wxObject *}{Get}{\param{long}{ key}}
 
@@ -100,24 +107,25 @@ is destroyed.
 Gets data from the hash table, using an integer or string key (depending on which
 has table constructor was used).
 
-\membersection{wxHashTable::MakeKey}
+\membersection{wxHashTable::MakeKey}\label{wxhashtablemakekey}
 
 \func{long}{MakeKey}{\param{const wxString\& }{string}}
 
 Makes an integer key out of a string. An application may wish to make a key
 explicitly (for instance when combining two data values to form a key).
 
-\membersection{wxHashTable::Next}
+\membersection{wxHashTable::Next}\label{wxhashtablenext}
 
-\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}
+\membersection{wxHashTable::Put}\label{wxhashtableput}
 
 \func{void}{Put}{\param{long}{ key}, \param{wxObject *}{object}}
 
@@ -127,7 +135,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}\label{wxhashtablegetcount}
 
 \constfunc{size\_t}{GetCount}{\void}