added wxGetPasswordFromUser(), dialogs sample shows it, documented it

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index fb4e77ba28906921711d7c30a48be0b473b6a987..6199e3ec2d4041b4de53710360853559334583ed 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -6,9 +6,37 @@ can be loaded from a file in a variety of formats, and is extensible to new form
 via image format handlers. Functions are available to set and get image bits, so
 it can be used for basic image manipulation.
 
 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 wxDC. Instead, a platform-specific
-wxBitmap object must be created from it, and that bitmap drawn on the wxDC, using
-wxDC::DrawBitmap.
+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
+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
+creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object.
+
+\wxheading{Available image handlers}
+
+The following image handlers are available. {\bf wxBMPHandler} is always
+installed by default. To use other image formats, install the appropiate
+handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
+
+\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).}
+\end{twocollist}
+
+When saving in PCX format, {\bf wxPCXHandler} will count the number of
+different colours in the image; if there are 256 or less colours, it will
+save as 8 bit, else it will save as 24 bit.
+
+Loading PNMs only works for ASCII or raw RGB images. When saving in
+PNM format, {\bf wxPNMHandler} will always save as raw RGB.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -21,6 +49,7 @@ wxDC::DrawBitmap.
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}

+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -44,13 +73,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{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}}
+\func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}

 
 \func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
 
 Loads an image from a file.
 
 
 \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}}
+\func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}

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


@@ -73,6 +102,10 @@ Loads an image from an input stream.
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.}
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNG}}}{Load a PNG bitmap file.}
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_JPEG}}}{Load a JPEG bitmap file.}
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.}
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNG}}}{Load a PNG bitmap file.}
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_JPEG}}}{Load a JPEG bitmap file.}

+\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF 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\_ANY}}}{Will try to autodetect the format.}

 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration.
 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration.


@@ -91,14 +124,14 @@ initialization in order to work with JPEGs.
 
 \pythonnote{Constructors supported by wxPython are:\par
 \indented{2cm}{\begin{twocollist}
 
 \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
+\twocolitem{{\bf wxImage(name, flag)}}{Loads an image from a file}
+\twocolitem{{\bf wxNullImage()}}{Create a null image (has no size or

 image data)}
 image data)}

-\twocolitem{\bf{wxEmptyImage(width, height)}}{Creates an empty image
+\twocolitem{{\bf wxEmptyImage(width, height)}}{Creates an empty image

 of the given size}
 of the given size}

-\twocolitem{\bf{wxImageFromMime(name, mimetype}}{Creates an image from
+\twocolitem{{\bf wxImageFromMime(name, mimetype}}{Creates an image from

 the given file of the given mimetype}
 the given file of the given mimetype}

-\twocolitem{\bf{wxImageFromBitmap(bitmap)}}{Creates an image from a
+\twocolitem{{\bf wxImageFromBitmap(bitmap)}}{Creates an image from a

 platform-dependent bitmap}
 \end{twocollist}}
 }
 platform-dependent bitmap}
 \end{twocollist}}
 }


@@ -122,7 +155,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}


@@ -138,9 +171,12 @@ This function is called by wxWindows on exit.
 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
 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 (crude) colour reduction has to take place. When in 8-bit mode, this
-routine will use a color cube created on program start-up to look up colors.
-Still, the image quality won't be perfect for photo images.
+that a colour reduction has to take place. 
+
+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).

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


@@ -258,6 +294,13 @@ 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::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::GetWidth}\label{wximagegetwidth}
 
 \constfunc{int}{GetWidth}{\void}
 \membersection{wxImage::GetWidth}\label{wximagegetwidth}
 
 \constfunc{int}{GetWidth}{\void}


@@ -278,15 +321,16 @@ Returns TRUE if there is a mask active, FALSE otherwise.
 
 \func{static void}{InitStandardHandlers}{\void}
 
 
 \func{static void}{InitStandardHandlers}{\void}
 

-Adds the standard image format handlers, which, depending on wxWindows
-configuration, can be handlers for Windows BMP (loading), PNG
-(loading and saving) and JPEG (loading and saving) file formats.
+Internal use only. Adds standard image format handlers. It only install BMP
+for the time being, which is use by wxBitmap.

 
 

-This function is called by wxWindows on startup.
+This function is called by wxWindows on startup, and shouldn't be called by
+the user.

 
 \wxheading{See also}
 
 \helpref{wxImageHandler}{wximagehandler}
 
 \wxheading{See also}
 
 \helpref{wxImageHandler}{wximagehandler}

+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}

 
 \membersection{wxImage::InsertHandler}
 
 
 \membersection{wxImage::InsertHandler}
 


@@ -303,11 +347,12 @@ of a given handler class in an application session.}
 
 \membersection{wxImage::LoadFile}\label{wximageloadfile}
 
 
 \membersection{wxImage::LoadFile}\label{wximageloadfile}
 

-\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}

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

-Loads an image from a file.
+Loads an image from a file. If no handler type is provided, the library will
+try to use wxBITMAP\_TYPE\_BMP.

 
 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}}
 
 
 \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}}
 


@@ -328,8 +373,12 @@ The meaning of {\it stream} data is determined by the {\it type} parameter.}
 \twocolwidtha{5cm}%
 \begin{twocollist}
 \twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Load a Windows image file.}
 \twocolwidtha{5cm}%
 \begin{twocollist}
 \twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Load a Windows image file.}

-\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Load a GIF image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Load a TIFF image file.}

 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Load a JPEG image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Load a JPEG image file.}

+\twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Load a PCX image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Load a PNM image file.}

 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration.}
 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration.}


@@ -347,9 +396,9 @@ TRUE if the operation succeeded, FALSE otherwise.
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \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
+\twocolitem{{\bf LoadFile(filename, type)}}{Loads an image of the given

 type from a file}
 type from a file}

-\twocolitem{\bf{LoadMimeFile(filename, mimetype)}}{Loads an image of the given
+\twocolitem{{\bf LoadMimeFile(filename, mimetype)}}{Loads an image of the given

 mimetype from a file}
 \end{twocollist}}
 }
 mimetype from a file}
 \end{twocollist}}
 }


@@ -398,12 +447,13 @@ Saves a image in the given stream.
 
 \docparam{stream}{An output stream. The meaning of {\it stream} is determined by the {\it type} parameter.}
 
 
 \docparam{stream}{An output stream. The meaning of {\it stream} is determined by the {\it type} parameter.}
 

-\docparam{type}{Currently two types can be used:
+\docparam{type}{Currently three types can be used:

 
 \twocolwidtha{5cm}%
 \begin{twocollist}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Save a JPEG image file.}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Save a JPEG image file.}

+\twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Save a PCX image file.}

 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration
 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration


@@ -426,20 +476,29 @@ Depending on how wxWindows has been configured, not all formats may be available
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \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
+\twocolitem{{\bf SaveFile(filename, type)}}{Saves the image using the given

 type to the named file}
 type to the named file}

-\twocolitem{\bf{SaveMimeFile(filename, mimetype)}}{Saves the image using the given
+\twocolitem{{\bf SaveMimeFile(filename, mimetype)}}{Saves the image using the given

 mimetype to the named file}
 \end{twocollist}}
 }
 
 mimetype to the named file}
 \end{twocollist}}
 }
 

+\membersection{wxImage::Replace}\label{wximagereplace}
+
+\func{void}{Replace}{\param{unsigned char}{ r1}, \param{unsigned char}{ g1}, \param{unsigned char}{ b1},
+\param{unsigned char}{ r2}, \param{unsigned char}{ g2}, \param{unsigned char}{ b2}}
+
+Replaces the colour specified by {\it r1,g1,b1} by the colour {\it r2,g2,b2}.
+

 \membersection{wxImage::Rescale}\label{wximagerescale}
 
 \membersection{wxImage::Rescale}\label{wximagerescale}
 

-\func{wxImage}{Rescale}{\param{int}{ width}, \param{int}{ height}}
+\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.
 
 
 Changes the size of the image in-place: after a call to this function, the
 image will have the given width and height.
 

+Returns the (modified) image itself.
+

 \wxheading{See also}
 
 \helpref{Scale}{wximagescale}
 \wxheading{See also}
 
 \helpref{Scale}{wximagescale}


@@ -452,8 +511,8 @@ 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.
 
 scaling bitmaps in general as the only other way to scale bitmaps
 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.
+It may be mentioned that the GTK port uses this function internally
+to scale bitmaps when using mapping mode in wxDC. 

 
 Example:
 
 
 Example:
 


@@ -478,13 +537,6 @@ Example:
 
 \helpref{Rescale}{wximagerescale}
 
 
 \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}}


@@ -512,7 +564,8 @@ Sets the mask colour for this image (and tells the image to use the mask).
 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
 data, but in some cases this might be too slow so that the data will have to
 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
 data, but in some cases this might be too slow so that the data will have to

-be set directly. In that case you have to get that data by calling GetData().
+be set directly. In that case you will have to get access to the image data 
+using the \helpref{GetData}{wximagegetdata} method.

 
 \membersection{wxImage::operator $=$}
 
 
 \membersection{wxImage::operator $=$}
 


@@ -587,6 +640,7 @@ created by IJG.)
 \wxheading{See also}
 
 \helpref{wxImage}{wximage}
 \wxheading{See also}
 
 \helpref{wxImage}{wximage}

+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -615,6 +669,20 @@ Gets the name of this handler.
 
 Gets the file extension associated with this handler.
 
 
 Gets the file extension associated with this handler.
 

+\membersection{wxImageHandler::GetImageCount}\label{wximagehandlergetimagecount}
+
+\func{int}{GetImageCount}{\param{wxInputStream\&}{ stream}}
+
+If the image file contains more than one image and the image handler is capable 
+of retrieving these individually, this function will return the number of
+available images.
+
+\docparam{stream}{Opened input stream for reading image file.}
+
+\wxheading{Return value}
+
+Number of available images. For most image handles, this defaults to 1.
+

 \membersection{wxImageHandler::GetType}
 
 \constfunc{long}{GetType}{\void}
 \membersection{wxImageHandler::GetType}
 
 \constfunc{long}{GetType}{\void}


@@ -629,16 +697,21 @@ Gets the MIME type associated with this handler.
 
 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 
 
 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 

-\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}}
+\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=TRUE}, \param{int}{ index=0}}

 
 

-Loads a image from a stream, putting the resulting data into {\it image}.
+Loads a image from a stream, putting the resulting data into {\it image}. If the image file contains
+more than one image and the image handler is capable of retrieving these individually, {\it index}
+indicates which image to read from the stream.

 
 \wxheading{Parameters}
 
 \docparam{image}{The image object which is to be affected by this operation.}
 
 
 \wxheading{Parameters}
 
 \docparam{image}{The image object which is to be affected by this operation.}
 

-\docparam{stream}{Opened input stream.
-The meaning of {\it stream} is determined by the {\it type} parameter.}
+\docparam{stream}{Opened input stream for reading images.}
+
+\docparam{verbose}{If set to TRUE, errors reported by the image handler will produce wxLogMessages.}
+
+\docparam{index}{The index of the image in the file (starting from zero).}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -660,7 +733,7 @@ Saves a image in the output stream.
 
 \docparam{image}{The image object which is to be affected by this operation.}
 
 
 \docparam{image}{The image object which is to be affected by this operation.}
 

-\docparam{stream}{A stream. The meaning of {\it stream} is determined by the {\it type} parameter.}
+\docparam{stream}{An opened stream for writing images.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}