X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7b2471a060f4f79481a2de8e6341571ad1674ff1..43c9c17dfbc351e9b754aa6380db12d292c2e115:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index a68a97cfea..1366f12d04 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -21,6 +21,7 @@ wxDC::DrawBitmap. \wxheading{See also} \helpref{wxBitmap}{wxbitmap} +\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} \latexignore{\rtfignore{\wxheading{Members}}} @@ -258,6 +259,13 @@ Gets the green value of the mask colour. Gets the red value of the mask colour. +\membersection{wxImage::GetSubImage}\label{wximagegetsubimage} + +\constfunc{wxImage}{GetSubImage}{\param{const wxRect&}{rect}} + +Returns a sub image of the current one as long as the rect belongs entirely to +the image. + \membersection{wxImage::GetWidth}\label{wximagegetwidth} \constfunc{int}{GetWidth}{\void} @@ -278,15 +286,16 @@ 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), PNG -(loading and saving) and JPEG (loading and saving) file formats. +Internal use only. Adds standard image format handlers. It only install BMP +for the time being, which is use by wxBitmap. -This function is called by wxWindows on startup. +This function is called by wxWindows on startup, and shouldn't be called by +the user. \wxheading{See also} \helpref{wxImageHandler}{wximagehandler} +\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} \membersection{wxImage::InsertHandler} @@ -303,11 +312,12 @@ of a given handler class in an application session.} \membersection{wxImage::LoadFile}\label{wximageloadfile} -\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}} +\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}} \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const wxString\&}{ mimetype}} -Loads an image from a file. +Loads an image from a file. If no handler type is provided, the library will +try to use wxBITMAP\_TYPE\_BMP. \func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}} @@ -328,8 +338,11 @@ The meaning of {\it stream} data is determined by the {\it type} parameter.} \twocolwidtha{5cm}% \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\_GIF}}{Load a GIF image file.} \twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Load a JPEG image file.} +\twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Load a PCX image file.} +\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.} +\twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Load a PNM image file.} \end{twocollist} The validity of these flags depends on the platform and wxWindows configuration.} @@ -437,8 +450,8 @@ mimetype to the named file} \func{wxImage}{Rescale}{\param{int}{ width}, \param{int}{ height}} -Changes the size of the image in-place: after a call to this function, thei -mage will have the given width and height. +Changes the size of the image in-place: after a call to this function, the +image will have the given width and height. \wxheading{See also} @@ -452,8 +465,8 @@ 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 to blit a wxMemoryDC into another wxMemoryDC. -NB: although Windows can do such scaling itself but in the GTK port, scaling -bitmaps is done using this routine internally. +It may be mentioned that the GTK post uses this function internally +to scale bitmaps when using mapping mode in wxDC. Example: @@ -478,13 +491,6 @@ Example: \helpref{Rescale}{wximagerescale} -\membersection{wxImage::GetSubImage}\label{wximagegetsubimage} - -\constfunc{wxImage}{GetSubImage}{\param{const wxRect&}{rect}} - -Returns a sub image of the current one as long as the rect belongs entirely to -the image. - \membersection{wxImage::SetData}\label{wximagesetdata} \func{void}{SetData}{\param{unsigned char*}{data}} @@ -587,6 +593,7 @@ created by IJG.) \wxheading{See also} \helpref{wxImage}{wximage} +\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} \latexignore{\rtfignore{\wxheading{Members}}}