A few tweaks and cleanups

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

diff --git a/include/wx/image.h b/include/wx/image.h
index 9cee5d69f8ee6e51e16f61920df670f707cb2cc4..7522d068541b532cfc0cc8f944aa1658261c4c53 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -19,6 +19,7 @@
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/bitmap.h"
+#include "wx/hashmap.h"
 
 #if wxUSE_STREAMS
 #  include "wx/stream.h"
@@ -26,6 +27,8 @@
 
 #if wxUSE_IMAGE
 
+#define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
+
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
@@ -43,10 +46,10 @@ 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 GetImagesCount( wxInputStream& stream );
+    virtual int GetImageCount( wxInputStream& stream );
 
     bool CanRead( wxInputStream& stream ) { return DoCanRead(stream); }
     bool CanRead( const wxString& name );
@@ -76,16 +79,25 @@ private:
 };
 
 //-----------------------------------------------------------------------------
-// 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:
@@ -103,7 +115,7 @@ public:
     wxImage( const wxImage& image );
     wxImage( const wxImage* image );
 
-#if wxUSE_GUI
+#if WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI
     // convertion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
     wxImage( const wxBitmap &bitmap );
     wxBitmap ConvertToBitmap() const;
@@ -158,29 +170,30 @@ public:
     // 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 );
+                                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);
 
     static bool CanRead( const wxString& name );
-    static int GetImagesCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
+    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 );
-    static int GetImagesCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
+    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;
@@ -213,8 +226,15 @@ public:
     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)
     {
@@ -266,6 +286,7 @@ WXDLLEXPORT_DATA(extern wxImage)    wxNullImage;
 #include "wx/imagtiff.h"
 #include "wx/imagpnm.h"
 #include "wx/imagxpm.h"
+#include "wx/imagiff.h"
 
 #endif // wxUSE_IMAGE