wxDateTime starting to work, more tests for it and for threads in console sample

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index d911a1fc2833856e0b01aae7cc5d5f986c5ff0fc..8578e0f634b6a323233258a9df819a8ddd1f2d49 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -14,9 +14,14 @@ 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}

+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}

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


@@ -42,10 +47,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}


@@ -65,6 +74,9 @@ 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.}

 \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.


@@ -72,13 +84,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.}
 

-Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application 
+\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}
 
 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}
 \membersection{wxImage::\destruct{wxImage}}
 
 \func{}{\destruct{wxImage}}{\void}


@@ -98,6 +126,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}


@@ -153,12 +182,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.


@@ -227,6 +262,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}


@@ -247,15 +289,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}
 


@@ -272,12 +315,17 @@ 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}}

 
 

-Loads an image from a file.
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const wxString\&}{ mimetype}}
+
+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}}
 

+\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}


@@ -293,12 +341,17 @@ 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\_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.}
 

+\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.


@@ -307,6 +360,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}


@@ -334,10 +398,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}


@@ -357,6 +425,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.


@@ -369,21 +439,66 @@ 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.
+
+It may be mentioned that the GTK post uses this function internally
+to scale bitmaps when using mapping mode in wxDC. 
+
+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}}
 
 
 \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.
 


@@ -465,8 +580,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.)


@@ -475,9 +589,14 @@ 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}

+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}

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


@@ -512,6 +631,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}}


@@ -587,3 +712,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.}
+