Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).

[wxWidgets.git] / docs / latex / wx / hashmap.tex

diff --git a/docs/latex/wx/hashmap.tex b/docs/latex/wx/hashmap.tex
index c499284ea24ca93e1c604a0a4ad95478ff554a08..ebb9c60e6a3c55b0593afdb78f946271ecab99a5 100644 (file)
--- a/docs/latex/wx/hashmap.tex
+++ b/docs/latex/wx/hashmap.tex
@@ -2,8 +2,8 @@
 
 This is a simple, type-safe, and reasonably efficient hash map class,
 whose interface is a subset of the interface of STL containers. In
-particular, the interface is modelled after std::map, and the various,
-non standard, std::hash\_map.
+particular, the interface is modeled after std::map, and the various,
+non-standard, std::hash\_map.
 
 \wxheading{Example}
 
@@ -48,7 +48,7 @@ non standard, std::hash\_map.
                                 CLASSNAME ); // name of the class
 \end{verbatim}
 
-Declares an hash map class named CLASSNAME, with {\tt wxString} keys
+Declares a hash map class named CLASSNAME, with {\tt wxString} keys
 and VALUE\_T values.
 
 \begin{verbatim}
@@ -56,7 +56,7 @@ and VALUE\_T values.
                                  CLASSNAME ); // name of the class
 \end{verbatim}
 
-Declares an hash map class named CLASSNAME, with {\tt void*} keys
+Declares a hash map class named CLASSNAME, with {\tt void*} keys
 and VALUE\_T values.
 
 \begin{verbatim}
@@ -77,7 +77,7 @@ and their unsigned counterparts ), {\tt wxStringHash} for strings
 Similarly three equality predicates:
 {\tt wxIntegerEqual}, {\tt wxStringEqual}, {\tt wxPointerEqual} are provided.
 
-Using this you could declare an hash map mapping {\tt int} values
+Using this you could declare a hash map mapping {\tt int} values
 to {\tt wxString} like this:
 
 \begin{verbatim}
@@ -130,11 +130,13 @@ you used in the class declaration.
 \twocolitem{wxHashMap::mapped\_type}{Type of the values stored in the hash map}
 \twocolitem{wxHashMap::value\_type}{Equivalent to
 {\tt struct \{ key\_type first; mapped\_type second \};} }
-\twocolitem{wxHashMap::iterator}{Used to enumerate all the elements in an hash
+\twocolitem{wxHashMap::iterator}{Used to enumerate all the elements in a hash
 map; it is similar to a {\tt value\_type*}}
 \twocolitem{wxHashMap::const\_iterator}{Used to enumerate all the elements
 in a constant hash map; it is similar to a {\tt const value\_type*}}
 \twocolitem{wxHashMap::size\_type}{Used for sizes}
+\twocolitem{wxHashMap::Insert\_Result}{The return value for
+\helpref{insert()}{wxhashmapinsert}}
 \end{twocollist}
 
 \wxheading{Iterators}
@@ -183,13 +185,13 @@ Removes all elements from the hash map.
 \constfunc{size\_type}{count}{\param{const key\_type\&}{ key}}
 
 Counts the number of elements with the given key present in the map.
-This function can actually return 0 or 1.
+This function returns only 0 or 1.
 
 \membersection{wxHashMap::empty}\label{wxhashmapempty}
 
 \constfunc{bool}{empty}{}
 
-Returns true if the hash map does not contain any element, false otherwise.
+Returns true if the hash map does not contain any elements, false otherwise.
 
 \membersection{wxHashMap::end}\label{wxhashmapend}
 
@@ -226,15 +228,18 @@ is returned (i.e. hashmap.find( non\_existent\_key ) == hashmap.end()).
 
 \membersection{wxHashMap::insert}\label{wxhashmapinsert}
 
-\func{void}{insert}{\param{const value\_type\&}{ v}}
+\func{Insert\_Result}{insert}{\param{const value\_type\&}{ v}}
 
-Inserts the given value in the hash map.
+Inserts the given value in the hash map. The return value is
+equivalent to a \texttt{std::pair<wxHashMap::iterator, bool>};
+the iterator points to the inserted element, the boolean value
+is \texttt{true} if \texttt{v} was actually inserted.
 
 \membersection{wxHashMap::operator[]}\label{wxhashmapbracket}
 
 \func{mapped\_type\&}{operator[]}{\param{const key\_type\&}{ key}}
 
-Use it as an array subscript. The only difference is that if the
+Use the key as an array subscript. The only difference is that if the
 given key is not present in the hash map, an element with the
 default {\tt value\_type()} is inserted in the table.