added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-08 13:52:38 +00:00
parent 5d713a7574
commit 23324ae1c7
272 changed files with 92200 additions and 9 deletions
--- a/interface/hash.h
+++ b/interface/hash.h
@@ -0,0 +1,107 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        hash.h
+// Purpose:     documentation for wxHashTable class
+// 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
+*/
+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.
+    */
+    wxHashTable(unsigned int key_type, int size = 1000);
+
+    /**
+        Destroys the hash table.
+    */
+    ~wxHashTable();
+
+    /**
+        The counterpart of @e Next.  If the application wishes to iterate
+        through all the data in the hash table, it can call @e BeginFind and
+        then loop on @e Next.
+    */
+    void BeginFind();
+
+    /**
+        Clears the hash table of all nodes (but as usual, doesn't delete user data).
+    */
+    void Clear();
+
+    //@{
+    /**
+        Deletes entry in hash table and returns the user's data (if found).
+    */
+    wxObject * Delete(long key);
+        wxObject * Delete(const wxString& key);
+    //@}
+
+    /**
+        If set to @true data stored in hash table will be deleted when hash table object
+        is destroyed.
+    */
+    void DeleteContents(bool flag);
+
+    //@{
+    /**
+        Gets data from the hash table, using an integer or string key (depending on
+        which
+        has table constructor was used).
+    */
+    wxObject * Get(long key);
+        wxObject * Get(const char* key);
+    //@}
+
+    /**
+        Returns the number of elements in the hash table.
+    */
+    size_t GetCount();
+
+    /**
+        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).
+    */
+    long MakeKey(const wxString& string);
+
+    /**
+        If the application wishes to iterate through all the data in the hash
+        table, it can call @e BeginFind and then loop on @e Next. This function
+        returns a @b Node() pointer (or @NULL if there are no more nodes).
+        The return value is functionally equivalent to @b wxNode but might not be
+        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();
+
+    //@{
+    /**
+        Inserts data into the hash table, using an integer or string key (depending on
+        which
+        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);
+    //@}
+};