Add RunScript and implement on all backends. Document and add a very simple unit...

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

diff --git a/include/wx/imagbmp.h b/include/wx/imagbmp.h
index 2fbccbf619f3c8a13fac9a52a6989a8d15f5b259..a54dceb21173b535c494c9f895b314450a24e18d 100644 (file)
--- a/include/wx/imagbmp.h
+++ b/include/wx/imagbmp.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        imagbmp.h
-// Purpose:     wxImage BMP, ICO and CUR handlers
+// Name:        wx/imagbmp.h
+// Purpose:     wxImage BMP, ICO, CUR and ANI handlers

 // Author:      Robert Roebling, Chris Elliott
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling, Chris Elliott
 // Author:      Robert Roebling, Chris Elliott
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling, Chris Elliott


@@ -10,15 +10,17 @@
 #ifndef _WX_IMAGBMP_H_
 #define _WX_IMAGBMP_H_
 
 #ifndef _WX_IMAGBMP_H_
 #define _WX_IMAGBMP_H_
 

-#ifdef __GNUG__
-#pragma interface "imagbmp.h"
-#endif
-

 #include "wx/image.h"
 
 // defines for saving the BMP file in different formats, Bits Per Pixel
 #include "wx/image.h"
 
 // defines for saving the BMP file in different formats, Bits Per Pixel

-// USE: wximage.SetOption( wxBMP_FORMAT, wxBMP_xBPP );
-#define wxBMP_FORMAT wxString(_T("wxBMP_FORMAT"))
+// USE: wximage.SetOption( wxIMAGE_OPTION_BMP_FORMAT, wxBMP_xBPP );
+#define wxIMAGE_OPTION_BMP_FORMAT wxString(wxT("wxBMP_FORMAT"))
+
+// These two options are filled in upon reading CUR file and can (should) be
+// specified when saving a CUR file - they define the hotspot of the cursor:
+#define wxIMAGE_OPTION_CUR_HOTSPOT_X  wxT("HotSpotX")
+#define wxIMAGE_OPTION_CUR_HOTSPOT_Y  wxT("HotSpotY")
+

 
 enum
 {
 
 enum
 {


@@ -38,27 +40,27 @@ enum
 // wxBMPHandler
 // ----------------------------------------------------------------------------
 
 // wxBMPHandler
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBMPHandler : public wxImageHandler
+class WXDLLIMPEXP_CORE wxBMPHandler : public wxImageHandler

 {
 public:
     wxBMPHandler()
     {
 {
 public:
     wxBMPHandler()
     {

-        m_name = _T("Windows bitmap file");
-        m_extension = _T("bmp");
+        m_name = wxT("Windows bitmap file");
+        m_extension = wxT("bmp");

         m_type = wxBITMAP_TYPE_BMP;
         m_type = wxBITMAP_TYPE_BMP;

-        m_mime = _T("image/x-bmp");
-    };
+        m_mime = wxT("image/x-bmp");
+    }

 
 #if wxUSE_STREAMS
 
 #if wxUSE_STREAMS

-    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
-    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=0 );
-    virtual bool DoCanRead( wxInputStream& stream );
-                                
+    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=true );
+    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1 );
+

 protected:
 protected:

-    bool SaveDib(wxImage *image, wxOutputStream& stream, bool verbose, 
+    virtual bool DoCanRead( wxInputStream& stream );
+    bool SaveDib(wxImage *image, wxOutputStream& stream, bool verbose,

                  bool IsBmp, bool IsMask);
                  bool IsBmp, bool IsMask);

-    bool DoLoadDib(wxImage *image, int width, int height, int bpp, int ncolors, 
-                   int comp, off_t bmpOffset, wxInputStream& stream,
+    bool DoLoadDib(wxImage *image, int width, int height, int bpp, int ncolors,
+                   int comp, wxFileOffset bmpOffset, wxInputStream& stream,

                    bool verbose, bool IsBmp, bool hasPalette);
     bool LoadDib(wxImage *image, wxInputStream& stream, bool verbose, bool IsBmp);
 #endif // wxUSE_STREAMS
                    bool verbose, bool IsBmp, bool hasPalette);
     bool LoadDib(wxImage *image, wxInputStream& stream, bool verbose, bool IsBmp);
 #endif // wxUSE_STREAMS


@@ -67,27 +69,30 @@ private:
      DECLARE_DYNAMIC_CLASS(wxBMPHandler)
 };
 
      DECLARE_DYNAMIC_CLASS(wxBMPHandler)
 };
 

-
+#if wxUSE_ICO_CUR

 // ----------------------------------------------------------------------------
 // wxICOHandler
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxICOHandler
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxICOHandler : public wxBMPHandler
+class WXDLLIMPEXP_CORE wxICOHandler : public wxBMPHandler

 {
 public:
     wxICOHandler()
     {
 {
 public:
     wxICOHandler()
     {

-        m_name = _T("Windows icon file");
-        m_extension = _T("ico");
+        m_name = wxT("Windows icon file");
+        m_extension = wxT("ico");

         m_type = wxBITMAP_TYPE_ICO;
         m_type = wxBITMAP_TYPE_ICO;

-        m_mime = _T("image/x-ico");
-    };
+        m_mime = wxT("image/x-ico");
+    }

 
 #if wxUSE_STREAMS
 
 #if wxUSE_STREAMS

-    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
-    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 LoadFile( wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1 );
+    virtual bool DoLoadFile( wxImage *image, wxInputStream& stream, bool verbose, int index );
+
+protected:
+    virtual int DoGetImageCount( wxInputStream& stream );

     virtual bool DoCanRead( wxInputStream& stream );
     virtual bool DoCanRead( wxInputStream& stream );

-    virtual int GetImageCount( wxInputStream& stream );

 #endif // wxUSE_STREAMS
 
 private:
 #endif // wxUSE_STREAMS
 
 private:


@@ -99,26 +104,22 @@ private:
 // wxCURHandler
 // ----------------------------------------------------------------------------
 
 // wxCURHandler
 // ----------------------------------------------------------------------------
 

-// These two options are filled in upon reading CUR file and can (should) be
-// specified when saving a CUR file - they define the hotspot of the cursor:
-#define wxCUR_HOTSPOT_X  wxT("HotSpotX")
-#define wxCUR_HOTSPOT_Y  wxT("HotSpotY")
-
-class WXDLLEXPORT wxCURHandler : public wxICOHandler
+class WXDLLIMPEXP_CORE wxCURHandler : public wxICOHandler

 {
 public:
     wxCURHandler()
     {
 {
 public:
     wxCURHandler()
     {

-        m_name = _T("Windows cursor file");
-        m_extension = _T("cur");
+        m_name = wxT("Windows cursor file");
+        m_extension = wxT("cur");

         m_type = wxBITMAP_TYPE_CUR;
         m_type = wxBITMAP_TYPE_CUR;

-        m_mime = _T("image/x-cur");
-    };
-    
+        m_mime = wxT("image/x-cur");
+    }
+

     // VS: This handler's meat is implemented inside wxICOHandler (the two
     //     formats are almost identical), but we hide this fact at
     //     the API level, since it is a mere implementation detail.
 
     // VS: This handler's meat is implemented inside wxICOHandler (the two
     //     formats are almost identical), but we hide this fact at
     //     the API level, since it is a mere implementation detail.
 

+protected:

 #if wxUSE_STREAMS
     virtual bool DoCanRead( wxInputStream& stream );
 #endif // wxUSE_STREAMS
 #if wxUSE_STREAMS
     virtual bool DoCanRead( wxInputStream& stream );
 #endif // wxUSE_STREAMS


@@ -126,5 +127,34 @@ public:
 private:
     DECLARE_DYNAMIC_CLASS(wxCURHandler)
 };
 private:
     DECLARE_DYNAMIC_CLASS(wxCURHandler)
 };

+// ----------------------------------------------------------------------------
+// wxANIHandler
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxANIHandler : public wxCURHandler
+{
+public:
+    wxANIHandler()
+    {
+        m_name = wxT("Windows animated cursor file");
+        m_extension = wxT("ani");
+        m_type = wxBITMAP_TYPE_ANI;
+        m_mime = wxT("image/x-ani");
+    }
+
+
+#if wxUSE_STREAMS
+    virtual bool SaveFile( wxImage *WXUNUSED(image), wxOutputStream& WXUNUSED(stream), bool WXUNUSED(verbose=true) ){return false ;}
+    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1 );
+
+protected:
+    virtual int DoGetImageCount( wxInputStream& stream );
+    virtual bool DoCanRead( wxInputStream& stream );
+#endif // wxUSE_STREAMS
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxANIHandler)
+};

 
 

+#endif // wxUSE_ICO_CUR

 #endif // _WX_IMAGBMP_H_
 #endif // _WX_IMAGBMP_H_