]> git.saurik.com Git - wxWidgets.git/blob - include/wx/bitmap.h
revert last change, plus small cleanup
[wxWidgets.git] / include / wx / bitmap.h
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$
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 WXDLLEXPORT wxBitmap;
24 class WXDLLEXPORT wxBitmapHandler;
25 class WXDLLEXPORT wxIcon;
26 class WXDLLEXPORT wxImage;
27 class WXDLLEXPORT wxMask;
28 class WXDLLEXPORT wxPalette;
29
30 // ----------------------------------------------------------------------------
31 // wxVariant support
32 // ----------------------------------------------------------------------------
33
34 #if wxUSE_VARIANT
35 #include "wx/variant.h"
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:
93 wxBitmapHandlerBase() { m_type = wxBITMAP_TYPE_INVALID; }
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
103 void SetName(const wxString& name) { m_name = name; }
104 void SetExtension(const wxString& ext) { m_extension = ext; }
105 void SetType(wxBitmapType type) { m_type = type; }
106 const wxString& GetName() const { return m_name; }
107 const wxString& GetExtension() const { return m_extension; }
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 bool operator == (const wxBitmap& bmp) const;
131 bool operator != (const wxBitmap& bmp) const;
132
133 bool Create(int width, int height, int depth = -1);
134
135 static void InitStandardHandlers();
136 */
137
138 virtual bool Ok() const = 0;
139
140 virtual int GetHeight() const = 0;
141 virtual int GetWidth() const = 0;
142 virtual int GetDepth() const = 0;
143
144 virtual wxImage ConvertToImage() const = 0;
145
146 virtual wxMask *GetMask() const = 0;
147 virtual void SetMask(wxMask *mask) = 0;
148
149 virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;
150
151 virtual bool SaveFile(const wxString &name, wxBitmapType type,
152 const wxPalette *palette = (wxPalette *)NULL) const = 0;
153 virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;
154
155 /*
156 If raw bitmap access is supported (see wx/rawbmp.h), the following
157 methods should be implemented:
158
159 virtual bool GetRawData(wxRawBitmapData *data) = 0;
160 virtual void UngetRawData(wxRawBitmapData *data) = 0;
161 */
162
163 #if wxUSE_PALETTE
164 virtual wxPalette *GetPalette() const = 0;
165 virtual void SetPalette(const wxPalette& palette) = 0;
166 #endif // wxUSE_PALETTE
167
168 // copies the contents and mask of the given (colour) icon to the bitmap
169 virtual bool CopyFromIcon(const wxIcon& icon) = 0;
170
171 // implementation:
172 virtual void SetHeight(int height) = 0;
173 virtual void SetWidth(int width) = 0;
174 virtual void SetDepth(int depth) = 0;
175
176 // Format handling
177 static inline wxList& GetHandlers() { return sm_handlers; }
178 static void AddHandler(wxBitmapHandlerBase *handler);
179 static void InsertHandler(wxBitmapHandlerBase *handler);
180 static bool RemoveHandler(const wxString& name);
181 static wxBitmapHandler *FindHandler(const wxString& name);
182 static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);
183 static wxBitmapHandler *FindHandler(wxBitmapType bitmapType);
184
185 //static void InitStandardHandlers();
186 // (wxBitmap must implement this one)
187
188 static void CleanUpHandlers();
189
190 // this method is only used by the generic implementation of wxMask
191 // currently but could be useful elsewhere in the future: it can be
192 // overridden to quantize the colour to correspond to bitmap colour depth
193 // if necessary; default implementation simply returns the colour as is
194 virtual wxColour QuantizeColour(const wxColour& colour) const
195 {
196 return colour;
197 }
198
199 protected:
200 static wxList sm_handlers;
201
202 DECLARE_ABSTRACT_CLASS(wxBitmapBase)
203 };
204
205 #endif // wxUSE_BITMAP_BASE
206
207 #if defined(__WXPALMOS__)
208 #include "wx/palmos/bitmap.h"
209 #elif defined(__WXMSW__)
210 #include "wx/msw/bitmap.h"
211 #elif defined(__WXMOTIF__)
212 #include "wx/x11/bitmap.h"
213 #elif defined(__WXGTK20__)
214 #include "wx/gtk/bitmap.h"
215 #elif defined(__WXGTK__)
216 #include "wx/gtk1/bitmap.h"
217 #elif defined(__WXX11__)
218 #include "wx/x11/bitmap.h"
219 #elif defined(__WXMGL__)
220 #include "wx/mgl/bitmap.h"
221 #elif defined(__WXDFB__)
222 #include "wx/dfb/bitmap.h"
223 #elif defined(__WXMAC__)
224 #include "wx/mac/bitmap.h"
225 #elif defined(__WXCOCOA__)
226 #include "wx/cocoa/bitmap.h"
227 #elif defined(__WXPM__)
228 #include "wx/os2/bitmap.h"
229 #endif
230
231 // we must include generic mask.h after wxBitmap definition
232 #if defined(__WXMGL__) || defined(__WXDFB__)
233 #define wxUSE_GENERIC_MASK 1
234 #else
235 #define wxUSE_GENERIC_MASK 0
236 #endif
237
238 #if wxUSE_GENERIC_MASK
239 #include "wx/generic/mask.h"
240 #endif
241
242 #endif // _WX_BITMAP_H_BASE_