Some doc corrections; removed wxDocument arg from wxView constructor;

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index a7808cd051f61d085c6c55d5910010a563d10d56..7a9351b80407db88c7ad138d8c07a1c586fcd5a9 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}


@@ -64,13 +68,17 @@ Loads an image from an input stream.
 \begin{twocollist}
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.}
 \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNG}}}{Load a PNG bitmap file.}
 \begin{twocollist}
 \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.}

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

-If all possible wxWindows settings are used, the loading a BMP (Windows bitmap) file
-and a PNG (portable network graphics) file is supported on all platforms that
+If all possible wxWindows settings are used, the loading a BMP (Windows bitmap) file,
+a PNG (portable network graphics) file and a JPEG file is supported on all platforms that

 implement wxImage.}
 
 implement wxImage.}
 

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


@@ -244,8 +252,8 @@ Returns TRUE if there is a mask active, FALSE otherwise.
 \func{static void}{InitStandardHandlers}{\void}
 
 Adds the standard image format handlers, which, depending on wxWindows
 \func{static void}{InitStandardHandlers}{\void}
 
 Adds the standard image format handlers, which, depending on wxWindows

-configuration, can be handlers for Windows BMP (loading) and PNG
-(loading and saving) file formats.
+configuration, can be handlers for Windows BMP (loading), PNG
+(loading and saving) and JPEG (loading and saving) file formats.

 
 This function is called by wxWindows on startup.
 
 
 This function is called by wxWindows on startup.
 


@@ -290,6 +298,7 @@ The meaning of {\it stream} data is determined by the {\it type} parameter.}
 \begin{twocollist}
 \twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Load a Windows image file.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
 \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\_JPEG}}{Load a JPEG 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.}


@@ -341,11 +350,12 @@ 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 only one type can be used:
+\docparam{type}{Currently two types can be used:

 
 \twocolwidtha{5cm}%
 \begin{twocollist}
 \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG 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.}

 \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


@@ -369,9 +379,9 @@ Depending on how wxWindows has been configured, not all formats may be available
 
 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 do blit a wxMemoryDC into another wxMemoryDC. Windows can such scaling
-itself, but on GTK scaling bitmaps is done using this routine 
-internally.
+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.

 
 \membersection{wxImage::SetData}\label{wximagesetdata}
 
 
 \membersection{wxImage::SetData}\label{wximagesetdata}
 


@@ -391,7 +401,7 @@ Specifies whether there is a mask or not. The area of the mask is determined by
 
 \func{void}{SetMaskColour}{\param{unsigned char }{red}, \param{unsigned char }{blue}, \param{unsigned char }{green}}
 
 
 \func{void}{SetMaskColour}{\param{unsigned char }{red}, \param{unsigned char }{blue}, \param{unsigned char }{green}}
 

-Sets the mask colour for this image.
+Sets the mask colour for this image (and tells the image to use the mask).

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


@@ -457,10 +467,21 @@ If you wish to extend the capabilities of wxImage, derive a class from wxImageHa
 and add the handler using \helpref{wxImage::AddHandler}{wximageaddhandler} in your
 application initialisation.
 
 and add the handler using \helpref{wxImage::AddHandler}{wximageaddhandler} in your
 application initialisation.
 

+\wxheading{Note (Legal Issue)}
+
+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.)
+

 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 

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

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