X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..e333075415c35d2e869ea585fa41f01a2c938897:/interface/hash.h diff --git a/interface/hash.h b/interface/hash.h index 581f46013c..b7bfc1091a 100644 --- a/interface/hash.h +++ b/interface/hash.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: hash.h -// Purpose: documentation for wxHashTable class +// Purpose: interface of wxHashTable // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -9,26 +9,25 @@ /** @class wxHashTable @wxheader{hash.h} - + @b Please note that this class is retained for backward compatibility reasons; you should use 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. - + @library{wxbase} @category{containers} - - @seealso - wxList + + @see wxList */ class wxHashTable : public wxObject { public: /** - Constructor. @e key_type is one of wxKEY_INTEGER, or wxKEY_STRING, - and indicates what sort of keying is required. @e size is optional. + Constructor. @a key_type is one of wxKEY_INTEGER, or wxKEY_STRING, + and indicates what sort of keying is required. @a size is optional. */ wxHashTable(unsigned int key_type, int size = 1000); @@ -53,8 +52,8 @@ public: /** Deletes entry in hash table and returns the user's data (if found). */ - wxObject * Delete(long key); - wxObject * Delete(const wxString& key); + wxObject* Delete(long key); + wxObject* Delete(const wxString& key); //@} /** @@ -69,14 +68,14 @@ public: which has table constructor was used). */ - wxObject * Get(long key); - wxObject * Get(const char* key); + wxObject* Get(long key); + wxObject* Get(const char* key); //@} /** Returns the number of elements in the hash table. */ - size_t GetCount(); + size_t GetCount() const; /** Makes an integer key out of a string. An application may wish to make a key @@ -92,7 +91,7 @@ public: implemented as a @b wxNode. The user will probably only wish to use the @b GetData method to retrieve the data; the node may also be deleted. */ - wxHashTable::Node * Next(); + wxHashTable::Node* Next(); //@{ /** @@ -101,7 +100,8 @@ public: has table constructor was used). The key string is copied and stored by the hash table implementation. */ - void Put(long key, wxObject * object); - void Put(const char* key, wxObject * object); + void Put(long key, wxObject* object); + void Put(const char* key, wxObject* object); //@} }; +