]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/msw/bitmap.h
WXWIN_COMPATIBILITY_2_2 should be 0 by default now
[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#ifdef __GNUG__
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
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
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#if WXWIN_COMPATIBILITY_2
166 void SetOk(bool isOk);
167#endif // WXWIN_COMPATIBILITY_2
168
169#if WXWIN_COMPATIBILITY
170#if wxUSE_PALETTE
171 wxPalette *GetColourMap() const { return GetPalette(); }
172 void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
173#endif // wxUSE_PALETTE
174#endif // WXWIN_COMPATIBILITY
175
176 // implementation only from now on
177 // -------------------------------
178
179public:
180 void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
181 WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
182
183#ifdef __WXDEBUG__
184 void SetSelectedInto(wxDC *dc);
185 wxDC *GetSelectedInto() const;
186#endif // __WXDEBUG__
187
188protected:
189 // common part of all ctors
190 void Init();
191
192 virtual wxGDIImageRefData *CreateData() const;
193
194 // creates the bitmap from XPM data, supposed to be called from ctor
195 bool CreateFromXpm(const char **bits);
196
197 // creates an uninitialized bitmap, called from Create()s above
198 bool DoCreate(int w, int h, int depth, WXHDC hdc);
199
200#if wxUSE_IMAGE
201 // creates the bitmap from wxImage, supposed to be called from ctor
202 bool CreateFromImage(const wxImage& image, int depth);
203
204 // creates a DDB from wxImage, supposed to be called from ctor
205 bool CreateFromImage(const wxImage& image, const wxDC& dc);
206
207 // common part of the 2 methods above (hdc may be 0)
208 bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc);
209#endif // wxUSE_IMAGE
210
211private:
212#ifdef __WIN32__
213 // common part of CopyFromIcon/CopyFromCursor for Win32
214 bool CopyFromIconOrCursor(const wxGDIImage& icon);
215#endif // __WIN32__
216
217 DECLARE_DYNAMIC_CLASS(wxBitmap)
218};
219
220// ----------------------------------------------------------------------------
221// wxMask: a mono bitmap used for drawing bitmaps transparently.
222// ----------------------------------------------------------------------------
223
224class WXDLLEXPORT wxMask : public wxObject
225{
226public:
227 wxMask();
228
229 // Construct a mask from a bitmap and a colour indicating the transparent
230 // area
231 wxMask(const wxBitmap& bitmap, const wxColour& colour);
232
233 // Construct a mask from a bitmap and a palette index indicating the
234 // transparent area
235 wxMask(const wxBitmap& bitmap, int paletteIndex);
236
237 // Construct a mask from a mono bitmap (copies the bitmap).
238 wxMask(const wxBitmap& bitmap);
239
240 // construct a mask from the givne bitmap handle
241 wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; }
242
243 virtual ~wxMask();
244
245 bool Create(const wxBitmap& bitmap, const wxColour& colour);
246 bool Create(const wxBitmap& bitmap, int paletteIndex);
247 bool Create(const wxBitmap& bitmap);
248
249 // Implementation
250 WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
251 void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
252
253protected:
254 WXHBITMAP m_maskBitmap;
255
256 DECLARE_DYNAMIC_CLASS(wxMask)
257};
258
259// ----------------------------------------------------------------------------
260// wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
261// ----------------------------------------------------------------------------
262
263class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
264{
265public:
266 wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
267 wxBitmapHandler(const wxString& name, const wxString& ext, long type)
268 : wxGDIImageHandler(name, ext, type)
269 {
270 }
271
272 // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
273 // old class which worked only with bitmaps
274 virtual bool Create(wxBitmap *bitmap,
275 void *data,
276 long flags,
277 int width, int height, int depth = 1);
278 virtual bool LoadFile(wxBitmap *bitmap,
279 const wxString& name,
280 long flags,
281 int desiredWidth, int desiredHeight);
282 virtual bool SaveFile(wxBitmap *bitmap,
283 const wxString& name,
284 int type,
285 const wxPalette *palette = NULL);
286
287 virtual bool Create(wxGDIImage *image,
288 void *data,
289 long flags,
290 int width, int height, int depth = 1);
291 virtual bool Load(wxGDIImage *image,
292 const wxString& name,
293 long flags,
294 int desiredWidth, int desiredHeight);
295 virtual bool Save(wxGDIImage *image,
296 const wxString& name,
297 int type);
298
299private:
300 DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
301};
302
303#endif
304 // _WX_BITMAP_H_