Updated wxHashTable::Next documentation to use wxHashTable::Node*

for the return type (which currently is just a typedef for wxNode*).

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24393 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/hash.tex b/docs/latex/wx/hash.tex
index afd8c0a635f3b6bba61d8edb58f60bf9b1cf5332..7c60031e913044f84ba3947ee6a62a925de61e78 100644 (file)
--- a/docs/latex/wx/hash.tex
+++ b/docs/latex/wx/hash.tex
@@ -112,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}
 

diff --git a/include/wx/hash.h b/include/wx/hash.h
index 3720dd0c1fd0c99246c3e1d932baa2bf42cb1d13..4fb1436c21c7c5fdf188c5dc0b961df7c3b5b0f1 100644 (file)
--- a/include/wx/hash.h
+++ b/include/wx/hash.h
@@ -447,6 +447,9 @@ private:
 class WXDLLIMPEXP_BASE wxHashTable : public wxObject
 {
 public:
+    typedef wxNode Node;
+    typedef wxNode* compatibility_iterator;
+
     int n;
     int current_position;
     wxNode *current_node;
@@ -523,7 +526,6 @@ public:
     // Returns number of nodes
     size_t GetCount() const { return m_count; }
 
-    typedef wxNode* compatibility_iterator;
 private:
     size_t m_count;             // number of elements in the hashtable
     bool m_deleteContents;