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