Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

revised base64.h;bitmap.h

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52553 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-15 18:15:46 +00:00
parent 390f44afb6
commit 698d17c32c
3 changed files with 460 additions and 436 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
interface/base64.h
View File

@@ -6,38 +6,69 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// ============================================================================
// Global functions/macros
// ============================================================================
/** @ingroup group_funcmacro_misc */
//@{ //@{
/** /**
These functions encode the given data using base64. The first of them is the This function encodes the given data using base64.
raw encoding function writing the output string into provided buffer while the
other ones return the output as wxString. There is no error return for these To allocate the buffer of the correct size, use wxBase64EncodedSize() or call
functions except for the first one which returns @c wxCONV_FAILED if the this function with @a dst set to @NULL -- it will then return the necessary
output buffer is too small. To allocate the buffer of the correct size, use buffer size.
wxBase64EncodedSize() or call this function with
@a dst set to @NULL -- it will then return the necessary buffer size. This raw encoding function overload writes the output string into the
provided buffer; the other overloads return it as a wxString.
@param dst @param dst
The output buffer, may be @NULL to retrieve the needed buffer The output buffer, may be @NULL to retrieve the needed buffer size.
size.
@param dstLen @param dstLen
The output buffer size, ignored if dst is @NULL. The output buffer size, ignored if dst is @NULL.
@param src @param src
The input buffer, must not be @NULL. The input buffer, must not be @NULL.
@param srcLen @param srcLen
The length of the input data. The length of the input data.
@returns @c wxCONV_FAILED if the output buffer is too small.
*/ */
size_t wxBase64Encode(char* dst, size_t dstLen, size_t wxBase64Encode(char* dst, size_t dstLen,
const void* src, const void* src,
size_t srcLen); size_t srcLen);
/**
This function encodes the given data using base64 and returns the output
as a wxString.
There is no error return.
To allocate the buffer of the correct size, use wxBase64EncodedSize() or call
this function with @a dst set to @NULL -- it will then return the necessary
buffer size.
@param src
The input buffer, must not be @NULL.
@param srcLen
The length of the input data.
*/
wxString wxBase64Encode(const void* src, size_t srcLen); wxString wxBase64Encode(const void* src, size_t srcLen);
/**
This function encodes the given data using base64 and returns the output
as a wxString.
There is no error return.
*/
wxString wxBase64Encode(const wxMemoryBuffer& buf); wxString wxBase64Encode(const wxMemoryBuffer& buf);
//@}
/** /**
Returns the size of the buffer necessary to contain the data encoded in a Returns the size of the buffer necessary to contain the data encoded in a
base64 string of length @e srcLen. This can be useful for allocating a base64 string of length @e srcLen. This can be useful for allocating a
buffer to be passed to wxBase64Decode(). buffer to be passed to wxBase64Decode().
*/ */
size_t wxBase64DecodedSize(size_t srcLen); size_t wxBase64DecodedSize(size_t srcLen);
@@ -48,41 +79,34 @@ size_t wxBase64DecodedSize(size_t srcLen);
*/ */
size_t wxBase64EncodedSize(size_t len); size_t wxBase64EncodedSize(size_t len);
//@{
/** /**
These function decode a Base64-encoded string. The first version is a raw This function decodes a Base64-encoded string.
decoding function and decodes the data into the provided buffer @a dst of
the given size @e dstLen. An error is returned if the buffer is not large This overload is a raw decoding function and decodes the data into the provided
enough -- that is not at least wxBase64DecodedSize(srcLen)() buffer @a dst of the given size @e dstLen. An error is returned if the buffer
bytes. The second version allocates memory internally and returns it as is not large enough -- that is not at least wxBase64DecodedSize(srcLen)() bytes.
wxMemoryBuffer and is recommended for normal use.
The first version returns the number of bytes written to the buffer or the This overload returns the number of bytes written to the buffer or the
necessary buffer size if @a dst was @NULL or @c wxCONV_FAILED on necessary buffer size if @a dst was @NULL or @c wxCONV_FAILED on
error, e.g. if the output buffer is too small or invalid characters were error, e.g. if the output buffer is too small or invalid characters were
encountered in the input string. The second version returns a buffer with the encountered in the input string.
base64 decoded binary equivalent of the input string. In neither case is the
buffer NUL-terminated.
@param dst @param dst
Pointer to output buffer, may be @NULL to just compute the Pointer to output buffer, may be @NULL to just compute the
necessary buffer size. necessary buffer size.
@param dstLen @param dstLen
The size of the output buffer, ignored if dst is The size of the output buffer, ignored if dst is @NULL.
@NULL.
@param src @param src
The input string, must not be @NULL. For the version using The input string, must not be @NULL. For the version using
wxString, the input string should contain only ASCII characters. wxString, the input string should contain only ASCII characters.
@param srcLen @param srcLen
The length of the input string or special value The length of the input string or special value wxNO_LEN if the string is
wxNO_LEN if the string is NUL-terminated and the length should be NUL-terminated and the length should be computed by this function itself.
computed by this function itself.
@param mode @param mode
This parameter specifies the function behaviour when invalid This parameter specifies the function behaviour when invalid characters
characters are encountered in input. By default, any such character stops are encountered in input. By default, any such character stops the
the
decoding with error. If the mode is wxBase64DecodeMode_SkipWS, then the decoding with error. If the mode is wxBase64DecodeMode_SkipWS, then the
white white space characters are silently skipped instead. And if it is
space characters are silently skipped instead. And if it is
wxBase64DecodeMode_Relaxed, then all invalid characters are skipped. wxBase64DecodeMode_Relaxed, then all invalid characters are skipped.
@param posErr @param posErr
If this pointer is non-@NULL and an error occurs during If this pointer is non-@NULL and an error occurs during
@@ -93,12 +117,32 @@ size_t wxBase64Decode(void* dst, size_t dstLen,
size_t srcLen = wxNO_LEN, size_t srcLen = wxNO_LEN,
wxBase64DecodeMode mode = wxBase64DecodeMode_Strict, wxBase64DecodeMode mode = wxBase64DecodeMode_Strict,
size_t posErr = NULL); size_t posErr = NULL);
/**
See the wxBase64Decode(void*,size_t,const char*,size_t,wxBase64DecodeMode,size_t)
overload for more info about the parameters of this function.
This overload allocates memory internally and returns it as wxMemoryBuffer
and is recommended for normal use.
This overload returns a buffer with the base64 decoded binary equivalent
of the input string. In neither case is the buffer @NULL-terminated.
*/
wxMemoryBuffer wxBase64Decode(const char* src, wxMemoryBuffer wxBase64Decode(const char* src,
size_t srcLen = wxNO_LEN, size_t srcLen = wxNO_LEN,
wxBase64DecodeMode mode = wxBase64DecodeMode_Strict, wxBase64DecodeMode mode = wxBase64DecodeMode_Strict,
size_t posErr = NULL); size_t posErr = NULL);
/**
See the wxBase64Decode(void*,size_t,const char*,size_t,wxBase64DecodeMode,size_t)
overload for more info about the parameters of this function.
This overload takes as input a wxString and returns the internally-allocated
memory as a wxMemoryBuffer, containing the base64 decoded data.
*/
wxMemoryBuffer wxBase64Decode(const wxString& src, wxMemoryBuffer wxBase64Decode(const wxString& src,
wxBase64DecodeMode mode = wxBase64DecodeMode_Strict, wxBase64DecodeMode mode = wxBase64DecodeMode_Strict,
size_t posErr = NULL); size_t posErr = NULL);
//@} //@}

595
interface/bitmap.h
View File

@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// Name: bitmap.h // Name: bitmap.h
// Purpose: interface of wxBitmapHandler // Purpose: interface of wxBitmap* classes
// Author: wxWidgets team // Author: wxWidgets team
// RCS-ID: $Id$ // RCS-ID: $Id$
// Licence: wxWindows license // Licence: wxWindows license
@@ -10,28 +10,27 @@
@class wxBitmapHandler @class wxBitmapHandler
@wxheader{bitmap.h} @wxheader{bitmap.h}
Overview() This is the base class for implementing bitmap file loading/saving, and
bitmap creation from data.
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. 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 If you wish to extend the capabilities of wxBitmap, derive a class from
wxBitmapHandler wxBitmapHandler and add the handler using wxBitmap::AddHandler in your
and add the handler using wxBitmap::AddHandler in your
application initialisation. application initialisation.
@library{wxcore} @library{wxcore}
@category{FIXME} @category{misc}
@see wxBitmap, wxIcon, wxCursor @see @ref overview_bitmap, wxBitmap, wxIcon, wxCursor
*/ */
class wxBitmapHandler : public wxObject class wxBitmapHandler : public wxObject
{ {
public: public:
/** /**
Default constructor. In your own default constructor, initialise the members Default constructor.
m_name, m_extension and m_type.
In your own default constructor, initialise the members m_name,
m_extension and m_type.
*/ */
wxBitmapHandler(); wxBitmapHandler();
@@ -41,9 +40,8 @@ public:
~wxBitmapHandler(); ~wxBitmapHandler();
/** /**
Creates a bitmap from the given data, which can be of arbitrary type. The Creates a bitmap from the given data, which can be of arbitrary type.
wxBitmap object @a bitmap is The wxBitmap object @a bitmap is manipulated by this function.
manipulated by this function.
@param bitmap @param bitmap
The wxBitmap object. The wxBitmap object.
@@ -56,15 +54,15 @@ public:
@param data @param data
Data whose type depends on the value of type. Data whose type depends on the value of type.
@param type @param type
A bitmap type identifier - see wxBitmapHandler() for a list A bitmap type identifier - see ::wxBitmapType for a list
of possible values. of possible values.
@todo why type is an int and not a wxBitmapType?
@returns @true if the call succeeded, @false otherwise (the default). @returns @true if the call succeeded, @false otherwise (the default).
*/ */
virtual bool Create(wxBitmap* bitmap, const void* data, int type, virtual bool Create(wxBitmap* bitmap, const void* data, int type,
int width, int width, int height, int depth = -1);
int height,
int depth = -1);
/** /**
Gets the file extension associated with this handler. Gets the file extension associated with this handler.
@@ -78,12 +76,13 @@ public:
/** /**
Gets the bitmap type associated with this handler. Gets the bitmap type associated with this handler.
@todo why type is an int and not a wxBitmapType?
*/ */
long GetType() const; long GetType() const;
/** /**
Loads a bitmap from a file or resource, putting the resulting data into @e Loads a bitmap from a file or resource, putting the resulting data into
bitmap. @a bitmap.
@param bitmap @param bitmap
The bitmap object which is to be affected by this operation. The bitmap object which is to be affected by this operation.
@@ -95,6 +94,8 @@ public:
@returns @true if the operation succeeded, @false otherwise. @returns @true if the operation succeeded, @false otherwise.
@todo why type is an int and not a wxBitmapType?
@see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile() @see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile()
*/ */
bool LoadFile(wxBitmap* bitmap, const wxString& name, long type); bool LoadFile(wxBitmap* bitmap, const wxString& name, long type);
@@ -113,6 +114,8 @@ public:
@returns @true if the operation succeeded, @false otherwise. @returns @true if the operation succeeded, @false otherwise.
@todo why type is an int and not a wxBitmapType?
@see wxBitmap::LoadFile, wxBitmap::SaveFile, LoadFile() @see wxBitmap::LoadFile, wxBitmap::SaveFile, LoadFile()
*/ */
bool SaveFile(wxBitmap* bitmap, const wxString& name, int type, bool SaveFile(wxBitmap* bitmap, const wxString& name, int type,
@@ -137,14 +140,15 @@ public:
/** /**
Sets the handler type. Sets the handler type.
@param name @todo why type is an int and not a wxBitmapType?
@param type
Handler type. Handler type.
*/ */
void SetType(long type); void SetType(long type);
}; };
/** /**
@class wxBitmap @class wxBitmap
@wxheader{bitmap.h} @wxheader{bitmap.h}
@@ -152,35 +156,81 @@ public:
This class encapsulates the concept of a platform-dependent bitmap, This class encapsulates the concept of a platform-dependent bitmap,
either monochrome or colour or colour with alpha channel support. either monochrome or colour or colour with alpha channel support.
@note
Many wxBitmap functions take a @e type parameter, which is a value of
the ::wxBitmapType enumeration.
The validity of those values depends however on the platform where your program
is running and from the 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 load and save all formats that wxImage; see wxImage for
more info. Of course, you must have wxImage handlers loaded.
@library{wxcore} @library{wxcore}
@category{gdi} @category{gdi}
@stdobjects @stdobjects
::Objects:, ::wxNullBitmap, ::wxNullBitmap
@see @ref overview_wxbitmapoverview "wxBitmap overview", @ref @see @ref overview_bitmap, @ref overview_bitmap_supportedformats,
overview_supportedbitmapformats "supported bitmap file formats", wxDC::Blit, wxIcon, wxCursor, wxBitmap, wxMemoryDC wxDC::Blit, wxIcon, wxCursor, wxBitmap, wxMemoryDC
*/ */
class wxBitmap : public wxGDIObject class wxBitmap : public wxGDIObject
{ {
public: public:
//@{
/** /**
Creates bitmap object from the image. This has to be done Default constructor.
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 Constructs a bitmap object with no data; an assignment or another member
current system if depth is -1) which entails that a colour reduction has function such as Create() or LoadFile() must be called subsequently.
to take place. */
When in 8-bit mode (PseudoColour mode), the GTK port will use a color cube wxBitmap();
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 Copy constructor, uses @ref overview_refcount "reference counting".
more To make a real copy, you can use:
sophisticated dithering algorithms).
On Windows, if there is a palette present (set with SetPalette), it will be @code
used when wxBitmap newBitmap = oldBitmap.GetSubBitmap(
creating the wxBitmap (most useful in 8-bit display mode). On other platforms, wxRect(0, 0, oldBitmap.GetWidth(), oldBitmap.GetHeight()));
the palette is currently ignored. @endcode
*/
wxBitmap(const wxBitmap& bitmap);
/**
Creates a bitmap from the given @a data which is interpreted in
platform-dependent manner.
@param data
Specifies the bitmap data in a platform-dependent format.
@param type
May be one of the ::wxBitmapType values and indicates which type of
bitmap does @a data contains. See the note in the class
detailed description.
@param width
Specifies the width of the bitmap.
@param height
Specifies the height of the bitmap.
@param depth
Specifies the depth of the bitmap.
If this is omitted, the display depth of the screen is used.
@todo why type is an int and not a wxBitmapType?
*/
wxBitmap(const void* data, int type, int width, int height, int depth = -1);
/**
Creates a bitmap from the given array @a bits.
You should only use this function for monochrome bitmaps (depth 1) in
portable programs: in this case the 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 CreateBitmap() API.
Under other platforms, only monochrome bitmaps may be created using this constructor
and wxImage should be used for creating colour bitmaps from static data.
@param bits @param bits
Specifies an array of pixel values. Specifies an array of pixel values.
@@ -189,128 +239,73 @@ public:
@param height @param height
Specifies the height of the bitmap. Specifies the height of the bitmap.
@param depth @param depth
Specifies the depth of the bitmap. If this is omitted, the display depth of Specifies the depth of the bitmap.
the If this is omitted, the display depth of the screen is used.
screen is used. */
wxBitmap(const char bits[], int width, int height, int depth = 1);
/**
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.
A depth of 32 including an alpha channel is supported under MSW, Mac and GTK+.
*/
wxBitmap(int width, int height, int depth = -1);
/**
Creates a bitmap from XPM data.
*/
wxBitmap(const char* const* bits);
/**
Loads a bitmap from a file or resource.
@param name @param name
This can refer to a resource name under MS Windows, or a filename under MS This can refer to a resource name or a filename under MS Windows and X.
Windows and X. Its meaning is determined by the @a type parameter.
Its meaning is determined by the type parameter.
@param type @param type
May be one of the following: May be one of the ::wxBitmapType values and indicates which type of
bitmap should be loaded. See the note in the class detailed description.
wxBITMAP_TYPE_BMP
Load a Windows bitmap file.
wxBITMAP_TYPE_BMP_RESOURCE
Load a Windows bitmap resource from the executable. Windows only.
wxBITMAP_TYPE_PICT_RESOURCE
Load a PICT image resource from the executable. Mac OS only.
wxBITMAP_TYPE_GIF
Load a GIF bitmap file.
wxBITMAP_TYPE_XBM
Load an X bitmap file.
wxBITMAP_TYPE_XPM
Load an XPM bitmap file.
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 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.
@param img
Platform-independent wxImage object.
@remarks The first form constructs a bitmap object with no data; an
assignment or another member function such as Create or
LoadFile must be called subsequently.
@see LoadFile() @see LoadFile()
*/ */
wxBitmap();
wxBitmap(const wxBitmap& bitmap);
wxBitmap(const void* data, int type, int width, int height,
int depth = -1);
wxBitmap(const char bits[], int width, int height,
int depth = 1);
wxBitmap(int width, int height, int depth = -1);
wxBitmap(const char* const* bits);
wxBitmap(const wxString& name, long type); wxBitmap(const wxString& name, long type);
/**
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.
@param img
Platform-independent wxImage object.
@param depth
Specifies the depth of the bitmap.
If this is omitted, the display depth of the screen is used.
*/
wxBitmap(const wxImage& img, int depth = -1); wxBitmap(const wxImage& img, int depth = -1);
//@}
/** /**
Destructor. Destructor.
See @ref overview_refcountdestruct "reference-counted object destruction" for See @ref overview_refcount_destruct for more info.
more info.
If the application omits to delete the bitmap explicitly, the bitmap will be If the application omits to delete the bitmap explicitly, the bitmap will be
destroyed automatically by wxWidgets when the application exits. destroyed automatically by wxWidgets when the application exits.
@warning
Do not delete a bitmap that is selected into a memory device context. Do not delete a bitmap that is selected into a memory device context.
*/ */
~wxBitmap(); ~wxBitmap();
@@ -344,55 +339,70 @@ public:
*/ */
bool CopyFromIcon(const wxIcon& icon); bool CopyFromIcon(const wxIcon& icon);
//@{
/**
Creates a fresh bitmap.
If the final argument is omitted, the display depth of the screen is used.
This overload works on all platforms.
*/
virtual bool Create(int width, int height, int depth = -1);
/** /**
Creates a bitmap from the given data, which can be of arbitrary type. Creates a bitmap from the given data, which can be of arbitrary type.
@param data
Data whose type depends on the value of type.
@param type
A bitmap type identifier; see ::wxBitmapType for the list of values.
See the note in the class detailed description for more info.
@param width @param width
The width of the bitmap in pixels. The width of the bitmap in pixels.
@param height @param height
The height of the bitmap in pixels. The height of the bitmap in pixels.
@param depth @param depth
The depth of the bitmap in pixels. If this is -1, the screen depth is used. The depth of the bitmap in pixels. If this is -1, the screen depth is used.
@param data
Data whose type depends on the value of type.
@param type
A bitmap type identifier - see wxBitmap() for a list
of possible values.
@returns @true if the call succeeded, @false otherwise. @returns @true if the call succeeded, @false otherwise.
@remarks The first form works on all platforms. The portability of the This overload depends on the @a type of data.
second form depends on the type of data.
@see wxBitmap()
*/ */
virtual bool Create(int width, int height, int depth = -1);
virtual bool Create(const void* data, int type, int width,
int height,
int depth = -1);
//@}
//@{ virtual bool Create(const void* data, int type, int width,
int height, int depth = -1);
/**
Finds the handler with the given @a name.
@returns A pointer to the handler if found, @NULL otherwise.
*/
static wxBitmapHandler* FindHandler(const wxString& name);
/**
Finds the handler associated with the given @a extension and @a type.
@param extension
The file extension, such as "bmp" (without the dot).
@param bitmapType
The bitmap type managed by the handler, see ::wxBitmapType.
@returns A pointer to the handler if found, @NULL otherwise.
*/
static wxBitmapHandler* FindHandler(const wxString& extension,
wxBitmapType bitmapType);
/** /**
Finds the handler associated with the given bitmap type. Finds the handler associated with the given bitmap type.
@param name
The handler name.
@param extension
The file extension, such as "bmp".
@param bitmapType @param bitmapType
The bitmap type, such as wxBITMAP_TYPE_BMP. The bitmap type managed by the handler, see ::wxBitmapType.
@returns A pointer to the handler if found, @NULL otherwise. @returns A pointer to the handler if found, @NULL otherwise.
@see wxBitmapHandler @see wxBitmapHandler
*/ */
static wxBitmapHandler* FindHandler(const wxString& name);
static wxBitmapHandler* FindHandler(const wxString& extension,
wxBitmapType bitmapType);
static wxBitmapHandler* FindHandler(wxBitmapType bitmapType); static wxBitmapHandler* FindHandler(wxBitmapType bitmapType);
//@}
/** /**
Gets the colour depth of the bitmap. A value of 1 indicates a Gets the colour depth of the bitmap. A value of 1 indicates a
@@ -443,8 +453,9 @@ public:
/** /**
Adds the standard bitmap format handlers, which, depending on wxWidgets Adds the standard bitmap format handlers, which, depending on wxWidgets
configuration, can be handlers for Windows bitmap, Windows bitmap resource, and configuration, can be handlers for Windows bitmap, Windows bitmap resource,
XPM. and XPM.
This function is called by wxWidgets on startup. This function is called by wxWidgets on startup.
@see wxBitmapHandler @see wxBitmapHandler
@@ -472,103 +483,25 @@ public:
@param name @param name
Either a filename or a Windows resource name. Either a filename or a Windows resource name.
The meaning of name is determined by the type parameter. The meaning of name is determined by the @a type parameter.
@param type @param type
One of the following values: One of the ::wxBitmapType values; see the note in the class
detailed description.
wxBITMAP_TYPE_BMP
Load a Windows bitmap file.
wxBITMAP_TYPE_BMP_RESOURCE
Load a Windows bitmap resource from the executable.
wxBITMAP_TYPE_PICT_RESOURCE
Load a PICT image resource from the executable. Mac OS only.
wxBITMAP_TYPE_GIF
Load a GIF bitmap file.
wxBITMAP_TYPE_XBM
Load an X bitmap file.
wxBITMAP_TYPE_XPM
Load an XPM bitmap file.
The validity of these flags depends on the platform and wxWidgets
configuration.
In addition, wxBitmap can read all formats that 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.)
@returns @true if the operation succeeded, @false otherwise. @returns @true if the operation succeeded, @false otherwise.
@remarks A palette may be associated with the bitmap if one exists @remarks A palette may be associated with the bitmap if one exists
(especially for colour Windows bitmaps), and if the (especially for colour Windows bitmaps), and if the
code supports it. You can check if one has been created code supports it. You can check if one has been created
by using the GetPalette member. by using the GetPalette() member.
@see SaveFile() @see SaveFile()
*/ */
bool LoadFile(const wxString& name, wxBitmapType type); bool LoadFile(const wxString& name, wxBitmapType type);
/** /**
Finds the handler with the given name, and removes it. The handler Finds the handler with the given name, and removes it.
is not deleted. The handler is not deleted.
@param name @param name
The handler name. The handler name.
@@ -585,63 +518,8 @@ public:
@param name @param name
A filename. The meaning of name is determined by the type parameter. A filename. The meaning of name is determined by the type parameter.
@param type @param type
One of the following values: One of the ::wxBitmapType values; see the note in the class
detailed description.
wxBITMAP_TYPE_BMP
Save a Windows bitmap file.
wxBITMAP_TYPE_GIF
Save a GIF bitmap file.
wxBITMAP_TYPE_XBM
Save an X bitmap file.
wxBITMAP_TYPE_XPM
Save an XPM bitmap file.
The validity of these flags depends on the platform and wxWidgets
configuration.
In addition, wxBitmap can save all formats that wxImage can
(wxBITMAP_TYPE_JPEG, wxBITMAP_TYPE_PNG).
(Of course you must have wxImage handlers loaded.)
@param palette @param palette
An optional palette used for saving the bitmap. An optional palette used for saving the bitmap.
@@ -658,6 +536,9 @@ public:
/** /**
Sets the depth member (does not affect the bitmap data). Sets the depth member (does not affect the bitmap data).
@todo since these functions do not affect the bitmap data,
why they exist??
@param depth @param depth
Bitmap depth. Bitmap depth.
*/ */
@@ -699,7 +580,7 @@ public:
void SetWidth(int width); void SetWidth(int width);
/** /**
Assignment operator, using @ref overview_trefcount "reference counting". Assignment operator, using @ref overview_refcount "reference counting".
@param bitmap @param bitmap
Bitmap to assign. Bitmap to assign.
@@ -707,15 +588,8 @@ public:
wxBitmap operator =(const wxBitmap& bitmap); wxBitmap operator =(const wxBitmap& bitmap);
}; };
/** /**
FIXME An empty wxBitmap object.
*/
wxBitmap Objects:
;
/**
FIXME
*/ */
wxBitmap wxNullBitmap; wxBitmap wxNullBitmap;
@@ -727,11 +601,10 @@ wxBitmap wxNullBitmap;
@wxheader{bitmap.h} @wxheader{bitmap.h}
This class encapsulates a monochrome mask bitmap, where the masked area is This class encapsulates a monochrome mask bitmap, where the masked area is
black and black and the unmasked area is white.
the unmasked area is white. When associated with a bitmap and drawn in a device
context, When associated with a bitmap and drawn in a device context, the unmasked
the unmasked area of the bitmap will be drawn, and the masked area will not be area of the bitmap will be drawn, and the masked area will not be drawn.
drawn.
@library{wxcore} @library{wxcore}
@category{gdi} @category{gdi}
@@ -741,47 +614,67 @@ wxBitmap wxNullBitmap;
class wxMask : public wxObject class wxMask : public wxObject
{ {
public: public:
//@{
/**
Default constructor.
*/
wxMask();
/** /**
Constructs a mask from a bitmap and a palette index that indicates the Constructs a mask from a bitmap and a palette index that indicates the
background. Not background.
yet implemented for GTK. Not yet implemented for GTK.
@param bitmap @param bitmap
A valid bitmap. A valid bitmap.
@param colour
A colour specifying the transparency RGB values.
@param index @param index
Index into a palette, specifying the transparency colour. Index into a palette, specifying the transparency colour.
*/ */
wxMask();
wxMask(const wxBitmap& bitmap);
wxMask(const wxBitmap& bitmap,
const wxColour& colour);
wxMask(const wxBitmap& bitmap, int index); wxMask(const wxBitmap& bitmap, int index);
//@}
/**
Constructs a mask from a monochrome bitmap.
@beginWxPythonOnly
This is the default constructor for wxMask in wxPython.
@endWxPythonOnly
*/
wxMask(const wxBitmap& bitmap);
/**
Constructs a mask from a bitmap and a colour that indicates the background.
@beginWxPythonOnly
wxPython has an alternate wxMask constructor matching this form called wxMaskColour.
@endWxPythonOnly
*/
wxMask(const wxBitmap& bitmap, const wxColour& colour);
/** /**
Destroys the wxMask object and the underlying bitmap data. Destroys the wxMask object and the underlying bitmap data.
*/ */
~wxMask(); ~wxMask();
//@{
/** /**
Constructs a mask from a bitmap and a palette index that indicates the Constructs a mask from a bitmap and a palette index that indicates the
background. Not background.
yet implemented for GTK. Not yet implemented for GTK.
@param bitmap @param bitmap
A valid bitmap. A valid bitmap.
@param colour
A colour specifying the transparency RGB values.
@param index @param index
Index into a palette, specifying the transparency colour. Index into a palette, specifying the transparency colour.
*/ */
bool Create(const wxBitmap& bitmap);
bool Create(const wxBitmap& bitmap, const wxColour& colour);
bool Create(const wxBitmap& bitmap, int index); bool Create(const wxBitmap& bitmap, int index);
//@}
/**
Constructs a mask from a monochrome bitmap.
*/
bool Create(const wxBitmap& bitmap);
/**
Constructs a mask from a bitmap and a colour that indicates the background.
*/
bool Create(const wxBitmap& bitmap, const wxColour& colour);
}; };

87
interface/gdicmn.h
View File

@@ -6,6 +6,93 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/**
Bitmap flags.
*/
enum wxBitmapType
{
wxBITMAP_TYPE_INVALID,
wxBITMAP_TYPE_BMP,
wxBITMAP_TYPE_BMP_RESOURCE,
wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
wxBITMAP_TYPE_ICO,
wxBITMAP_TYPE_ICO_RESOURCE,
wxBITMAP_TYPE_CUR,
wxBITMAP_TYPE_CUR_RESOURCE,
wxBITMAP_TYPE_XBM,
wxBITMAP_TYPE_XBM_DATA,
wxBITMAP_TYPE_XPM,
wxBITMAP_TYPE_XPM_DATA,
wxBITMAP_TYPE_TIF,
wxBITMAP_TYPE_TIF_RESOURCE,
wxBITMAP_TYPE_GIF,
wxBITMAP_TYPE_GIF_RESOURCE,
wxBITMAP_TYPE_PNG,
wxBITMAP_TYPE_PNG_RESOURCE,
wxBITMAP_TYPE_JPEG,
wxBITMAP_TYPE_JPEG_RESOURCE,
wxBITMAP_TYPE_PNM,
wxBITMAP_TYPE_PNM_RESOURCE,
wxBITMAP_TYPE_PCX,
wxBITMAP_TYPE_PCX_RESOURCE,
wxBITMAP_TYPE_PICT,
wxBITMAP_TYPE_PICT_RESOURCE,
wxBITMAP_TYPE_ICON,
wxBITMAP_TYPE_ICON_RESOURCE,
wxBITMAP_TYPE_ANI,
wxBITMAP_TYPE_IFF,
wxBITMAP_TYPE_TGA,
wxBITMAP_TYPE_MACCURSOR,
wxBITMAP_TYPE_MACCURSOR_RESOURCE,
wxBITMAP_TYPE_ANY = 50
};
/**
Standard cursors.
*/
enum wxStockCursor
{
wxCURSOR_NONE,
wxCURSOR_ARROW,
wxCURSOR_RIGHT_ARROW,
wxCURSOR_BULLSEYE,
wxCURSOR_CHAR,
wxCURSOR_CROSS,
wxCURSOR_HAND,
wxCURSOR_IBEAM,
wxCURSOR_LEFT_BUTTON,
wxCURSOR_MAGNIFIER,
wxCURSOR_MIDDLE_BUTTON,
wxCURSOR_NO_ENTRY,
wxCURSOR_PAINT_BRUSH,
wxCURSOR_PENCIL,
wxCURSOR_POINT_LEFT,
wxCURSOR_POINT_RIGHT,
wxCURSOR_QUESTION_ARROW,
wxCURSOR_RIGHT_BUTTON,
wxCURSOR_SIZENESW,
wxCURSOR_SIZENS,
wxCURSOR_SIZENWSE,
wxCURSOR_SIZEWE,
wxCURSOR_SIZING,
wxCURSOR_SPRAYCAN,
wxCURSOR_WAIT,
wxCURSOR_WATCH,
wxCURSOR_BLANK,
wxCURSOR_DEFAULT, //!< standard X11 cursor
wxCURSOR_COPY_ARROW , //!< MacOS Theme Plus arrow
// Not yet implemented for Windows
wxCURSOR_CROSS_REVERSE,
wxCURSOR_DOUBLE_ARROW,
wxCURSOR_BASED_ARROW_UP,
wxCURSOR_BASED_ARROW_DOWN,
wxCURSOR_ARROWWAIT,
wxCURSOR_MAX
};
/** /**
@class wxRealPoint @class wxRealPoint
@wxheader{gdicmn.h} @wxheader{gdicmn.h}