X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1e6d94998fcbdb3ce60774e38c0d4b6ee20c6798..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/bitmap.tex diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index f847a82bf0..db2d9f7ac3 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -3,20 +3,34 @@ %\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 files} + + + +\wxheading{Predefined objects} + +Objects: + +{\bf wxNullBitmap} + \wxheading{See also} -\helpref{wxBitmap overview}{wxbitmapoverview}, \helpref{wxDC::Blit}{wxdcblit}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}, \helpref{wxMemoryDC}{wxmemorydc} +\helpref{wxBitmap overview}{wxbitmapoverview}, +\helpref{supported bitmap file formats}{supportedbitmapformats}, +\helpref{wxDC::Blit}{wxdcblit}, +\helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}, \helpref{wxBitmap}{wxbitmap}, +\helpref{wxMemoryDC}{wxmemorydc} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxBitmap::wxBitmap}\label{wxbitmapconstr} +\membersection{wxBitmap::wxBitmap}\label{wxbitmapctor} \func{}{wxBitmap}{\void} @@ -24,22 +38,42 @@ Default constructor. \func{}{wxBitmap}{\param{const wxBitmap\& }{bitmap}} -Copy constructor. +Copy constructor, uses \helpref{reference counting}{trefcount}. +To make a real copy, you can use: -\func{}{wxBitmap}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} +\begin{verbatim} + wxBitmap newBitmap = oldBitmap.GetSubBitmap( + wxRect(0, 0, oldBitmap.GetWidth(), oldBitmap.GetHeight())); +\end{verbatim} -Creates a bitmap from the given data, which can be of arbitrary type. +\func{}{wxBitmap}{\param{const void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} + +Creates a bitmap from the given data which is interpreted in platform-dependent +manner. \func{}{wxBitmap}{\param{const char}{ bits[]}, \param{int}{ width}, \param{int}{ height}\\ \param{int}{ depth = 1}} Creates a bitmap from an array of bits. +You should only use this function for monochrome bitmaps ({\it depth} 1) in +portable programs: in this case the {\it bits} parameter should contain an XBM +image. + +For other bit depths, the behaviour is platform dependent: under Windows, the +data is passed without any changes to the underlying {\tt CreateBitmap()} API. +Under other platforms, only monochrome bitmaps may be created using this +constructor and \helpref{wxImage}{wximage} should be used for creating colour +bitmaps from static data. + \func{}{wxBitmap}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} -Creates a new bitmap. +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. 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}} +\func{}{wxBitmap}{\param{const char* const*}{ bits}} Creates a bitmap from XPM data. @@ -47,6 +81,23 @@ Creates a bitmap from XPM data. Loads a bitmap from a file or resource. +\func{}{wxBitmap}{\param{const wxImage\&}{ img}, \param{int}{ depth = -1}} + +Creates bitmap object from the image. This has to be done +to actually display an image as you cannot draw an image directly on a window. +The resulting bitmap will use the provided colour depth (or that of the +current system if depth is -1) which entails that a colour reduction has +to take place. + +When in 8-bit mode (PseudoColour mode), the GTK port will use a color cube created +on program start-up to look up colors. This ensures a very fast conversion, but +the image quality won't be perfect (and could be better for photo images using more +sophisticated dithering algorithms). + +On Windows, if there is a palette present (set with SetPalette), it will be used when +creating the wxBitmap (most useful in 8-bit display mode). On other platforms, +the palette is currently ignored. + \wxheading{Parameters} \docparam{bits}{Specifies an array of pixel values.} @@ -65,17 +116,24 @@ Its meaning is determined by the {\it type} parameter.} \twocolwidtha{5cm} \begin{twocollist} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP\_RESOURCE}}}{Load a Windows bitmap from the resource database.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XBM}}}{Load an X bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XPM}}}{Load an XPM bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_RESOURCE}}}{Load a Windows resource name.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.} +\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.} \end{twocollist} -The validity of these flags depends on the platform and wxWindows configuration. -If all possible wxWindows settings are used, the Windows platform supports BMP, BMP\_RESOURCE, -XPM\_DATA, and XPM. Under X, the available formats are BMP, GIF, XBM, and XPM.} +The validity of these flags depends on the platform and wxWidgets configuration. +If all possible wxWidgets settings are used, the Windows platform supports BMP file, BMP resource, +XPM data, and XPM. Under wxGTK, the available formats are BMP file, XPM data, XPM file, and PNG file. +Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM file. + +In addition, wxBitmap can read all formats that \helpref{wxImage}{wximage} can, which currently include +wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_TIF, wxBITMAP\_TYPE\_PNG, wxBITMAP\_TYPE\_GIF, wxBITMAP\_TYPE\_PCX, +and wxBITMAP\_TYPE\_PNM. Of course, you must have wxImage handlers loaded. } + +\docparam{img}{Platform-independent wxImage object.} \wxheading{Remarks} @@ -94,7 +152,7 @@ X and Windows. The sixth form constructs a new bitmap. -The seventh form constructs a bitmap from pixmap (XPM) data, if wxWindows has been configured +The seventh form constructs a bitmap from pixmap (XPM) data, if wxWidgets has been configured to incorporate this feature. To use this constructor, you must first include an XPM file. For @@ -113,23 +171,46 @@ The eighth form constructs a bitmap from a file or resource. {\it name} can refe to a resource name under MS Windows, or a filename under MS Windows and X. Under Windows, {\it type} defaults to wxBITMAP\_TYPE\_BMP\_RESOURCE. -Under X, {\it type} defaults to wxBITMAP\_TYPE\_XBM. +Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM. \wxheading{See also} \helpref{wxBitmap::LoadFile}{wxbitmaploadfile} -\membersection{wxBitmap::\destruct{wxBitmap}} +\pythonnote{Constructors supported by wxPython are:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf wxBitmap(name, flag)}}{Loads a bitmap from a file} +\twocolitem{{\bf wxEmptyBitmap(width, height, depth = -1)}}{Creates an +empty bitmap with the given specifications} +\twocolitem{{\bf wxBitmapFromXPMData(listOfStrings)}}{Create a bitmap +from a Python list of strings whose contents are XPM data.} +\twocolitem{{\bf wxBitmapFromBits(bits, width, height, +depth=-1)}}{Create a bitmap from an array of bits contained in a +string.} +\twocolitem{{\bf wxBitmapFromImage(image, depth=-1)}}{Convert a +wxImage to a wxBitmap.} +\end{twocollist}} +} + +\perlnote{Constructors supported by wxPerl are:\par +\begin{itemize} +\item{Wx::Bitmap->new( width, height, depth = -1 )} +\item{Wx::Bitmap->new( name, type )} +\item{Wx::Bitmap->new( icon )} +\item{Wx::Bitmap->newFromBits( bits, width, height, depth = 1 )} +\item{Wx::Bitmap->newFromXPM( data )} +\end{itemize} +} + +\membersection{wxBitmap::\destruct{wxBitmap}}\label{wxbitmapdtor} \func{}{\destruct{wxBitmap}}{\void} -Destroys the wxBitmap object and possibly the underlying bitmap data. -Because reference counting is used, the bitmap may not actually be -destroyed at this point - only when the reference count is zero will the -data be deleted. +Destructor. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. If the application omits to delete the bitmap explicitly, the bitmap will be -destroyed automatically by wxWindows when the application exits. +destroyed automatically by wxWidgets when the application exits. Do not delete a bitmap that is selected into a memory device context. @@ -146,22 +227,36 @@ of a given handler class in an application session.} \helpref{wxBitmapHandler}{wxbitmaphandler} -\membersection{wxBitmap::CleanUpHandlers} +\membersection{wxBitmap::CleanUpHandlers}\label{wxbitmapcleanuphandlers} \func{static void}{CleanUpHandlers}{\void} Deletes all bitmap handlers. -This function is called by wxWindows on exit. +This function is called by wxWidgets on exit. + +\membersection{wxBitmap::ConvertToImage}\label{wxbitmapconverttoimage} + +\func{wxImage}{ConvertToImage}{\void} -\membersection{wxBitmap::Create} +Creates an image from a platform-dependent bitmap. This preserves +mask information so that bitmaps and images can be converted back +and forth without loss in that respect. + +\membersection{wxBitmap::CopyFromIcon}\label{wxbitmapcopyfromicon} + +\func{bool}{CopyFromIcon}{\param{const wxIcon\&}{ icon}} + +Creates the bitmap from an icon. + +\membersection{wxBitmap::Create}\label{wxbitmapcreate} \func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} Creates a fresh bitmap. If the final argument is omitted, the display depth of the screen is used. -\func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} +\func{virtual bool}{Create}{\param{const void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} Creates a bitmap from the given data, which can be of arbitrary type. @@ -175,12 +270,12 @@ Creates a bitmap from the given data, which can be of arbitrary type. \docparam{data}{Data whose type depends on the value of {\it type}.} -\docparam{type}{A bitmap type identifier - see \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for a list +\docparam{type}{A bitmap type identifier - see \helpref{wxBitmap::wxBitmap}{wxbitmapctor} for a list of possible values.} \wxheading{Return value} -TRUE if the call succeeded, FALSE otherwise. +true if the call succeeded, false otherwise. \wxheading{Remarks} @@ -189,19 +284,19 @@ type of data. \wxheading{See also} -\helpref{wxBitmap::wxBitmap}{wxbitmapconstr} +\helpref{wxBitmap::wxBitmap}{wxbitmapctor} -\membersection{wxBitmap::FindHandler} +\membersection{wxBitmap::FindHandler}\label{wxbitmapfindhandler} \func{static wxBitmapHandler*}{FindHandler}{\param{const wxString\& }{name}} 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. @@ -219,14 +314,14 @@ A pointer to the handler if found, NULL otherwise. \helpref{wxBitmapHandler}{wxbitmaphandler} -\membersection{wxBitmap::GetDepth} +\membersection{wxBitmap::GetDepth}\label{wxbitmapgetdepth} \constfunc{int}{GetDepth}{\void} Gets the colour depth of the bitmap. A value of 1 indicates a monochrome bitmap. -\membersection{wxBitmap::GetHandlers} +\membersection{wxBitmap::GetHandlers}\label{wxbitmapgethandlers} \func{static wxList\&}{GetHandlers}{\void} @@ -274,20 +369,27 @@ Gets the width of the bitmap in pixels. \helpref{wxBitmap::GetHeight}{wxbitmapgetheight} -\membersection{wxBitmap::InitStandardHandlers} +\membersection{wxBitmap::GetSubBitmap}\label{wxbitmapgetsubbitmap} + +\constfunc{wxBitmap}{GetSubBitmap}{\param{const wxRect\&}{rect}} + +Returns a sub bitmap of the current one as long as the rect belongs entirely to +the bitmap. This function preserves bit depth and mask information. + +\membersection{wxBitmap::InitStandardHandlers}\label{wxbitmapinitstandardhandlers} \func{static void}{InitStandardHandlers}{\void} -Adds the standard bitmap format handlers, which, depending on wxWindows +Adds the standard bitmap format handlers, which, depending on wxWidgets configuration, can be handlers for Windows bitmap, Windows bitmap resource, and XPM. -This function is called by wxWindows on startup. +This function is called by wxWidgets on startup. \wxheading{See also} \helpref{wxBitmapHandler}{wxbitmaphandler} -\membersection{wxBitmap::InsertHandler} +\membersection{wxBitmap::InsertHandler}\label{wxbitmapinserthandler} \func{static void}{InsertHandler}{\param{wxBitmapHandler*}{ handler}} @@ -302,7 +404,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. @@ -316,17 +418,22 @@ 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.} \end{twocollist} -The validity of these flags depends on the platform and wxWindows configuration.} +The validity of these flags depends on the platform and wxWidgets configuration. + +In addition, wxBitmap can read all formats that \helpref{wxImage}{wximage} can +(wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG, wxBITMAP\_TYPE\_GIF, wxBITMAP\_TYPE\_PCX, wxBITMAP\_TYPE\_PNM). +(Of course you must have wxImage handlers loaded.) } \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{Remarks} @@ -338,13 +445,13 @@ if one has been created by using the \helpref{GetPalette}{wxbitmapgetpalette} me \helpref{wxBitmap::SaveFile}{wxbitmapsavefile} -\membersection{wxBitmap::Ok}\label{wxbitmapok} +\membersection{wxBitmap::IsOk}\label{wxbitmapisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} -Returns TRUE if bitmap data is present. +Returns true if bitmap data is present. -\membersection{wxBitmap::RemoveHandler} +\membersection{wxBitmap::RemoveHandler}\label{wxbitmapremovehandler} \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}} @@ -355,7 +462,7 @@ is not deleted. \wxheading{Return value} -TRUE if the handler was found and removed, FALSE otherwise. +true if the handler was found and removed, false otherwise. \wxheading{See also} @@ -363,7 +470,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. @@ -381,18 +488,23 @@ Saves a bitmap in the named file. \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save an XPM bitmap file.} \end{twocollist} -The validity of these flags depends on the platform and wxWindows configuration.} +The validity of these flags depends on the platform and wxWidgets configuration. -\docparam{palette}{An optional palette used for saving the bitmap. TODO: this parameter should -probably be eliminated; instead the app should set the palette before saving.} +In addition, wxBitmap can save all formats that \helpref{wxImage}{wximage} can +(wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG). +(Of course you must have wxImage handlers loaded.) } + +\docparam{palette}{An optional palette used for saving the bitmap.} +% TODO: this parameter should +%probably be eliminated; instead the app should set the palette before saving. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{Remarks} -Depending on how wxWindows has been configured, not all formats may be available. +Depending on how wxWidgets has been configured, not all formats may be available. \wxheading{See also} @@ -432,37 +544,32 @@ The bitmap object owns the mask once this has been called. \helpref{wxBitmap::GetMask}{wxbitmapgetmask}, \helpref{wxMask}{wxmask} -\membersection{wxBitmap::SetOk} - -\func{void}{SetOk}{\param{int }{isOk}} - -Sets the validity member (does not affect the bitmap data). - -\wxheading{Parameters} - -\docparam{isOk}{Validity flag.} +%% VZ: this function is an implementation detail and shouldn't be documented +%%\membersection{wxBitmap::SetOk}\label{wxbitmapsetok} +%% +%%\func{void}{SetOk}{\param{int }{isOk}} +%% +%%Sets the validity member (does not affect the bitmap data). +%% +%%\wxheading{Parameters} +%% +%%\docparam{isOk}{Validity flag.} \membersection{wxBitmap::SetPalette}\label{wxbitmapsetpalette} -\func{void}{SetPalette}{\param{wxPalette* }{palette}} +\func{void}{SetPalette}{\param{const wxPalette\& }{palette}} -Sets the associated palette: it will be deleted in the wxBitmap -destructor, so if you do not wish it to be deleted automatically, -reset the palette to NULL before the bitmap is deleted. +Sets the associated palette. (Not implemented under GTK+). \wxheading{Parameters} \docparam{palette}{The palette to set.} -\wxheading{Remarks} - -The bitmap object owns the palette once this has been called. - \wxheading{See also} \helpref{wxPalette}{wxpalette} -\membersection{wxBitmap::SetWidth} +\membersection{wxBitmap::SetWidth}\label{wxbitmapsetwidth} \func{void}{SetWidth}{\param{int }{width}} @@ -472,13 +579,11 @@ Sets the width member (does not affect the bitmap data). \docparam{width}{Bitmap width in pixels.} -\membersection{wxBitmap::operator $=$} +\membersection{wxBitmap::operator $=$}\label{wxbitmapassign} \func{wxBitmap\& }{operator $=$}{\param{const wxBitmap\& }{bitmap}} -Assignment operator. This operator does not copy any data, but instead -passes a pointer to the data in {\it bitmap} and increments a reference -counter. It is a fast operation. +Assignment operator, using \helpref{reference counting}{trefcount}. \wxheading{Parameters} @@ -488,194 +593,4 @@ counter. It is a fast operation. Returns 'this' object. -\membersection{wxBitmap::operator $==$} - -\func{bool}{operator $==$}{\param{const wxBitmap\& }{bitmap}} - -Equality operator. This operator tests whether the internal data pointers are -equal (a fast test). - -\wxheading{Parameters} - -\docparam{bitmap}{Bitmap to compare with 'this'} - -\wxheading{Return value} - -Returns TRUE if the bitmaps were effectively equal, FALSE otherwise. - -\membersection{wxBitmap::operator $!=$} - -\func{bool}{operator $!=$}{\param{const wxBitmap\& }{bitmap}} - -Inequality operator. This operator tests whether the internal data pointers are -unequal (a fast test). - -\wxheading{Parameters} - -\docparam{bitmap}{Bitmap to compare with 'this'} - -\wxheading{Return value} - -Returns TRUE if the bitmaps were unequal, FALSE otherwise. - -\section{\class{wxBitmapHandler}}\label{wxbitmaphandler} - -\overview{Overview}{wxbitmapoverview} - -This is the base class for implementing bitmap file loading/saving, and bitmap creation from data. -It is used within wxBitmap and is not normally seen by the application. - -If you wish to extend the capabilities of wxBitmap, derive a class from wxBitmapHandler -and add the handler using \helpref{wxBitmap::AddHandler}{wxbitmapaddhandler} in your -application initialisation. - -\wxheading{Derived from} - -\helpref{wxObject}{wxobject} - -\wxheading{See also} - -\helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor} - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxBitmapHandler::wxBitmapHandler}\label{wxbitmaphandlerconstr} - -\func{}{wxBitmapHandler}{\void} - -Default constructor. In your own default constructor, initialise the members -m\_name, m\_extension and m\_type. - -\membersection{wxBitmapHandler::\destruct{wxBitmapHandler}} - -\func{}{\destruct{wxBitmapHandler}}{\void} - -Destroys the wxBitmapHandler object. - -\membersection{wxBitmapHandler::Create} - -\func{virtual bool}{Create}{\param{wxBitmap* }{bitmap}, \param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} - -Creates a bitmap from the given data, which can be of arbitrary type. The wxBitmap object {\it bitmap} is -manipulated by this function. - -\wxheading{Parameters} - -\docparam{bitmap}{The wxBitmap object.} - -\docparam{width}{The width of the bitmap in pixels.} - -\docparam{height}{The height of the bitmap in pixels.} - -\docparam{depth}{The depth of the bitmap in pixels. If this is -1, the screen depth is used.} - -\docparam{data}{Data whose type depends on the value of {\it type}.} - -\docparam{type}{A bitmap type identifier - see \helpref{wxBitmapHandler::wxBitmapHandler}{wxbitmapconstr} for a list -of possible values.} - -\wxheading{Return value} - -TRUE if the call succeeded, FALSE otherwise (the default). - -\membersection{wxBitmapHandler::GetName} - -\constfunc{wxString}{GetName}{\void} - -Gets the name of this handler. - -\membersection{wxBitmapHandler::GetExtension} - -\constfunc{wxString}{GetExtension}{\void} - -Gets the file extension associated with this handler. - -\membersection{wxBitmapHandler::GetType} - -\constfunc{long}{GetType}{\void} - -Gets the bitmap type associated with this handler. - -\membersection{wxBitmapHandler::LoadFile}\label{wxbitmaphandlerloadfile} - -\func{bool}{LoadFile}{\param{wxBitmap* }{bitmap}, \param{const wxString\&}{ name}, \param{long}{ type}} - -Loads a bitmap from a file or resource, putting the resulting data into {\it bitmap}. - -\wxheading{Parameters} - -\docparam{bitmap}{The bitmap object which is to be affected by this operation.} - -\docparam{name}{Either a filename or a Windows resource name. -The meaning of {\it name} is determined by the {\it type} parameter.} - -\docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for values this can take.} - -\wxheading{Return value} - -TRUE if the operation succeeded, FALSE otherwise. - -\wxheading{See also} - -\helpref{wxBitmap::LoadFile}{wxbitmaploadfile}\\ -\helpref{wxBitmap::SaveFile}{wxbitmapsavefile}\\ -\helpref{wxBitmapHandler::SaveFile}{wxbitmaphandlersavefile} - -\membersection{wxBitmapHandler::SaveFile}\label{wxbitmaphandlersavefile} - -\func{bool}{SaveFile}{\param{wxBitmap* }{bitmap}, \param{const wxString\& }{name}, \param{int}{ type}, \param{wxPalette* }{palette = NULL}} - -Saves a bitmap in the named file. - -\wxheading{Parameters} - -\docparam{bitmap}{The bitmap object which is to be affected by this operation.} - -\docparam{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.} - -\docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for values this can take.} - -\docparam{palette}{An optional palette used for saving the bitmap. TODO: this parameter should -probably be eliminated; instead the app should set the palette before saving.} - -\wxheading{Return value} - -TRUE if the operation succeeded, FALSE otherwise. - -\wxheading{See also} - -\helpref{wxBitmap::LoadFile}{wxbitmaploadfile}\\ -\helpref{wxBitmap::SaveFile}{wxbitmapsavefile}\\ -\helpref{wxBitmapHandler::LoadFile}{wxbitmaphandlerloadfile} - -\membersection{wxBitmapHandler::SetName} - -\func{void}{SetName}{\param{const wxString\& }{name}} - -Sets the handler name. - -\wxheading{Parameters} - -\docparam{name}{Handler name.} - -\membersection{wxBitmapHandler::SetExtension} - -\func{void}{SetExtension}{\param{const wxString\& }{extension}} - -Sets the handler extension. - -\wxheading{Parameters} - -\docparam{extension}{Handler extension.} - -\membersection{wxBitmapHandler::SetType} - -\func{void}{SetType}{\param{long }{type}} - -Sets the handler type. - -\wxheading{Parameters} - -\docparam{name}{Handler type.} -