1. added code to dyntbar to allow bitmap loading from windows resources

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 281fd8a7e1caa61732c88a036441b637abd5d826..7a9351b80407db88c7ad138d8c07a1c586fcd5a9 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -10,12 +10,14 @@ A wxImage cannot (currently) be drawn directly to a wxDC. Instead, a platform-sp
 wxBitmap object must be created from it, and that bitmap drawn on the wxDC, using
 wxDC::DrawBitmap.
 
 wxBitmap object must be created from it, and that bitmap drawn on the wxDC, using
 wxDC::DrawBitmap.
 

-This class is currently only available under GTK and Windows.
-

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

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

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


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

 
 Loads an image from a file.
 
 
 Loads an image from a file.
 

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

 \wxheading{Parameters}
 
 \docparam{width}{Specifies the width of the image.}
 \wxheading{Parameters}
 
 \docparam{width}{Specifies the width of the image.}


@@ -54,19 +60,25 @@ Loads an image from a file.
 
 \docparam{name}{This refers to an image filename. Its meaning is determined by the {\it type} parameter.}
 
 
 \docparam{name}{This refers to an image filename. Its meaning is determined by the {\it type} parameter.}
 

+\docparam{stream}{This refers to an input stream. Its meaning is determined by the {\it type} parameter. It is equal to loading from file except that you provide opened stream (file, HTTP or any other custom class).}
+

 \docparam{type}{May be one of the following:
 
 \docparam{type}{May be one of the following:
 

-\twocolwidtha{5cm}
+\twocolwidtha{5cm}%

 \begin{twocollist}
 \begin{twocollist}

-\twocolitem{{\bf \indexit{wxIMAGE\_TYPE\_BMP}}}{Load a Windows bitmap file.}
-\twocolitem{{\bf \indexit{wxIMAGE\_TYPE\_PNG}}}{Load a PNG 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.}

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


@@ -105,10 +117,9 @@ 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. Especially when converting
-to 8-bit (or even less) bitmaps, the routine is slow and will reduce the
-quality of the resulting bitmap. A proper set of colour reduction methods has
-not yet been written.
+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.

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


@@ -150,7 +161,7 @@ Finds the handler associated with the given image type.
 
 \docparam{extension}{The file extension, such as ``bmp".}
 
 
 \docparam{extension}{The file extension, such as ``bmp".}
 

-\docparam{imageType}{The image type, such as wxIMAGE\_TYPE\_BMP.}
+\docparam{imageType}{The image type, such as wxBITMAP\_TYPE\_BMP.}

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


@@ -241,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.
 


@@ -269,17 +280,25 @@ of a given handler class in an application session.}
 
 Loads an image from a file.
 
 
 Loads an image from a file.
 

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

 \wxheading{Parameters}
 
 \docparam{name}{A filename.
 The meaning of {\it name} is determined by the {\it type} parameter.}
 
 \wxheading{Parameters}
 
 \docparam{name}{A filename.
 The meaning of {\it name} is determined by the {\it type} parameter.}
 

+\docparam{stream}{An input stream.
+The meaning of {\it stream} data is determined by the {\it type} parameter.}
+

 \docparam{type}{One of the following values:
 
 \docparam{type}{One of the following values:
 

-\twocolwidtha{5cm}
+\twocolwidtha{5cm}%

 \begin{twocollist}
 \begin{twocollist}

-\twocolitem{{\bf wxIMAGE\_TYPE\_BMP}}{Load a Windows image file.}
-\twocolitem{{\bf wxIMAGE\_TYPE\_PNG}}{Load a PNG image file.}
+\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.}


@@ -321,15 +340,22 @@ TRUE if the handler was found and removed, FALSE otherwise.
 
 Saves a image in the named file.
 
 
 Saves a image in the named file.
 

+\func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}}
+
+Saves a image in the given stream.
+

 \wxheading{Parameters}
 
 \docparam{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.}
 
 \wxheading{Parameters}
 
 \docparam{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.}
 

-\docparam{type}{Currently only one type can be used:
+\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:

 
 

-\twocolwidtha{5cm}
+\twocolwidtha{5cm}%

 \begin{twocollist}
 \begin{twocollist}

-\twocolitem{{\bf wxIMAGE\_TYPE\_PNG}}{Save a PNG image file.}
+\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


@@ -353,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}
 


@@ -375,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}
 


@@ -441,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}


@@ -484,16 +521,16 @@ Gets the image type associated with this handler.
 
 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 
 
 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 

-\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{const wxString\&}{ name}}
+\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}}

 
 

-Loads a image from a file or resource, putting the resulting data into {\it image}.
+Loads a image from a stream, putting the resulting data into {\it image}.

 
 \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{name}{Either a filename or a Windows resource name.
-The meaning of {\it name} is determined by the {\it type} parameter.}
+\docparam{stream}{Opened input stream.
+The meaning of {\it stream} is determined by the {\it type} parameter.}

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


@@ -507,15 +544,15 @@ TRUE if the operation succeeded, FALSE otherwise.
 
 \membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
 
 
 \membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
 

-\func{bool}{SaveFile}{\param{wxImage* }{image}, \param{const wxString\& }{name}}
+\func{bool}{SaveFile}{\param{wxImage* }{image}, \param{wxOutputStream\& }{stream}}

 
 

-Saves a image in the named file.
+Saves a image in the output 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{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.}
+\docparam{stream}{A stream. The meaning of {\it stream} is determined by the {\it type} parameter.}

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


@@ -557,4 +594,3 @@ Sets the handler type.
 
 \docparam{name}{Handler type.}
 
 
 \docparam{name}{Handler type.}
 

-