]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: image.h | |
3 | // Purpose: wxImage class | |
4 | // Author: Robert Roebling | |
5 | // RCS-ID: $Id$ | |
6 | // Copyright: (c) Robert Roebling | |
7 | // Licence: wxWindows licence | |
8 | ///////////////////////////////////////////////////////////////////////////// | |
9 | ||
10 | #ifndef _WX_IMAGE_H_ | |
11 | #define _WX_IMAGE_H_ | |
12 | ||
13 | #if defined(__GNUG__) && !defined(__APPLE__) | |
14 | #pragma interface "image.h" | |
15 | #endif | |
16 | ||
17 | #include "wx/setup.h" | |
18 | #include "wx/object.h" | |
19 | #include "wx/string.h" | |
20 | #include "wx/gdicmn.h" | |
21 | #if WXWIN_COMPATIBILITY_2_2 | |
22 | # include "wx/bitmap.h" | |
23 | #endif | |
24 | #include "wx/hashmap.h" | |
25 | ||
26 | #if wxUSE_STREAMS | |
27 | # include "wx/stream.h" | |
28 | #endif | |
29 | ||
30 | #if wxUSE_IMAGE | |
31 | ||
32 | // on some systems (Unixware 7.x) index is defined as a macro in the headers | |
33 | // which breaks the compilation below | |
34 | #undef index | |
35 | ||
36 | #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName")) | |
37 | ||
38 | //----------------------------------------------------------------------------- | |
39 | // classes | |
40 | //----------------------------------------------------------------------------- | |
41 | ||
42 | class WXDLLEXPORT wxImageHandler; | |
43 | class WXDLLEXPORT wxImage; | |
44 | class WXDLLEXPORT wxPalette; | |
45 | ||
46 | //----------------------------------------------------------------------------- | |
47 | // wxImageHandler | |
48 | //----------------------------------------------------------------------------- | |
49 | ||
50 | class WXDLLEXPORT wxImageHandler: public wxObject | |
51 | { | |
52 | public: | |
53 | wxImageHandler() | |
54 | : m_name(wxT("")), m_extension(wxT("")), m_mime(), m_type(0) | |
55 | { } | |
56 | ||
57 | #if wxUSE_STREAMS | |
58 | virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 ); | |
59 | virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ); | |
60 | ||
61 | virtual int GetImageCount( wxInputStream& stream ); | |
62 | ||
63 | bool CanRead( wxInputStream& stream ) { return CallDoCanRead(stream); } | |
64 | bool CanRead( const wxString& name ); | |
65 | #endif // wxUSE_STREAMS | |
66 | ||
67 | void SetName(const wxString& name) { m_name = name; } | |
68 | void SetExtension(const wxString& ext) { m_extension = ext; } | |
69 | void SetType(long type) { m_type = type; } | |
70 | void SetMimeType(const wxString& type) { m_mime = type; } | |
71 | wxString GetName() const { return m_name; } | |
72 | wxString GetExtension() const { return m_extension; } | |
73 | long GetType() const { return m_type; } | |
74 | wxString GetMimeType() const { return m_mime; } | |
75 | ||
76 | protected: | |
77 | #if wxUSE_STREAMS | |
78 | virtual bool DoCanRead( wxInputStream& stream ) = 0; | |
79 | ||
80 | // save the stream position, call DoCanRead() and restore the position | |
81 | bool CallDoCanRead(wxInputStream& stream); | |
82 | #endif // wxUSE_STREAMS | |
83 | ||
84 | wxString m_name; | |
85 | wxString m_extension; | |
86 | wxString m_mime; | |
87 | long m_type; | |
88 | ||
89 | private: | |
90 | DECLARE_CLASS(wxImageHandler) | |
91 | }; | |
92 | ||
93 | //----------------------------------------------------------------------------- | |
94 | // wxImageHistogram | |
95 | //----------------------------------------------------------------------------- | |
96 | ||
97 | class WXDLLEXPORT wxImageHistogramEntry | |
98 | { | |
99 | public: | |
100 | wxImageHistogramEntry() { index = value = 0; } | |
101 | unsigned long index; | |
102 | unsigned long value; | |
103 | }; | |
104 | ||
105 | WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry, | |
106 | wxIntegerHash, wxIntegerEqual, | |
107 | wxImageHistogramBase); | |
108 | ||
109 | class WXDLLEXPORT wxImageHistogram : public wxImageHistogramBase | |
110 | { | |
111 | public: | |
112 | wxImageHistogram() : wxImageHistogramBase(256) { } | |
113 | ||
114 | // get the key in the histogram for the given RGB values | |
115 | static unsigned long MakeKey(unsigned char r, | |
116 | unsigned char g, | |
117 | unsigned char b) | |
118 | { | |
119 | return (r << 16) | (g << 8) | b; | |
120 | } | |
121 | ||
122 | // find first colour that is not used in the image and has higher | |
123 | // RGB values than RGB(startR, startG, startB) | |
124 | // | |
125 | // returns true and puts this colour in r, g, b (each of which may be NULL) | |
126 | // on success or returns false if there are no more free colours | |
127 | bool FindFirstUnusedColour(unsigned char *r, | |
128 | unsigned char *g, | |
129 | unsigned char *b, | |
130 | unsigned char startR = 1, | |
131 | unsigned char startG = 0, | |
132 | unsigned char startB = 0 ) const; | |
133 | }; | |
134 | ||
135 | //----------------------------------------------------------------------------- | |
136 | // wxImage | |
137 | //----------------------------------------------------------------------------- | |
138 | ||
139 | class WXDLLEXPORT wxImage: public wxObject | |
140 | { | |
141 | public: | |
142 | wxImage(); | |
143 | wxImage( int width, int height, bool clear = true ); | |
144 | wxImage( int width, int height, unsigned char* data, bool static_data = FALSE ); | |
145 | wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 ); | |
146 | wxImage( const wxString& name, const wxString& mimetype, int index = -1 ); | |
147 | ||
148 | #if wxUSE_STREAMS | |
149 | wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ); | |
150 | wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 ); | |
151 | #endif // wxUSE_STREAMS | |
152 | ||
153 | wxImage( const wxImage& image ); | |
154 | wxImage( const wxImage* image ); | |
155 | ||
156 | #if WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI | |
157 | // conversion to/from wxBitmap (deprecated, use wxBitmap's methods instead): | |
158 | wxDEPRECATED( wxImage(const wxBitmap &bitmap) ); | |
159 | wxDEPRECATED( wxBitmap ConvertToBitmap() const ); | |
160 | #ifdef __WXGTK__ | |
161 | wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const; | |
162 | #endif | |
163 | #endif | |
164 | ||
165 | bool Create( int width, int height, bool clear = true ); | |
166 | bool Create( int width, int height, unsigned char* data, bool static_data = FALSE ); | |
167 | void Destroy(); | |
168 | ||
169 | // creates an identical copy of the image (the = operator | |
170 | // just raises the ref count) | |
171 | wxImage Copy() const; | |
172 | ||
173 | // return the new image with size width*height | |
174 | wxImage GetSubImage( const wxRect& ) const; | |
175 | ||
176 | // pastes image into this instance and takes care of | |
177 | // the mask colour and out of bounds problems | |
178 | void Paste( const wxImage &image, int x, int y ); | |
179 | ||
180 | // return the new image with size width*height | |
181 | wxImage Scale( int width, int height ) const; | |
182 | ||
183 | wxImage ShrinkBy( int xFactor , int yFactor ) const ; | |
184 | ||
185 | // rescales the image in place | |
186 | wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); } | |
187 | ||
188 | // Rotates the image about the given point, 'angle' radians. | |
189 | // Returns the rotated image, leaving this image intact. | |
190 | wxImage Rotate(double angle, const wxPoint & centre_of_rotation, | |
191 | bool interpolating = TRUE, wxPoint * offset_after_rotation = (wxPoint*) NULL) const; | |
192 | ||
193 | wxImage Rotate90( bool clockwise = TRUE ) const; | |
194 | wxImage Mirror( bool horizontally = TRUE ) const; | |
195 | ||
196 | // replace one colour with another | |
197 | void Replace( unsigned char r1, unsigned char g1, unsigned char b1, | |
198 | unsigned char r2, unsigned char g2, unsigned char b2 ); | |
199 | ||
200 | // convert to monochrome image (<r,g,b> will be replaced by white, everything else by black) | |
201 | wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const; | |
202 | ||
203 | // these routines are slow but safe | |
204 | void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b ); | |
205 | unsigned char GetRed( int x, int y ) const; | |
206 | unsigned char GetGreen( int x, int y ) const; | |
207 | unsigned char GetBlue( int x, int y ) const; | |
208 | ||
209 | void SetAlpha(int x, int y, unsigned char alpha); | |
210 | unsigned char GetAlpha(int x, int y); | |
211 | ||
212 | // find first colour that is not used in the image and has higher | |
213 | // RGB values than <startR,startG,startB> | |
214 | bool FindFirstUnusedColour( unsigned char *r, unsigned char *g, unsigned char *b, | |
215 | unsigned char startR = 1, unsigned char startG = 0, | |
216 | unsigned char startB = 0 ) const; | |
217 | // Set image's mask to the area of 'mask' that has <r,g,b> colour | |
218 | bool SetMaskFromImage(const wxImage & mask, | |
219 | unsigned char mr, unsigned char mg, unsigned char mb); | |
220 | ||
221 | static bool CanRead( const wxString& name ); | |
222 | static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY ); | |
223 | virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 ); | |
224 | virtual bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 ); | |
225 | ||
226 | #if wxUSE_STREAMS | |
227 | static bool CanRead( wxInputStream& stream ); | |
228 | static int GetImageCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY ); | |
229 | virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ); | |
230 | virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 ); | |
231 | #endif | |
232 | ||
233 | virtual bool SaveFile( const wxString& name ) const; | |
234 | virtual bool SaveFile( const wxString& name, int type ) const; | |
235 | virtual bool SaveFile( const wxString& name, const wxString& mimetype ) const; | |
236 | ||
237 | #if wxUSE_STREAMS | |
238 | virtual bool SaveFile( wxOutputStream& stream, int type ) const; | |
239 | virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const; | |
240 | #endif | |
241 | ||
242 | bool Ok() const; | |
243 | int GetWidth() const; | |
244 | int GetHeight() const; | |
245 | ||
246 | // these functions provide fastest access to wxImage data but should be | |
247 | // used carefully as no checks are done | |
248 | unsigned char *GetData() const; | |
249 | void SetData( unsigned char *data ); | |
250 | void SetData( unsigned char *data, int new_width, int new_height ); | |
251 | ||
252 | unsigned char *GetAlpha() const; // may return NULL! | |
253 | bool HasAlpha() const { return GetAlpha() != NULL; } | |
254 | void SetAlpha(unsigned char *alpha = NULL); | |
255 | ||
256 | // Mask functions | |
257 | void SetMaskColour( unsigned char r, unsigned char g, unsigned char b ); | |
258 | unsigned char GetMaskRed() const; | |
259 | unsigned char GetMaskGreen() const; | |
260 | unsigned char GetMaskBlue() const; | |
261 | void SetMask( bool mask = TRUE ); | |
262 | bool HasMask() const; | |
263 | ||
264 | #if wxUSE_PALETTE | |
265 | // Palette functions | |
266 | bool HasPalette() const; | |
267 | const wxPalette& GetPalette() const; | |
268 | void SetPalette(const wxPalette& palette); | |
269 | #endif // wxUSE_PALETTE | |
270 | ||
271 | // Option functions (arbitrary name/value mapping) | |
272 | void SetOption(const wxString& name, const wxString& value); | |
273 | void SetOption(const wxString& name, int value); | |
274 | wxString GetOption(const wxString& name) const; | |
275 | int GetOptionInt(const wxString& name) const; | |
276 | bool HasOption(const wxString& name) const; | |
277 | ||
278 | unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 ) const; | |
279 | ||
280 | // Computes the histogram of the image and fills a hash table, indexed | |
281 | // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry | |
282 | // objects. Each of them contains an 'index' (useful to build a palette | |
283 | // with the image colours) and a 'value', which is the number of pixels | |
284 | // in the image with that colour. | |
285 | // Returned value: # of entries in the histogram | |
286 | unsigned long ComputeHistogram( wxImageHistogram &h ) const; | |
287 | ||
288 | wxImage& operator = (const wxImage& image) | |
289 | { | |
290 | if ( (*this) != image ) | |
291 | Ref(image); | |
292 | return *this; | |
293 | } | |
294 | ||
295 | bool operator == (const wxImage& image) const | |
296 | { return m_refData == image.m_refData; } | |
297 | bool operator != (const wxImage& image) const | |
298 | { return m_refData != image.m_refData; } | |
299 | ||
300 | static wxList& GetHandlers() { return sm_handlers; } | |
301 | static void AddHandler( wxImageHandler *handler ); | |
302 | static void InsertHandler( wxImageHandler *handler ); | |
303 | static bool RemoveHandler( const wxString& name ); | |
304 | static wxImageHandler *FindHandler( const wxString& name ); | |
305 | static wxImageHandler *FindHandler( const wxString& extension, long imageType ); | |
306 | static wxImageHandler *FindHandler( long imageType ); | |
307 | static wxImageHandler *FindHandlerMime( const wxString& mimetype ); | |
308 | ||
309 | static void CleanUpHandlers(); | |
310 | static void InitStandardHandlers(); | |
311 | ||
312 | protected: | |
313 | static wxList sm_handlers; | |
314 | ||
315 | private: | |
316 | friend class WXDLLEXPORT wxImageHandler; | |
317 | ||
318 | DECLARE_DYNAMIC_CLASS(wxImage) | |
319 | }; | |
320 | ||
321 | ||
322 | extern void WXDLLEXPORT wxInitAllImageHandlers(); | |
323 | ||
324 | WXDLLEXPORT_DATA(extern wxImage) wxNullImage; | |
325 | ||
326 | //----------------------------------------------------------------------------- | |
327 | // wxImage handlers | |
328 | //----------------------------------------------------------------------------- | |
329 | ||
330 | #include "wx/imagbmp.h" | |
331 | #include "wx/imagpng.h" | |
332 | #include "wx/imaggif.h" | |
333 | #include "wx/imagpcx.h" | |
334 | #include "wx/imagjpeg.h" | |
335 | #include "wx/imagtiff.h" | |
336 | #include "wx/imagpnm.h" | |
337 | #include "wx/imagxpm.h" | |
338 | #include "wx/imagiff.h" | |
339 | ||
340 | #endif // wxUSE_IMAGE | |
341 | ||
342 | #endif | |
343 | // _WX_IMAGE_H_ | |
344 |