]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/image.h
fixed typo
[wxWidgets.git] / include / wx / image.h
index 09aa6ed4a2899b47731ba0d27c2ff12009404db2..786b76f3a214de059308144c04bfbe3826e6dbf1 100644 (file)
 #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_IMAGE
+
+#define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
+
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
@@ -41,7 +46,7 @@ public:
     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 );
@@ -68,49 +73,72 @@ protected:
     wxString  m_extension;
     wxString  m_mime;
     long      m_type;
-    
+
 private:
     DECLARE_CLASS(wxImageHandler)
 };
 
 //-----------------------------------------------------------------------------
-// wxImage
+// wxImageHistogram
 //-----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHNode
+class WXDLLEXPORT wxImageHistogramEntry
 {
 public:
+    wxImageHistogramEntry() : index(0), value(0) {}
     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( 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( 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 );
+
+#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 );
 
-    // these functions get implemented in /src/(platform)/bitmap.cpp
+#if WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI
+    // convertion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
     wxImage( const wxBitmap &bitmap );
-    operator wxBitmap() const { return ConvertToBitmap(); }
     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 );
+    void Create( int width, int height, unsigned char* data, bool static_data = FALSE );
     void Destroy();
 
+    // 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;
 
+    // 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 );
+
     // return the new image with size width*height
     wxImage Scale( int width, int height ) const;
 
@@ -120,34 +148,58 @@ 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,
-                   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;
 
     // 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)
+    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 );
-    unsigned char GetGreen( int x, int y );
-    unsigned char GetBlue( int x, int y );
+    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 );
-    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 );
-    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
 
-    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
-    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;
@@ -156,7 +208,9 @@ public:
 
     char unsigned *GetData() const;
     void SetData( char unsigned *data );
+    void SetData( char unsigned *data, int new_width, int new_height );
 
+    // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
     unsigned char GetMaskRed() const;
     unsigned char GetMaskGreen() const;
@@ -164,8 +218,29 @@ public:
     void SetMask( bool mask = TRUE );
     bool HasMask() const;
 
-    unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 );
-    unsigned long ComputeHistogram( wxHashTable &h );
+#if wxUSE_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);
+    void SetOption(const wxString& name, int value);
+    wxString GetOption(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 ) 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)
     {
@@ -192,9 +267,13 @@ public:
     static void InitStandardHandlers();
 
 protected:
-    static wxList sm_handlers;
+    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)
@@ -203,6 +282,7 @@ private:
 
 extern void WXDLLEXPORT wxInitAllImageHandlers();
 
+WXDLLEXPORT_DATA(extern wxImage)    wxNullImage;
 
 //-----------------------------------------------------------------------------
 // wxImage handlers
@@ -215,6 +295,10 @@ extern void WXDLLEXPORT wxInitAllImageHandlers();
 #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_