]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/image.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
doc view code inteprets wxSTREAM_EOF as correct,
[wxWidgets.git] / include / wx / image.h
diff --git a/include/wx/image.h b/include/wx/image.h
index 2a1c3ad5b07370c7aeee96cae01766206ff377e1..cbff996d7595a5d96c78bf5defdc04e29aef0462 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
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_IMAGE_H_
@@ -18,9 +18,10 @@
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
+#include "wx/bitmap.h"
 
 #if wxUSE_STREAMS
-#include "wx/stream.h"
+#  include "wx/stream.h"
 #endif
 
 //-----------------------------------------------------------------------------
@@ -34,42 +35,59 @@ class WXDLLEXPORT wxPNGHandler;
 #if wxUSE_LIBJPEG
 class WXDLLEXPORT wxJPEGHandler;
 #endif
+#if wxUSE_LIBTIFF
+class WXDLLEXPORT wxTIFFHandler;
+#endif
 class WXDLLEXPORT wxBMPHandler;
+#if wxUSE_GIF
+class WXDLLEXPORT wxGIFHandler;
+#endif
+#if wxUSE_PNM
+class WXDLLEXPORT wxPNMHandler;
+#endif
+#if wxUSE_PCX
+class WXDLLEXPORT wxPCXHandler;
+#endif
 class WXDLLEXPORT wxImage;
 
-class WXDLLEXPORT wxBitmap;
-
 //-----------------------------------------------------------------------------
 // wxImageHandler
 //-----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxImageHandler: public wxObject
 {
-  DECLARE_DYNAMIC_CLASS(wxImageHandler)
-  
+  DECLARE_CLASS(wxImageHandler)
+
 public:
   wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }
 
 #if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+  
+  virtual int GetImageCount( wxInputStream& stream );
+
+  bool CanRead( wxInputStream& stream ) { return DoCanRead(stream); }
+  bool CanRead( const wxString& name );
 #endif
 
-  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; }
+  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:
+  virtual bool DoCanRead( wxInputStream& stream ) = 0;
+
   wxString  m_name;
   wxString  m_extension;
   wxString  m_mime;
   long      m_type;
-  
+
 };
 
 //-----------------------------------------------------------------------------
@@ -80,7 +98,7 @@ protected:
 class WXDLLEXPORT wxPNGHandler: public wxImageHandler
 {
   DECLARE_DYNAMIC_CLASS(wxPNGHandler)
-  
+
 public:
 
   inline wxPNGHandler()
@@ -92,8 +110,9 @@ public:
   };
 
 #if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+  virtual bool DoCanRead( wxInputStream& stream );
 #endif
 };
 #endif
@@ -118,8 +137,37 @@ public:
   };
 
 #if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+  virtual bool DoCanRead( wxInputStream& stream );
+#endif
+};
+#endif
+
+//-----------------------------------------------------------------------------
+// wxTIFFHandler
+//-----------------------------------------------------------------------------
+
+#if wxUSE_LIBTIFF
+class WXDLLEXPORT wxTIFFHandler: public wxImageHandler
+{
+  DECLARE_DYNAMIC_CLASS(wxTIFFHandler)
+
+public:
+
+  inline wxTIFFHandler()
+  {
+      m_name = "TIFF file";
+      m_extension = "tif";
+      m_type = wxBITMAP_TYPE_TIF;
+      m_mime = "image/tiff";
+  };
+
+#if wxUSE_STREAMS
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+  virtual bool DoCanRead( wxInputStream& stream );
+  virtual int GetImageCount( wxInputStream& stream );
 #endif
 };
 #endif
@@ -131,7 +179,7 @@ public:
 class WXDLLEXPORT wxBMPHandler: public wxImageHandler
 {
   DECLARE_DYNAMIC_CLASS(wxBMPHandler)
-  
+
 public:
 
   inline wxBMPHandler()
@@ -143,7 +191,8 @@ public:
   };
 
 #if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool DoCanRead( wxInputStream& stream );
 #endif
 };
 
@@ -151,6 +200,8 @@ public:
 // wxGIFHandler
 //-----------------------------------------------------------------------------
 
+#if wxUSE_GIF
+
 class WXDLLEXPORT wxGIFHandler : public wxImageHandler
 {
   DECLARE_DYNAMIC_CLASS(wxGIFHandler)
@@ -166,10 +217,66 @@ public:
   };
 
 #if wxUSE_STREAMS
-  virtual bool LoadFile( wxImage *image, wxInputStream& stream );
-  virtual bool SaveFile( wxImage *image, wxOutputStream& stream );
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+  virtual bool DoCanRead( wxInputStream& stream );
 #endif
 };
+#endif
+
+//-----------------------------------------------------------------------------
+// wxPNMHandler
+//-----------------------------------------------------------------------------
+
+#if wxUSE_PNM
+class WXDLLEXPORT wxPNMHandler : public wxImageHandler
+{
+  DECLARE_DYNAMIC_CLASS(wxPNMHandler)
+
+public:
+
+  inline wxPNMHandler()
+  {
+      m_name = "PNM file";
+      m_extension = "pnm";
+      m_type = wxBITMAP_TYPE_PNM;
+      m_mime = "image/pnm";
+  };
+
+#if wxUSE_STREAMS
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+  virtual bool DoCanRead( wxInputStream& stream );
+#endif
+};
+#endif
+
+//-----------------------------------------------------------------------------
+// wxPCXHandler
+//-----------------------------------------------------------------------------
+
+#if wxUSE_PCX
+class WXDLLEXPORT wxPCXHandler : public wxImageHandler
+{
+  DECLARE_DYNAMIC_CLASS(wxPCXHandler)
+
+public:
+
+  inline wxPCXHandler()
+  {
+      m_name = "PCX file";
+      m_extension = "pcx";
+      m_type = wxBITMAP_TYPE_PCX;
+      m_mime = "image/pcx";
+  };
+
+#if wxUSE_STREAMS
+  virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
+  virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+  virtual bool DoCanRead( wxInputStream& stream );
+#endif // wxUSE_STREAMS
+};
+#endif // wxUSE_PCX
 
 //-----------------------------------------------------------------------------
 // wxImage
@@ -185,34 +292,44 @@ public:
 
   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, 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 wxImage& image );
   wxImage( const wxImage* image );
-  
-  // these functions get implemented in /src/(platform)/bitmap.cpp 
+
+  // 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();
-  
-  wxImage Scale( int width, int height );
-  
-  // these routines are slow but safe  
+
+  // return the new image with size width*height
+  wxImage GetSubImage( const wxRect& ) const;
+
+  // return the new image with size width*height
+  wxImage Scale( int width, int height ) const;
+
+  // rescales the image in place
+  void 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 );
+
+  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 );
 
 #if wxUSE_STREAMS
-  virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_PNG );
+  static bool CanRead( wxInputStream& stream );
+  virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
   virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype );
 #endif
 
@@ -230,7 +347,7 @@ public:
 
   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;
@@ -238,18 +355,19 @@ public:
   void SetMask( bool mask = TRUE );
   bool HasMask() const;
 
-  inline wxImage& operator = (const wxImage& image)
-    { if ((*this) == image)
-          return (*this);
+  wxImage& operator = (const wxImage& image)
+  {
+    if ( (*this) != image )
       Ref(image);
-      return *this; }
+    return *this;
+  }
 
-  inline bool operator == (const wxImage& image)
+  bool operator == (const wxImage& image)
     { return m_refData == image.m_refData; }
-  inline bool operator != (const wxImage& image) 
+  bool operator != (const wxImage& image)
     { return m_refData != image.m_refData; }
 
-  static inline wxList& GetHandlers() { return sm_handlers; }
+  static wxList& GetHandlers() { return sm_handlers; }
   static void AddHandler( wxImageHandler *handler );
   static void InsertHandler( wxImageHandler *handler );
   static bool RemoveHandler( const wxString& name );
@@ -264,9 +382,11 @@ public:
 protected:
 
   static wxList sm_handlers;
-  
+
 };
 
+extern void WXDLLEXPORT wxInitAllImageHandlers();
+
 #endif
   // _WX_IMAGE_H_
 
wxWidgets (Impactor)