ifdef'ed out GetBoundingRect for wxGTK

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index bd0617ef9832c1be8fbde0b121115149a97ab334..fb4e77ba28906921711d7c30a48be0b473b6a987 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -14,6 +14,10 @@ wxDC::DrawBitmap.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/image.h>
+

 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}


@@ -42,10 +46,14 @@ Creates an image with the given width and height.
 
 \func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}}
 
 
 \func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}}
 

+\func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
+

 Loads an image from a file.
 
 \func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}}
 
 Loads an image from a file.
 
 \func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}}
 

+\func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
+

 Loads an image from an input stream.
 
 \wxheading{Parameters}
 Loads an image from an input stream.
 
 \wxheading{Parameters}


@@ -72,10 +80,29 @@ If all possible wxWindows settings are used, the loading a BMP (Windows bitmap)
 a PNG (portable network graphics) file and a JPEG file is supported on all platforms that
 implement wxImage.}
 
 a PNG (portable network graphics) file and a JPEG file is supported on all platforms that
 implement wxImage.}
 

+\docparam{mimetype}{MIME type string (for example 'image/jpeg')}
+
+Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application
+initialization in order to work with JPEGs.
+

 \wxheading{See also}
 
 \helpref{wxImage::LoadFile}{wximageloadfile}
 
 \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}
 \membersection{wxImage::\destruct{wxImage}}
 
 \func{}{\destruct{wxImage}}{\void}


@@ -95,6 +122,7 @@ of a given handler class in an application session.}
 
 \helpref{wxImageHandler}{wximagehandler}
 
 
 \helpref{wxImageHandler}{wximagehandler}
 

+\pythonnote{In wxPython this static method is named \tt{wxImage_AddHandler}.}

 \membersection{wxImage::CleanUpHandlers}
 
 \func{static void}{CleanUpHandlers}{\void}
 \membersection{wxImage::CleanUpHandlers}
 
 \func{static void}{CleanUpHandlers}{\void}


@@ -150,12 +178,18 @@ Finds the handler associated with the given extension and type.
 
 Finds the handler associated with the given image type.
 
 
 Finds the handler associated with the given image type.
 

+\func{static wxImageHandler*}{FindHandlerMime}{\param{const wxString\& }{mimetype}}
+
+Finds the handler associated with the given MIME type.
+

 \docparam{name}{The handler name.}
 
 \docparam{extension}{The file extension, such as ``bmp".}
 
 \docparam{imageType}{The image type, such as wxBITMAP\_TYPE\_BMP.}
 
 \docparam{name}{The handler name.}
 
 \docparam{extension}{The file extension, such as ``bmp".}
 
 \docparam{imageType}{The image type, such as wxBITMAP\_TYPE\_BMP.}
 

+\docparam{mimetype}{MIME type.}
+

 \wxheading{Return value}
 
 A pointer to the handler if found, NULL otherwise.
 \wxheading{Return value}
 
 A pointer to the handler if found, NULL otherwise.


@@ -271,10 +305,14 @@ of a given handler class in an application session.}
 
 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
 
 
 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
 

+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const wxString\&}{ mimetype}}
+

 Loads an image from a file.
 
 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}}
 
 Loads an image from a file.
 
 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}}
 

+\func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ mimetype}}
+

 Loads an image from an input stream.
 
 \wxheading{Parameters}
 Loads an image from an input stream.
 
 \wxheading{Parameters}


@@ -296,6 +334,8 @@ The meaning of {\it stream} data is determined by the {\it type} parameter.}
 
 The validity of these flags depends on the platform and wxWindows configuration.}
 
 
 The validity of these flags depends on the platform and wxWindows configuration.}
 

+\docparam{mimetype}{MIME type string (for example 'image/jpeg')}
+

 \wxheading{Return value}
 
 TRUE if the operation succeeded, FALSE otherwise.
 \wxheading{Return value}
 
 TRUE if the operation succeeded, FALSE otherwise.


@@ -304,6 +344,17 @@ TRUE if the operation succeeded, FALSE otherwise.
 
 \helpref{wxImage::SaveFile}{wximagesavefile}
 
 
 \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}
 \membersection{wxImage::Ok}\label{wximageok}
 
 \constfunc{bool}{Ok}{\void}


@@ -331,10 +382,14 @@ TRUE if the handler was found and removed, FALSE otherwise.
 
 \func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}}
 
 
 \func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}}
 

+\func{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}}
 
 Saves a image in the named file.
 
 \func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}}
 

+\func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
+

 Saves a image in the given stream.
 
 \wxheading{Parameters}
 Saves a image in the given stream.
 
 \wxheading{Parameters}


@@ -354,6 +409,8 @@ Saves a image in the given stream.
 The validity of these flags depends on the platform and wxWindows configuration
 as well as user-added handlers.}
 
 The validity of these flags depends on the platform and wxWindows configuration
 as well as user-added handlers.}
 

+\docparam{mimetype}{MIME type.}
+

 \wxheading{Return value}
 
 TRUE if the operation succeeded, FALSE otherwise.
 \wxheading{Return value}
 
 TRUE if the operation succeeded, FALSE otherwise.


@@ -366,21 +423,73 @@ Depending on how wxWindows has been configured, not all formats may be available
 
 \helpref{wxImage::LoadFile}{wximageloadfile}
 
 
 \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, the
+image will have the given width and height.
+
+\wxheading{See also}
+
+\helpref{Scale}{wximagescale}
+

 \membersection{wxImage::Scale}\label{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
 
 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::GetSubImage}\label{wximagegetsubimage}
+
+\constfunc{wxImage}{GetSubImage}{\param{const wxRect&}{rect}}
+
+Returns a sub image of the current one as long as the rect belongs entirely to 
+the image.

 
 \membersection{wxImage::SetData}\label{wximagesetdata}
 
 \func{void}{SetData}{\param{unsigned char*}{data}}
 
 
 \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.
 
 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.
 


@@ -462,8 +571,7 @@ application initialisation.
 
 \wxheading{Note (Legal Issue)}
 
 
 \wxheading{Note (Legal Issue)}
 

-This software is based in part on the work of
- the Independent JPEG Group.
+This software is based in part on the work of the Independent JPEG Group.

 
 (Applies when wxWindows is linked with JPEG support. wxJPEGHandler uses libjpeg
 created by IJG.)
 
 (Applies when wxWindows is linked with JPEG support. wxJPEGHandler uses libjpeg
 created by IJG.)


@@ -472,6 +580,10 @@ created by IJG.)
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/image.h>
+

 \wxheading{See also}
 
 \helpref{wxImage}{wximage}
 \wxheading{See also}
 
 \helpref{wxImage}{wximage}


@@ -509,6 +621,12 @@ Gets the file extension associated with this handler.
 
 Gets the image type associated with this handler.
 
 
 Gets the image type associated with this handler.
 

+\membersection{wxImageHandler::GetMimeType}
+
+\constfunc{wxString}{GetMimeType}{\void}
+
+Gets the MIME type associated with this handler.
+

 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 
 \func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}}
 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 
 \func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}}


@@ -584,3 +702,14 @@ Sets the handler type.
 
 \docparam{name}{Handler type.}
 
 
 \docparam{name}{Handler type.}
 

+
+\membersection{wxImageHandler::SetMimeType}
+
+\func{void}{SetMimeType}{\param{const wxString\& }{mimetype}}
+
+Sets the handler MIME type.
+
+\wxheading{Parameters}
+
+\docparam{mimename}{Handler MIME type.}
+