X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..d7af2feac42c8b27a0823131dc2f4004c2472279:/docs/latex/wx/hash.tex diff --git a/docs/latex/wx/hash.tex b/docs/latex/wx/hash.tex index 5cb1232974..3609e1c5f5 100644 --- a/docs/latex/wx/hash.tex +++ b/docs/latex/wx/hash.tex @@ -1,5 +1,8 @@ \section{\class{wxHashTable}}\label{wxhashtable} +{\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 wxWindows, and for an application if it wishes. Data can be hashed on an integer or string key. @@ -8,6 +11,10 @@ key. \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Example} Below is an example of using a hash table. @@ -79,11 +86,19 @@ 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} + +\func{void}{DeleteContents}{\param{bool}{ flag}} + +If set to TRUE data stored in hash table will be deleted when hash table object +is destroyed. + + \membersection{wxHashTable::Get} \func{wxObject *}{Get}{\param{long}{ key}} -\func{wxObject *}{Get}{\param{const wxString\& }{ key}} +\func{wxObject *}{Get}{\param{const char*}{ key}} Gets data from the hash table, using an integer or string key (depending on which has table constructor was used). @@ -109,10 +124,15 @@ description for \helpref{wxNode}{wxnode}. The user will probably only wish to us \func{void}{Put}{\param{long}{ key}, \param{wxObject *}{object}} -\func{void}{Put}{\param{const wxString\& }{ key}, \param{wxObject *}{object}} +\func{void}{Put}{\param{const char*}{ key}, \param{wxObject *}{object}} 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. +\membersection{wxHashTable::GetCount} + +\constfunc{size\_t}{GetCount}{\void} + +Returns the number of elements in the hash table.