another makefile updated

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 8325f4be631f8de1e581c93901d436d2b7615a57..c99c8a9ecd937ec4ae331c680ebeee1921c9aff3 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -82,13 +82,27 @@ implement wxImage.}
 
 \docparam{mimetype}{MIME type string (for example 'image/jpeg')}
 
-Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application 
+Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application
 initialization in order to work with JPEGs.
 
 \wxheading{See also}
 
 \helpref{wxImage::LoadFile}{wximageloadfile}
 
+\pythonnote{Constructors supported by wxPython are:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{wxImage(name, flag)}}{Loads an image from a file}
+\twocolitem{\bf{wxNullImage()}}{Create a null image (has no size or
+image data)}
+\twocolitem{\bf{wxEmptyImage(width, height)}}{Creates an empty image
+of the given size}
+\twocolitem{\bf{wxImageFromMime(name, mimetype}}{Creates an image from
+the given file of the given mimetype}
+\twocolitem{\bf{wxImageFromBitmap(bitmap)}}{Creates an image from a
+platform-dependent bitmap}
+\end{twocollist}}
+}
+
 \membersection{wxImage::\destruct{wxImage}}
 
 \func{}{\destruct{wxImage}}{\void}
@@ -108,6 +122,7 @@ of a given handler class in an application session.}
 
 \helpref{wxImageHandler}{wximagehandler}
 
+\pythonnote{In wxPython this static method is named \tt{wxImage_AddHandler}.}
 \membersection{wxImage::CleanUpHandlers}
 
 \func{static void}{CleanUpHandlers}{\void}
@@ -329,6 +344,17 @@ TRUE if the operation succeeded, FALSE otherwise.
 
 \helpref{wxImage::SaveFile}{wximagesavefile}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{LoadFile(filename, type)}}{Loads an image of the given
+type from a file}
+\twocolitem{\bf{LoadMimeFile(filename, mimetype)}}{Loads an image of the given
+mimetype from a file}
+\end{twocollist}}
+}
+
+
 \membersection{wxImage::Ok}\label{wximageok}
 
 \constfunc{bool}{Ok}{\void}
@@ -397,21 +423,66 @@ Depending on how wxWindows has been configured, not all formats may be available
 
 \helpref{wxImage::LoadFile}{wximageloadfile}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SaveFile(filename, type)}}{Saves the image using the given
+type to the named file}
+\twocolitem{\bf{SaveMimeFile(filename, mimetype)}}{Saves the image using the given
+mimetype to the named file}
+\end{twocollist}}
+}
+
+\membersection{wxImage::Rescale}\label{wximagerescale}
+
+\func{wxImage}{Rescale}{\param{int}{ width}, \param{int}{ height}}
+
+Changes the size of the image in-place: after a call to this function, thei
+mage will have the given width and height.
+
+\wxheading{See also}
+
+\helpref{Scale}{wximagescale}
+
 \membersection{wxImage::Scale}\label{wximagescale}
 
-\func{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
+\constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
 
 Returns a scaled version of the image. This is also useful for
 scaling bitmaps in general as the only other way to scale bitmaps
-is to blit a wxMemoryDC into another wxMemoryDC. Windows can do such 
-scaling itself but in the GTK port, scaling bitmaps is done using 
-this routine internally.
+is to blit a wxMemoryDC into another wxMemoryDC.
+
+NB: although Windows can do such scaling itself but in the GTK port, scaling
+bitmaps is done using this routine internally.
+
+Example:
+
+\begin{verbatim}
+    // get the bitmap from somewhere
+    wxBitmap bmp = ...;
+
+    // rescale it to have size of 32*32
+    if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
+    {
+        wxImage image(bmp);
+        bmp = image.Scale(32, 32).ConvertToBitmap();
+
+        // another possibility:
+        image.Rescale(32, 32);
+        bmp = image;
+    }
+
+\end{verbatim}
+
+\wxheading{See also}
+
+\helpref{Rescale}{wximagerescale}
 
 \membersection{wxImage::SetData}\label{wximagesetdata}
 
 \func{void}{SetData}{\param{unsigned char*}{data}}
 
-Sets the image data without performing checks. The data given must have 
+Sets the image data without performing checks. The data given must have
 the size (width*height*3) or results will be unexpected. Don't use this
 method if you aren't sure you know what you are doing.