create the DIBs in correct (and not down up) line order

[wxWidgets.git] / include / wx / image.h

diff --git a/include/wx/image.h b/include/wx/image.h
index 6df67faa3c9e11ebdc649dfce081b66525fabc62..f118631b244f805af30ce348289ca40ab287e1c3 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -10,7 +10,7 @@
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
 #pragma interface "image.h"
 #endif
 
@@ -18,7 +18,9 @@
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
-#include "wx/bitmap.h"
+#if WXWIN_COMPATIBILITY_2_2
+#  include "wx/bitmap.h"
+#endif
 #include "wx/hashmap.h"
 
 #if wxUSE_STREAMS
@@ -35,6 +37,7 @@
 
 class WXDLLEXPORT wxImageHandler;
 class WXDLLEXPORT wxImage;
+class WXDLLEXPORT wxPalette;
 
 //-----------------------------------------------------------------------------
 // wxImageHandler
@@ -44,7 +47,7 @@ class WXDLLEXPORT wxImageHandler: public wxObject
 {
 public:
     wxImageHandler()
-        : m_name(""), m_extension(""), m_mime(), m_type(0)
+        : m_name(wxT("")), m_extension(wxT("")), m_mime(), m_type(0)
         { }
 
 #if wxUSE_STREAMS
@@ -53,7 +56,7 @@ public:
 
     virtual int GetImageCount( wxInputStream& stream );
 
-    bool CanRead( wxInputStream& stream ) { return DoCanRead(stream); }
+    bool CanRead( wxInputStream& stream ) { return CallDoCanRead(stream); }
     bool CanRead( const wxString& name );
 #endif // wxUSE_STREAMS
 
@@ -69,6 +72,9 @@ public:
 protected:
 #if wxUSE_STREAMS
     virtual bool DoCanRead( wxInputStream& stream ) = 0;
+
+    // save the stream position, call DoCanRead() and restore the position
+    bool CallDoCanRead(wxInputStream& stream);
 #endif // wxUSE_STREAMS
 
     wxString  m_name;
@@ -94,7 +100,33 @@ public:
 
 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
                              wxIntegerHash, wxIntegerEqual,
-                             wxImageHistogram);
+                             wxImageHistogramBase);
+
+class wxImageHistogram : public wxImageHistogramBase
+{
+public:
+    wxImageHistogram() : wxImageHistogramBase(256) { }
+
+    // get the key in the histogram for the given RGB values
+    static unsigned long MakeKey(unsigned char r,
+                                 unsigned char g,
+                                 unsigned char b)
+    {
+        return (r << 16) | (g << 8) | b;
+    }
+
+    // find first colour that is not used in the image and has higher
+    // RGB values than RGB(startR, startG, startB)
+    //
+    // returns true and puts this colour in r, g, b (each of which may be NULL)
+    // on success or returns false if there are no more free colours
+    bool FindFirstUnusedColour(unsigned char *r,
+                               unsigned char *g,
+                               unsigned char *b,
+                               unsigned char startR = 1,
+                               unsigned char startG = 0,
+                               unsigned char startB = 0 ) const;
+};
 
 //-----------------------------------------------------------------------------
 // wxImage
@@ -118,9 +150,9 @@ public:
     wxImage( const wxImage* image );
 
 #if WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI
-    // convertion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
-    wxImage( const wxBitmap &bitmap );
-    wxBitmap ConvertToBitmap() const;
+    // conversion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
+    wxDEPRECATED( wxImage(const wxBitmap &bitmap) );
+    wxDEPRECATED( wxBitmap ConvertToBitmap() const );
 #ifdef __WXGTK__
     wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;
 #endif
@@ -143,6 +175,8 @@ public:
 
     // return the new image with size width*height
     wxImage Scale( int width, int height ) const;
+    
+    wxImage ShrinkBy( int xFactor , int yFactor ) const ;
 
     // rescales the image in place
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
@@ -168,6 +202,9 @@ public:
     unsigned char GetGreen( int x, int y ) const;
     unsigned char GetBlue( int x, int y ) const;
 
+    void SetAlpha(int x, int y, unsigned char alpha);
+    unsigned char GetAlpha(int x, int y);
+
     // find first colour that is not used in the image and has higher
     // RGB values than <startR,startG,startB>
     bool FindFirstUnusedColour( unsigned char *r, unsigned char *g, unsigned char *b,
@@ -202,9 +239,15 @@ public:
     int GetWidth() const;
     int GetHeight() const;
 
-    char unsigned *GetData() const;
-    void SetData( char unsigned *data );
-    void SetData( char unsigned *data, int new_width, int new_height );
+    // these functions provide fastest access to wxImage data but should be
+    // used carefully as no checks are done
+    unsigned char *GetData() const;
+    void SetData( unsigned char *data );
+    void SetData( unsigned char *data, int new_width, int new_height );
+
+    unsigned char *GetAlpha() const;    // may return NULL!
+    bool HasAlpha() const { return GetAlpha() != NULL; }
+    void SetAlpha(unsigned char *alpha = NULL);
 
     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
@@ -245,9 +288,9 @@ public:
         return *this;
     }
 
-    bool operator == (const wxImage& image)
+    bool operator == (const wxImage& image) const
         { return m_refData == image.m_refData; }
-    bool operator != (const wxImage& image)
+    bool operator != (const wxImage& image) const
         { return m_refData != image.m_refData; }
 
     static wxList& GetHandlers() { return sm_handlers; }