From: Václav Slavík <vslavik@fastmail.fm>
Date: Fri, 8 Feb 2002 00:16:44 +0000 (+0000)
Subject: changed wxImage::ComputeHistogram to use wxHashMap
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/d7af2feac42c8b27a0823131dc2f4004c2472279

changed wxImage::ComputeHistogram to use wxHashMap


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@14061 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/changes.txt b/docs/changes.txt
index a25333f67f..bd2c9656df 100644
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -46,6 +46,9 @@ All (GUI):
 - wxGridCellAttrProvider class API changed, you will need to update your code
   if you derived any classes from it
 
+- wxImage::ComputeHistogram()'s signature changed to 
+  unsigned long ComputeHistogram(wxImageHistogram&) const
+
 wxMSW:
 
 - build system changed: setup.h is not a static file in include/wx any more
@@ -81,6 +84,8 @@ wxBase:
   (if possible) and, especially, not to leak the file descriptors under Unix
 - memory leak in wxHTTP fixed (Dimitri)
 - fixes to AM_PATH_WXCONFIG autoconf macro
+- added wxHashMap class that replaces type-unsafe wxHashTable and is modelled
+  after STL hash_map
 
 Unix (Base/GUI):
 
@@ -89,6 +94,8 @@ Unix (Base/GUI):
 
 All (GUI):
 
+- wxImage::ComputeHistogram() now uses wxImageHistogram instead of type-unsafe
+  wxHashTable
 - significantly improved native font support
 - added IFF image handler
 - fixed using custom renderers in wxGrid which was broken in 2.3.2
diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index a068e11d44..cb487fc78e 100644
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -205,6 +205,32 @@ Deletes all image handlers.
 
 This function is called by wxWindows on exit.
 
+\membersection{wxImage::ComputeHistogram}\label{wximagecomputehistogram}
+
+\constfunc{unsigned long}{ComputeHistogram}{\param{wxImageHistogram\& }{histogram}}
+
+Computes the histogram of the image. {\it histogram} is a reference to 
+wxImageHistogram object. wxImageHistogram is a specialization of 
+\helpref{wxHashMap}{wxhashmap} "template" and is defined as follows:
+
+\begin{verbatim}
+class WXDLLEXPORT wxImageHistogramEntry
+{
+public:
+    wxImageHistogramEntry() : index(0), value(0) {}
+    unsigned long index;
+    unsigned long value;
+};
+
+WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
+                             wxIntegerHash, wxIntegerEqual,
+                             wxImageHistogram);
+\end{verbatim}
+
+\wxheading{Return value}
+
+Returns number of colours in the histogram.
+
 \membersection{wxImage::ConvertToBitmap}\label{wximageconverttobitmap}
 
 \constfunc{wxBitmap}{ConvertToBitmap}{\void}
@@ -611,15 +637,15 @@ TRUE if the handler was found and removed, FALSE otherwise.
 
 \membersection{wxImage::SaveFile}\label{wximagesavefile}
 
-\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}}
+\constfunc{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}}
 
-\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
+\constfunc{bool}{SaveFile}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
 
 Saves a image in the named file.
 
-\func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}}
+\constfunc{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}}
 
-\func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
+\constfunc{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
 
 Saves a image in the given stream.