wxPython/src/image.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        image.i
   3 // Purpose:     SWIG interface file for wxImage, wxImageHandler, etc.
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     28-Apr-1999
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13
  14 %module image
  15
  16 %{
  17 #include "helpers.h"
  18 #include "pyistream.h"
  19 #include <wx/image.h>
  20 %}
  21
  22 //----------------------------------------------------------------------
  23
  24 %include typemaps.i
  25 %include my_typemaps.i
  26
  27 // Import some definitions of other classes, etc.
  28 %import _defs.i
  29 %import misc.i
  30 %import gdi.i
  31 %import streams.i
  32
  33 //---------------------------------------------------------------------------
  34
  35 class wxImageHandler : public wxObject {
  36 public:
  37     // wxImageHandler();    Abstract Base Class
  38     wxString GetName();
  39     wxString GetExtension();
  40     long GetType();
  41     wxString GetMimeType();
  42
  43     //bool LoadFile(wxImage* image, wxInputStream& stream);
  44     //bool SaveFile(wxImage* image, wxOutputStream& stream);
  45     //virtual int GetImageCount( wxInputStream& stream );
  46     //bool CanRead( wxInputStream& stream );
  47
  48     bool CanRead( const wxString& name );
  49
  50     void SetName(const wxString& name);
  51     void SetExtension(const wxString& extension);
  52     void SetType(long type);
  53     void SetMimeType(const wxString& mimetype);
  54 };
  55
  56 //---------------------------------------------------------------------------
  57
  58 class wxPNGHandler : public wxImageHandler {
  59 public:
  60     wxPNGHandler();
  61 };
  62
  63
  64 class wxJPEGHandler : public wxImageHandler {
  65 public:
  66     wxJPEGHandler();
  67 };
  68
  69
  70 class wxBMPHandler : public wxImageHandler {
  71 public:
  72     wxBMPHandler();
  73 };
  74
  75 class wxICOHandler : public wxBMPHandler {
  76 public:
  77     wxICOHandler();
  78 };
  79
  80 class wxCURHandler : public wxICOHandler {
  81 public:
  82     wxCURHandler();
  83 };
  84
  85 class wxANIHandler : public wxCURHandler {
  86 public:
  87     wxANIHandler();
  88 };
  89
  90 class wxGIFHandler : public wxImageHandler {
  91 public:
  92     wxGIFHandler();
  93 };
  94
  95 class wxPNMHandler : public wxImageHandler {
  96 public:
  97     wxPNMHandler();
  98 };
  99
 100 class wxPCXHandler : public wxImageHandler {
 101 public:
 102     wxPCXHandler();
 103 };
 104
 105 class wxTIFFHandler : public wxImageHandler {
 106 public:
 107     wxTIFFHandler();
 108 };
 109
 110
 111
 112 //---------------------------------------------------------------------------
 113
 114 class wxImage : public wxObject {
 115 public:
 116     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 117     ~wxImage();
 118
 119     wxBitmap ConvertToBitmap(); // deprecated
 120 #ifdef __WXGTK__
 121     wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;
 122 #endif
 123     void Create( int width, int height );
 124     void Destroy();
 125
 126     wxImage Scale( int width, int height );
 127     wxImage& Rescale(int width, int height);
 128
 129     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
 130     unsigned char GetRed( int x, int y );
 131     unsigned char GetGreen( int x, int y );
 132     unsigned char GetBlue( int x, int y );
 133
 134     static bool CanRead( const wxString& name );
 135     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
 136
 137     bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 138     %name(LoadMimeFile)bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 );
 139
 140     bool SaveFile( const wxString& name, int type );
 141     %name(SaveMimeFile)bool SaveFile( const wxString& name, const wxString& mimetype );
 142
 143     %name(CanReadStream) static bool CanRead( wxInputStream& stream );
 144     %name(LoadStream) bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
 145     %name(LoadMimeStream) bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 146
 147     bool Ok();
 148     int GetWidth();
 149     int GetHeight();
 150
 151     wxImage GetSubImage(const wxRect& rect);
 152     wxImage Copy();
 153     void Paste( const wxImage &image, int x, int y );
 154
 155     //unsigned char *GetData();
 156     //void SetData( unsigned char *data );
 157
 158     %addmethods {
 159         PyObject* GetData() {
 160             unsigned char* data = self->GetData();
 161             int len = self->GetWidth() * self->GetHeight() * 3;
 162             return PyString_FromStringAndSize((char*)data, len);
 163         }
 164
 165         void SetData(PyObject* data) {
 166             unsigned char* dataPtr;
 167
 168             if (! PyString_Check(data)) {
 169                 PyErr_SetString(PyExc_TypeError, "Expected string object");
 170                 return /* NULL */ ;
 171             }
 172
 173             size_t len = self->GetWidth() * self->GetHeight() * 3;
 174             dataPtr = (unsigned char*) malloc(len);
 175             memcpy(dataPtr, PyString_AsString(data), len);
 176             self->SetData(dataPtr);
 177         }
 178     }
 179
 180     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
 181     unsigned char GetMaskRed();
 182     unsigned char GetMaskGreen();
 183     unsigned char GetMaskBlue();
 184     void SetMask( bool mask = TRUE );
 185     bool HasMask();
 186
 187     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,
 188                    bool interpolating = TRUE, wxPoint * offset_after_rotation = NULL) const ;
 189     wxImage Rotate90( bool clockwise = TRUE ) ;
 190     wxImage Mirror( bool horizontally = TRUE ) ;
 191
 192     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
 193                   unsigned char r2, unsigned char g2, unsigned char b2 );
 194
 195     // convert to monochrome image (<r,g,b> will be replaced by white, everything else by black)
 196     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 197
 198     void SetOption(const wxString& name, const wxString& value);
 199     %name(SetOptionInt)void SetOption(const wxString& name, int value);
 200     wxString GetOption(const wxString& name) const;
 201     int GetOptionInt(const wxString& name) const;
 202     bool HasOption(const wxString& name) const;
 203
 204     unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 );
 205     // TODO: unsigned long ComputeHistogram( wxHashTable &h );
 206
 207     static void AddHandler( wxImageHandler *handler );
 208     static void InsertHandler( wxImageHandler *handler );
 209     static bool RemoveHandler( const wxString& name );
 210 };
 211
 212
 213 // Alternate constructors
 214 %new wxImage* wxEmptyImage(int width=0, int height=0);
 215 %new wxImage* wxImageFromMime(const wxString& name, const wxString& mimetype, int index = -1);
 216 %new wxImage* wxImageFromBitmap(const wxBitmap &bitmap);
 217 %new wxImage* wxImageFromData(int width, int height, unsigned char* data);
 218 %new wxImage* wxImageFromStream(wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1);
 219 %new wxImage* wxImageFromStreamMime(wxInputStream& stream, const wxString& mimetype, int index = -1 );
 220
 221 %{
 222     wxImage* wxEmptyImage(int width=0, int height=0) {
 223         if (width == 0 && height == 0)
 224             return new wxImage;
 225         else
 226             return new wxImage(width, height);
 227     }
 228
 229
 230     wxImage* wxImageFromMime(const wxString& name, const wxString& mimetype, int index) {
 231         return new wxImage(name, mimetype, index);
 232     }
 233
 234
 235     wxImage* wxImageFromBitmap(const wxBitmap &bitmap) {
 236         return new wxImage(bitmap);
 237     }
 238
 239
 240     wxImage* wxImageFromData(int width, int height, unsigned char* data) {
 241         // Copy the source data so the wxImage can clean it up later
 242         unsigned char* copy = (unsigned char*)malloc(width*height*3);
 243         if (copy == NULL) {
 244             PyErr_NoMemory();
 245             return NULL;
 246         }
 247         memcpy(copy, data, width*height*3);
 248         return new wxImage(width, height, copy, FALSE);
 249     }
 250
 251
 252     wxImage* wxImageFromStream(wxInputStream& stream,
 253                                long type = wxBITMAP_TYPE_ANY, int index = -1) {
 254         return new wxImage(stream, type, index);
 255     }
 256
 257
 258     wxImage* wxImageFromStreamMime(wxInputStream& stream,
 259                                    const wxString& mimetype, int index = -1 ) {
 260         return new wxImage(stream, mimetype, index);
 261     }
 262 %}
 263
 264
 265
 266 void wxInitAllImageHandlers();
 267
 268
 269 %readonly
 270 %{
 271 #if 0
 272 %}
 273
 274 extern wxImage    wxNullImage;
 275
 276 %readwrite
 277 %{
 278 #endif
 279 %}
 280
 281
 282
 283 //---------------------------------------------------------------------------
 284 // This one is here to avoid circular imports
 285
 286 %new wxBitmap* wxBitmapFromImage(const wxImage& img, int depth=-1);
 287
 288 %{
 289     wxBitmap* wxBitmapFromImage(const wxImage& img, int depth=-1) {
 290         return new wxBitmap(img, depth);
 291     }
 292
 293 %}
 294
 295
 296 //---------------------------------------------------------------------------