[wxWidgets.git] / include / wx / bitmap.h

///////////////////////////////////////////////////////////////////////////////
// Name:        wx/bitmap.h
// Purpose:     wxBitmap class interface
// Author:      Vaclav Slavik
// Modified by:
// Created:     22.04.01
// RCS-ID:      $Id$
// Copyright:   (c) wxWidgets team
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_BITMAP_H_BASE_
#define _WX_BITMAP_H_BASE_

// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------

#include "wx/string.h"
#include "wx/gdicmn.h"  // for wxBitmapType
#include "wx/colour.h"
#include "wx/image.h"

class WXDLLIMPEXP_FWD_CORE wxBitmap;
class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
class WXDLLIMPEXP_FWD_CORE wxIcon;
class WXDLLIMPEXP_FWD_CORE wxMask;
class WXDLLIMPEXP_FWD_CORE wxPalette;
class WXDLLIMPEXP_FWD_CORE wxDC;

// ----------------------------------------------------------------------------
// wxVariant support
// ----------------------------------------------------------------------------

#if wxUSE_VARIANT
#include "wx/variant.h"
DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLIMPEXP_CORE)
#endif

// ----------------------------------------------------------------------------
// wxMask represents the transparent area of the bitmap
// ----------------------------------------------------------------------------

// TODO: all implementation of wxMask, except the generic one,
//       do not derive from wxMaskBase,,, they should
class WXDLLIMPEXP_CORE wxMaskBase : public wxObject
{
public:
    // create the mask from bitmap pixels of the given colour
    bool Create(const wxBitmap& bitmap, const wxColour& colour);

#if wxUSE_PALETTE
    // create the mask from bitmap pixels with the given palette index
    bool Create(const wxBitmap& bitmap, int paletteIndex);
#endif // wxUSE_PALETTE

    // create the mask from the given mono bitmap
    bool Create(const wxBitmap& bitmap);

protected:
    // this function is called from Create() to free the existing mask data
    virtual void FreeData() = 0;

    // these functions must be overridden to implement the corresponding public
    // Create() methods, they shouldn't call FreeData() as it's already called
    // by the public wrappers
    virtual bool InitFromColour(const wxBitmap& bitmap,
                                const wxColour& colour) = 0;
    virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0;
};

#if defined(__WXDFB__) || \
    defined(__WXMAC__) || \
    defined(__WXGTK__) || \
    defined(__WXCOCOA__) || \
    defined(__WXMOTIF__) || \
    defined(__WXX11__)
    #define wxUSE_BITMAP_BASE 1
#else
    #define wxUSE_BITMAP_BASE 0
#endif

// a more readable way to tell
#define wxBITMAP_SCREEN_DEPTH       (-1)


// ----------------------------------------------------------------------------
// wxBitmapHelpers: container for various bitmap methods common to all ports.
// ----------------------------------------------------------------------------

// Unfortunately, currently wxBitmap does not inherit from wxBitmapBase on all
// platforms and this is not easy to fix. So we extract at least some common
// methods into this class from which both wxBitmapBase (and hence wxBitmap on
// all platforms where it does inherit from it) and wxBitmap in wxMSW and other
// exceptional ports (only wxPM and old wxCocoa) inherit.
class WXDLLIMPEXP_CORE wxBitmapHelpers
{
public:
    // Create a new wxBitmap from the PNG data in the given buffer.
    static wxBitmap NewFromPNGData(const void* data, size_t size);
};


// All ports except wxMSW and wxOS2 use wxBitmapHandler and wxBitmapBase as
// base class for wxBitmapHandler; wxMSW and wxOS2 use wxGDIImageHandler as
// base class since it allows some code reuse there.
#if wxUSE_BITMAP_BASE

// ----------------------------------------------------------------------------
// wxBitmapHandler: class which knows how to create/load/save bitmaps in
// different formats
// ----------------------------------------------------------------------------

class WXDLLIMPEXP_CORE wxBitmapHandler : public wxObject
{
public:
    wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
    virtual ~wxBitmapHandler() { }

    // NOTE: the following functions should be pure virtuals, but they aren't
    //       because otherwise almost all ports would have to implement
    //       them as "return false"...

    virtual bool Create(wxBitmap *WXUNUSED(bitmap), const void* WXUNUSED(data),
                         wxBitmapType WXUNUSED(type), int WXUNUSED(width), int WXUNUSED(height),
                         int WXUNUSED(depth) = 1)
        { return false; }

    virtual bool LoadFile(wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
                           wxBitmapType WXUNUSED(type), int WXUNUSED(desiredWidth),
                           int WXUNUSED(desiredHeight))
        { return false; }

    virtual bool SaveFile(const wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
                           wxBitmapType WXUNUSED(type), const wxPalette *WXUNUSED(palette) = NULL) const
        { return false; }

    void SetName(const wxString& name)      { m_name = name; }
    void SetExtension(const wxString& ext)  { m_extension = ext; }
    void SetType(wxBitmapType type)         { m_type = type; }
    const wxString& GetName() const         { return m_name; }
    const wxString& GetExtension() const    { return m_extension; }
    wxBitmapType GetType() const            { return m_type; }

private:
    wxString      m_name;
    wxString      m_extension;
    wxBitmapType  m_type;

    DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
};

// ----------------------------------------------------------------------------
// wxBitmap: class which represents platform-dependent bitmap (unlike wxImage)
// ----------------------------------------------------------------------------

class WXDLLIMPEXP_CORE wxBitmapBase : public wxGDIObject,
                                      public wxBitmapHelpers
{
public:
    /*
    Derived class must implement these:

    wxBitmap();
    wxBitmap(const wxBitmap& bmp);
    wxBitmap(const char bits[], int width, int height, int depth = 1);
    wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
    wxBitmap(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH);
    wxBitmap(const char* const* bits);
    wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
    wxBitmap(const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH);

    static void InitStandardHandlers();
    */

    virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
    virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
    virtual bool CreateScaled(int w, int h, int d, double logicalScale)
        { return Create(w*logicalScale,h*logicalScale,d); }

    virtual int GetHeight() const = 0;
    virtual int GetWidth() const = 0;
    virtual int GetDepth() const = 0;

    wxSize GetSize() const
        { return wxSize(GetWidth(), GetHeight()); }

    // support for scaled bitmaps
    virtual double GetScaleFactor() const { return 1.0; }
    virtual double GetScaledWidth() const { return GetWidth() / GetScaleFactor(); }
    virtual double GetScaledHeight() const { return GetHeight() / GetScaleFactor(); }
    virtual wxSize GetScaledSize() const
    { return wxSize(GetScaledWidth(), GetScaledHeight()); }

#if wxUSE_IMAGE
    virtual wxImage ConvertToImage() const = 0;

    // Convert to disabled (dimmed) bitmap.
    wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;
#endif // wxUSE_IMAGE

    virtual wxMask *GetMask() const = 0;
    virtual void SetMask(wxMask *mask) = 0;

    virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;

    virtual bool SaveFile(const wxString &name, wxBitmapType type,
                          const wxPalette *palette = NULL) const = 0;
    virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;

    /*
       If raw bitmap access is supported (see wx/rawbmp.h), the following
       methods should be implemented:

       virtual bool GetRawData(wxRawBitmapData *data) = 0;
       virtual void UngetRawData(wxRawBitmapData *data) = 0;
     */

#if wxUSE_PALETTE
    virtual wxPalette *GetPalette() const = 0;
    virtual void SetPalette(const wxPalette& palette) = 0;
#endif // wxUSE_PALETTE

    // copies the contents and mask of the given (colour) icon to the bitmap
    virtual bool CopyFromIcon(const wxIcon& icon) = 0;

    // implementation:
    virtual void SetHeight(int height) = 0;
    virtual void SetWidth(int width) = 0;
    virtual void SetDepth(int depth) = 0;

    // Format handling
    static inline wxList& GetHandlers() { return sm_handlers; }
    static void AddHandler(wxBitmapHandler *handler);
    static void InsertHandler(wxBitmapHandler *handler);
    static bool RemoveHandler(const wxString& name);
    static wxBitmapHandler *FindHandler(const wxString& name);
    static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);
    static wxBitmapHandler *FindHandler(wxBitmapType bitmapType);

    //static void InitStandardHandlers();
    //  (wxBitmap must implement this one)

    static void CleanUpHandlers();

    // this method is only used by the generic implementation of wxMask
    // currently but could be useful elsewhere in the future: it can be
    // overridden to quantize the colour to correspond to bitmap colour depth
    // if necessary; default implementation simply returns the colour as is
    virtual wxColour QuantizeColour(const wxColour& colour) const
    {
        return colour;
    }

protected:
    static wxList sm_handlers;

    DECLARE_ABSTRACT_CLASS(wxBitmapBase)
};

#endif // wxUSE_BITMAP_BASE


// the wxBITMAP_DEFAULT_TYPE constant defines the default argument value
// for wxBitmap's ctor and wxBitmap::LoadFile() functions.
#if defined(__WXMSW__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE
    #include "wx/msw/bitmap.h"
#elif defined(__WXMOTIF__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM
    #include "wx/x11/bitmap.h"
#elif defined(__WXGTK20__)
    #ifdef __WINDOWS__
        #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE
    #else
        #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM
    #endif
    #include "wx/gtk/bitmap.h"
#elif defined(__WXGTK__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM
    #include "wx/gtk1/bitmap.h"
#elif defined(__WXX11__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_XPM
    #include "wx/x11/bitmap.h"
#elif defined(__WXDFB__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE
    #include "wx/dfb/bitmap.h"
#elif defined(__WXMAC__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_PICT_RESOURCE
    #include "wx/osx/bitmap.h"
#elif defined(__WXCOCOA__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE
    #include "wx/cocoa/bitmap.h"
#elif defined(__WXPM__)
    #define wxBITMAP_DEFAULT_TYPE    wxBITMAP_TYPE_BMP_RESOURCE
    #include "wx/os2/bitmap.h"
#endif

#if wxUSE_IMAGE
inline
wxBitmap
#if wxUSE_BITMAP_BASE
wxBitmapBase::
#else
wxBitmap::
#endif
ConvertToDisabled(unsigned char brightness) const
{
    return ConvertToImage().ConvertToDisabled(brightness);
}
#endif // wxUSE_IMAGE

// we must include generic mask.h after wxBitmap definition
#if defined(__WXDFB__)
    #define wxUSE_GENERIC_MASK 1
#else
    #define wxUSE_GENERIC_MASK 0
#endif

#if wxUSE_GENERIC_MASK
    #include "wx/generic/mask.h"
#endif

#endif // _WX_BITMAP_H_BASE_
Commit	Line	Data
1e6feb95 VZ	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/bitmap.h
	3	// Purpose: wxBitmap class interface
	4	// Author: Vaclav Slavik
	5	// Modified by:
	6	// Created: 22.04.01
	7	// RCS-ID: $Id$
77ffb593	8	// Copyright: (c) wxWidgets team
65571936	9	// Licence: wxWindows licence
1e6feb95 VZ	10	///////////////////////////////////////////////////////////////////////////////
1e6feb95 VZ	11
34138703 JS	12	#ifndef _WX_BITMAP_H_BASE_
34138703 JS	13	#define _WX_BITMAP_H_BASE_
c801d85f	14
1e6feb95 VZ	15	// ----------------------------------------------------------------------------
	16	// headers
	17	// ----------------------------------------------------------------------------
	18
1e6feb95	19	#include "wx/string.h"
22bd9387	20	#include "wx/gdicmn.h" // for wxBitmapType
acb53ea5	21	#include "wx/colour.h"
ac04aa99	22	#include "wx/image.h"
1e6feb95	23
b5dbe15d VS	24	class WXDLLIMPEXP_FWD_CORE wxBitmap;
	25	class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
	26	class WXDLLIMPEXP_FWD_CORE wxIcon;
b5dbe15d VS	27	class WXDLLIMPEXP_FWD_CORE wxMask;
b5dbe15d VS	28	class WXDLLIMPEXP_FWD_CORE wxPalette;
a85ccd79	29	class WXDLLIMPEXP_FWD_CORE wxDC;
1e6feb95	30
6f5d7825 RR	31	// ----------------------------------------------------------------------------
	32	// wxVariant support
	33	// ----------------------------------------------------------------------------
	34
	35	#if wxUSE_VARIANT
	36	#include "wx/variant.h"
53a2db12	37	DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLIMPEXP_CORE)
6f5d7825 RR	38	#endif
6f5d7825 RR	39
87f83ac8 VZ	40	// ----------------------------------------------------------------------------
	41	// wxMask represents the transparent area of the bitmap
	42	// ----------------------------------------------------------------------------
	43
e86f2cc8 FM	44	// TODO: all implementation of wxMask, except the generic one,
e86f2cc8 FM	45	// do not derive from wxMaskBase,,, they should
53a2db12	46	class WXDLLIMPEXP_CORE wxMaskBase : public wxObject
87f83ac8 VZ	47	{
	48	public:
	49	// create the mask from bitmap pixels of the given colour
	50	bool Create(const wxBitmap& bitmap, const wxColour& colour);
	51
	52	#if wxUSE_PALETTE
	53	// create the mask from bitmap pixels with the given palette index
	54	bool Create(const wxBitmap& bitmap, int paletteIndex);
	55	#endif // wxUSE_PALETTE
	56
	57	// create the mask from the given mono bitmap
	58	bool Create(const wxBitmap& bitmap);
	59
	60	protected:
	61	// this function is called from Create() to free the existing mask data
	62	virtual void FreeData() = 0;
	63
	64	// these functions must be overridden to implement the corresponding public
	65	// Create() methods, they shouldn't call FreeData() as it's already called
	66	// by the public wrappers
	67	virtual bool InitFromColour(const wxBitmap& bitmap,
	68	const wxColour& colour) = 0;
	69	virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0;
	70	};
	71
0e1f8ea4	72	#if defined(__WXDFB__) \|\| \
d22004c4	73	defined(__WXMAC__) \|\| \
4611dd06	74	defined(__WXGTK__) \|\| \
d22004c4 WS	75	defined(__WXCOCOA__) \|\| \
	76	defined(__WXMOTIF__) \|\| \
	77	defined(__WXX11__)
91885f46 VZ	78	#define wxUSE_BITMAP_BASE 1
	79	#else
	80	#define wxUSE_BITMAP_BASE 0
	81	#endif
	82
e86f2cc8 FM	83	// a more readable way to tell
	84	#define wxBITMAP_SCREEN_DEPTH (-1)
	85
	86
20e6714a VZ	87	// ----------------------------------------------------------------------------
	88	// wxBitmapHelpers: container for various bitmap methods common to all ports.
	89	// ----------------------------------------------------------------------------
	90
	91	// Unfortunately, currently wxBitmap does not inherit from wxBitmapBase on all
	92	// platforms and this is not easy to fix. So we extract at least some common
c3f641cb	93	// methods into this class from which both wxBitmapBase (and hence wxBitmap on
20e6714a VZ	94	// all platforms where it does inherit from it) and wxBitmap in wxMSW and other
	95	// exceptional ports (only wxPM and old wxCocoa) inherit.
	96	class WXDLLIMPEXP_CORE wxBitmapHelpers
	97	{
	98	public:
	99	// Create a new wxBitmap from the PNG data in the given buffer.
	100	static wxBitmap NewFromPNGData(const void* data, size_t size);
	101	};
	102
	103
bd362275 VZ	104	// All ports except wxMSW and wxOS2 use wxBitmapHandler and wxBitmapBase as
	105	// base class for wxBitmapHandler; wxMSW and wxOS2 use wxGDIImageHandler as
	106	// base class since it allows some code reuse there.
91885f46	107	#if wxUSE_BITMAP_BASE
b496583b	108
1e6feb95 VZ	109	// ----------------------------------------------------------------------------
	110	// wxBitmapHandler: class which knows how to create/load/save bitmaps in
	111	// different formats
	112	// ----------------------------------------------------------------------------
	113
53a2db12	114	class WXDLLIMPEXP_CORE wxBitmapHandler : public wxObject
1e6feb95 VZ	115	{
1e6feb95 VZ	116	public:
e86f2cc8 FM	117	wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
	118	virtual ~wxBitmapHandler() { }
	119
	120	// NOTE: the following functions should be pure virtuals, but they aren't
	121	// because otherwise almost all ports would have to implement
	122	// them as "return false"...
1e6feb95	123
e86f2cc8 FM	124	virtual bool Create(wxBitmap WXUNUSED(bitmap), const void WXUNUSED(data),
	125	wxBitmapType WXUNUSED(type), int WXUNUSED(width), int WXUNUSED(height),
	126	int WXUNUSED(depth) = 1)
	127	{ return false; }
	128
	129	virtual bool LoadFile(wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
	130	wxBitmapType WXUNUSED(type), int WXUNUSED(desiredWidth),
	131	int WXUNUSED(desiredHeight))
	132	{ return false; }
	133
	134	virtual bool SaveFile(const wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
	135	wxBitmapType WXUNUSED(type), const wxPalette *WXUNUSED(palette) = NULL) const
	136	{ return false; }
1e6feb95	137
4b61c88d RR	138	void SetName(const wxString& name) { m_name = name; }
	139	void SetExtension(const wxString& ext) { m_extension = ext; }
	140	void SetType(wxBitmapType type) { m_type = type; }
452418c4 PC	141	const wxString& GetName() const { return m_name; }
452418c4 PC	142	const wxString& GetExtension() const { return m_extension; }
4b61c88d RR	143	wxBitmapType GetType() const { return m_type; }
	144
	145	private:
1e6feb95 VZ	146	wxString m_name;
	147	wxString m_extension;
	148	wxBitmapType m_type;
	149
e86f2cc8	150	DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
1e6feb95 VZ	151	};
1e6feb95 VZ	152
e86f2cc8 FM	153	// ----------------------------------------------------------------------------
	154	// wxBitmap: class which represents platform-dependent bitmap (unlike wxImage)
	155	// ----------------------------------------------------------------------------
	156
20e6714a VZ	157	class WXDLLIMPEXP_CORE wxBitmapBase : public wxGDIObject,
20e6714a VZ	158	public wxBitmapHelpers
1e6feb95 VZ	159	{
1e6feb95 VZ	160	public:
1e6feb95 VZ	161	/*
	162	Derived class must implement these:
	163
	164	wxBitmap();
e86f2cc8	165	wxBitmap(const wxBitmap& bmp);
1e6feb95	166	wxBitmap(const char bits[], int width, int height, int depth = 1);
e86f2cc8	167	wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
732d8c74	168	wxBitmap(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH);
452418c4	169	wxBitmap(const char* const* bits);
1e6feb95	170	wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
e86f2cc8	171	wxBitmap(const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH);
1e6feb95 VZ	172
	173	static void InitStandardHandlers();
	174	*/
	175
e86f2cc8	176	virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
732d8c74	177	virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
a066916b	178	virtual bool CreateScaled(int w, int h, int d, double logicalScale)
b5ec0c78	179	{ return Create(wlogicalScale,hlogicalScale,d); }
e86f2cc8	180
1e6feb95 VZ	181	virtual int GetHeight() const = 0;
	182	virtual int GetWidth() const = 0;
	183	virtual int GetDepth() const = 0;
	184
c74b07ac FM	185	wxSize GetSize() const
	186	{ return wxSize(GetWidth(), GetHeight()); }
	187
9afa58e3	188	// support for scaled bitmaps
a85ccd79 SC	189	virtual double GetScaleFactor() const { return 1.0; }
	190	virtual double GetScaledWidth() const { return GetWidth() / GetScaleFactor(); }
	191	virtual double GetScaledHeight() const { return GetHeight() / GetScaleFactor(); }
9afa58e3 SC	192	virtual wxSize GetScaledSize() const
	193	{ return wxSize(GetScaledWidth(), GetScaledHeight()); }
	194
c0521644	195	#if wxUSE_IMAGE
1e6feb95	196	virtual wxImage ConvertToImage() const = 0;
ac04aa99 VZ	197
	198	// Convert to disabled (dimmed) bitmap.
	199	wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;
c0521644	200	#endif // wxUSE_IMAGE
1e6feb95 VZ	201
	202	virtual wxMask *GetMask() const = 0;
	203	virtual void SetMask(wxMask *mask) = 0;
	204
	205	virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;
	206
	207	virtual bool SaveFile(const wxString &name, wxBitmapType type,
d3b9f782	208	const wxPalette *palette = NULL) const = 0;
1e6feb95 VZ	209	virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;
1e6feb95 VZ	210
f28e099e VZ	211	/*
	212	If raw bitmap access is supported (see wx/rawbmp.h), the following
	213	methods should be implemented:
	214
	215	virtual bool GetRawData(wxRawBitmapData *data) = 0;
	216	virtual void UngetRawData(wxRawBitmapData *data) = 0;
	217	*/
	218
	219	#if wxUSE_PALETTE
1e6feb95 VZ	220	virtual wxPalette *GetPalette() const = 0;
1e6feb95 VZ	221	virtual void SetPalette(const wxPalette& palette) = 0;
f28e099e	222	#endif // wxUSE_PALETTE
1e6feb95	223
1e6feb95 VZ	224	// copies the contents and mask of the given (colour) icon to the bitmap
	225	virtual bool CopyFromIcon(const wxIcon& icon) = 0;
	226
	227	// implementation:
	228	virtual void SetHeight(int height) = 0;
	229	virtual void SetWidth(int width) = 0;
	230	virtual void SetDepth(int depth) = 0;
	231
	232	// Format handling
	233	static inline wxList& GetHandlers() { return sm_handlers; }
e86f2cc8 FM	234	static void AddHandler(wxBitmapHandler *handler);
e86f2cc8 FM	235	static void InsertHandler(wxBitmapHandler *handler);
1e6feb95 VZ	236	static bool RemoveHandler(const wxString& name);
	237	static wxBitmapHandler *FindHandler(const wxString& name);
	238	static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);
	239	static wxBitmapHandler *FindHandler(wxBitmapType bitmapType);
	240
	241	//static void InitStandardHandlers();
	242	// (wxBitmap must implement this one)
	243
	244	static void CleanUpHandlers();
	245
87f83ac8 VZ	246	// this method is only used by the generic implementation of wxMask
	247	// currently but could be useful elsewhere in the future: it can be
	248	// overridden to quantize the colour to correspond to bitmap colour depth
	249	// if necessary; default implementation simply returns the colour as is
	250	virtual wxColour QuantizeColour(const wxColour& colour) const
	251	{
	252	return colour;
	253	}
	254
1e6feb95 VZ	255	protected:
	256	static wxList sm_handlers;
	257
	258	DECLARE_ABSTRACT_CLASS(wxBitmapBase)
	259	};
91885f46 VZ	260
91885f46 VZ	261	#endif // wxUSE_BITMAP_BASE
1e6feb95	262
cbea3ec6 FM	263
	264	// the wxBITMAP_DEFAULT_TYPE constant defines the default argument value
	265	// for wxBitmap's ctor and wxBitmap::LoadFile() functions.
bd362275	266	#if defined(__WXMSW__)
cbea3ec6	267	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46	268	#include "wx/msw/bitmap.h"
2049ba38	269	#elif defined(__WXMOTIF__)
cbea3ec6	270	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
91885f46	271	#include "wx/x11/bitmap.h"
1be7a35c	272	#elif defined(__WXGTK20__)
327972e7 VZ	273	#ifdef __WINDOWS__
	274	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
	275	#else
	276	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
	277	#endif
91885f46	278	#include "wx/gtk/bitmap.h"
1be7a35c	279	#elif defined(__WXGTK__)
cbea3ec6	280	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
91885f46	281	#include "wx/gtk1/bitmap.h"
83df96d6	282	#elif defined(__WXX11__)
cbea3ec6	283	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
91885f46	284	#include "wx/x11/bitmap.h"
b3c86150	285	#elif defined(__WXDFB__)
4ca8531f	286	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46	287	#include "wx/dfb/bitmap.h"
34138703	288	#elif defined(__WXMAC__)
cbea3ec6	289	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_PICT_RESOURCE
ef0e9220	290	#include "wx/osx/bitmap.h"
fed66a87	291	#elif defined(__WXCOCOA__)
cbea3ec6	292	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46	293	#include "wx/cocoa/bitmap.h"
1777b9bb	294	#elif defined(__WXPM__)
cbea3ec6	295	#define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46	296	#include "wx/os2/bitmap.h"
c801d85f KB	297	#endif
c801d85f KB	298
ac04aa99 VZ	299	#if wxUSE_IMAGE
	300	inline
	301	wxBitmap
	302	#if wxUSE_BITMAP_BASE
	303	wxBitmapBase::
	304	#else
	305	wxBitmap::
	306	#endif
	307	ConvertToDisabled(unsigned char brightness) const
	308	{
	309	return ConvertToImage().ConvertToDisabled(brightness);
	310	}
	311	#endif // wxUSE_IMAGE
	312
87f83ac8	313	// we must include generic mask.h after wxBitmap definition
0e1f8ea4	314	#if defined(__WXDFB__)
87f83ac8 VZ	315	#define wxUSE_GENERIC_MASK 1
	316	#else
	317	#define wxUSE_GENERIC_MASK 0
	318	#endif
	319
	320	#if wxUSE_GENERIC_MASK
	321	#include "wx/generic/mask.h"
	322	#endif
	323
91885f46	324	#endif // _WX_BITMAP_H_BASE_