/////////////////////////////////////////////////////////////////////////////
// Name: hash.h
-// Purpose: documentation for wxHashTable class
+// Purpose: interface of wxHashTable
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@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);
/**
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);
//@}
/**
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
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();
//@{
/**
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);
//@}
};
+