Fixed typo.

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

diff --git a/include/wx/imagbmp.h b/include/wx/imagbmp.h
index 0d67d7a8fb4d1dc6d944a78edddac065a4d243d4..c85fac0e6a65e91bdae632d153464384a1f0f6b3 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
+// Purpose:     wxImage BMP, ICO, CUR and ANI handlers
 // Author:      Robert Roebling, Chris Elliott
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling, Chris Elliott
@@ -10,15 +10,24 @@
 #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
 {
@@ -50,15 +59,15 @@ public:
     };
 
 #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 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:
-    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 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
@@ -84,11 +93,12 @@ public:
     };
 
 #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=-1 );
     virtual bool DoLoadFile( wxImage *image, wxInputStream& stream, bool verbose, int index );
-    virtual bool DoCanRead( wxInputStream& stream );
     virtual int GetImageCount( wxInputStream& stream );
+protected:
+    virtual bool DoCanRead( wxInputStream& stream );
 #endif // wxUSE_STREAMS
 
 private:
@@ -100,11 +110,6 @@ private:
 // 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
 {
 public:
@@ -115,11 +120,12 @@ public:
         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
@@ -141,13 +147,14 @@ public:
         m_type = wxBITMAP_TYPE_ANI;
         m_mime = _T("image/x-ani");
     };
-    
+
 
 #if wxUSE_STREAMS
-    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ) {return FALSE ;};
-    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 );
-    virtual bool DoCanRead( wxInputStream& stream );
+    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: