]> git.saurik.com Git - wxWidgets.git/blame - include/wx/os2/bitmap.h
Applied patch [ 619705 ] Fixes wxApp::GetComCtl32Version
[wxWidgets.git] / include / wx / os2 / bitmap.h
CommitLineData
0e320a79 1/////////////////////////////////////////////////////////////////////////////
3b9e3455 2// Name: wx/os2/bitmap.h
0e320a79 3// Purpose: wxBitmap class
d88de032 4// Author: David Webster
0e320a79 5// Modified by:
3b9e3455 6// Created: 11/28/99
0e320a79 7// RCS-ID: $Id$
d88de032
DW
8// Copyright: (c) David Webster
9// Licence: wxWindows licence
0e320a79
DW
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_BITMAP_H_
13#define _WX_BITMAP_H_
14
3b9e3455
DW
15#ifdef __GNUG__
16 #pragma interface "bitmap.h"
17#endif
18
58b16424 19#include "wx/os2/private.h"
3b9e3455 20#include "wx/os2/gdiimage.h"
0e320a79
DW
21#include "wx/gdicmn.h"
22#include "wx/palette.h"
23
0e320a79
DW
24class WXDLLEXPORT wxDC;
25class WXDLLEXPORT wxControl;
26class WXDLLEXPORT wxBitmap;
27class WXDLLEXPORT wxBitmapHandler;
28class WXDLLEXPORT wxIcon;
3b9e3455 29class WXDLLEXPORT wxMask;
0e320a79 30class WXDLLEXPORT wxCursor;
d88de032 31class WXDLLEXPORT wxControl;
fd859211 32class WXDLLEXPORT wxImage;
0e320a79 33
3b9e3455
DW
34// ----------------------------------------------------------------------------
35// Bitmap data
36//
37// NB: this class is private, but declared here to make it possible inline
38// wxBitmap functions accessing it
39// ----------------------------------------------------------------------------
0e320a79 40
3b9e3455 41class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
0e320a79 42{
0e320a79
DW
43public:
44 wxBitmapRefData();
3b9e3455
DW
45 virtual ~wxBitmapRefData() { Free(); }
46
47 virtual void Free();
0e320a79
DW
48
49public:
3b9e3455
DW
50 int m_nNumColors;
51 wxPalette m_vBitmapPalette;
52 int m_nQuality;
0e320a79 53
3b9e3455
DW
54 // OS2-specific
55 // ------------
0e320a79 56
3b9e3455 57 wxDC* m_pSelectedInto;
3b9e3455 58
8bb6da4a
DW
59 //
60 // Optional mask for transparent drawing
61 //
3b9e3455 62 wxMask* m_pBitmapMask;
8bb6da4a 63}; // end of CLASS wxBitmapRefData
0e320a79 64
3b9e3455
DW
65// ----------------------------------------------------------------------------
66// wxBitmap: a mono or colour bitmap
67// ----------------------------------------------------------------------------
0e320a79 68
3b9e3455 69class WXDLLEXPORT wxBitmap : public wxGDIImage
0e320a79 70{
0e320a79 71public:
3b9e3455
DW
72 // default ctor creates an invalid bitmap, you must Create() it later
73 wxBitmap() { Init(); }
74
75 // Copy constructors
76 inline wxBitmap(const wxBitmap& rBitmap)
10769d8c 77 { Init(); Ref(rBitmap); SetHandle(rBitmap.GetHandle()); }
3b9e3455
DW
78
79 // Initialize with raw data
80 wxBitmap( const char bits[]
81 ,int nWidth
82 ,int nHeight
83 ,int nDepth = 1
84 );
85
86 // Initialize with XPM data
98edf626
DW
87 wxBitmap(const char** ppData) { CreateFromXpm(ppData); }
88 wxBitmap(char** ppData) { CreateFromXpm((const char**)ppData); }
3b9e3455 89
b6f4144e
DW
90 // Load a resource
91 wxBitmap( int nId
3b9e3455
DW
92 ,long lType = wxBITMAP_TYPE_BMP_RESOURCE
93 );
94
b6f4144e
DW
95 // For compatiability with other ports, under OS/2 does same as default ctor
96 inline wxBitmap( const wxString& WXUNUSED(rFilename)
97 ,long WXUNUSED(lType)
98 )
99 { Init(); }
3b9e3455
DW
100 // New constructor for generalised creation from data
101 wxBitmap( void* pData
102 ,long lType
103 ,int nWidth
104 ,int nHeight
105 ,int nDepth = 1
106 );
107
108 // If depth is omitted, will create a bitmap compatible with the display
109 wxBitmap( int nWidth
110 ,int nHeight
111 ,int nDepth = -1
112 );
113
98edf626 114 wxBitmap( const wxImage& image, int depth = -1 )
fd859211
VS
115 { (void)CreateFromImage(image, depth); }
116
3b9e3455
DW
117 // we must have this, otherwise icons are silently copied into bitmaps using
118 // the copy ctor but the resulting bitmap is invalid!
119 inline wxBitmap(const wxIcon& rIcon)
120 { Init(); CopyFromIcon(rIcon); }
121
122 wxBitmap& operator=(const wxBitmap& rBitmap)
123 {
124 if ( m_refData != rBitmap.m_refData )
125 Ref(rBitmap);
126 return(*this);
127 }
128
129 wxBitmap& operator=(const wxIcon& rIcon)
130 {
131 (void)CopyFromIcon(rIcon);
132
133 return(*this);
134 }
135
136 wxBitmap& operator=(const wxCursor& rCursor)
137 {
138 (void)CopyFromCursor(rCursor);
139 return (*this);
140 }
141
142 virtual ~wxBitmap();
143
98edf626 144 wxImage ConvertToImage() const;
fd859211 145
341366c6
DW
146 // get the given part of bitmap
147 wxBitmap GetSubBitmap(const wxRect& rRect) const;
148
3b9e3455
DW
149 // copies the contents and mask of the given (colour) icon to the bitmap
150 bool CopyFromIcon(const wxIcon& rIcon);
151
152 // copies the contents and mask of the given cursor to the bitmap
153 bool CopyFromCursor(const wxCursor& rCursor);
154
155 virtual bool Create( int nWidth
156 ,int nHeight
157 ,int nDepth = -1
158 );
159 virtual bool Create( void* pData
160 ,long lType
161 ,int nWidth
162 ,int nHeight
163 ,int nDepth = 1
164 );
b6f4144e 165 virtual bool LoadFile( int nId
3b9e3455
DW
166 ,long lType = wxBITMAP_TYPE_BMP_RESOURCE
167 );
168 virtual bool SaveFile( const wxString& rName
169 ,int lType
170 ,const wxPalette* pCmap = NULL
171 );
172
173 inline wxBitmapRefData* GetBitmapData() const
174 { return (wxBitmapRefData *)m_refData; }
175
176 inline int GetQuality() const
58b16424 177 { return (GetBitmapData() ? GetBitmapData()->m_nQuality : 0); }
3b9e3455
DW
178
179 void SetQuality(int nQ);
180
181 wxPalette* GetPalette() const
58b16424 182 { return (GetBitmapData() ? (& GetBitmapData()->m_vBitmapPalette) : (wxPalette*) NULL); }
3b9e3455
DW
183
184 void SetPalette(const wxPalette& rPalette);
185
186 inline wxMask* GetMask() const
58b16424 187 { return (GetBitmapData() ? GetBitmapData()->m_pBitmapMask : (wxMask*) NULL); }
3b9e3455
DW
188
189 void SetMask(wxMask* pMask) ;
190
ab4fece8 191 inline bool operator==(const wxBitmap& rBitmap) const
3b9e3455
DW
192 { return m_refData == rBitmap.m_refData; }
193
ab4fece8 194 inline bool operator!=(const wxBitmap& rBitmap) const
3b9e3455
DW
195 { return m_refData != rBitmap.m_refData; }
196
197#if WXWIN_COMPATIBILITY_2
198 void SetOk(bool bIsOk);
199#endif // WXWIN_COMPATIBILITY_2
0e320a79 200
3b9e3455
DW
201#if WXWIN_COMPATIBILITY
202 inline wxPalette* GetColourMap() const
203 { return GetPalette(); }
0e320a79 204
3b9e3455
DW
205 inline void SetColourMap(wxPalette* pCmap)
206 { SetPalette(*pCmap); };
0e320a79 207
3b9e3455 208#endif // WXWIN_COMPATIBILITY
0e320a79 209
3b9e3455
DW
210 // Implementation
211public:
58b16424
DW
212 inline void SetHBITMAP(WXHBITMAP hBmp)
213 { SetHandle((WXHANDLE)hBmp); }
3b9e3455
DW
214
215 inline WXHBITMAP GetHBITMAP() const
216 { return (WXHBITMAP)GetHandle(); }
217
218 inline void SetSelectedInto(wxDC* pDc)
58b16424 219 { if (GetBitmapData()) GetBitmapData()->m_pSelectedInto = pDc; }
3b9e3455
DW
220
221 inline wxDC* GetSelectedInto() const
58b16424 222 { return (GetBitmapData() ? GetBitmapData()->m_pSelectedInto : (wxDC*) NULL); }
3b9e3455 223
79c09341 224 inline bool IsMono(void) const { return m_bIsMono; }
1759c491 225
4f72fe4f 226 // An OS/2 version that probably doesn't do anything like the msw version
3b9e3455 227 wxBitmap GetBitmapForDC(wxDC& rDc) const;
0e320a79 228
3b9e3455
DW
229protected:
230 // common part of all ctors
231 void Init();
0e320a79 232
3b9e3455
DW
233 inline virtual wxGDIImageRefData* CreateData() const
234 { return new wxBitmapRefData; }
0e320a79 235
341366c6 236 // creates the bitmap from XPM data, supposed to be called from ctor
98edf626 237 bool CreateFromXpm(const char** ppData);
fd859211 238 bool CreateFromImage(const wxImage& image, int depth);
341366c6 239
3b9e3455
DW
240private:
241 bool CopyFromIconOrCursor(const wxGDIImage& rIcon);
0e320a79 242
79c09341 243 bool m_bIsMono;
3b9e3455 244 DECLARE_DYNAMIC_CLASS(wxBitmap)
341366c6 245}; // end of CLASS wxBitmap
d88de032 246
3b9e3455
DW
247// ----------------------------------------------------------------------------
248// wxMask: a mono bitmap used for drawing bitmaps transparently.
249// ----------------------------------------------------------------------------
0e320a79 250
3b9e3455
DW
251class WXDLLEXPORT wxMask : public wxObject
252{
253public:
254 wxMask();
255
256 // Construct a mask from a bitmap and a colour indicating the transparent
257 // area
258 wxMask( const wxBitmap& rBitmap
259 ,const wxColour& rColour
260 );
261
262 // Construct a mask from a bitmap and a palette index indicating the
263 // transparent area
264 wxMask( const wxBitmap& rBitmap
265 ,int nPaletteIndex
266 );
267
268 // Construct a mask from a mono bitmap (copies the bitmap).
269 wxMask(const wxBitmap& rBitmap);
270
271 // construct a mask from the givne bitmap handle
272 wxMask(WXHBITMAP hBmp)
273 { m_hMaskBitmap = hBmp; }
274
275 virtual ~wxMask();
276
277 bool Create( const wxBitmap& bitmap
278 ,const wxColour& rColour
279 );
280 bool Create( const wxBitmap& rBitmap
281 ,int nPaletteIndex
282 );
283 bool Create(const wxBitmap& rBitmap);
284
285 // Implementation
286 WXHBITMAP GetMaskBitmap() const
287 { return m_hMaskBitmap; }
288 void SetMaskBitmap(WXHBITMAP hBmp)
289 { m_hMaskBitmap = hBmp; }
0e320a79 290
0e320a79 291protected:
3b9e3455
DW
292 WXHBITMAP m_hMaskBitmap;
293 DECLARE_DYNAMIC_CLASS(wxMask)
8bb6da4a 294}; // end of CLASS wxMask
3b9e3455
DW
295
296// ----------------------------------------------------------------------------
297// wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
298// ----------------------------------------------------------------------------
0e320a79 299
3b9e3455
DW
300class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
301{
0e320a79 302public:
3b9e3455
DW
303 inline wxBitmapHandler()
304 { m_lType = wxBITMAP_TYPE_INVALID; }
305
306 inline wxBitmapHandler( const wxString& rName
307 ,const wxString& rExt
308 ,long lType
309 )
310 : wxGDIImageHandler( rName
311 ,rExt
312 ,lType)
313 {
314 }
315
316 // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
317 // old class which worked only with bitmaps
318 virtual bool Create( wxBitmap* pBitmap
319 ,void* pData
320 ,long lFlags
321 ,int nWidth
322 ,int nHeight
323 ,int nDepth = 1
324 );
325 virtual bool LoadFile( wxBitmap* pBitmap
b6f4144e 326 ,int nId
3b9e3455
DW
327 ,long lFlags
328 ,int nDesiredWidth
329 ,int nDesiredHeight
330 );
331 virtual bool SaveFile( wxBitmap* pBitmap
332 ,const wxString& rName
333 ,int lType
334 ,const wxPalette* pPalette = NULL
335 );
336
337 virtual bool Create( wxGDIImage* pImage
338 ,void* pData
339 ,long lFlags
340 ,int nWidth
341 ,int nHeight
342 ,int nDepth = 1
343 );
344 virtual bool Load( wxGDIImage* pImage
b6f4144e 345 ,int nId
3b9e3455
DW
346 ,long lFlags
347 ,int nDesiredWidth
348 ,int nDesiredHeight
349 );
58b16424
DW
350 virtual bool Save( wxGDIImage* pImage
351 ,const wxString& rName
352 ,int lType
3b9e3455
DW
353 );
354private:
b6f4144e
DW
355 inline virtual bool Load( wxGDIImage* pImage
356 ,const wxString& rName
357 ,HPS hPs
358 ,long lFlags
359 ,int nDesiredWidth
360 ,int nDesiredHeight
361 )
362 { return FALSE; }
3b9e3455 363 DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
8bb6da4a 364}; // end of CLASS wxBitmapHandler
3b9e3455 365
0e320a79
DW
366#endif
367 // _WX_BITMAP_H_