X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b931f7ee94f9168cc95f2c360647c172cc169adb..a84ece11fffdde5d1bbd254ba58ac3cee79c2e77:/docs/latex/wx/image.tex?ds=sidebyside diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 5cdd7d29c2..574391e7c1 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -24,17 +24,18 @@ handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or \twocolwidtha{5cm}% \begin{twocollist} -\twocolitem{\indexit{wxBMPHandler}}{Only for loading, always installed.} +\twocolitem{\indexit{wxBMPHandler}}{For loading and saving, always installed.} \twocolitem{\indexit{wxPNGHandler}}{For loading and saving.} \twocolitem{\indexit{wxJPEGHandler}}{For loading and saving.} \twocolitem{\indexit{wxGIFHandler}}{Only for loading, due to legal issues.} \twocolitem{\indexit{wxPCXHandler}}{For loading and saving (see below).} \twocolitem{\indexit{wxPNMHandler}}{For loading and saving (see below).} \twocolitem{\indexit{wxTIFFHandler}}{For loading and saving.} +\twocolitem{\indexit{wxIFFHandler}}{For loading only.} \twocolitem{\indexit{wxXPMHandler}}{For loading and saving.} \twocolitem{\indexit{wxICOHandler}}{For loading and saving.} \twocolitem{\indexit{wxCURHandler}}{For loading and saving.} -\twocolitem{\indexit{wxANIHandler}}{For loading and saving.} +\twocolitem{\indexit{wxANIHandler}}{For loading only.} \end{twocollist} When saving in PCX format, {\bf wxPCXHandler} will count the number of @@ -196,6 +197,10 @@ of a given handler class in an application session.} \helpref{wxImageHandler}{wximagehandler} +\func{bool}{CanRead}{\param{const wxString\&}{ filename}} + +returns TRUE if the current image handlers can read this file + \pythonnote{In wxPython this static method is named {\tt wxImage\_AddHandler}.} \membersection{wxImage::CleanUpHandlers} @@ -642,13 +647,19 @@ TRUE if the handler was found and removed, FALSE otherwise. \constfunc{bool}{SaveFile}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}} -Saves a image in the named file. +Saves an image in the named file. + +\constfunc{bool}{SaveFile}{\param{const wxString\& }{name}} + +Saves an image in the named file. File type is determined from the extension of the +file name. Note that this function may fail if the extension is not recognized! You +can use one of the forms above to save images to files with non-standard extensions. \constfunc{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}} \constfunc{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{const wxString\&}{ mimetype}} -Saves a image in the given stream. +Saves an image in the given stream. \wxheading{Parameters} @@ -656,17 +667,17 @@ Saves a image in the given stream. \docparam{stream}{Opened output stream to save the image to.} -\docparam{type}{Currently three types can be used: +\docparam{type}{Currently these types can be used: \twocolwidtha{5cm}% \begin{twocollist} +\twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Save a BMP image file.} \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Save a JPEG image file.} \twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.} \twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise).} \twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Save a PNM image file (as raw RGB always).} \twocolitem{{\bf wxBITMAP\_TYPE\_TIFF}}{Save a TIFF image file.} \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save a XPM image file.} -\twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Save a ICO image file. } \twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Save a Windows icon file (ICO) (the size may be up to 255 wide by 127 high. A single image is saved in 8 colors at the size supplied).} \twocolitem{{\bf wxBITMAP\_TYPE\_CUR}}{Save a Windows cursor file (CUR).} \end{twocollist}}