1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxBitmap class interface
4 // Author: Vaclav Slavik
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_BITMAP_H_BASE_
13 #define _WX_BITMAP_H_BASE_
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 #include "wx/string.h"
20 #include "wx/gdicmn.h" // for wxBitmapType
21 #include "wx/colour.h"
24 class WXDLLIMPEXP_FWD_CORE wxBitmap
;
25 class WXDLLIMPEXP_FWD_CORE wxBitmapHandler
;
26 class WXDLLIMPEXP_FWD_CORE wxIcon
;
27 class WXDLLIMPEXP_FWD_CORE wxMask
;
28 class WXDLLIMPEXP_FWD_CORE wxPalette
;
30 // ----------------------------------------------------------------------------
32 // ----------------------------------------------------------------------------
35 #include "wx/variant.h"
36 DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap
,WXDLLIMPEXP_CORE
)
39 // ----------------------------------------------------------------------------
40 // wxMask represents the transparent area of the bitmap
41 // ----------------------------------------------------------------------------
43 // TODO: all implementation of wxMask, except the generic one,
44 // do not derive from wxMaskBase,,, they should
45 class WXDLLIMPEXP_CORE wxMaskBase
: public wxObject
48 // create the mask from bitmap pixels of the given colour
49 bool Create(const wxBitmap
& bitmap
, const wxColour
& colour
);
52 // create the mask from bitmap pixels with the given palette index
53 bool Create(const wxBitmap
& bitmap
, int paletteIndex
);
54 #endif // wxUSE_PALETTE
56 // create the mask from the given mono bitmap
57 bool Create(const wxBitmap
& bitmap
);
60 // this function is called from Create() to free the existing mask data
61 virtual void FreeData() = 0;
63 // these functions must be overridden to implement the corresponding public
64 // Create() methods, they shouldn't call FreeData() as it's already called
65 // by the public wrappers
66 virtual bool InitFromColour(const wxBitmap
& bitmap
,
67 const wxColour
& colour
) = 0;
68 virtual bool InitFromMonoBitmap(const wxBitmap
& bitmap
) = 0;
71 #if defined(__WXMGL__) || \
72 defined(__WXDFB__) || \
73 defined(__WXMAC__) || \
74 defined(__WXGTK__) || \
75 defined(__WXCOCOA__) || \
76 defined(__WXMOTIF__) || \
78 #define wxUSE_BITMAP_BASE 1
80 #define wxUSE_BITMAP_BASE 0
83 // a more readable way to tell
84 #define wxBITMAP_SCREEN_DEPTH (-1)
87 // All ports except wxMSW and wxOS2 use wxBitmapHandler and wxBitmapBase as
88 // base class for wxBitmapHandler; wxMSW and wxOS2 use wxGDIImageHandler as
89 // base class since it allows some code reuse there.
92 // ----------------------------------------------------------------------------
93 // wxBitmapHandler: class which knows how to create/load/save bitmaps in
95 // ----------------------------------------------------------------------------
97 class WXDLLIMPEXP_CORE wxBitmapHandler
: public wxObject
100 wxBitmapHandler() { m_type
= wxBITMAP_TYPE_INVALID
; }
101 virtual ~wxBitmapHandler() { }
103 // NOTE: the following functions should be pure virtuals, but they aren't
104 // because otherwise almost all ports would have to implement
105 // them as "return false"...
107 virtual bool Create(wxBitmap
*WXUNUSED(bitmap
), const void* WXUNUSED(data
),
108 wxBitmapType
WXUNUSED(type
), int WXUNUSED(width
), int WXUNUSED(height
),
109 int WXUNUSED(depth
) = 1)
112 virtual bool LoadFile(wxBitmap
*WXUNUSED(bitmap
), const wxString
& WXUNUSED(name
),
113 wxBitmapType
WXUNUSED(type
), int WXUNUSED(desiredWidth
),
114 int WXUNUSED(desiredHeight
))
117 virtual bool SaveFile(const wxBitmap
*WXUNUSED(bitmap
), const wxString
& WXUNUSED(name
),
118 wxBitmapType
WXUNUSED(type
), const wxPalette
*WXUNUSED(palette
) = NULL
) const
121 void SetName(const wxString
& name
) { m_name
= name
; }
122 void SetExtension(const wxString
& ext
) { m_extension
= ext
; }
123 void SetType(wxBitmapType type
) { m_type
= type
; }
124 const wxString
& GetName() const { return m_name
; }
125 const wxString
& GetExtension() const { return m_extension
; }
126 wxBitmapType
GetType() const { return m_type
; }
130 wxString m_extension
;
133 DECLARE_ABSTRACT_CLASS(wxBitmapHandler
)
137 // ----------------------------------------------------------------------------
138 // wxBitmap: class which represents platform-dependent bitmap (unlike wxImage)
139 // ----------------------------------------------------------------------------
141 class WXDLLIMPEXP_CORE wxBitmapBase
: public wxGDIObject
145 Derived class must implement these:
148 wxBitmap(const wxBitmap& bmp);
149 wxBitmap(const char bits[], int width, int height, int depth = 1);
150 wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
151 wxBitmap(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH);
152 wxBitmap(const char* const* bits);
153 wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
154 wxBitmap(const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH);
156 static void InitStandardHandlers();
159 virtual bool Create(int width
, int height
, int depth
= wxBITMAP_SCREEN_DEPTH
) = 0;
160 virtual bool Create(const wxSize
& sz
, int depth
= wxBITMAP_SCREEN_DEPTH
) = 0;
162 virtual int GetHeight() const = 0;
163 virtual int GetWidth() const = 0;
164 virtual int GetDepth() const = 0;
166 wxSize
GetSize() const
167 { return wxSize(GetWidth(), GetHeight()); }
170 virtual wxImage
ConvertToImage() const = 0;
172 // Convert to disabled (dimmed) bitmap.
173 wxBitmap
ConvertToDisabled(unsigned char brightness
= 255) const;
174 #endif // wxUSE_IMAGE
176 virtual wxMask
*GetMask() const = 0;
177 virtual void SetMask(wxMask
*mask
) = 0;
179 virtual wxBitmap
GetSubBitmap(const wxRect
& rect
) const = 0;
181 virtual bool SaveFile(const wxString
&name
, wxBitmapType type
,
182 const wxPalette
*palette
= NULL
) const = 0;
183 virtual bool LoadFile(const wxString
&name
, wxBitmapType type
) = 0;
186 If raw bitmap access is supported (see wx/rawbmp.h), the following
187 methods should be implemented:
189 virtual bool GetRawData(wxRawBitmapData *data) = 0;
190 virtual void UngetRawData(wxRawBitmapData *data) = 0;
194 virtual wxPalette
*GetPalette() const = 0;
195 virtual void SetPalette(const wxPalette
& palette
) = 0;
196 #endif // wxUSE_PALETTE
198 // copies the contents and mask of the given (colour) icon to the bitmap
199 virtual bool CopyFromIcon(const wxIcon
& icon
) = 0;
202 virtual void SetHeight(int height
) = 0;
203 virtual void SetWidth(int width
) = 0;
204 virtual void SetDepth(int depth
) = 0;
207 static inline wxList
& GetHandlers() { return sm_handlers
; }
208 static void AddHandler(wxBitmapHandler
*handler
);
209 static void InsertHandler(wxBitmapHandler
*handler
);
210 static bool RemoveHandler(const wxString
& name
);
211 static wxBitmapHandler
*FindHandler(const wxString
& name
);
212 static wxBitmapHandler
*FindHandler(const wxString
& extension
, wxBitmapType bitmapType
);
213 static wxBitmapHandler
*FindHandler(wxBitmapType bitmapType
);
215 //static void InitStandardHandlers();
216 // (wxBitmap must implement this one)
218 static void CleanUpHandlers();
220 // this method is only used by the generic implementation of wxMask
221 // currently but could be useful elsewhere in the future: it can be
222 // overridden to quantize the colour to correspond to bitmap colour depth
223 // if necessary; default implementation simply returns the colour as is
224 virtual wxColour
QuantizeColour(const wxColour
& colour
) const
230 static wxList sm_handlers
;
232 DECLARE_ABSTRACT_CLASS(wxBitmapBase
)
235 #endif // wxUSE_BITMAP_BASE
238 // the wxBITMAP_DEFAULT_TYPE constant defines the default argument value
239 // for wxBitmap's ctor and wxBitmap::LoadFile() functions.
240 #if defined(__WXMSW__)
241 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
242 #include "wx/msw/bitmap.h"
243 #elif defined(__WXMOTIF__)
244 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
245 #include "wx/x11/bitmap.h"
246 #elif defined(__WXGTK20__)
247 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
248 #include "wx/gtk/bitmap.h"
249 #elif defined(__WXGTK__)
250 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
251 #include "wx/gtk1/bitmap.h"
252 #elif defined(__WXX11__)
253 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
254 #include "wx/x11/bitmap.h"
255 #elif defined(__WXMGL__)
256 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
257 #include "wx/mgl/bitmap.h"
258 #elif defined(__WXDFB__)
259 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
260 #include "wx/dfb/bitmap.h"
261 #elif defined(__WXMAC__)
262 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_PICT_RESOURCE
263 #include "wx/osx/bitmap.h"
264 #elif defined(__WXCOCOA__)
265 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
266 #include "wx/cocoa/bitmap.h"
267 #elif defined(__WXPM__)
268 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
269 #include "wx/os2/bitmap.h"
275 #if wxUSE_BITMAP_BASE
280 ConvertToDisabled(unsigned char brightness
) const
282 return ConvertToImage().ConvertToDisabled(brightness
);
284 #endif // wxUSE_IMAGE
286 // we must include generic mask.h after wxBitmap definition
287 #if defined(__WXMGL__) || defined(__WXDFB__)
288 #define wxUSE_GENERIC_MASK 1
290 #define wxUSE_GENERIC_MASK 0
293 #if wxUSE_GENERIC_MASK
294 #include "wx/generic/mask.h"
297 #endif // _WX_BITMAP_H_BASE_