]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/msw/bitmap.h
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / include / wx / msw / bitmap.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/msw/bitmap.h
3// Purpose: wxBitmap class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_BITMAP_H_
13#define _WX_BITMAP_H_
14
15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "bitmap.h"
17#endif
18
19#include "wx/msw/gdiimage.h"
20#include "wx/gdicmn.h"
21#include "wx/palette.h"
22
23class WXDLLEXPORT wxBitmap;
24class WXDLLEXPORT wxBitmapHandler;
25class WXDLLEXPORT wxBitmapRefData;
26class WXDLLEXPORT wxControl;
27class WXDLLEXPORT wxCursor;
28class WXDLLEXPORT wxDC;
29#if wxUSE_WXDIB
30class WXDLLEXPORT wxDIB;
31#endif
32class WXDLLEXPORT wxIcon;
33class WXDLLEXPORT wxImage;
34class WXDLLEXPORT wxMask;
35class WXDLLEXPORT wxPalette;
36class WXDLLEXPORT wxPixelDataBase;
37
38// ----------------------------------------------------------------------------
39// wxBitmap: a mono or colour bitmap
40// ----------------------------------------------------------------------------
41
42class WXDLLEXPORT wxBitmap : public wxGDIImage
43{
44public:
45 // default ctor creates an invalid bitmap, you must Create() it later
46 wxBitmap() { Init(); }
47
48 // Copy constructors
49 wxBitmap(const wxBitmap& bitmap) { Init(); Ref(bitmap); }
50
51 // Initialize with raw data
52 wxBitmap(const char bits[], int width, int height, int depth = 1);
53
54 // Initialize with XPM data
55 wxBitmap(const char **data) { CreateFromXpm(data); }
56 wxBitmap(char **data) { CreateFromXpm((const char **)data); }
57
58 // Load a file or resource
59 wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
60
61 // New constructor for generalised creation from data
62 wxBitmap(void *data, long type, int width, int height, int depth = 1);
63
64 // Create a new, uninitialized bitmap of the given size and depth (if it
65 // is omitted, will create a bitmap compatible with the display)
66 //
67 // NB: this ctor will create a DIB for 24 and 32bpp bitmaps, use ctor
68 // taking a DC argument if you want to force using DDB in this case
69 wxBitmap(int width, int height, int depth = -1);
70
71 // Create a bitmap compatible with the given DC
72 wxBitmap(int width, int height, const wxDC& dc);
73
74#if wxUSE_IMAGE && wxUSE_WXDIB
75 // Convert from wxImage
76 wxBitmap(const wxImage& image, int depth = -1)
77 { (void)CreateFromImage(image, depth); }
78
79 // Create a DDB compatible with the given DC from wxImage
80 wxBitmap(const wxImage& image, const wxDC& dc)
81 { (void)CreateFromImage(image, dc); }
82#endif // wxUSE_IMAGE
83
84 // we must have this, otherwise icons are silently copied into bitmaps using
85 // the copy ctor but the resulting bitmap is invalid!
86 wxBitmap(const wxIcon& icon) { Init(); CopyFromIcon(icon); }
87
88 wxBitmap& operator=(const wxBitmap& bitmap)
89 {
90 if ( m_refData != bitmap.m_refData )
91 Ref(bitmap);
92 return *this;
93 }
94
95 wxBitmap& operator=(const wxIcon& icon)
96 {
97 (void)CopyFromIcon(icon);
98
99 return *this;
100 }
101
102 wxBitmap& operator=(const wxCursor& cursor)
103 {
104 (void)CopyFromCursor(cursor);
105
106 return *this;
107 }
108
109 virtual ~wxBitmap();
110
111#if wxUSE_IMAGE && wxUSE_WXDIB
112 wxImage ConvertToImage() const;
113#endif // wxUSE_IMAGE
114
115 // get the given part of bitmap
116 wxBitmap GetSubBitmap( const wxRect& rect ) const;
117
118 // copies the contents and mask of the given (colour) icon to the bitmap
119 bool CopyFromIcon(const wxIcon& icon);
120
121 // copies the contents and mask of the given cursor to the bitmap
122 bool CopyFromCursor(const wxCursor& cursor);
123
124#if wxUSE_WXDIB
125 // copies from a device independent bitmap
126 bool CopyFromDIB(const wxDIB& dib);
127#endif
128
129 virtual bool Create(int width, int height, int depth = -1);
130 virtual bool Create(int width, int height, const wxDC& dc);
131 virtual bool Create(void *data, long type, int width, int height, int depth = 1);
132 virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
133 virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
134
135 wxBitmapRefData *GetBitmapData() const
136 { return (wxBitmapRefData *)m_refData; }
137
138 // raw bitmap access support functions
139 void *GetRawData(wxPixelDataBase& data, int bpp);
140 void UngetRawData(wxPixelDataBase& data);
141
142#if wxUSE_PALETTE
143 wxPalette* GetPalette() const;
144 void SetPalette(const wxPalette& palette);
145#endif // wxUSE_PALETTE
146
147 wxMask *GetMask() const;
148 void SetMask(wxMask *mask);
149
150 bool operator==(const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
151 bool operator!=(const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
152
153 // these functions are internal and shouldn't be used, they risk to
154 // disappear in the future
155 bool HasAlpha() const;
156 void UseAlpha();
157
158#if WXWIN_COMPATIBILITY_2_4
159 // these functions do nothing and are only there for backwards
160 // compatibility
161 wxDEPRECATED( int GetQuality() const );
162 wxDEPRECATED( void SetQuality(int quality) );
163#endif // WXWIN_COMPATIBILITY_2_4
164
165 // implementation only from now on
166 // -------------------------------
167
168public:
169 void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
170 WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
171
172#ifdef __WXDEBUG__
173 void SetSelectedInto(wxDC *dc);
174 wxDC *GetSelectedInto() const;
175#endif // __WXDEBUG__
176
177protected:
178 // common part of all ctors
179 void Init();
180
181 virtual wxGDIImageRefData *CreateData() const;
182
183 // creates the bitmap from XPM data, supposed to be called from ctor
184 bool CreateFromXpm(const char **bits);
185
186 // creates an uninitialized bitmap, called from Create()s above
187 bool DoCreate(int w, int h, int depth, WXHDC hdc);
188
189#if wxUSE_IMAGE && wxUSE_WXDIB
190 // creates the bitmap from wxImage, supposed to be called from ctor
191 bool CreateFromImage(const wxImage& image, int depth);
192
193 // creates a DDB from wxImage, supposed to be called from ctor
194 bool CreateFromImage(const wxImage& image, const wxDC& dc);
195
196 // common part of the 2 methods above (hdc may be 0)
197 bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc);
198#endif // wxUSE_IMAGE
199
200private:
201#ifdef __WIN32__
202 // common part of CopyFromIcon/CopyFromCursor for Win32
203 bool CopyFromIconOrCursor(const wxGDIImage& icon);
204#endif // __WIN32__
205
206 DECLARE_DYNAMIC_CLASS(wxBitmap)
207};
208
209// ----------------------------------------------------------------------------
210// wxMask: a mono bitmap used for drawing bitmaps transparently.
211// ----------------------------------------------------------------------------
212
213class WXDLLEXPORT wxMask : public wxObject
214{
215public:
216 wxMask();
217
218 // Construct a mask from a bitmap and a colour indicating the transparent
219 // area
220 wxMask(const wxBitmap& bitmap, const wxColour& colour);
221
222 // Construct a mask from a bitmap and a palette index indicating the
223 // transparent area
224 wxMask(const wxBitmap& bitmap, int paletteIndex);
225
226 // Construct a mask from a mono bitmap (copies the bitmap).
227 wxMask(const wxBitmap& bitmap);
228
229 // construct a mask from the givne bitmap handle
230 wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; }
231
232 virtual ~wxMask();
233
234 bool Create(const wxBitmap& bitmap, const wxColour& colour);
235 bool Create(const wxBitmap& bitmap, int paletteIndex);
236 bool Create(const wxBitmap& bitmap);
237
238 // Implementation
239 WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
240 void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
241
242protected:
243 WXHBITMAP m_maskBitmap;
244
245 DECLARE_DYNAMIC_CLASS(wxMask)
246};
247
248// ----------------------------------------------------------------------------
249// wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
250// ----------------------------------------------------------------------------
251
252class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
253{
254public:
255 wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
256 wxBitmapHandler(const wxString& name, const wxString& ext, long type)
257 : wxGDIImageHandler(name, ext, type)
258 {
259 }
260
261 // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
262 // old class which worked only with bitmaps
263 virtual bool Create(wxBitmap *bitmap,
264 void *data,
265 long flags,
266 int width, int height, int depth = 1);
267 virtual bool LoadFile(wxBitmap *bitmap,
268 const wxString& name,
269 long flags,
270 int desiredWidth, int desiredHeight);
271 virtual bool SaveFile(wxBitmap *bitmap,
272 const wxString& name,
273 int type,
274 const wxPalette *palette = NULL);
275
276 virtual bool Create(wxGDIImage *image,
277 void *data,
278 long flags,
279 int width, int height, int depth = 1);
280 virtual bool Load(wxGDIImage *image,
281 const wxString& name,
282 long flags,
283 int desiredWidth, int desiredHeight);
284 virtual bool Save(wxGDIImage *image,
285 const wxString& name,
286 int type);
287
288private:
289 DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
290};
291
292#endif
293 // _WX_BITMAP_H_