Fixed typo in my last commit (it did break socket detection code :-( ).

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

diff --git a/include/wx/image.h b/include/wx/image.h
index bd3d4845826b0570f66cb35f627db8167f6ca911..cf69aa743aa9e8c98132d895c08fc8762622cd5c 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:    wxWindows licence
+// Licence:     wxWindows licence

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


@@ -18,261 +18,277 @@
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"

+#include "wx/bitmap.h"
+#include "wx/hashmap.h"

 
 #if wxUSE_STREAMS
 
 #if wxUSE_STREAMS

-#include "wx/stream.h"
+#  include "wx/stream.h"

 #endif
 
 #endif
 

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

 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxImageHandler;
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxImageHandler;

-#if wxUSE_LIBPNG
-class WXDLLEXPORT wxPNGHandler;
-#endif
-#if wxUSE_LIBJPEG
-class WXDLLEXPORT wxJPEGHandler;
-#endif
-class WXDLLEXPORT wxBMPHandler;

 class WXDLLEXPORT wxImage;
 
 class WXDLLEXPORT wxImage;
 

-class WXDLLEXPORT wxBitmap;
-

 //-----------------------------------------------------------------------------
 // wxImageHandler
 //-----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxImageHandler: public wxObject
 {
 //-----------------------------------------------------------------------------
 // wxImageHandler
 //-----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxImageHandler: public wxObject
 {

-  DECLARE_DYNAMIC_CLASS(wxImageHandler)
-  

 public:
 public:

-  wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }
+    wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }

 
 #if wxUSE_STREAMS
 
 #if wxUSE_STREAMS

-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
-#endif
+    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 );

 
 

-  inline void SetName(const wxString& name) { m_name = name; }
-  inline void SetExtension(const wxString& ext) { m_extension = ext; }
-  inline void SetType(long type) { m_type = type; }
-  inline void SetMimeType(const wxString& type) { m_mime = type; }
-  inline wxString GetName() const { return m_name; }
-  inline wxString GetExtension() const { return m_extension; }
-  inline long GetType() const { return m_type; }
-  inline wxString GetMimeType() const { return m_mime; }
+    bool CanRead( wxInputStream& stream ) { return DoCanRead(stream); }
+    bool CanRead( const wxString& name );
+#endif // wxUSE_STREAMS
+
+    void SetName(const wxString& name) { m_name = name; }
+    void SetExtension(const wxString& ext) { m_extension = ext; }
+    void SetType(long type) { m_type = type; }
+    void SetMimeType(const wxString& type) { m_mime = type; }
+    wxString GetName() const { return m_name; }
+    wxString GetExtension() const { return m_extension; }
+    long GetType() const { return m_type; }
+    wxString GetMimeType() const { return m_mime; }

 
 protected:
 
 protected:

-  wxString  m_name;
-  wxString  m_extension;
-  wxString  m_mime;
-  long      m_type;
-  
+#if wxUSE_STREAMS
+    virtual bool DoCanRead( wxInputStream& stream ) = 0;
+#endif // wxUSE_STREAMS
+
+    wxString  m_name;
+    wxString  m_extension;
+    wxString  m_mime;
+    long      m_type;
+
+private:
+    DECLARE_CLASS(wxImageHandler)

 };
 
 //-----------------------------------------------------------------------------
 };
 
 //-----------------------------------------------------------------------------

-// wxPNGHandler
+// wxImageHistogram

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

-#if wxUSE_LIBPNG
-class WXDLLEXPORT wxPNGHandler: public wxImageHandler
+class WXDLLEXPORT wxImageHistogramEntry

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxPNGHandler)
-  

 public:
 public:

-
-  inline wxPNGHandler()
-  {
-      m_name = "PNG file";
-      m_extension = "png";
-      m_type = wxBITMAP_TYPE_PNG;
-      m_mime = "image/png";
-  };
-
-#if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
-#endif
+    wxImageHistogramEntry() : index(0), value(0) {}
+    unsigned long index;
+    unsigned long value;

 };
 };

-#endif
+
+WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
+                             wxIntegerHash, wxIntegerEqual,
+                             wxImageHistogram);

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

-// wxJPEGHandler
+// wxImage

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

-#if wxUSE_LIBJPEG
-class WXDLLEXPORT wxJPEGHandler: public wxImageHandler
+class WXDLLEXPORT wxImage: public wxObject

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxJPEGHandler)
-

 public:
 public:

-
-  inline wxJPEGHandler()
-  {
-      m_name = "JPEG file";
-      m_extension = "jpg";
-      m_type = wxBITMAP_TYPE_JPEG;
-      m_mime = "image/jpeg";
-  };
+    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, int index = -1 );
+    wxImage( const wxString& name, const wxString& mimetype, int index = -1 );

 
 #if wxUSE_STREAMS
 
 #if wxUSE_STREAMS

-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
+    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 );
+
+#if wxUSE_GUI
+    // convertion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
+    wxImage( const wxBitmap &bitmap );
+    wxBitmap ConvertToBitmap() const;
+#ifdef __WXGTK__
+    wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;

 #endif
 #endif

-};

 #endif
 
 #endif
 

-//-----------------------------------------------------------------------------
-// wxBMPHandler
-//-----------------------------------------------------------------------------
+    void Create( int width, int height );
+    void Create( int width, int height, unsigned char* data, bool static_data = FALSE );
+    void Destroy();

 
 

-class WXDLLEXPORT wxBMPHandler: public wxImageHandler
-{
-  DECLARE_DYNAMIC_CLASS(wxBMPHandler)
-  
-public:
+    // creates an identical copy of the image (the = operator
+    // just raises the ref count)
+    wxImage Copy() const;

 
 

-  inline wxBMPHandler()
-  {
-      m_name = "BMP file";
-      m_extension = "bmp";
-      m_type = wxBITMAP_TYPE_BMP;
-      m_mime = "image/bmp";
-  };
+    // return the new image with size width*height
+    wxImage GetSubImage( const wxRect& ) const;

 
 

-#if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-#endif
-};
+    // 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 );

 
 

-//-----------------------------------------------------------------------------
-// wxGIFHandler
-//-----------------------------------------------------------------------------
+    // return the new image with size width*height
+    wxImage Scale( int width, int height ) const;

 
 

-class WXDLLEXPORT wxGIFHandler : public wxImageHandler
-{
-  DECLARE_DYNAMIC_CLASS(wxGIFHandler)
+    // rescales the image in place
+    wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }

 
 

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

 
 

-  inline wxGIFHandler()
-  {
-      m_name = "GIF file";
-      m_extension = "gif";
-      m_type = wxBITMAP_TYPE_GIF;
-      m_mime = "image/gif";
-  };
+    wxImage Rotate90( bool clockwise = TRUE ) const;
+    wxImage Mirror( bool horizontally = TRUE ) const;

 
 

-#if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
-#endif
-};
+    // 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 );

 
 

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

 
 

-class WXDLLEXPORT wxImage: public wxObject
-{
-  DECLARE_DYNAMIC_CLASS(wxImage)
-
-  friend class WXDLLEXPORT wxImageHandler;
+    // 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;

 
 

-public:
+    // 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);

 
 

-  wxImage();
-  wxImage( int width, int height );
-  wxImage( const wxString& name, long type = wxBITMAP_TYPE_PNG );
-  wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_PNG );
-  wxImage( const wxString& name, const wxString& mimetype );
-  wxImage( wxInputStream& stream, const wxString& mimetype );
-
-  wxImage( const wxImage& image );
-  wxImage( const wxImage* image );
-  
-  // these functions get implemented in /src/(platform)/bitmap.cpp 
-  wxImage( const wxBitmap &bitmap );
-  operator wxBitmap() const { return ConvertToBitmap(); }
-  wxBitmap ConvertToBitmap() const;
-
-  void Create( int width, int height );
-  void Destroy();
-  
-  // return the new image with size width*height
-  wxImage Scale( int width, int height ) const;
-
-  // rescales the image in place
-  wxImage Rescale( int width, int height ) { *this = Scale(width, height); }
-
-  // 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 );
-  
-  virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_PNG );
-  virtual bool LoadFile( const wxString& name, const wxString& mimetype );
+    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 );
+    virtual bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 );

 
 #if wxUSE_STREAMS
 
 #if wxUSE_STREAMS

-  virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_PNG );
-  virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype );
+    static bool CanRead( wxInputStream& stream );
+    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, 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
 
 #endif
 

-  bool Ok() const;
-  int GetWidth() const;
-  int GetHeight() const;
-
-  char unsigned *GetData() const;
-  void SetData( char unsigned *data );
-  
-  void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
-  unsigned char GetMaskRed() const;
-  unsigned char GetMaskGreen() const;
-  unsigned char GetMaskBlue() const;
-  void SetMask( bool mask = TRUE );
-  bool HasMask() const;
-
-  wxImage& operator = (const wxImage& image)
-  {
-    if ( (*this) != image )
-      Ref(image);
-    return *this;
-  }
-
-  bool operator == (const wxImage& image)
-    { return m_refData == image.m_refData; }
-  bool operator != (const wxImage& image) 
-    { return m_refData != image.m_refData; }
-
-  static wxList& GetHandlers() { return sm_handlers; }
-  static void AddHandler( wxImageHandler *handler );
-  static void InsertHandler( wxImageHandler *handler );
-  static bool RemoveHandler( const wxString& name );
-  static wxImageHandler *FindHandler( const wxString& name );
-  static wxImageHandler *FindHandler( const wxString& extension, long imageType );
-  static wxImageHandler *FindHandler( long imageType );
-  static wxImageHandler *FindHandlerMime( const wxString& mimetype );
-
-  static void CleanUpHandlers();
-  static void InitStandardHandlers();
+    bool Ok() const;
+    int GetWidth() const;
+    int GetHeight() const;
+
+    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;
+    unsigned char GetMaskBlue() 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);
+#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)
+    {
+        if ( (*this) != image )
+            Ref(image);
+        return *this;
+    }
+
+    bool operator == (const wxImage& image)
+        { return m_refData == image.m_refData; }
+    bool operator != (const wxImage& image)
+        { return m_refData != image.m_refData; }
+
+    static wxList& GetHandlers() { return sm_handlers; }
+    static void AddHandler( wxImageHandler *handler );
+    static void InsertHandler( wxImageHandler *handler );
+    static bool RemoveHandler( const wxString& name );
+    static wxImageHandler *FindHandler( const wxString& name );
+    static wxImageHandler *FindHandler( const wxString& extension, long imageType );
+    static wxImageHandler *FindHandler( long imageType );
+    static wxImageHandler *FindHandlerMime( const wxString& mimetype );
+
+    static void CleanUpHandlers();
+    static void InitStandardHandlers();

 
 protected:
 
 protected:

+    static wxList   sm_handlers;
+
+private:
+    friend class WXDLLEXPORT wxImageHandler;

 
 

-  static wxList sm_handlers;
-  
+    DECLARE_DYNAMIC_CLASS(wxImage)

 };
 
 };
 

+
+extern void WXDLLEXPORT wxInitAllImageHandlers();
+
+WXDLLEXPORT_DATA(extern wxImage)    wxNullImage;
+
+//-----------------------------------------------------------------------------
+// wxImage handlers
+//-----------------------------------------------------------------------------
+
+#include "wx/imagbmp.h"
+#include "wx/imagpng.h"
+#include "wx/imaggif.h"
+#include "wx/imagpcx.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_