added wxRegEx::GetMatchCount (patch 938995)

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

diff --git a/include/wx/image.h b/include/wx/image.h
index 6df67faa3c9e11ebdc649dfce081b66525fabc62..91217cd6669a1f70df2ebdc3f0020f59f9566d0c 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -10,7 +10,7 @@
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "image.h"
 #endif
 
 #pragma interface "image.h"
 #endif
 


@@ -18,7 +18,9 @@
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #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
 #include "wx/hashmap.h"
 
 #if wxUSE_STREAMS


@@ -27,6 +29,10 @@
 
 #if wxUSE_IMAGE
 
 
 #if wxUSE_IMAGE
 

+// on some systems (Unixware 7.x) index is defined as a macro in the headers
+// which breaks the compilation below
+#undef index
+

 #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
 
 //-----------------------------------------------------------------------------
 #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
 
 //-----------------------------------------------------------------------------


@@ -35,6 +41,7 @@
 
 class WXDLLEXPORT wxImageHandler;
 class WXDLLEXPORT wxImage;
 
 class WXDLLEXPORT wxImageHandler;
 class WXDLLEXPORT wxImage;

+class WXDLLEXPORT wxPalette;

 
 //-----------------------------------------------------------------------------
 // wxImageHandler
 
 //-----------------------------------------------------------------------------
 // wxImageHandler


@@ -44,7 +51,7 @@ class WXDLLEXPORT wxImageHandler: public wxObject
 {
 public:
     wxImageHandler()
 {
 public:
     wxImageHandler()

-        : m_name(""), m_extension(""), m_mime(), m_type(0)
+        : m_name(wxEmptyString), m_extension(wxEmptyString), m_mime(), m_type(0)

         { }
 
 #if wxUSE_STREAMS
         { }
 
 #if wxUSE_STREAMS


@@ -53,7 +60,7 @@ public:
 
     virtual int GetImageCount( wxInputStream& stream );
 
 
     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
 
     bool CanRead( const wxString& name );
 #endif // wxUSE_STREAMS
 


@@ -69,6 +76,9 @@ public:
 protected:
 #if wxUSE_STREAMS
     virtual bool DoCanRead( wxInputStream& stream ) = 0;
 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;
 #endif // wxUSE_STREAMS
 
     wxString  m_name;


@@ -87,14 +97,40 @@ private:
 class WXDLLEXPORT wxImageHistogramEntry
 {
 public:
 class WXDLLEXPORT wxImageHistogramEntry
 {
 public:

-    wxImageHistogramEntry() : index(0), value(0) {}
+    wxImageHistogramEntry() { index = value = 0; }

     unsigned long index;
     unsigned long value;
 };
 
 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
                              wxIntegerHash, wxIntegerEqual,
     unsigned long index;
     unsigned long value;
 };
 
 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
                              wxIntegerHash, wxIntegerEqual,

-                             wxImageHistogram);
+                             wxImageHistogramBase);
+
+class WXDLLEXPORT 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
 
 //-----------------------------------------------------------------------------
 // wxImage


@@ -104,7 +140,7 @@ class WXDLLEXPORT wxImage: public wxObject
 {
 public:
     wxImage();
 {
 public:
     wxImage();

-    wxImage( int width, int height );
+    wxImage( int width, int height, bool clear = true );

     wxImage( int width, int height, unsigned char* data, bool static_data = FALSE );
     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     wxImage( const wxString& name, const wxString& mimetype, int index = -1 );
     wxImage( int width, int height, unsigned char* data, bool static_data = FALSE );
     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     wxImage( const wxString& name, const wxString& mimetype, int index = -1 );


@@ -117,17 +153,8 @@ public:
     wxImage( const wxImage& image );
     wxImage( const wxImage* image );
 
     wxImage( const wxImage& image );
     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;
-#ifdef __WXGTK__
-    wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;
-#endif
-#endif
-
-    void Create( int width, int height );
-    void Create( int width, int height, unsigned char* data, bool static_data = FALSE );
+    bool Create( int width, int height, bool clear = true );
+    bool Create( int width, int height, unsigned char* data, bool static_data = FALSE );

     void Destroy();
 
     // creates an identical copy of the image (the = operator
     void Destroy();
 
     // creates an identical copy of the image (the = operator


@@ -144,6 +171,8 @@ public:
     // return the new image with size width*height
     wxImage Scale( int width, int height ) const;
 
     // 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); }
 
     // rescales the image in place
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 


@@ -168,6 +197,9 @@ public:
     unsigned char GetGreen( int x, int y ) const;
     unsigned char GetBlue( int x, int y ) const;
 
     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) const;
+

     // 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,
     // 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 +234,15 @@ public:
     int GetWidth() const;
     int GetHeight() const;
 
     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 );
 
     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );


@@ -232,8 +270,8 @@ public:
 
     // Computes the histogram of the image and fills a hash table, indexed
     // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry
 
     // Computes the histogram of the image and fills a hash table, indexed
     // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry

-    // objects. Each of them contains an 'index' (useful to build a palette 
-    // with the image colours) and a 'value', which is the number of pixels 
+    // objects. Each of them contains an 'index' (useful to build a palette
+    // with the image colours) and a 'value', which is the number of pixels

     // in the image with that colour.
     // Returned value: # of entries in the histogram
     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
     // in the image with that colour.
     // Returned value: # of entries in the histogram
     unsigned long ComputeHistogram( wxImageHistogram &h ) const;


@@ -245,9 +283,9 @@ public:
         return *this;
     }
 
         return *this;
     }
 

-    bool operator == (const wxImage& image)
+    bool operator == (const wxImage& image) const

         { return m_refData == image.m_refData; }
         { 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; }
         { return m_refData != image.m_refData; }
 
     static wxList& GetHandlers() { return sm_handlers; }


@@ -259,6 +297,8 @@ public:
     static wxImageHandler *FindHandler( long imageType );
     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 
     static wxImageHandler *FindHandler( long imageType );
     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 

+    static wxString GetImageExtWildcard();
+

     static void CleanUpHandlers();
     static void InitStandardHandlers();
 
     static void CleanUpHandlers();
     static void InitStandardHandlers();