fixed typo

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

diff --git a/include/wx/image.h b/include/wx/image.h
index 7e872e39118a630c193ecd9259e1f28cdfcd48f9..786b76f3a214de059308144c04bfbe3826e6dbf1 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -19,11 +19,16 @@
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/bitmap.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/bitmap.h"

+#include "wx/hashmap.h"

 
 #if wxUSE_STREAMS
 #  include "wx/stream.h"
 #endif
 
 
 #if wxUSE_STREAMS
 #  include "wx/stream.h"
 #endif
 

+#if wxUSE_IMAGE
+
+#define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
+

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


@@ -41,7 +46,7 @@ public:
     wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }
 
 #if wxUSE_STREAMS
     wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }
 
 #if wxUSE_STREAMS

-    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+    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 bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
 
     virtual int GetImageCount( wxInputStream& stream );


@@ -68,41 +73,55 @@ protected:
     wxString  m_extension;
     wxString  m_mime;
     long      m_type;
     wxString  m_extension;
     wxString  m_mime;
     long      m_type;

-    
+

 private:
     DECLARE_CLASS(wxImageHandler)
 };
 
 //-----------------------------------------------------------------------------
 private:
     DECLARE_CLASS(wxImageHandler)
 };
 
 //-----------------------------------------------------------------------------

-// wxImage
+// wxImageHistogram

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHNode
+class WXDLLEXPORT wxImageHistogramEntry

 {
 public:
 {
 public:

+    wxImageHistogramEntry() : index(0), value(0) {}

     unsigned long index;
     unsigned long value;
 };
 
     unsigned long index;
     unsigned long value;
 };
 

+WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
+                             wxIntegerHash, wxIntegerEqual,
+                             wxImageHistogram);
+
+//-----------------------------------------------------------------------------
+// wxImage
+//-----------------------------------------------------------------------------
+

 class WXDLLEXPORT wxImage: public wxObject
 {
 public:
     wxImage();
     wxImage( int width, int height );
     wxImage( int width, int height, unsigned char* data, bool static_data = FALSE );
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:
     wxImage();
     wxImage( int width, int height );
     wxImage( int width, int height, unsigned char* data, bool static_data = FALSE );

-    wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY );
-    wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
-    wxImage( const wxString& name, const wxString& mimetype );
-    wxImage( wxInputStream& stream, const wxString& mimetype );
+    wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
+    wxImage( const wxString& name, const wxString& mimetype, int index = -1 );
+
+#if wxUSE_STREAMS
+    wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
+    wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 );
+#endif // wxUSE_STREAMS

 
     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 );
     wxImage( const wxBitmap &bitmap );

-    operator wxBitmap() const { return ConvertToBitmap(); }

     wxBitmap ConvertToBitmap() const;
 #ifdef __WXGTK__
     wxBitmap ConvertToBitmap() const;
 #ifdef __WXGTK__

-    wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue );
+    wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;
+#endif

 #endif
 
     void Create( int width, int height );
 #endif
 
     void Create( int width, int height );


@@ -112,13 +131,13 @@ public:
     // creates an identical copy of the image (the = operator
     // just raises the ref count)
     wxImage Copy() const;
     // creates an identical copy of the image (the = operator
     // just raises the ref count)
     wxImage Copy() const;

-    
+

     // return the new image with size width*height
     wxImage GetSubImage( const wxRect& ) const;
     // return the new image with size width*height
     wxImage GetSubImage( const wxRect& ) const;

-    
+

     // pastes image into this instance and takes care of
     // the mask colour and out of bounds problems
     // pastes image into this instance and takes care of
     // the mask colour and out of bounds problems

-    void Paste( const wxImage &image, int x, int y );    
+    void Paste( const wxImage &image, int x, int y );

 
     // 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;


@@ -138,28 +157,49 @@ public:
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 
     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)
+    wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
+

     // these routines are slow but safe
     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
     unsigned char GetRed( int x, int y ) const;
     unsigned char GetGreen( int x, int y ) const;
     unsigned char GetBlue( int x, int y ) const;
 
     // these routines are slow but safe
     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
     unsigned char GetRed( int x, int y ) const;
     unsigned char GetGreen( int x, int y ) const;
     unsigned char GetBlue( 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,
+                                unsigned char startR = 1, unsigned char startG = 0,
+                                unsigned char startB = 0 ) const;
+    // Set image's mask to the area of 'mask' that has <r,g,b> colour
+    bool SetMaskFromImage(const wxImage & mask,
+                          unsigned char mr, unsigned char mg, unsigned char mb);
+
+    void DoFloodFill (wxCoord x, wxCoord y,
+        const wxBrush & fillBrush,
+        const wxColour& testColour,
+        int style = wxFLOOD_SURFACE,
+        int LogicalFunction = wxCOPY /* currently unused */ ) ;
+

     static bool CanRead( const wxString& name );
     static bool CanRead( const wxString& name );

-    virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY );
-    virtual bool LoadFile( const wxString& name, const wxString& mimetype );
+    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 );
+    virtual bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 );

 
 #if wxUSE_STREAMS
     static bool CanRead( wxInputStream& stream );
 
 #if wxUSE_STREAMS
     static bool CanRead( wxInputStream& stream );

-    virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
-    virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype );
+    static int GetImageCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
+    virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
+    virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 );

 #endif
 
 #endif
 

-    virtual bool SaveFile( const wxString& name, int type );
-    virtual bool SaveFile( const wxString& name, const wxString& mimetype );
+    virtual bool SaveFile( const wxString& name ) const;
+    virtual bool SaveFile( const wxString& name, int type ) const;
+    virtual bool SaveFile( const wxString& name, const wxString& mimetype ) const;

 
 #if wxUSE_STREAMS
 
 #if wxUSE_STREAMS

-    virtual bool SaveFile( wxOutputStream& stream, int type );
-    virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype );
+    virtual bool SaveFile( wxOutputStream& stream, int type ) const;
+    virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const;

 #endif
 
     bool Ok() const;
 #endif
 
     bool Ok() const;


@@ -178,10 +218,12 @@ public:
     void SetMask( bool mask = TRUE );
     bool HasMask() const;
 
     void SetMask( bool mask = TRUE );
     bool HasMask() const;
 

+#if wxUSE_PALETTE

     // Palette functions
     bool HasPalette() const;
     const wxPalette& GetPalette() const;
     void SetPalette(const wxPalette& palette);
     // Palette functions
     bool HasPalette() const;
     const wxPalette& GetPalette() const;
     void SetPalette(const wxPalette& palette);

+#endif // wxUSE_PALETTE

 
     // Option functions (arbitrary name/value mapping)
     void SetOption(const wxString& name, const wxString& value);
 
     // Option functions (arbitrary name/value mapping)
     void SetOption(const wxString& name, const wxString& value);


@@ -190,8 +232,15 @@ public:
     int GetOptionInt(const wxString& name) const;
     bool HasOption(const wxString& name) const;
 
     int GetOptionInt(const wxString& name) const;
     bool HasOption(const wxString& name) const;
 

-    unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 );
-    unsigned long ComputeHistogram( wxHashTable &h );
+    unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 ) const;
+
+    // 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 
+    // in the image with that colour.
+    // Returned value: # of entries in the histogram
+    unsigned long ComputeHistogram( wxImageHistogram &h ) const;

 
     wxImage& operator = (const wxImage& image)
     {
 
     wxImage& operator = (const wxImage& image)
     {


@@ -221,6 +270,10 @@ protected:
     static wxList   sm_handlers;
 
 private:
     static wxList   sm_handlers;
 
 private:

+    //these two are called by FloodFill
+    bool MatchPixel(int x, int y, int w, int h, const wxColour & c) ;
+    bool MatchBoundaryPixel(int x, int y, int w, int h, const wxColour & fill, const wxColour & bound) ;
+

     friend class WXDLLEXPORT wxImageHandler;
 
     DECLARE_DYNAMIC_CLASS(wxImage)
     friend class WXDLLEXPORT wxImageHandler;
 
     DECLARE_DYNAMIC_CLASS(wxImage)


@@ -229,6 +282,7 @@ private:
 
 extern void WXDLLEXPORT wxInitAllImageHandlers();
 
 
 extern void WXDLLEXPORT wxInitAllImageHandlers();
 

+WXDLLEXPORT_DATA(extern wxImage)    wxNullImage;

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


@@ -241,6 +295,10 @@ extern void WXDLLEXPORT wxInitAllImageHandlers();
 #include "wx/imagjpeg.h"
 #include "wx/imagtiff.h"
 #include "wx/imagpnm.h"
 #include "wx/imagjpeg.h"
 #include "wx/imagtiff.h"
 #include "wx/imagpnm.h"

+#include "wx/imagxpm.h"
+#include "wx/imagiff.h"
+
+#endif // wxUSE_IMAGE

 
 #endif
   // _WX_IMAGE_H_
 
 #endif
   // _WX_IMAGE_H_