X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/658974ae667919850d1718af60591b40cb7a5954..3aa5d53272727835f297450e153ed79dc132e48a:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index a068e11d44..aa5589fcac 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -145,8 +145,8 @@ initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to get the hotspot for loaded cursor file: \begin{verbatim} - int hotspot_x = image.GetOptionInt(wxCUR_HOTSPOT_X); - int hotspot_y = image.GetOptionInt(wxCUR_HOTSPOT_Y); + int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X); + int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y); \end{verbatim} @@ -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} @@ -555,8 +581,8 @@ Depending on how wxWindows has been configured, not all formats may be available Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to get the hotspot for loaded cursor file: \begin{verbatim} - int hotspot_x = image.GetOptionInt(wxCUR_HOTSPOT_X); - int hotspot_y = image.GetOptionInt(wxCUR_HOTSPOT_Y); + int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X); + int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y); \end{verbatim} @@ -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. @@ -658,8 +684,8 @@ Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to set the hotspot before saving an image into a cursor file (default hotspot is in the centre of the image): \begin{verbatim} - image.SetOption(wxCUR_HOTSPOT_X, hotspotX); - image.SetOption(wxCUR_HOTSPOT_Y, hotspotY); + image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotspotX); + image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotspotY); \end{verbatim}