]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/bitmap.h
enum wxWebViewBackend has been removed.
[wxWidgets.git] / include / wx / msw / bitmap.h
CommitLineData
2bda0e17 1/////////////////////////////////////////////////////////////////////////////
6d167489 2// Name: wx/msw/bitmap.h
2bda0e17
KB
3// Purpose: wxBitmap class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
bbcdf8bc 8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_BITMAP_H_
13#define _WX_BITMAP_H_
2bda0e17 14
6d167489 15#include "wx/msw/gdiimage.h"
2bda0e17
KB
16#include "wx/palette.h"
17
b5dbe15d
VS
18class WXDLLIMPEXP_FWD_CORE wxBitmap;
19class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
20class WXDLLIMPEXP_FWD_CORE wxBitmapRefData;
21class WXDLLIMPEXP_FWD_CORE wxControl;
22class WXDLLIMPEXP_FWD_CORE wxCursor;
23class WXDLLIMPEXP_FWD_CORE wxDC;
086b3a5b 24#if wxUSE_WXDIB
b5dbe15d 25class WXDLLIMPEXP_FWD_CORE wxDIB;
086b3a5b 26#endif
b5dbe15d 27class WXDLLIMPEXP_FWD_CORE wxIcon;
b5dbe15d
VS
28class WXDLLIMPEXP_FWD_CORE wxMask;
29class WXDLLIMPEXP_FWD_CORE wxPalette;
30class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
2bda0e17 31
11f406f9
VZ
32// What kind of transparency should a bitmap copied from an icon or cursor
33// have?
34enum wxBitmapTransparency
35{
36 wxBitmapTransparency_Auto, // default: copy alpha if the source has it
37 wxBitmapTransparency_None, // never create alpha
38 wxBitmapTransparency_Always // always use alpha
39};
40
6d167489
VZ
41// ----------------------------------------------------------------------------
42// wxBitmap: a mono or colour bitmap
e86f2cc8 43// NOTE: for wxMSW we don't use the wxBitmapBase base class declared in bitmap.h!
6d167489 44// ----------------------------------------------------------------------------
2bda0e17 45
20e6714a
VZ
46class WXDLLIMPEXP_CORE wxBitmap : public wxGDIImage,
47 public wxBitmapHelpers
6d167489 48{
2bda0e17 49public:
4fe5383d 50 // default ctor creates an invalid bitmap, you must Create() it later
f8855e47 51 wxBitmap() { }
4fe5383d
VZ
52
53 // Initialize with raw data
54 wxBitmap(const char bits[], int width, int height, int depth = 1);
55
56 // Initialize with XPM data
452418c4 57 wxBitmap(const char* const* data);
459f812b 58#ifdef wxNEEDS_CHARPP
29b7b6ca
PC
59 wxBitmap(char** data)
60 {
5c33522f 61 *this = wxBitmap(const_cast<const char* const*>(data));
29b7b6ca
PC
62 }
63#endif
2bda0e17 64
4fe5383d 65 // Load a file or resource
cbea3ec6 66 wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
2bda0e17 67
4fe5383d 68 // New constructor for generalised creation from data
e86f2cc8 69 wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
2bda0e17 70
2cf45d69
VZ
71 // Create a new, uninitialized bitmap of the given size and depth (if it
72 // is omitted, will create a bitmap compatible with the display)
73 //
74 // NB: this ctor will create a DIB for 24 and 32bpp bitmaps, use ctor
75 // taking a DC argument if you want to force using DDB in this case
732d8c74
FM
76 wxBitmap(int width, int height, int depth = -1) { (void)Create(width, height, depth); }
77 wxBitmap(const wxSize& sz, int depth = -1) { (void)Create(sz, depth); }
6d51f220 78
2cf45d69
VZ
79 // Create a bitmap compatible with the given DC
80 wxBitmap(int width, int height, const wxDC& dc);
81
50a9dd77 82#if wxUSE_IMAGE
2cf45d69 83 // Convert from wxImage
6463b9f5
JS
84 wxBitmap(const wxImage& image, int depth = -1)
85 { (void)CreateFromImage(image, depth); }
2cf45d69
VZ
86
87 // Create a DDB compatible with the given DC from wxImage
6463b9f5
JS
88 wxBitmap(const wxImage& image, const wxDC& dc)
89 { (void)CreateFromImage(image, dc); }
6d51f220 90#endif // wxUSE_IMAGE
2bda0e17 91
4fe5383d
VZ
92 // we must have this, otherwise icons are silently copied into bitmaps using
93 // the copy ctor but the resulting bitmap is invalid!
11f406f9
VZ
94 wxBitmap(const wxIcon& icon,
95 wxBitmapTransparency transp = wxBitmapTransparency_Auto)
96 {
97 CopyFromIcon(icon, transp);
98 }
2bda0e17 99
4fe5383d
VZ
100 wxBitmap& operator=(const wxIcon& icon)
101 {
102 (void)CopyFromIcon(icon);
07cf98cb 103
4fe5383d
VZ
104 return *this;
105 }
07cf98cb 106
6d167489
VZ
107 wxBitmap& operator=(const wxCursor& cursor)
108 {
109 (void)CopyFromCursor(cursor);
110
111 return *this;
112 }
113
4fe5383d 114 virtual ~wxBitmap();
2bda0e17 115
50a9dd77 116#if wxUSE_IMAGE
fd859211 117 wxImage ConvertToImage() const;
ac04aa99 118 wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;
6d51f220 119#endif // wxUSE_IMAGE
fd859211 120
4b7f2165 121 // get the given part of bitmap
8208e181 122 wxBitmap GetSubBitmap( const wxRect& rect ) const;
6d51f220 123
18f2ae49 124 // NB: This should not be called from user code. It is for wx internal
cbea3ec6 125 // use only.
18f2ae49
KO
126 wxBitmap GetSubBitmapOfHDC( const wxRect& rect, WXHDC hdc ) const;
127
4fe5383d 128 // copies the contents and mask of the given (colour) icon to the bitmap
11f406f9
VZ
129 bool CopyFromIcon(const wxIcon& icon,
130 wxBitmapTransparency transp = wxBitmapTransparency_Auto);
2bda0e17 131
6d167489 132 // copies the contents and mask of the given cursor to the bitmap
11f406f9
VZ
133 bool CopyFromCursor(const wxCursor& cursor,
134 wxBitmapTransparency transp = wxBitmapTransparency_Auto);
6d167489 135
086b3a5b 136#if wxUSE_WXDIB
b0ea5d96
VZ
137 // copies from a device independent bitmap
138 bool CopyFromDIB(const wxDIB& dib);
086b3a5b 139#endif
b0ea5d96 140
e86f2cc8 141 virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
732d8c74
FM
142 virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
143 { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
144
2cf45d69 145 virtual bool Create(int width, int height, const wxDC& dc);
e86f2cc8 146 virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
cbea3ec6 147 virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
e86f2cc8 148 virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
4fe5383d 149
8bbbae21
VZ
150 wxBitmapRefData *GetBitmapData() const
151 { return (wxBitmapRefData *)m_refData; }
6d167489 152
2cf45d69 153 // raw bitmap access support functions
b9bcaf11
VZ
154 void *GetRawData(wxPixelDataBase& data, int bpp);
155 void UngetRawData(wxPixelDataBase& data);
2cf45d69 156
d275c7eb 157#if wxUSE_PALETTE
8bbbae21 158 wxPalette* GetPalette() const;
4fe5383d 159 void SetPalette(const wxPalette& palette);
d275c7eb 160#endif // wxUSE_PALETTE
2bda0e17 161
8bbbae21 162 wxMask *GetMask() const;
ec023a6e 163 wxBitmap GetMaskBitmap() const;
acf8e3d2 164 void SetMask(wxMask *mask);
2bda0e17 165
10b41b53
VZ
166 // these functions are internal and shouldn't be used, they risk to
167 // disappear in the future
acf8e3d2 168 bool HasAlpha() const;
10b41b53 169 void UseAlpha();
8bbbae21 170
2cf45d69
VZ
171 // implementation only from now on
172 // -------------------------------
2bda0e17 173
2bda0e17 174public:
6d167489
VZ
175 void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
176 WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
177
8bbbae21
VZ
178 void SetSelectedInto(wxDC *dc);
179 wxDC *GetSelectedInto() const;
6d167489 180
4fe5383d 181protected:
8bbbae21 182 virtual wxGDIImageRefData *CreateData() const;
8f884a0d 183 virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
6d167489 184
2cf45d69
VZ
185 // creates an uninitialized bitmap, called from Create()s above
186 bool DoCreate(int w, int h, int depth, WXHDC hdc);
187
50a9dd77 188#if wxUSE_IMAGE
fd859211
VS
189 // creates the bitmap from wxImage, supposed to be called from ctor
190 bool CreateFromImage(const wxImage& image, int depth);
4b7f2165 191
2cf45d69
VZ
192 // creates a DDB from wxImage, supposed to be called from ctor
193 bool CreateFromImage(const wxImage& image, const wxDC& dc);
8bbbae21 194
2cf45d69
VZ
195 // common part of the 2 methods above (hdc may be 0)
196 bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc);
197#endif // wxUSE_IMAGE
0becd470 198
4fe5383d 199private:
6d167489 200 // common part of CopyFromIcon/CopyFromCursor for Win32
11f406f9
VZ
201 bool
202 CopyFromIconOrCursor(const wxGDIImage& icon,
203 wxBitmapTransparency transp = wxBitmapTransparency_Auto);
50a9dd77 204
6d167489 205
4fe5383d 206 DECLARE_DYNAMIC_CLASS(wxBitmap)
2bda0e17 207};
ce3ed50d 208
6d167489
VZ
209// ----------------------------------------------------------------------------
210// wxMask: a mono bitmap used for drawing bitmaps transparently.
211// ----------------------------------------------------------------------------
212
53a2db12 213class WXDLLIMPEXP_CORE wxMask : public wxObject
6d167489
VZ
214{
215public:
216 wxMask();
217
1b7c01c9
VZ
218 // Copy constructor
219 wxMask(const wxMask &mask);
220
6d167489
VZ
221 // Construct a mask from a bitmap and a colour indicating the transparent
222 // area
223 wxMask(const wxBitmap& bitmap, const wxColour& colour);
224
225 // Construct a mask from a bitmap and a palette index indicating the
226 // transparent area
227 wxMask(const wxBitmap& bitmap, int paletteIndex);
228
229 // Construct a mask from a mono bitmap (copies the bitmap).
230 wxMask(const wxBitmap& bitmap);
231
232 // construct a mask from the givne bitmap handle
233 wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; }
234
235 virtual ~wxMask();
236
237 bool Create(const wxBitmap& bitmap, const wxColour& colour);
238 bool Create(const wxBitmap& bitmap, int paletteIndex);
239 bool Create(const wxBitmap& bitmap);
240
241 // Implementation
242 WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
243 void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
244
245protected:
246 WXHBITMAP m_maskBitmap;
247
248 DECLARE_DYNAMIC_CLASS(wxMask)
249};
250
e86f2cc8 251
6d167489
VZ
252// ----------------------------------------------------------------------------
253// wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
e86f2cc8 254// NOTE: for wxMSW we don't use the wxBitmapHandler class declared in bitmap.h!
6d167489
VZ
255// ----------------------------------------------------------------------------
256
53a2db12 257class WXDLLIMPEXP_CORE wxBitmapHandler : public wxGDIImageHandler
6d167489
VZ
258{
259public:
cb62a16a 260 wxBitmapHandler() { }
e86f2cc8
FM
261 wxBitmapHandler(const wxString& name, const wxString& ext, wxBitmapType type)
262 : wxGDIImageHandler(name, ext, type) { }
6d167489 263
e86f2cc8 264 // implement wxGDIImageHandler's pure virtuals:
6d167489
VZ
265
266 virtual bool Create(wxGDIImage *image,
452418c4 267 const void* data,
e86f2cc8 268 wxBitmapType type,
6d167489
VZ
269 int width, int height, int depth = 1);
270 virtual bool Load(wxGDIImage *image,
271 const wxString& name,
e86f2cc8 272 wxBitmapType type,
6d167489 273 int desiredWidth, int desiredHeight);
e86f2cc8 274 virtual bool Save(const wxGDIImage *image,
6d167489 275 const wxString& name,
e86f2cc8
FM
276 wxBitmapType type) const;
277
278
279 // make wxBitmapHandler compatible with the wxBitmapHandler interface
280 // declared in bitmap.h, even if it's derived from wxGDIImageHandler:
281
282 virtual bool Create(wxBitmap *bitmap,
283 const void* data,
284 wxBitmapType type,
285 int width, int height, int depth = 1);
286 virtual bool LoadFile(wxBitmap *bitmap,
287 const wxString& name,
288 wxBitmapType type,
289 int desiredWidth, int desiredHeight);
290 virtual bool SaveFile(const wxBitmap *bitmap,
291 const wxString& name,
292 wxBitmapType type,
293 const wxPalette *palette = NULL) const;
6d167489
VZ
294
295private:
296 DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
297};
298
2bda0e17 299#endif
bbcdf8bc 300 // _WX_BITMAP_H_