Add *wxTopLevelWindowGTK*RequestUserAttention*int*;

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

diff --git a/include/wx/image.h b/include/wx/image.h
index 61f54d16cf83fe33ad69e76f061bd5d150894da8..38f2809d9880dea10a321e8d24f667e2d6b34f65 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -14,7 +14,7 @@
 #pragma interface "image.h"
 #endif
 
 #pragma interface "image.h"
 #endif
 

-#include "wx/setup.h"
+#include "wx/defs.h"

 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"


@@ -46,6 +46,13 @@ enum
     wxIMAGE_RESOLUTION_CM = 2
 };
 
     wxIMAGE_RESOLUTION_CM = 2
 };
 

+// alpha channel values: fully transparent, default threshold separating
+// transparent pixels from opaque for a few functions dealing with alpha and
+// fully opaque
+const unsigned char wxIMAGE_ALPHA_TRANSPARENT = 0;
+const unsigned char wxIMAGE_ALPHA_THRESHOLD = 0x80;
+const unsigned char wxIMAGE_ALPHA_OPAQUE = 0xff;
+

 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------


@@ -150,6 +157,31 @@ public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:

+#if wxABI_VERSION >= 20602
+    // red, green and blue are 8 bit unsigned integers in the range of 0..255
+    // We use the identifier RGBValue instead of RGB, since RGB is #defined
+    class RGBValue
+    {
+    public:
+      RGBValue(unsigned char r=0, unsigned char g=0, unsigned char b=0)
+        : red(r), green(g), blue(b) {}
+        unsigned char red;  
+        unsigned char green;
+        unsigned char blue;
+    };
+
+    // hue, saturation and value are doubles in the range 0.0..1.0
+    class HSVValue
+    {
+    public:
+        HSVValue(double h=0.0, double s=0.0, double v=0.0)
+            : hue(h), saturation(s), value(v) {}
+        double hue;  
+        double saturation;
+        double value;
+    };
+#endif // wxABI_VERSION >= 2.6.2
+

     wxImage(){}
     wxImage( int width, int height, bool clear = true );
     wxImage( int width, int height, unsigned char* data, bool static_data = false );
     wxImage(){}
     wxImage( int width, int height, bool clear = true );
     wxImage( int width, int height, unsigned char* data, bool static_data = false );


@@ -182,9 +214,9 @@ public:
 
     // Paste the image or part of this image into an image of the given size at the pos
     //  any newly exposed areas will be filled with the rgb colour
 
     // Paste the image or part of this image into an image of the given size at the pos
     //  any newly exposed areas will be filled with the rgb colour

-    //  by default if r = g = b = -1 then fill with this image's mask colour or find and 
+    //  by default if r = g = b = -1 then fill with this image's mask colour or find and

     //  set a suitable mask colour
     //  set a suitable mask colour

-    wxImage Size( const wxSize& size, const wxPoint& pos, 
+    wxImage Size( const wxSize& size, const wxPoint& pos,

                   int r = -1, int g = -1, int b = -1 ) const;
 
     // pastes image into this instance and takes care of
                   int r = -1, int g = -1, int b = -1 ) const;
 
     // pastes image into this instance and takes care of


@@ -200,7 +232,7 @@ public:
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 
     // resizes the image in place
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 
     // resizes the image in place

-    wxImage& Resize( const wxSize& size, const wxPoint& pos, 
+    wxImage& Resize( const wxSize& size, const wxPoint& pos,

                      int r = -1, int g = -1, int b = -1 ) { return *this = Size(size, pos, r, g, b); }
 
     // Rotates the image about the given point, 'angle' radians.
                      int r = -1, int g = -1, int b = -1 ) { return *this = Size(size, pos, r, g, b); }
 
     // Rotates the image about the given point, 'angle' radians.


@@ -240,7 +272,7 @@ public:
 
     // converts image's alpha channel to mask, if it has any, does nothing
     // otherwise:
 
     // converts image's alpha channel to mask, if it has any, does nothing
     // otherwise:

-    bool ConvertAlphaToMask(unsigned char threshold = 128);
+    bool ConvertAlphaToMask(unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD);

 
     // This method converts an image where the original alpha
     // information is only available as a shades of a colour
 
     // This method converts an image where the original alpha
     // information is only available as a shades of a colour


@@ -282,14 +314,19 @@ public:
     // these functions provide fastest access to wxImage data but should be
     // used carefully as no checks are done
     unsigned char *GetData() const;
     // 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 );
+    void SetData( unsigned char *data, bool static_data=false );
+    void SetData( unsigned char *data, int new_width, int new_height, bool static_data=false );

 
     unsigned char *GetAlpha() const;    // may return NULL!
     bool HasAlpha() const { return GetAlpha() != NULL; }
 
     unsigned char *GetAlpha() const;    // may return NULL!
     bool HasAlpha() const { return GetAlpha() != NULL; }

-    void SetAlpha(unsigned char *alpha = NULL);
+    void SetAlpha(unsigned char *alpha = NULL, bool static_data=false);

     void InitAlpha();
 
     void InitAlpha();
 

+    // return true if this pixel is masked or has alpha less than specified
+    // threshold
+    bool IsTransparent(int x, int y,
+                       unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD) const;
+

     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
     // Get the current mask colour or find a suitable colour
     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
     // Get the current mask colour or find a suitable colour


@@ -325,6 +362,12 @@ public:
     // Returned value: # of entries in the histogram
     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
 
     // Returned value: # of entries in the histogram
     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
 

+#if wxABI_VERSION >= 20602
+    // Rotates the hue of each pixel of the image. angle is a double in the range
+    // -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
+    void RotateHue(double angle);
+#endif // wxABI_VERSION >= 2.6.2
+

     wxImage& operator = (const wxImage& image)
     {
         if ( (*this) != image )
     wxImage& operator = (const wxImage& image)
     {
         if ( (*this) != image )


@@ -351,9 +394,21 @@ public:
     static void CleanUpHandlers();
     static void InitStandardHandlers();
 
     static void CleanUpHandlers();
     static void InitStandardHandlers();
 

+#if wxABI_VERSION >= 20602
+    static HSVValue RGBtoHSV(const RGBValue& rgb);
+    static RGBValue HSVtoRGB(const HSVValue& hsv);
+#endif // wxABI_VERSION >= 2.6.2
+
+

 protected:
     static wxList   sm_handlers;
 
 protected:
     static wxList   sm_handlers;
 

+    // return the index of the point with the given coordinates or -1 if the
+    // image is invalid of the coordinates are out of range
+    //
+    // note that index must be multiplied by 3 when using it with RGB array
+    long XYToIndex(int x, int y) const;
+

 private:
     friend class WXDLLEXPORT wxImageHandler;
 
 private:
     friend class WXDLLEXPORT wxImageHandler;