include/wx/image.h

   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 #ifdef __GNUG__
  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 #include "wx/bitmap.h"
  22
  23 #if wxUSE_STREAMS
  24 #  include "wx/stream.h"
  25 #endif
  26
  27 #if wxUSE_IMAGE
  28
  29 //-----------------------------------------------------------------------------
  30 // classes
  31 //-----------------------------------------------------------------------------
  32
  33 class WXDLLEXPORT wxImageHandler;
  34 class WXDLLEXPORT wxImage;
  35
  36 //-----------------------------------------------------------------------------
  37 // wxImageHandler
  38 //-----------------------------------------------------------------------------
  39
  40 class WXDLLEXPORT wxImageHandler: public wxObject
  41 {
  42 public:
  43     wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }
  44
  45 #if wxUSE_STREAMS
  46     virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
  47     virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
  48
  49     virtual int GetImageCount( wxInputStream& stream );
  50
  51     bool CanRead( wxInputStream& stream ) { return DoCanRead(stream); }
  52     bool CanRead( const wxString& name );
  53 #endif // wxUSE_STREAMS
  54
  55     void SetName(const wxString& name) { m_name = name; }
  56     void SetExtension(const wxString& ext) { m_extension = ext; }
  57     void SetType(long type) { m_type = type; }
  58     void SetMimeType(const wxString& type) { m_mime = type; }
  59     wxString GetName() const { return m_name; }
  60     wxString GetExtension() const { return m_extension; }
  61     long GetType() const { return m_type; }
  62     wxString GetMimeType() const { return m_mime; }
  63
  64 protected:
  65 #if wxUSE_STREAMS
  66     virtual bool DoCanRead( wxInputStream& stream ) = 0;
  67 #endif // wxUSE_STREAMS
  68
  69     wxString  m_name;
  70     wxString  m_extension;
  71     wxString  m_mime;
  72     long      m_type;
  73
  74 private:
  75     DECLARE_CLASS(wxImageHandler)
  76 };
  77
  78 //-----------------------------------------------------------------------------
  79 // wxImage
  80 //-----------------------------------------------------------------------------
  81
  82 class WXDLLEXPORT wxHNode
  83 {
  84 public:
  85     unsigned long index;
  86     unsigned long value;
  87 };
  88
  89 class WXDLLEXPORT wxImage: public wxObject
  90 {
  91 public:
  92     wxImage();
  93     wxImage( int width, int height );
  94     wxImage( int width, int height, unsigned char* data, bool static_data = FALSE );
  95     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY );
  96     wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
  97     wxImage( const wxString& name, const wxString& mimetype );
  98     wxImage( wxInputStream& stream, const wxString& mimetype );
  99
 100     wxImage( const wxImage& image );
 101     wxImage( const wxImage* image );
 102
 103 #if wxUSE_GUI
 104     // convertion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
 105     wxImage( const wxBitmap &bitmap );
 106     operator wxBitmap() const { return ConvertToBitmap(); }
 107     wxBitmap ConvertToBitmap() const;
 108 #ifdef __WXGTK__
 109     wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;
 110 #endif
 111 #endif
 112
 113     void Create( int width, int height );
 114     void Create( int width, int height, unsigned char* data, bool static_data = FALSE );
 115     void Destroy();
 116
 117     // creates an identical copy of the image (the = operator
 118     // just raises the ref count)
 119     wxImage Copy() const;
 120
 121     // return the new image with size width*height
 122     wxImage GetSubImage( const wxRect& ) const;
 123
 124     // pastes image into this instance and takes care of
 125     // the mask colour and out of bounds problems
 126     void Paste( const wxImage &image, int x, int y );
 127
 128     // return the new image with size width*height
 129     wxImage Scale( int width, int height ) const;
 130
 131     // rescales the image in place
 132     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 133
 134     // Rotates the image about the given point, 'angle' radians.
 135     // Returns the rotated image, leaving this image intact.
 136     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,
 137                    bool interpolating = TRUE, wxPoint * offset_after_rotation = (wxPoint*) NULL) const;
 138
 139     wxImage Rotate90( bool clockwise = TRUE ) const;
 140     wxImage Mirror( bool horizontally = TRUE ) const;
 141
 142     // replace one colour with another
 143     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
 144                   unsigned char r2, unsigned char g2, unsigned char b2 );
 145
 146     // convert to monochrome image (<r,g,b> will be replaced by white, everything else by black)
 147     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 148
 149     // these routines are slow but safe
 150     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
 151     unsigned char GetRed( int x, int y ) const;
 152     unsigned char GetGreen( int x, int y ) const;
 153     unsigned char GetBlue( int x, int y ) const;
 154
 155     static bool CanRead( const wxString& name );
 156     virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY );
 157     virtual bool LoadFile( const wxString& name, const wxString& mimetype );
 158
 159 #if wxUSE_STREAMS
 160     static bool CanRead( wxInputStream& stream );
 161     virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
 162     virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype );
 163 #endif
 164
 165     virtual bool SaveFile( const wxString& name, int type );
 166     virtual bool SaveFile( const wxString& name, const wxString& mimetype );
 167
 168 #if wxUSE_STREAMS
 169     virtual bool SaveFile( wxOutputStream& stream, int type );
 170     virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype );
 171 #endif
 172
 173     bool Ok() const;
 174     int GetWidth() const;
 175     int GetHeight() const;
 176
 177     char unsigned *GetData() const;
 178     void SetData( char unsigned *data );
 179     void SetData( char unsigned *data, int new_width, int new_height );
 180
 181     // Mask functions
 182     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
 183     unsigned char GetMaskRed() const;
 184     unsigned char GetMaskGreen() const;
 185     unsigned char GetMaskBlue() const;
 186     void SetMask( bool mask = TRUE );
 187     bool HasMask() const;
 188
 189     // Palette functions
 190     bool HasPalette() const;
 191     const wxPalette& GetPalette() const;
 192     void SetPalette(const wxPalette& palette);
 193
 194     // Option functions (arbitrary name/value mapping)
 195     void SetOption(const wxString& name, const wxString& value);
 196     void SetOption(const wxString& name, int value);
 197     wxString GetOption(const wxString& name) const;
 198     int GetOptionInt(const wxString& name) const;
 199     bool HasOption(const wxString& name) const;
 200
 201     unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 );
 202     unsigned long ComputeHistogram( wxHashTable &h );
 203
 204     wxImage& operator = (const wxImage& image)
 205     {
 206         if ( (*this) != image )
 207             Ref(image);
 208         return *this;
 209     }
 210
 211     bool operator == (const wxImage& image)
 212         { return m_refData == image.m_refData; }
 213     bool operator != (const wxImage& image)
 214         { return m_refData != image.m_refData; }
 215
 216     static wxList& GetHandlers() { return sm_handlers; }
 217     static void AddHandler( wxImageHandler *handler );
 218     static void InsertHandler( wxImageHandler *handler );
 219     static bool RemoveHandler( const wxString& name );
 220     static wxImageHandler *FindHandler( const wxString& name );
 221     static wxImageHandler *FindHandler( const wxString& extension, long imageType );
 222     static wxImageHandler *FindHandler( long imageType );
 223     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 224
 225     static void CleanUpHandlers();
 226     static void InitStandardHandlers();
 227
 228 protected:
 229     static wxList   sm_handlers;
 230
 231 private:
 232     friend class WXDLLEXPORT wxImageHandler;
 233
 234     DECLARE_DYNAMIC_CLASS(wxImage)
 235 };
 236
 237
 238 extern void WXDLLEXPORT wxInitAllImageHandlers();
 239
 240 WXDLLEXPORT_DATA(extern wxImage)    wxNullImage;
 241
 242 //-----------------------------------------------------------------------------
 243 // wxImage handlers
 244 //-----------------------------------------------------------------------------
 245
 246 #include "wx/imagbmp.h"
 247 #include "wx/imagpng.h"
 248 #include "wx/imaggif.h"
 249 #include "wx/imagpcx.h"
 250 #include "wx/imagjpeg.h"
 251 #include "wx/imagtiff.h"
 252 #include "wx/imagpnm.h"
 253 #include "wx/imagxpm.h"
 254
 255 #endif // wxUSE_IMAGE
 256
 257 #endif
 258   // _WX_IMAGE_H_
 259