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: bitmap.h 49563 2007-10-31 20:46:21Z VZ $
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_BITMAP_H_BASE_
13 #define _WX_BITMAP_H_BASE_
14
15 // ----------------------------------------------------------------------------
16 // headers
17 // ----------------------------------------------------------------------------
18
19 #include "wx/string.h"
20 #include "wx/gdicmn.h" // for wxBitmapType
21 #include "wx/colour.h"
22
23 class WXDLLIMPEXP_FWD_CORE wxBitmap;
24 class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
25 class WXDLLIMPEXP_FWD_CORE wxIcon;
26 class WXDLLIMPEXP_FWD_CORE wxImage;
27 class WXDLLIMPEXP_FWD_CORE wxMask;
28 class WXDLLIMPEXP_FWD_CORE wxPalette;
29
30 // ----------------------------------------------------------------------------
31 // wxVariant support
32 // ----------------------------------------------------------------------------
33
34 #if wxUSE_VARIANT
35 #include "wx/variant.h"
DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLEXPORT)36 DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLEXPORT)
37 #endif
38
39 // ----------------------------------------------------------------------------
40 // wxMask represents the transparent area of the bitmap
41 // ----------------------------------------------------------------------------
42
43 class WXDLLEXPORT wxMaskBase : public wxObject
44 {
45 public:
46 // create the mask from bitmap pixels of the given colour
47 bool Create(const wxBitmap& bitmap, const wxColour& colour);
48
49 #if wxUSE_PALETTE
50 // create the mask from bitmap pixels with the given palette index
51 bool Create(const wxBitmap& bitmap, int paletteIndex);
52 #endif // wxUSE_PALETTE
53
54 // create the mask from the given mono bitmap
55 bool Create(const wxBitmap& bitmap);
56
57 protected:
58 // this function is called from Create() to free the existing mask data
59 virtual void FreeData() = 0;
60
61 // these functions must be overridden to implement the corresponding public
62 // Create() methods, they shouldn't call FreeData() as it's already called
63 // by the public wrappers
64 virtual bool InitFromColour(const wxBitmap& bitmap,
65 const wxColour& colour) = 0;
66 virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0;
67 };
68
69 #if defined(__WXMGL__) || \
70 defined(__WXDFB__) || \
71 defined(__WXMAC__) || \
72 defined(__WXGTK__) || \
73 defined(__WXCOCOA__) || \
74 defined(__WXMOTIF__) || \
75 defined(__WXX11__)
76 #define wxUSE_BITMAP_BASE 1
77 #else
78 #define wxUSE_BITMAP_BASE 0
79 #endif
80
81 // Only used by some ports
82 // FIXME -- make all ports (but MSW which uses wxGDIImage) use these base classes
83 #if wxUSE_BITMAP_BASE
84
85 // ----------------------------------------------------------------------------
86 // wxBitmapHandler: class which knows how to create/load/save bitmaps in
87 // different formats
88 // ----------------------------------------------------------------------------
89
90 class WXDLLEXPORT wxBitmapHandlerBase : public wxObject
91 {
92 public:
wxBitmapHandlerBase()93 wxBitmapHandlerBase() { m_type = wxBITMAP_TYPE_INVALID; }
~wxBitmapHandlerBase()94 virtual ~wxBitmapHandlerBase() { }
95
96 virtual bool Create(wxBitmap *bitmap, const void* data, long flags,
97 int width, int height, int depth = 1);
98 virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
99 int desiredWidth, int desiredHeight);
100 virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name,
101 int type, const wxPalette *palette = NULL);
102
SetName(const wxString & name)103 void SetName(const wxString& name) { m_name = name; }
SetExtension(const wxString & ext)104 void SetExtension(const wxString& ext) { m_extension = ext; }
SetType(wxBitmapType type)105 void SetType(wxBitmapType type) { m_type = type; }
GetName()106 const wxString& GetName() const { return m_name; }
GetExtension()107 const wxString& GetExtension() const { return m_extension; }
GetType()108 wxBitmapType GetType() const { return m_type; }
109
110 private:
111 wxString m_name;
112 wxString m_extension;
113 wxBitmapType m_type;
114
115 DECLARE_ABSTRACT_CLASS(wxBitmapHandlerBase)
116 };
117
118 class WXDLLEXPORT wxBitmapBase : public wxGDIObject
119 {
120 public:
121 /*
122 Derived class must implement these:
123
124 wxBitmap();
125 wxBitmap(int width, int height, int depth = -1);
126 wxBitmap(const char bits[], int width, int height, int depth = 1);
127 wxBitmap(const char* const* bits);
128 wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
129 wxBitmap(const wxImage& image, int depth = -1);
130
131 bool Create(int width, int height, int depth = -1);
132
133 static void InitStandardHandlers();
134 */
135
Ok()136 virtual bool Ok() const { return IsOk(); }
137 virtual bool IsOk() const = 0;
138
139 virtual int GetHeight() const = 0;
140 virtual int GetWidth() const = 0;
141 virtual int GetDepth() const = 0;
142
143 virtual wxImage ConvertToImage() const = 0;
144
145 virtual wxMask *GetMask() const = 0;
146 virtual void SetMask(wxMask *mask) = 0;
147
148 virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;
149
150 virtual bool SaveFile(const wxString &name, wxBitmapType type,
151 const wxPalette *palette = (wxPalette *)NULL) const = 0;
152 virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;
153
154 /*
155 If raw bitmap access is supported (see wx/rawbmp.h), the following
156 methods should be implemented:
157
158 virtual bool GetRawData(wxRawBitmapData *data) = 0;
159 virtual void UngetRawData(wxRawBitmapData *data) = 0;
160 */
161
162 #if wxUSE_PALETTE
163 virtual wxPalette *GetPalette() const = 0;
164 virtual void SetPalette(const wxPalette& palette) = 0;
165 #endif // wxUSE_PALETTE
166
167 // copies the contents and mask of the given (colour) icon to the bitmap
168 virtual bool CopyFromIcon(const wxIcon& icon) = 0;
169
170 // implementation:
171 virtual void SetHeight(int height) = 0;
172 virtual void SetWidth(int width) = 0;
173 virtual void SetDepth(int depth) = 0;
174
175 // Format handling
GetHandlers()176 static inline wxList& GetHandlers() { return sm_handlers; }
177 static void AddHandler(wxBitmapHandlerBase *handler);
178 static void InsertHandler(wxBitmapHandlerBase *handler);
179 static bool RemoveHandler(const wxString& name);
180 static wxBitmapHandler *FindHandler(const wxString& name);
181 static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);
182 static wxBitmapHandler *FindHandler(wxBitmapType bitmapType);
183
184 //static void InitStandardHandlers();
185 // (wxBitmap must implement this one)
186
187 static void CleanUpHandlers();
188
189 // this method is only used by the generic implementation of wxMask
190 // currently but could be useful elsewhere in the future: it can be
191 // overridden to quantize the colour to correspond to bitmap colour depth
192 // if necessary; default implementation simply returns the colour as is
QuantizeColour(const wxColour & colour)193 virtual wxColour QuantizeColour(const wxColour& colour) const
194 {
195 return colour;
196 }
197
198 protected:
199 static wxList sm_handlers;
200
201 DECLARE_ABSTRACT_CLASS(wxBitmapBase)
202 };
203
204 #endif // wxUSE_BITMAP_BASE
205
206 #if defined(__WXPALMOS__)
207 #include "wx/palmos/bitmap.h"
208 #elif defined(__WXMSW__)
209 #include "wx/msw/bitmap.h"
210 #elif defined(__WXMOTIF__)
211 #include "wx/x11/bitmap.h"
212 #elif defined(__WXGTK20__)
213 #include "wx/gtk/bitmap.h"
214 #elif defined(__WXGTK__)
215 #include "wx/gtk1/bitmap.h"
216 #elif defined(__WXX11__)
217 #include "wx/x11/bitmap.h"
218 #elif defined(__WXMGL__)
219 #include "wx/mgl/bitmap.h"
220 #elif defined(__WXDFB__)
221 #include "wx/dfb/bitmap.h"
222 #elif defined(__WXMAC__)
223 #include "wx/mac/bitmap.h"
224 #elif defined(__WXCOCOA__)
225 #include "wx/cocoa/bitmap.h"
226 #elif defined(__WXPM__)
227 #include "wx/os2/bitmap.h"
228 #endif
229
230 // we must include generic mask.h after wxBitmap definition
231 #if defined(__WXMGL__) || defined(__WXDFB__)
232 #define wxUSE_GENERIC_MASK 1
233 #else
234 #define wxUSE_GENERIC_MASK 0
235 #endif
236
237 #if wxUSE_GENERIC_MASK
238 #include "wx/generic/mask.h"
239 #endif
240
241 #endif // _WX_BITMAP_H_BASE_
242