applied doc patch for wxPostEvent().

[wxWidgets.git] / wxPython / src / image.i

diff --git a/wxPython/src/image.i b/wxPython/src/image.i
index f015bfa27ea86771cb34e052672178115d5c1c2c..93afd3115cb27803a252e8e27a139446522f064a 100644 (file)
--- a/wxPython/src/image.i
+++ b/wxPython/src/image.i
@@ -30,7 +30,7 @@
 
 //---------------------------------------------------------------------------
 
-class wxImageHandler {
+class wxImageHandler : public wxObject {
 public:
     // wxImageHandler();    Abstract Base Class
     wxString GetName();
@@ -40,6 +40,10 @@ public:
 
     //bool LoadFile(wxImage* image, wxInputStream& stream);
     //bool SaveFile(wxImage* image, wxOutputStream& stream);
+    //virtual int GetImageCount( wxInputStream& stream );
+    //bool CanRead( wxInputStream& stream );
+
+    bool CanRead( const wxString& name );
 
     void SetName(const wxString& name);
     void SetExtension(const wxString& extension);
@@ -66,6 +70,20 @@ public:
     wxBMPHandler();
 };
 
+class wxICOHandler : public wxBMPHandler {
+public:
+    wxICOHandler();
+};
+
+class wxCURHandler : public wxICOHandler {
+public:
+    wxCURHandler();
+};
+
+class wxANIHandler : public wxCURHandler {
+public:
+    wxANIHandler();
+};
 
 class wxGIFHandler : public wxImageHandler {
 public:
@@ -88,19 +106,21 @@ public:
 };
 
 
+
 //---------------------------------------------------------------------------
 
-class wxImage {
+class wxImage : public wxObject {
 public:
-    wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY );
+    wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     ~wxImage();
 
-    wxBitmap ConvertToBitmap();
+    wxBitmap ConvertToBitmap(); // deprecated
 #ifdef __WXGTK__
     wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;
 #endif
     void Create( int width, int height );
     void Destroy();
+
     wxImage Scale( int width, int height );
     wxImage& Rescale(int width, int height);
 
@@ -110,8 +130,10 @@ public:
     unsigned char GetBlue( int x, int y );
 
     static bool CanRead( const wxString& name );
-    bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY );
-    %name(LoadMimeFile)bool LoadFile( const wxString& name, const wxString& mimetype );
+    static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
+
+    bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
+    %name(LoadMimeFile)bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 );
 
     bool SaveFile( const wxString& name, int type );
     %name(SaveMimeFile)bool SaveFile( const wxString& name, const wxString& mimetype );
@@ -164,6 +186,15 @@ public:
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 
+    // convert to monochrome image (<r,g,b> will be replaced by white, everything else by black)
+    wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
+
+    void SetOption(const wxString& name, const wxString& value);
+    %name(SetOptionInt)void SetOption(const wxString& name, int value);
+    wxString GetOption(const wxString& name) const;
+    int GetOptionInt(const wxString& name) const;
+    bool HasOption(const wxString& name) const;
+
     unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 );
     // TODO: unsigned long ComputeHistogram( wxHashTable &h );
 
@@ -175,8 +206,9 @@ public:
 
 // Alternate constructors
 %new wxImage* wxEmptyImage(int width=0, int height=0);
-%new wxImage* wxImageFromMime(const wxString& name, const wxString& mimetype);
+%new wxImage* wxImageFromMime(const wxString& name, const wxString& mimetype, int index = -1);
 %new wxImage* wxImageFromBitmap(const wxBitmap &bitmap);
+%new wxImage* wxImageFromData(int width, int height, unsigned char* data);
 %{
     wxImage* wxEmptyImage(int width=0, int height=0) {
         if (width == 0 && height == 0)
@@ -185,13 +217,24 @@ public:
             return new wxImage(width, height);
     }
 
-    wxImage* wxImageFromMime(const wxString& name, const wxString& mimetype) {
-        return new wxImage(name, mimetype);
+    wxImage* wxImageFromMime(const wxString& name, const wxString& mimetype, int index) {
+        return new wxImage(name, mimetype, index);
     }
 
     wxImage* wxImageFromBitmap(const wxBitmap &bitmap) {
         return new wxImage(bitmap);
     }
+
+    wxImage* wxImageFromData(int width, int height, unsigned char* data) {
+        // Copy the source data so the wxImage can clean it up later
+        unsigned char* copy = (unsigned char*)malloc(width*height*3);
+        if (copy == NULL) {
+            PyErr_NoMemory();
+            return NULL;
+        }
+        memcpy(copy, data, width*height*3);
+        return new wxImage(width, height, copy, FALSE);
+    }
 %}
 
 void wxInitAllImageHandlers();