X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2faa8e74b5cb5d630db5c24f1b8b5ce22a812bcd..b44f1ca20bd4d5c6970228e476ce74d4347a6ff3:/docs/latex/wx/bitmap.tex?ds=inline diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index 385a64fde1..c354102ed1 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -3,14 +3,14 @@ %\overview{Overview}{wxbitmapoverview} % This class encapsulates the concept of a platform-dependent bitmap, -either monochrome or colour. +either monochrome or colour or colour with alpha channel support. \wxheading{Derived from} \helpref{wxGDIObject}{wxgdiobject}\\ \helpref{wxObject}{wxobject} -\wxheading{Include file} +\wxheading{Include files} @@ -72,7 +72,8 @@ bitmaps from static data. Creates a new bitmap. A depth of -1 indicates the depth of the current screen or visual. Some platforms only support 1 for monochrome and -1 for the current -colour setting. +colour setting. Beginning with version 2.5.4 of wxWidgets a depth of 32 including +an alpha channel is supported under MSW, Mac and GTK+. \func{}{wxBitmap}{\param{const char**}{ bits}} @@ -118,11 +119,11 @@ Its meaning is determined by the {\it type} parameter.} \twocolwidtha{5cm} \begin{twocollist} \twocolitem{\indexit{wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.} -\twocolitem{\indexit{wxBITMAP\_TYPE\_BMP\_RESOURCE}}{Load a Windows bitmap from the resource database.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_BMP\_RESOURCE}}{Load a Windows bitmap resource from the executable. Windows only.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_PICT\_RESOURCE}}{Load a PICT image resource from the executable. Mac OS only.} \twocolitem{\indexit{wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.} \twocolitem{\indexit{wxBITMAP\_TYPE\_XBM}}{Load an X bitmap file.} \twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.} -\twocolitem{\indexit{wxBITMAP\_TYPE\_RESOURCE}}{Load a Windows resource name.} \end{twocollist} The validity of these flags depends on the platform and wxWidgets configuration. @@ -295,11 +296,11 @@ type of data. Finds the handler with the given name. -\func{static wxBitmapHandler*}{FindHandler}{\param{const wxString\& }{extension}, \param{long}{ bitmapType}} +\func{static wxBitmapHandler*}{FindHandler}{\param{const wxString\& }{extension}, \param{wxBitmapType}{ bitmapType}} Finds the handler associated with the given extension and type. -\func{static wxBitmapHandler*}{FindHandler}{\param{long }{bitmapType}} +\func{static wxBitmapHandler*}{FindHandler}{\param{wxBitmapType }{bitmapType}} Finds the handler associated with the given bitmap type. @@ -407,7 +408,7 @@ of a given handler class in an application session.} \membersection{wxBitmap::LoadFile}\label{wxbitmaploadfile} -\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}} +\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{wxBitmapType}{ type}} Loads a bitmap from a file or resource. @@ -421,7 +422,8 @@ The meaning of {\it name} is determined by the {\it type} parameter.} \twocolwidtha{5cm} \begin{twocollist} \twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.} -\twocolitem{{\bf wxBITMAP\_TYPE\_BMP\_RESOURCE}}{Load a Windows bitmap from the resource database.} +\twocolitem{{\bf wxBITMAP\_TYPE\_BMP\_RESOURCE}}{Load a Windows bitmap resource from the executable.} +\twocolitem{{\bf wxBITMAP\_TYPE\_PICT\_RESOURCE}}{Load a PICT image resource from the executable. Mac OS only.} \twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.} \twocolitem{{\bf wxBITMAP\_TYPE\_XBM}}{Load an X bitmap file.} \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.} @@ -472,7 +474,7 @@ true if the handler was found and removed, false otherwise. \membersection{wxBitmap::SaveFile}\label{wxbitmapsavefile} -\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}, \param{wxPalette* }{palette = NULL}} +\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type}, \param{wxPalette* }{palette = NULL}} Saves a bitmap in the named file. @@ -561,7 +563,7 @@ The bitmap object owns the mask once this has been called. \func{void}{SetPalette}{\param{const wxPalette\& }{palette}} -Sets the associated palette. +Sets the associated palette. (Not implemented under GTK+). \wxheading{Parameters}