X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/48b4e3029f55911772a7f8d16a3e3599d068285f..6cf7c00f3beb3aa6c84b47d43d904e0e40f91a97:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index bd0617ef98..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} + + + \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} @@ -72,6 +80,11 @@ 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.} +\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} @@ -150,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. @@ -271,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} @@ -296,6 +319,8 @@ The meaning of {\it stream} data is determined by the {\it type} parameter.} 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. @@ -331,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} @@ -354,6 +383,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.} +\docparam{mimetype}{MIME type.} + \wxheading{Return value} TRUE if the operation succeeded, FALSE otherwise. @@ -462,8 +493,7 @@ application initialisation. \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.) @@ -472,6 +502,10 @@ created by IJG.) \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxImage}{wximage} @@ -509,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}} @@ -584,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.} +