X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b11708106f93d28dbb47218b18e02674ad6c0cdb..6cf7c00f3beb3aa6c84b47d43d904e0e40f91a97:/docs/latex/wx/image.tex?ds=sidebyside

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 02cca80629..8325f4be63 100644
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -14,6 +14,10 @@ wxDC::DrawBitmap.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/image.h>
+
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}
@@ -42,10 +46,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{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{const wxString\&}{ mimetype}}
+
 Loads an image from an input stream.
 
 \wxheading{Parameters}
@@ -64,13 +72,19 @@ 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.}
+\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.
-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.}
 
+\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}
@@ -149,12 +163,18 @@ Finds the handler associated with the given extension and 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{mimetype}{MIME type.}
+
 \wxheading{Return value}
 
 A pointer to the handler if found, NULL otherwise.
@@ -244,8 +264,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
-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.
 
@@ -270,10 +290,14 @@ of a given handler class in an application session.}
 
 \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
 
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const wxString\&}{ mimetype}}
+
 Loads an image from a file.
 
 \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}
@@ -290,10 +314,13 @@ 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.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Load a JPEG image file.}
 \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.
@@ -329,10 +356,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{const wxString\&}{ mimetype}}
+
 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}
@@ -341,16 +372,19 @@ 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{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.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Save a JPEG image file.}
 \end{twocollist}
 
 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.
@@ -457,10 +491,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.
 
+\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{Include files}
+
+<wx/image.h>
+
 \wxheading{See also}
 
 \helpref{wxImage}{wximage}
@@ -498,6 +543,12 @@ Gets the file extension 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}}
@@ -573,3 +624,14 @@ Sets the 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.}
+