Common code for the same handling of wxSL_INVERSE.

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

diff --git a/include/wx/image.h b/include/wx/image.h
index afb94f2ef4a1faf1528898433d7a517a6f0abf01..6fb884955b062e61ec306cf1a72bd836aafffd03 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -4,7 +4,7 @@
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_IMAGE_H_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_IMAGE_H_


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


@@ -55,8 +52,8 @@ public:
         { }
 
 #if wxUSE_STREAMS
         { }
 
 #if wxUSE_STREAMS

-    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 );
-    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1 );
+    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=true );

 
     virtual int GetImageCount( wxInputStream& stream );
 
 
     virtual int GetImageCount( wxInputStream& stream );
 


@@ -139,9 +136,10 @@ public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:

-    wxImage();
+    wxImage(){}

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

-    wxImage( int width, int height, unsigned char* data, bool static_data = FALSE );
+    wxImage( int width, int height, unsigned char* data, bool static_data = false );
+    wxImage( int width, int height, unsigned char* data, unsigned char* alpha, 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( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     wxImage( const wxString& name, const wxString& mimetype, int index = -1 );
 


@@ -154,7 +152,8 @@ public:
     wxImage( const wxImage* image );
 
     bool Create( int width, int height, bool clear = true );
     wxImage( const wxImage* image );
 
     bool Create( int width, int height, bool clear = true );

-    bool Create( int width, int height, unsigned char* data, bool static_data = FALSE );
+    bool Create( int width, int height, unsigned char* data, bool static_data = false );
+    bool Create( int width, int height, unsigned char* data, unsigned char* alpha, 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


@@ -179,16 +178,17 @@ public:
     // Rotates the image about the given point, 'angle' radians.
     // Returns the rotated image, leaving this image intact.
     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,
     // Rotates the image about the given point, 'angle' radians.
     // Returns the rotated image, leaving this image intact.
     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,

-                   bool interpolating = TRUE, wxPoint * offset_after_rotation = (wxPoint*) NULL) const;
+                   bool interpolating = true, wxPoint * offset_after_rotation = (wxPoint*) NULL) const;

 
 

-    wxImage Rotate90( bool clockwise = TRUE ) const;
-    wxImage Mirror( bool horizontally = TRUE ) const;
+    wxImage Rotate90( bool clockwise = true ) const;
+    wxImage Mirror( bool horizontally = true ) const;

 
     // replace one colour with another
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 
 
     // replace one colour with another
     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)
+    // 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;
 
     // these routines are slow but safe
     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 
     // these routines are slow but safe


@@ -209,6 +209,22 @@ public:
     bool SetMaskFromImage(const wxImage & mask,
                           unsigned char mr, unsigned char mg, unsigned char mb);
 
     bool SetMaskFromImage(const wxImage & mask,
                           unsigned char mr, unsigned char mg, unsigned char mb);
 

+    // converts image's alpha channel to mask, if it has any, does nothing
+    // otherwise:
+    bool ConvertAlphaToMask(unsigned char threshold = 128);
+
+    // This method converts an image where the original alpha
+    // information is only available as a shades of a colour
+    // (actually shades of grey) typically when you draw anti-
+    // aliased text into a bitmap. The DC drawinf routines
+    // draw grey values on the black background although they
+    // actually mean to draw white with differnt alpha values.
+    // This method reverses it, assuming a black (!) background
+    // and white text (actually only the red channel is read).
+    // The method will then fill up the whole image with the
+    // colour given.
+    bool ConvertColourToAlpha( unsigned char r, unsigned char g, unsigned char b );
+

     static bool CanRead( const wxString& name );
     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
     virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     static bool CanRead( const wxString& name );
     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
     virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );


@@ -249,7 +265,7 @@ public:
     unsigned char GetMaskRed() const;
     unsigned char GetMaskGreen() const;
     unsigned char GetMaskBlue() const;
     unsigned char GetMaskRed() const;
     unsigned char GetMaskGreen() const;
     unsigned char GetMaskBlue() const;

-    void SetMask( bool mask = TRUE );
+    void SetMask( bool mask = true );

     bool HasMask() const;
 
 #if wxUSE_PALETTE
     bool HasMask() const;
 
 #if wxUSE_PALETTE


@@ -314,7 +330,7 @@ private:
 
 extern void WXDLLEXPORT wxInitAllImageHandlers();
 
 
 extern void WXDLLEXPORT wxInitAllImageHandlers();
 

-WXDLLEXPORT_DATA(extern wxImage)    wxNullImage;
+extern WXDLLEXPORT_DATA(wxImage)    wxNullImage;

 
 //-----------------------------------------------------------------------------
 // wxImage handlers
 
 //-----------------------------------------------------------------------------
 // wxImage handlers