supporting clang memory management annotations

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

diff --git a/include/wx/imagbmp.h b/include/wx/imagbmp.h
index 81661e1510e23939e23c2b24a1d0d3a10b265a0a..a54dceb21173b535c494c9f895b314450a24e18d 100644 (file)
--- a/include/wx/imagbmp.h
+++ b/include/wx/imagbmp.h
@@ -1,24 +1,26 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        imagbmp.h
-// Purpose:     wxImage BMP handler
-// Author:      Robert Roebling
+// Name:        wx/imagbmp.h
+// Purpose:     wxImage BMP, ICO, CUR and ANI 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(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
 {
@@ -38,65 +40,121 @@ enum
 // wxBMPHandler
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxBMPHandler : public wxImageHandler
+class WXDLLIMPEXP_CORE wxBMPHandler : public wxImageHandler
 {
 public:
     wxBMPHandler()
     {
-        m_name = _T("BMP file");
-        m_extension = _T("bmp");
+        m_name = wxT("Windows bitmap file");
+        m_extension = wxT("bmp");
         m_type = wxBITMAP_TYPE_BMP;
-        m_mime = _T("image/bmp");
-    };
+        m_mime = wxT("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
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxICOHandler : public wxBMPHandler
+class WXDLLIMPEXP_CORE wxICOHandler : public wxBMPHandler
 {
 public:
     wxICOHandler()
     {
-        m_name = _T("ICO file");
-        m_extension = _T("ico");
+        m_name = wxT("Windows icon file");
+        m_extension = wxT("ico");
         m_type = wxBITMAP_TYPE_ICO;
-        m_mime = _T("image/icon");
-    };
+        m_mime = wxT("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 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:
+    virtual int DoGetImageCount( wxInputStream& stream );
+    virtual bool DoCanRead( wxInputStream& stream );
 #endif // wxUSE_STREAMS
 
 private:
-    DECLARE_DYNAMIC_CLASS(wxBMPHandler)
+    DECLARE_DYNAMIC_CLASS(wxICOHandler)
 };
 
 
-#endif
-  // _WX_IMAGBMP_H_
+// ----------------------------------------------------------------------------
+// wxCURHandler
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxCURHandler : public wxICOHandler
+{
+public:
+    wxCURHandler()
+    {
+        m_name = wxT("Windows cursor file");
+        m_extension = wxT("cur");
+        m_type = wxBITMAP_TYPE_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.
+
+protected:
+#if wxUSE_STREAMS
+    virtual bool DoCanRead( wxInputStream& stream );
+#endif // wxUSE_STREAMS
+
+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_