]> git.saurik.com Git - wxWidgets.git/blame - include/wx/bitmap.h
Remove the documentation of non-existent wxNO_T macro.
[wxWidgets.git] / include / wx / bitmap.h
CommitLineData
1e6feb95
VZ
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$
77ffb593 8// Copyright: (c) wxWidgets team
65571936 9// Licence: wxWindows licence
1e6feb95
VZ
10///////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_BITMAP_H_BASE_
13#define _WX_BITMAP_H_BASE_
c801d85f 14
1e6feb95
VZ
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
1e6feb95 19#include "wx/string.h"
22bd9387 20#include "wx/gdicmn.h" // for wxBitmapType
acb53ea5 21#include "wx/colour.h"
ac04aa99 22#include "wx/image.h"
1e6feb95 23
b5dbe15d
VS
24class WXDLLIMPEXP_FWD_CORE wxBitmap;
25class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
26class WXDLLIMPEXP_FWD_CORE wxIcon;
b5dbe15d
VS
27class WXDLLIMPEXP_FWD_CORE wxMask;
28class WXDLLIMPEXP_FWD_CORE wxPalette;
1e6feb95 29
6f5d7825
RR
30// ----------------------------------------------------------------------------
31// wxVariant support
32// ----------------------------------------------------------------------------
33
34#if wxUSE_VARIANT
35#include "wx/variant.h"
53a2db12 36DECLARE_VARIANT_OBJECT_EXPORTED(wxBitmap,WXDLLIMPEXP_CORE)
6f5d7825
RR
37#endif
38
87f83ac8
VZ
39// ----------------------------------------------------------------------------
40// wxMask represents the transparent area of the bitmap
41// ----------------------------------------------------------------------------
42
e86f2cc8
FM
43// TODO: all implementation of wxMask, except the generic one,
44// do not derive from wxMaskBase,,, they should
53a2db12 45class WXDLLIMPEXP_CORE wxMaskBase : public wxObject
87f83ac8
VZ
46{
47public:
48 // create the mask from bitmap pixels of the given colour
49 bool Create(const wxBitmap& bitmap, const wxColour& colour);
50
51#if wxUSE_PALETTE
52 // create the mask from bitmap pixels with the given palette index
53 bool Create(const wxBitmap& bitmap, int paletteIndex);
54#endif // wxUSE_PALETTE
55
56 // create the mask from the given mono bitmap
57 bool Create(const wxBitmap& bitmap);
58
59protected:
60 // this function is called from Create() to free the existing mask data
61 virtual void FreeData() = 0;
62
63 // these functions must be overridden to implement the corresponding public
64 // Create() methods, they shouldn't call FreeData() as it's already called
65 // by the public wrappers
66 virtual bool InitFromColour(const wxBitmap& bitmap,
67 const wxColour& colour) = 0;
68 virtual bool InitFromMonoBitmap(const wxBitmap& bitmap) = 0;
69};
70
d22004c4 71#if defined(__WXMGL__) || \
b3c86150 72 defined(__WXDFB__) || \
d22004c4 73 defined(__WXMAC__) || \
4611dd06 74 defined(__WXGTK__) || \
d22004c4
WS
75 defined(__WXCOCOA__) || \
76 defined(__WXMOTIF__) || \
77 defined(__WXX11__)
91885f46
VZ
78 #define wxUSE_BITMAP_BASE 1
79#else
80 #define wxUSE_BITMAP_BASE 0
81#endif
82
e86f2cc8
FM
83// a more readable way to tell
84#define wxBITMAP_SCREEN_DEPTH (-1)
85
86
87// All ports except wxMSW,wxOS2,wxPalmOS use wxBitmapHandler and wxBitmapBase as base class
88// for wxBitmapHandler; wxMSW,wxOS2,wxPalmOS use wxGDIImageHandler as base class
89// since it allows some code reuse there.
91885f46 90#if wxUSE_BITMAP_BASE
b496583b 91
1e6feb95
VZ
92// ----------------------------------------------------------------------------
93// wxBitmapHandler: class which knows how to create/load/save bitmaps in
94// different formats
95// ----------------------------------------------------------------------------
96
53a2db12 97class WXDLLIMPEXP_CORE wxBitmapHandler : public wxObject
1e6feb95
VZ
98{
99public:
e86f2cc8
FM
100 wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
101 virtual ~wxBitmapHandler() { }
102
103 // NOTE: the following functions should be pure virtuals, but they aren't
104 // because otherwise almost all ports would have to implement
105 // them as "return false"...
1e6feb95 106
e86f2cc8
FM
107 virtual bool Create(wxBitmap *WXUNUSED(bitmap), const void* WXUNUSED(data),
108 wxBitmapType WXUNUSED(type), int WXUNUSED(width), int WXUNUSED(height),
109 int WXUNUSED(depth) = 1)
110 { return false; }
111
112 virtual bool LoadFile(wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
113 wxBitmapType WXUNUSED(type), int WXUNUSED(desiredWidth),
114 int WXUNUSED(desiredHeight))
115 { return false; }
116
117 virtual bool SaveFile(const wxBitmap *WXUNUSED(bitmap), const wxString& WXUNUSED(name),
118 wxBitmapType WXUNUSED(type), const wxPalette *WXUNUSED(palette) = NULL) const
119 { return false; }
1e6feb95 120
4b61c88d
RR
121 void SetName(const wxString& name) { m_name = name; }
122 void SetExtension(const wxString& ext) { m_extension = ext; }
123 void SetType(wxBitmapType type) { m_type = type; }
452418c4
PC
124 const wxString& GetName() const { return m_name; }
125 const wxString& GetExtension() const { return m_extension; }
4b61c88d
RR
126 wxBitmapType GetType() const { return m_type; }
127
128private:
1e6feb95
VZ
129 wxString m_name;
130 wxString m_extension;
131 wxBitmapType m_type;
132
e86f2cc8 133 DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
1e6feb95
VZ
134};
135
e86f2cc8
FM
136
137// ----------------------------------------------------------------------------
138// wxBitmap: class which represents platform-dependent bitmap (unlike wxImage)
139// ----------------------------------------------------------------------------
140
53a2db12 141class WXDLLIMPEXP_CORE wxBitmapBase : public wxGDIObject
1e6feb95
VZ
142{
143public:
1e6feb95
VZ
144 /*
145 Derived class must implement these:
146
147 wxBitmap();
e86f2cc8 148 wxBitmap(const wxBitmap& bmp);
1e6feb95 149 wxBitmap(const char bits[], int width, int height, int depth = 1);
e86f2cc8 150 wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
732d8c74 151 wxBitmap(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH);
452418c4 152 wxBitmap(const char* const* bits);
1e6feb95 153 wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
e86f2cc8 154 wxBitmap(const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH);
1e6feb95
VZ
155
156 static void InitStandardHandlers();
157 */
158
e86f2cc8 159 virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
732d8c74 160 virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH) = 0;
e86f2cc8 161
1e6feb95
VZ
162 virtual int GetHeight() const = 0;
163 virtual int GetWidth() const = 0;
164 virtual int GetDepth() const = 0;
165
c74b07ac
FM
166 wxSize GetSize() const
167 { return wxSize(GetWidth(), GetHeight()); }
168
c0521644 169#if wxUSE_IMAGE
1e6feb95 170 virtual wxImage ConvertToImage() const = 0;
ac04aa99
VZ
171
172 // Convert to disabled (dimmed) bitmap.
173 wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;
c0521644 174#endif // wxUSE_IMAGE
1e6feb95
VZ
175
176 virtual wxMask *GetMask() const = 0;
177 virtual void SetMask(wxMask *mask) = 0;
178
179 virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;
180
181 virtual bool SaveFile(const wxString &name, wxBitmapType type,
d3b9f782 182 const wxPalette *palette = NULL) const = 0;
1e6feb95
VZ
183 virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;
184
f28e099e
VZ
185 /*
186 If raw bitmap access is supported (see wx/rawbmp.h), the following
187 methods should be implemented:
188
189 virtual bool GetRawData(wxRawBitmapData *data) = 0;
190 virtual void UngetRawData(wxRawBitmapData *data) = 0;
191 */
192
193#if wxUSE_PALETTE
1e6feb95
VZ
194 virtual wxPalette *GetPalette() const = 0;
195 virtual void SetPalette(const wxPalette& palette) = 0;
f28e099e 196#endif // wxUSE_PALETTE
1e6feb95 197
1e6feb95
VZ
198 // copies the contents and mask of the given (colour) icon to the bitmap
199 virtual bool CopyFromIcon(const wxIcon& icon) = 0;
200
201 // implementation:
202 virtual void SetHeight(int height) = 0;
203 virtual void SetWidth(int width) = 0;
204 virtual void SetDepth(int depth) = 0;
205
206 // Format handling
207 static inline wxList& GetHandlers() { return sm_handlers; }
e86f2cc8
FM
208 static void AddHandler(wxBitmapHandler *handler);
209 static void InsertHandler(wxBitmapHandler *handler);
1e6feb95
VZ
210 static bool RemoveHandler(const wxString& name);
211 static wxBitmapHandler *FindHandler(const wxString& name);
212 static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);
213 static wxBitmapHandler *FindHandler(wxBitmapType bitmapType);
214
215 //static void InitStandardHandlers();
216 // (wxBitmap must implement this one)
217
218 static void CleanUpHandlers();
219
87f83ac8
VZ
220 // this method is only used by the generic implementation of wxMask
221 // currently but could be useful elsewhere in the future: it can be
222 // overridden to quantize the colour to correspond to bitmap colour depth
223 // if necessary; default implementation simply returns the colour as is
224 virtual wxColour QuantizeColour(const wxColour& colour) const
225 {
226 return colour;
227 }
228
1e6feb95
VZ
229protected:
230 static wxList sm_handlers;
231
232 DECLARE_ABSTRACT_CLASS(wxBitmapBase)
233};
91885f46
VZ
234
235#endif // wxUSE_BITMAP_BASE
1e6feb95 236
cbea3ec6
FM
237
238// the wxBITMAP_DEFAULT_TYPE constant defines the default argument value
239// for wxBitmap's ctor and wxBitmap::LoadFile() functions.
4055ed82 240#if defined(__WXPALMOS__)
cbea3ec6 241 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46 242 #include "wx/palmos/bitmap.h"
ffecfa5a 243#elif defined(__WXMSW__)
cbea3ec6 244 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46 245 #include "wx/msw/bitmap.h"
2049ba38 246#elif defined(__WXMOTIF__)
cbea3ec6 247 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
91885f46 248 #include "wx/x11/bitmap.h"
1be7a35c 249#elif defined(__WXGTK20__)
cbea3ec6 250 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
91885f46 251 #include "wx/gtk/bitmap.h"
1be7a35c 252#elif defined(__WXGTK__)
cbea3ec6 253 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
91885f46 254 #include "wx/gtk1/bitmap.h"
83df96d6 255#elif defined(__WXX11__)
cbea3ec6 256 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_XPM
91885f46 257 #include "wx/x11/bitmap.h"
1e6feb95 258#elif defined(__WXMGL__)
4ca8531f 259 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46 260 #include "wx/mgl/bitmap.h"
b3c86150 261#elif defined(__WXDFB__)
4ca8531f 262 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46 263 #include "wx/dfb/bitmap.h"
34138703 264#elif defined(__WXMAC__)
cbea3ec6 265 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_PICT_RESOURCE
ef0e9220 266 #include "wx/osx/bitmap.h"
fed66a87 267#elif defined(__WXCOCOA__)
cbea3ec6 268 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46 269 #include "wx/cocoa/bitmap.h"
1777b9bb 270#elif defined(__WXPM__)
cbea3ec6 271 #define wxBITMAP_DEFAULT_TYPE wxBITMAP_TYPE_BMP_RESOURCE
91885f46 272 #include "wx/os2/bitmap.h"
c801d85f
KB
273#endif
274
ac04aa99
VZ
275#if wxUSE_IMAGE
276inline
277wxBitmap
278#if wxUSE_BITMAP_BASE
279wxBitmapBase::
280#else
281wxBitmap::
282#endif
283ConvertToDisabled(unsigned char brightness) const
284{
285 return ConvertToImage().ConvertToDisabled(brightness);
286}
287#endif // wxUSE_IMAGE
288
87f83ac8
VZ
289// we must include generic mask.h after wxBitmap definition
290#if defined(__WXMGL__) || defined(__WXDFB__)
291 #define wxUSE_GENERIC_MASK 1
292#else
293 #define wxUSE_GENERIC_MASK 0
294#endif
295
296#if wxUSE_GENERIC_MASK
297 #include "wx/generic/mask.h"
298#endif
299
91885f46 300#endif // _WX_BITMAP_H_BASE_