Added regex to WXINC line (patch from Markus G)

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 136d07a3d56dbaad9e3f69e99b3ba2075555faf8..a2986cbf952d06203282ee0913a40794cd4dbbfe 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -1,14 +1,15 @@
 \section{\class{wxImage}}\label{wximage}
 
 This class encapsulates a platform-independent image. An image can be created
 \section{\class{wxImage}}\label{wximage}
 
 This class encapsulates a platform-independent image. An image can be created

-from data, or using the constructor taking a wxBitmap object. An image
+from data, or using \helpref{wxBitmap::ConvertToImage}{wxbitmapconverttoimage}. An image

 can be loaded from a file in a variety of formats, and is extensible to new formats
 via image format handlers. Functions are available to set and get image bits, so
 it can be used for basic image manipulation.
 
 A wxImage cannot (currently) be drawn directly to a \helpref{wxDC}{wxdc}. Instead, 
 a platform-specific \helpref{wxBitmap}{wxbitmap} object must be created from it using
 can be loaded from a file in a variety of formats, and is extensible to new formats
 via image format handlers. Functions are available to set and get image bits, so
 it can be used for basic image manipulation.
 
 A wxImage cannot (currently) be drawn directly to a \helpref{wxDC}{wxdc}. Instead, 
 a platform-specific \helpref{wxBitmap}{wxbitmap} object must be created from it using

-the \helpref{ConvertToBitmap}{wximageconverttobitmap} function. This bitmap can then
+the \helpref{wxBitmap::wxBitmap(wxImage,int depth)}{wxbitmapconstr} constructor. 
+This bitmap can then

 be drawn in a device context, using \helpref{wxDC::DrawBitmap}{wxdcdrawbitmap}.
 
 One colour value of the image may be used as a mask colour which will lead to the automatic
 be drawn in a device context, using \helpref{wxDC::DrawBitmap}{wxdcdrawbitmap}.
 
 One colour value of the image may be used as a mask colour which will lead to the automatic


@@ -23,13 +24,14 @@ handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
 
 \twocolwidtha{5cm}%
 \begin{twocollist}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}

-\twocolitem{{\bf \indexit{wxBMPHandler}}}{Only for loading, always installed.}
-\twocolitem{{\bf \indexit{wxPNGHandler}}}{For loading and saving.}
-\twocolitem{{\bf \indexit{wxJPEGHandler}}}{For loading and saving.}
-\twocolitem{{\bf \indexit{wxGIFHandler}}}{Only for loading, due to legal issues.}
-\twocolitem{{\bf \indexit{wxPCXHandler}}}{For loading and saving (see below).}
-\twocolitem{{\bf \indexit{wxPNMHandler}}}{For loading and saving (see below).}
-\twocolitem{{\bf \indexit{wxTIFFHandler}}}{For loading and saving.}
+\twocolitem{\indexit{wxBMPHandler}}{Only for loading, always installed.}
+\twocolitem{\indexit{wxPNGHandler}}{For loading and saving.}
+\twocolitem{\indexit{wxJPEGHandler}}{For loading and saving.}
+\twocolitem{\indexit{wxGIFHandler}}{Only for loading, due to legal issues.}
+\twocolitem{\indexit{wxPCXHandler}}{For loading and saving (see below).}
+\twocolitem{\indexit{wxPNMHandler}}{For loading and saving (see below).}
+\twocolitem{\indexit{wxTIFFHandler}}{For loading and saving.}
+\twocolitem{\indexit{wxXPMHandler}}{For loading and saving.}

 \end{twocollist}
 
 When saving in PCX format, {\bf wxPCXHandler} will count the number of
 \end{twocollist}
 
 When saving in PCX format, {\bf wxPCXHandler} will count the number of


@@ -66,7 +68,8 @@ Copy constructor.
 
 \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}}
 
 
 \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}}
 

-Constructs an image from a platform-dependent bitmap. This preserves
+(Deprecated form, use \helpref{wxBitmap::ConvertToImage}{wxbitmapconverttoimage}
+instead.) Constructs an image from a platform-dependent bitmap. This preserves

 mask information so that bitmaps and images can be converted back
 and forth without loss in that respect.
 
 mask information so that bitmaps and images can be converted back
 and forth without loss in that respect.
 


@@ -74,6 +77,13 @@ and forth without loss in that respect.
 
 Creates an image with the given width and height.
 
 
 Creates an image with the given width and height.
 

+\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=FALSE}}
+
+Creates an image from given data with the given width and height. If 
+{\it static\_data} is TRUE, then wxImage will not delete the actual
+image data in its destructor, otherwise it will free it by calling
+{\it free()}.
+

 \func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}
 
 \func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
 \func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}
 
 \func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}


@@ -100,14 +110,15 @@ Loads an image from an input stream.
 
 \twocolwidtha{5cm}%
 \begin{twocollist}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}

-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_JPEG}}}{Load a JPEG bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNG}}}{Load a PNG bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PCX}}}{Load a PCX bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNM}}}{Load a PNM bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_TIF}}}{Load a TIFF bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_ANY}}}{Will try to autodetect the format.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_JPEG}}{Load a JPEG bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_PNG}}{Load a PNG bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_PCX}}{Load a PCX bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_PNM}}{Load a PNM bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_TIF}}{Load a TIFF bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load a XPM bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.}

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


@@ -138,6 +149,15 @@ platform-dependent bitmap}
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\perlnote{Constructors supported by wxPerl are:\par
+\begin{itemize}
+\item{Wx::Image->new( bitmap )}
+\item{Wx::Image->new( width, height )}
+\item{Wx::Image->new( name, type )}
+\item{Wx::Image->new( name, mimetype )}
+\end{itemize}
+}
+

 \membersection{wxImage::\destruct{wxImage}}
 
 \func{}{\destruct{wxImage}}{\void}
 \membersection{wxImage::\destruct{wxImage}}
 
 \func{}{\destruct{wxImage}}{\void}


@@ -157,7 +177,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}.}
+\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}


@@ -170,15 +190,22 @@ This function is called by wxWindows on exit.
 
 \constfunc{wxBitmap}{ConvertToBitmap}{\void}
 
 
 \constfunc{wxBitmap}{ConvertToBitmap}{\void}
 

-Converts the image to a platform-specific bitmap object. This has to be done
-to actually display an image as you cannot draw an image directly on a window.
-The resulting bitmap will use the colour depth of the current system which entails
-that a colour reduction has to take place. 
+Deprecated, use equivalent \helpref{wxBitmap constructor}{wxbitmapconstr}
+(which takes wxImage and depth as its arguments) instead.
+
+\membersection{wxImage::ConvertToMono}\label{wxbitmapconverttomono}
+
+\constfunc{wxImage}{ConvertToMono}{\param{unsigned char}{ r}, \param{unsigned char}{ g}, \param{unsigned char}{ b}}
+
+Returns monochromatic version of the image. The returned image has white
+colour where the original has {\it (r,g,b)} colour and black colour 
+everywhere else.
+
+\membersection{wxImage::Copy}\label{wximagecopy}
+
+\constfunc{wxImage}{Copy}{\void}

 
 

-When in 8-bit mode (PseudoColour mode), the GTK port will use a color cube created 
-on program start-up to look up colors. This ensures a very fast conversion, but
-the image quality won't be perfect (and could be better for photo images using more
-sophisticated dithering algorithms).
+Returns an identical copy of the image.

 
 \membersection{wxImage::Create}\label{wximagecreate}
 
 
 \membersection{wxImage::Create}\label{wximagecreate}
 


@@ -296,6 +323,15 @@ Gets the green value of the mask colour.
 
 Gets the red value of the mask colour.
 
 
 Gets the red value of the mask colour.
 

+\membersection{wxImage::GetPalette}\label{wximagegetpalette}
+
+\constfunc{const wxPalette\&}{GetPalette}{\void}
+
+Returns the palette associated with the image. Currently the palette is only
+used when converting to wxBitmap under Windows.
+
+Eventually wxImage handlers will set the palette if one exists in the image file.
+

 \membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
 
 \constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{ rect}}
 \membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
 
 \constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{ rect}}


@@ -319,6 +355,45 @@ Gets the width of the image in pixels.
 
 Returns TRUE if there is a mask active, FALSE otherwise.
 
 
 Returns TRUE if there is a mask active, FALSE otherwise.
 

+\membersection{wxImage::GetOption}\label{wximagegetoption}
+
+\constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
+
+Gets a user-defined option. The function is case-insensitive to {\it name}.
+
+For example, when saving as a JPEG file, the option {\bf quality} is
+used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
+
+\wxheading{See also}
+
+\helpref{wxImage::SetOption}{wximagesetoption},\rtfsp
+\helpref{wxImage::GetOptionInt}{wximagegetoptionint},\rtfsp
+\helpref{wxImage::HasOption}{wximagehasoption}
+
+\membersection{wxImage::GetOptionInt}\label{wximagegetoptionint}
+
+\constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
+
+Gets a user-defined option as an integer. The function is case-insensitive to {\it name}.
+
+\wxheading{See also}
+
+\helpref{wxImage::SetOption}{wximagesetoption},\rtfsp
+\helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
+\helpref{wxImage::HasOption}{wximagehasoption}
+
+\membersection{wxImage::HasOption}\label{wximagehasoption}
+
+\constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
+
+Returns TRUE if the given option is present. The function is case-insensitive to {\it name}.
+
+\wxheading{See also}
+
+\helpref{wxImage::SetOption}{wximagesetoption},\rtfsp
+\helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
+\helpref{wxImage::GetOptionInt}{wximagegetoptionint}
+

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


@@ -379,6 +454,7 @@ Loads an image from an input stream.
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Load a PNM image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Load a TIFF image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Load a PNM image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Load a TIFF image file.}

+\twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Load a XPM image file.}

 \twocolitem{{\bf wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.}
 \end{twocollist}}
 
 \twocolitem{{\bf wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.}
 \end{twocollist}}
 


@@ -406,6 +482,13 @@ mimetype from a file}
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\perlnote{Methods supported by wxPerl are:\par
+\begin{itemize}
+\item{bitmap->LoadFile( name, type )}
+\item{bitmap->LoadFile( name, mimetype )}
+\end{itemize}
+}
+

 
 \membersection{wxImage::Ok}\label{wximageok}
 
 
 \membersection{wxImage::Ok}\label{wximageok}
 


@@ -458,7 +541,8 @@ Saves a image in the given stream.
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise).}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Save a PNM image file (as raw RGB always).}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise).}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Save a PNM image file (as raw RGB always).}

-\twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Save a TIFF image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_TIFF}}{Save a TIFF image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save a XPM image file.}

 \end{twocollist}}
 
 \docparam{mimetype}{MIME type.}
 \end{twocollist}}
 
 \docparam{mimetype}{MIME type.}


@@ -485,6 +569,20 @@ mimetype to the named file}
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\perlnote{Methods supported by wxPerl are:\par
+\begin{itemize}
+\item{bitmap->SaveFile( name, type )}
+\item{bitmap->SaveFile( name, mimetype )}
+\end{itemize}
+}
+
+\membersection{wxImage::Mirror}\label{wximagemirror}
+
+\constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = TRUE}}
+
+Returns a mirrored copy of the image. The parameter {\it horizontally}
+indicates the orientation.
+

 \membersection{wxImage::Replace}\label{wximagereplace}
 
 \func{void}{Replace}{\param{unsigned char}{ r1}, \param{unsigned char}{ g1}, \param{unsigned char}{ b1},
 \membersection{wxImage::Replace}\label{wximagereplace}
 
 \func{void}{Replace}{\param{unsigned char}{ r1}, \param{unsigned char}{ g1}, \param{unsigned char}{ b1},


@@ -517,6 +615,13 @@ rotated image background. Else, black (rgb 0, 0, 0) will be used.
 
 Returns the rotated image, leaving this image intact.
 
 
 Returns the rotated image, leaving this image intact.
 

+\membersection{wxImage::Rotate90}\label{wximagerotate90}
+
+\constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = TRUE}}
+
+Returns a copy of the image rotated 90 degrees in the direction
+indicated by {\it clockwise}.
+

 \membersection{wxImage::Scale}\label{wximagescale}
 
 \constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
 \membersection{wxImage::Scale}\label{wximagescale}
 
 \constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}


@@ -526,7 +631,7 @@ scaling bitmaps in general as the only other way to scale bitmaps
 is to blit a wxMemoryDC into another wxMemoryDC.
 
 It may be mentioned that the GTK port uses this function internally
 is to blit a wxMemoryDC into another wxMemoryDC.
 
 It may be mentioned that the GTK port uses this function internally

-to scale bitmaps when using mapping mode in wxDC. 
+to scale bitmaps when using mapping modes in wxDC. 

 
 Example:
 
 
 Example:
 


@@ -538,7 +643,7 @@ Example:
     if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
     {
         wxImage image(bmp);
     if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
     {
         wxImage image(bmp);

-        bmp = image.Scale(32, 32).ConvertToBitmap();
+        bmp = wxBitmap(image.Scale(32, 32));

 
         // another possibility:
         image.Rescale(32, 32);
 
         // another possibility:
         image.Rescale(32, 32);


@@ -571,9 +676,33 @@ Specifies whether there is a mask or not. The area of the mask is determined by
 
 Sets the mask colour for this image (and tells the image to use the mask).
 
 
 Sets the mask colour for this image (and tells the image to use the mask).
 

+\membersection{wxImage::SetOption}\label{wximagesetoption}
+
+\func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
+
+\func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
+
+Sets a user-defined option. The function is case-insensitive to {\it name}.
+
+For example, when saving as a JPEG file, the option {\bf quality} is
+used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
+
+\wxheading{See also}
+
+\helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
+\helpref{wxImage::GetOptionInt}{wximagegetoptionint},\rtfsp
+\helpref{wxImage::HasOption}{wximagehasoption}
+
+\membersection{wxImage::SetPalette}\label{wximagesetpalette}
+
+\func{void}{SetPalette}{\param{const wxPalette\&}{ palette}}
+
+Associates a palette with the image. The palette may be used when converting
+wxImage to wxBitmap (MSW only at present) or in file save operations (none as yet).
+

 \membersection{wxImage::SetRGB}\label{wximagesetrgb}
 
 \membersection{wxImage::SetRGB}\label{wximagesetrgb}
 

-\func{void}{SetRGB}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{red}, \param{unsigned char }{blue}, \param{unsigned char }{green}}
+\func{void}{SetRGB}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{red}, \param{unsigned char }{green}, \param{unsigned char }{blue}}

 
 Sets the pixel at the given coordinate. This routine performs bounds-checks
 for the coordinate so it can be considered a safe way to manipulate the
 
 Sets the pixel at the given coordinate. This routine performs bounds-checks
 for the coordinate so it can be considered a safe way to manipulate the


@@ -779,24 +908,23 @@ Sets the handler extension.
 
 \docparam{extension}{Handler extension.}
 
 
 \docparam{extension}{Handler extension.}
 

-\membersection{wxImageHandler::SetType}
+\membersection{wxImageHandler::SetMimeType}\label{wximagehandlersetmimetype}

 
 

-\func{void}{SetType}{\param{long }{type}}
+\func{void}{SetMimeType}{\param{const wxString\& }{mimetype}}

 
 

-Sets the handler type.
+Sets the handler MIME type.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{name}{Handler type.}
-
+\docparam{mimename}{Handler MIME type.}

 
 

-\membersection{wxImageHandler::SetMimeType}
+\membersection{wxImageHandler::SetType}

 
 

-\func{void}{SetMimeType}{\param{const wxString\& }{mimetype}}
+\func{void}{SetType}{\param{long }{type}}

 
 

-Sets the handler MIME type.
+Sets the handler type.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{mimename}{Handler MIME type.}
+\docparam{name}{Handler type.}