clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/image.h b/include/wx/image.h
index 778de2940492e5a152d923f4ecb1a35cd19d69bb..aa3070e60d983306f571c56c7c1f181e1eae0c33 100644 (file)
--- a/include/wx/image.h
+++ b/include/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,9 @@ 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( 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 +151,7 @@ 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 );

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


@@ -179,16 +176,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


@@ -198,7 +196,7 @@ public:
     unsigned char GetBlue( int x, int y ) const;
 
     void SetAlpha(int x, int y, unsigned char alpha);
     unsigned char GetBlue( int x, int y ) const;
 
     void SetAlpha(int x, int y, unsigned char alpha);

-    unsigned char GetAlpha(int x, int y);
+    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>
 
     // find first colour that is not used in the image and has higher
     // RGB values than <startR,startG,startB>


@@ -209,6 +207,10 @@ 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);
+

     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 +251,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