Escape underscores

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

diff --git a/include/wx/imagbmp.h b/include/wx/imagbmp.h
index 81661e1510e23939e23c2b24a1d0d3a10b265a0a..d45267079321ae70d59713a96180ef3dce4e33cf 100644 (file)
--- a/include/wx/imagbmp.h
+++ b/include/wx/imagbmp.h
@@ -1,24 +1,33 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        imagbmp.h
-// Purpose:     wxImage BMP handler
-// Author:      Robert Roebling
+// Purpose:     wxImage BMP, ICO and CUR handlers
+// Author:      Robert Roebling, Chris Elliott
 // RCS-ID:      $Id$
-// Copyright:   (c) Robert Roebling
+// Copyright:   (c) Robert Roebling, Chris Elliott
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #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
-// 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(_T("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")
+
+#if WXWIN_COMPATIBILITY_2_4
+    // Do not use these macros, they are deprecated
+    #define wxBMP_FORMAT    wxIMAGE_OPTION_BMP_FORMAT
+    #define wxCUR_HOTSPOT_X wxIMAGE_OPTION_CUR_HOTSPOT_X
+    #define wxCUR_HOTSPOT_Y wxIMAGE_OPTION_CUR_HOTSPOT_Y
+#endif
+
 
 enum
 {
@@ -43,32 +52,31 @@ class WXDLLEXPORT wxBMPHandler : public wxImageHandler
 public:
     wxBMPHandler()
     {
-        m_name = _T("BMP file");
+        m_name = _T("Windows bitmap file");
         m_extension = _T("bmp");
         m_type = wxBITMAP_TYPE_BMP;
-        m_mime = _T("image/bmp");
+        m_mime = _T("image/x-bmp");
     };
 
 #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=-1 );
 
-  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 );
-                                
 protected:
-  bool SaveDib(wxImage *image, wxOutputStream& stream, bool verbose, bool IsBmp, bool IsMask);
-  bool DoLoadDib (wxImage * image, int width, int height, int bpp, int ncolors, int comp,
-                off_t bmpOffset, wxInputStream& stream,
-                bool verbose, bool IsBmp, bool hasPalette  ) ;
-  bool LoadDib( wxImage *image, wxInputStream& stream, bool verbose, bool IsBmp  ) ;
-
+    virtual bool DoCanRead( wxInputStream& stream );
+    bool SaveDib(wxImage *image, wxOutputStream& stream, bool verbose,
+                 bool IsBmp, bool IsMask);
+    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
 
 private:
      DECLARE_DYNAMIC_CLASS(wxBMPHandler)
 };
 
-
+#if wxUSE_ICO_CUR
 // ----------------------------------------------------------------------------
 // wxICOHandler
 // ----------------------------------------------------------------------------
@@ -78,25 +86,80 @@ class WXDLLEXPORT wxICOHandler : public wxBMPHandler
 public:
     wxICOHandler()
     {
-        m_name = _T("ICO file");
+        m_name = _T("Windows icon file");
         m_extension = _T("ico");
         m_type = wxBITMAP_TYPE_ICO;
-        m_mime = _T("image/icon");
+        m_mime = _T("image/x-ico");
     };
 
 #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=-1 );
+    virtual bool DoLoadFile( wxImage *image, wxInputStream& stream, bool verbose, int index );
+    virtual int GetImageCount( wxInputStream& stream );
+protected:
+    virtual bool DoCanRead( wxInputStream& stream );
+#endif // 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 );
-                
+private:
+    DECLARE_DYNAMIC_CLASS(wxICOHandler)
+};
+
+
+// ----------------------------------------------------------------------------
+// wxCURHandler
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxCURHandler : public wxICOHandler
+{
+public:
+    wxCURHandler()
+    {
+        m_name = _T("Windows cursor file");
+        m_extension = _T("cur");
+        m_type = wxBITMAP_TYPE_CUR;
+        m_mime = _T("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.
+
+protected:
+#if wxUSE_STREAMS
+    virtual bool DoCanRead( wxInputStream& stream );
 #endif // wxUSE_STREAMS
 
 private:
-    DECLARE_DYNAMIC_CLASS(wxBMPHandler)
+    DECLARE_DYNAMIC_CLASS(wxCURHandler)
 };
+// ----------------------------------------------------------------------------
+// wxANIHandler
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxANIHandler : public wxCURHandler
+{
+public:
+    wxANIHandler()
+    {
+        m_name = _T("Windows animated cursor file");
+        m_extension = _T("ani");
+        m_type = wxBITMAP_TYPE_ANI;
+        m_mime = _T("image/x-ani");
+    };
 
 
-#endif
-  // _WX_IMAGBMP_H_
+#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 );
+    virtual int GetImageCount( wxInputStream& stream );
+protected:
+    virtual bool DoCanRead( wxInputStream& stream );
+#endif // wxUSE_STREAMS
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxANIHandler)
+};
 
+#endif // wxUSE_ICO_CUR
+#endif // _WX_IMAGBMP_H_