]>
Commit | Line | Data |
---|---|---|
0dbd6262 SC |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: bitmap.h | |
3 | // Purpose: wxBitmap class | |
4 | // Author: AUTHOR | |
5 | // Modified by: | |
6 | // Created: ??/??/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) AUTHOR | |
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/gdiobj.h" | |
20 | #include "wx/gdicmn.h" | |
21 | #include "wx/palette.h" | |
22 | ||
23 | // Bitmap | |
24 | class WXDLLEXPORT wxDC; | |
25 | class WXDLLEXPORT wxControl; | |
26 | class WXDLLEXPORT wxBitmap; | |
27 | class WXDLLEXPORT wxBitmapHandler; | |
28 | class WXDLLEXPORT wxIcon; | |
29 | class WXDLLEXPORT wxCursor; | |
fd859211 | 30 | class WXDLLEXPORT wxImage; |
0dbd6262 | 31 | |
03e11df5 GD |
32 | GWorldPtr wxMacCreateGWorld( int width , int height , int depth ) ; |
33 | void wxMacDestroyGWorld( GWorldPtr gw ) ; | |
519cb848 | 34 | PicHandle wxMacCreatePict( GWorldPtr gw , GWorldPtr mask = NULL ) ; |
03e11df5 | 35 | void wxMacSetColorTableEntry( CTabHandle newColors , int index , int red , int green , int blue ) ; |
519cb848 SC |
36 | CTabHandle wxMacCreateColorTable( int numColors ) ; |
37 | ||
0dbd6262 SC |
38 | // A mask is a mono bitmap used for drawing bitmaps |
39 | // transparently. | |
40 | class WXDLLEXPORT wxMask: public wxObject | |
41 | { | |
42 | DECLARE_DYNAMIC_CLASS(wxMask) | |
43 | ||
44 | public: | |
45 | wxMask(); | |
46 | ||
47 | // Construct a mask from a bitmap and a colour indicating | |
48 | // the transparent area | |
49 | wxMask(const wxBitmap& bitmap, const wxColour& colour); | |
50 | ||
51 | // Construct a mask from a bitmap and a palette index indicating | |
52 | // the transparent area | |
53 | wxMask(const wxBitmap& bitmap, int paletteIndex); | |
54 | ||
55 | // Construct a mask from a mono bitmap (copies the bitmap). | |
56 | wxMask(const wxBitmap& bitmap); | |
57 | ||
58 | ~wxMask(); | |
59 | ||
60 | bool Create(const wxBitmap& bitmap, const wxColour& colour); | |
61 | bool Create(const wxBitmap& bitmap, int paletteIndex); | |
62 | bool Create(const wxBitmap& bitmap); | |
63 | ||
0dbd6262 | 64 | // Implementation |
5fde6fcc | 65 | bool PointMasked(int x, int y); |
0dbd6262 SC |
66 | inline WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; } |
67 | inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; } | |
68 | protected: | |
69 | WXHBITMAP m_maskBitmap; | |
0dbd6262 SC |
70 | }; |
71 | ||
3dec57ad | 72 | enum { kMacBitmapTypeUnknownType , kMacBitmapTypeGrafWorld, kMacBitmapTypePict , kMacBitmapTypeIcon } ; |
519cb848 | 73 | |
0dbd6262 SC |
74 | class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData |
75 | { | |
76 | friend class WXDLLEXPORT wxBitmap; | |
77 | friend class WXDLLEXPORT wxIcon; | |
78 | friend class WXDLLEXPORT wxCursor; | |
79 | public: | |
80 | wxBitmapRefData(); | |
81 | ~wxBitmapRefData(); | |
82 | ||
83 | public: | |
84 | int m_width; | |
85 | int m_height; | |
86 | int m_depth; | |
87 | bool m_ok; | |
88 | int m_numColors; | |
89 | wxPalette m_bitmapPalette; | |
90 | int m_quality; | |
91 | ||
519cb848 SC |
92 | int m_bitmapType ; |
93 | PicHandle m_hPict ; | |
94 | WXHBITMAP m_hBitmap; | |
3dec57ad | 95 | WXHICON m_hIcon ; |
0dbd6262 SC |
96 | wxMask * m_bitmapMask; // Optional mask |
97 | }; | |
98 | ||
99 | #define M_BITMAPDATA ((wxBitmapRefData *)m_refData) | |
100 | ||
101 | class WXDLLEXPORT wxBitmapHandler: public wxObject | |
102 | { | |
103 | DECLARE_DYNAMIC_CLASS(wxBitmapHandler) | |
104 | public: | |
105 | wxBitmapHandler() { m_name = ""; m_extension = ""; m_type = 0; }; | |
03e11df5 GD |
106 | #ifdef __WXMAC_X__ |
107 | virtual ~wxBitmapHandler() {} // Added min for Mac X | |
108 | #endif | |
0dbd6262 SC |
109 | |
110 | virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1); | |
111 | virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags, | |
112 | int desiredWidth, int desiredHeight); | |
113 | virtual bool SaveFile(wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL); | |
114 | ||
115 | inline void SetName(const wxString& name) { m_name = name; } | |
116 | inline void SetExtension(const wxString& ext) { m_extension = ext; } | |
117 | inline void SetType(long type) { m_type = type; } | |
118 | inline wxString GetName() const { return m_name; } | |
119 | inline wxString GetExtension() const { return m_extension; } | |
120 | inline long GetType() const { return m_type; } | |
121 | protected: | |
122 | wxString m_name; | |
123 | wxString m_extension; | |
124 | long m_type; | |
125 | }; | |
126 | ||
127 | #define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData()) | |
128 | ||
129 | class WXDLLEXPORT wxBitmap: public wxGDIObject | |
130 | { | |
131 | DECLARE_DYNAMIC_CLASS(wxBitmap) | |
132 | ||
133 | friend class WXDLLEXPORT wxBitmapHandler; | |
134 | ||
135 | public: | |
136 | wxBitmap(); // Platform-specific | |
137 | ||
138 | // Copy constructors | |
139 | inline wxBitmap(const wxBitmap& bitmap) | |
140 | { Ref(bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); } | |
141 | ||
142 | // Initialize with raw data. | |
143 | wxBitmap(const char bits[], int width, int height, int depth = 1); | |
144 | ||
0dbd6262 | 145 | // Initialize with XPM data |
b7d667c5 GD |
146 | bool CreateFromXpm(const char **bits); |
147 | wxBitmap(const char **bits); | |
148 | wxBitmap(char **bits); | |
0dbd6262 SC |
149 | |
150 | // Load a file or resource | |
519cb848 | 151 | wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_PICT_RESOURCE); |
0dbd6262 SC |
152 | |
153 | // Constructor for generalised creation from data | |
154 | wxBitmap(void *data, long type, int width, int height, int depth = 1); | |
155 | ||
156 | // If depth is omitted, will create a bitmap compatible with the display | |
157 | wxBitmap(int width, int height, int depth = -1); | |
fd859211 VS |
158 | |
159 | // Convert from wxImage: | |
160 | wxBitmap(const wxImage& image, int depth = -1); | |
161 | ||
0dbd6262 | 162 | ~wxBitmap(); |
fd859211 VS |
163 | |
164 | wxImage ConvertToImage() const; | |
0dbd6262 | 165 | |
5fde6fcc GD |
166 | // get the given part of bitmap |
167 | wxBitmap GetSubBitmap( const wxRect& rect ) const; | |
168 | ||
0dbd6262 SC |
169 | virtual bool Create(int width, int height, int depth = -1); |
170 | virtual bool Create(void *data, long type, int width, int height, int depth = 1); | |
171 | virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE); | |
172 | virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL); | |
173 | ||
5fde6fcc GD |
174 | bool Ok() const; |
175 | int GetWidth() const; | |
176 | int GetHeight() const; | |
177 | int GetDepth() const; | |
178 | int GetQuality() const; | |
0dbd6262 SC |
179 | void SetWidth(int w); |
180 | void SetHeight(int h); | |
181 | void SetDepth(int d); | |
182 | void SetQuality(int q); | |
183 | void SetOk(bool isOk); | |
184 | ||
5fde6fcc | 185 | wxPalette* GetPalette() const; |
0dbd6262 SC |
186 | void SetPalette(const wxPalette& palette); |
187 | ||
5fde6fcc | 188 | wxMask *GetMask() const; |
0dbd6262 SC |
189 | void SetMask(wxMask *mask) ; |
190 | ||
5fde6fcc GD |
191 | int GetBitmapType() const; |
192 | ||
0dbd6262 SC |
193 | inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; } |
194 | inline bool operator == (const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; } | |
195 | inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; } | |
196 | ||
197 | // Format handling | |
198 | static inline wxList& GetHandlers() { return sm_handlers; } | |
199 | static void AddHandler(wxBitmapHandler *handler); | |
200 | static void InsertHandler(wxBitmapHandler *handler); | |
201 | static bool RemoveHandler(const wxString& name); | |
202 | static wxBitmapHandler *FindHandler(const wxString& name); | |
203 | static wxBitmapHandler *FindHandler(const wxString& extension, long bitmapType); | |
204 | static wxBitmapHandler *FindHandler(long bitmapType); | |
205 | ||
206 | static void InitStandardHandlers(); | |
207 | static void CleanUpHandlers(); | |
208 | protected: | |
209 | static wxList sm_handlers; | |
210 | ||
0dbd6262 SC |
211 | // TODO: Implementation |
212 | public: | |
213 | void SetHBITMAP(WXHBITMAP bmp); | |
5fde6fcc | 214 | WXHBITMAP GetHBITMAP() const; |
3dec57ad SC |
215 | void SetHICON(WXHICON ico); |
216 | inline WXHICON GetHICON() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_hIcon : 0); } | |
03e11df5 | 217 | |
5fde6fcc GD |
218 | PicHandle GetPict() const; |
219 | ||
0dbd6262 | 220 | bool FreeResource(bool force = FALSE); |
0dbd6262 SC |
221 | }; |
222 | #endif | |
223 | // _WX_BITMAP_H_ |