include/wx/imagbmp.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        imagbmp.h
   3 // Purpose:     wxImage BMP, ICO and CUR handlers
   4 // Author:      Robert Roebling, Chris Elliott
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) Robert Roebling, Chris Elliott
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_IMAGBMP_H_
  11 #define _WX_IMAGBMP_H_
  12
  13 #ifdef __GNUG__
  14 #pragma interface "imagbmp.h"
  15 #endif
  16
  17 #include "wx/image.h"
  18
  19 // defines for saving the BMP file in different formats, Bits Per Pixel
  20 // USE: wximage.SetOption( wxBMP_FORMAT, wxBMP_xBPP );
  21 #define wxBMP_FORMAT wxString(_T("wxBMP_FORMAT"))
  22
  23 enum
  24 {
  25     wxBMP_24BPP        = 24, // default, do not need to set
  26     //wxBMP_16BPP      = 16, // wxQuantize can only do 236 colors?
  27     wxBMP_8BPP         =  8, // 8bpp, quantized colors
  28     wxBMP_8BPP_GREY    =  9, // 8bpp, rgb averaged to greys
  29     wxBMP_8BPP_GRAY    =  wxBMP_8BPP_GREY,
  30     wxBMP_8BPP_RED     = 10, // 8bpp, red used as greyscale
  31     wxBMP_8BPP_PALETTE = 11, // 8bpp, use the wxImage's palette
  32     wxBMP_4BPP         =  4, // 4bpp, quantized colors
  33     wxBMP_1BPP         =  1, // 1bpp, quantized "colors"
  34     wxBMP_1BPP_BW      =  2  // 1bpp, black & white from red
  35 };
  36
  37 // ----------------------------------------------------------------------------
  38 // wxBMPHandler
  39 // ----------------------------------------------------------------------------
  40
  41 class WXDLLEXPORT wxBMPHandler : public wxImageHandler
  42 {
  43 public:
  44     wxBMPHandler()
  45     {
  46         m_name = _T("Windows bitmap file");
  47         m_extension = _T("bmp");
  48         m_type = wxBITMAP_TYPE_BMP;
  49         m_mime = _T("image/x-bmp");
  50     };
  51
  52 #if wxUSE_STREAMS
  53     virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
  54     virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 );
  55     virtual bool DoCanRead( wxInputStream& stream );
  56
  57 protected:
  58     bool SaveDib(wxImage *image, wxOutputStream& stream, bool verbose,
  59                  bool IsBmp, bool IsMask);
  60     bool DoLoadDib(wxImage *image, int width, int height, int bpp, int ncolors,
  61                    int comp, off_t bmpOffset, wxInputStream& stream,
  62                    bool verbose, bool IsBmp, bool hasPalette);
  63     bool LoadDib(wxImage *image, wxInputStream& stream, bool verbose, bool IsBmp);
  64 #endif // wxUSE_STREAMS
  65
  66 private:
  67      DECLARE_DYNAMIC_CLASS(wxBMPHandler)
  68 };
  69
  70 #if wxUSE_ICO_CUR
  71 // ----------------------------------------------------------------------------
  72 // wxICOHandler
  73 // ----------------------------------------------------------------------------
  74
  75 class WXDLLEXPORT wxICOHandler : public wxBMPHandler
  76 {
  77 public:
  78     wxICOHandler()
  79     {
  80         m_name = _T("Windows icon file");
  81         m_extension = _T("ico");
  82         m_type = wxBITMAP_TYPE_ICO;
  83         m_mime = _T("image/x-ico");
  84     };
  85
  86 #if wxUSE_STREAMS
  87     virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
  88     virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 );
  89     virtual bool DoLoadFile( wxImage *image, wxInputStream& stream, bool verbose, int index );
  90     virtual bool DoCanRead( wxInputStream& stream );
  91     virtual int GetImageCount( wxInputStream& stream );
  92 #endif // wxUSE_STREAMS
  93
  94 private:
  95     DECLARE_DYNAMIC_CLASS(wxICOHandler)
  96 };
  97
  98
  99 // ----------------------------------------------------------------------------
 100 // wxCURHandler
 101 // ----------------------------------------------------------------------------
 102
 103 // These two options are filled in upon reading CUR file and can (should) be
 104 // specified when saving a CUR file - they define the hotspot of the cursor:
 105 #define wxCUR_HOTSPOT_X  wxT("HotSpotX")
 106 #define wxCUR_HOTSPOT_Y  wxT("HotSpotY")
 107
 108 class WXDLLEXPORT wxCURHandler : public wxICOHandler
 109 {
 110 public:
 111     wxCURHandler()
 112     {
 113         m_name = _T("Windows cursor file");
 114         m_extension = _T("cur");
 115         m_type = wxBITMAP_TYPE_CUR;
 116         m_mime = _T("image/x-cur");
 117     };
 118
 119     // VS: This handler's meat is implemented inside wxICOHandler (the two
 120     //     formats are almost identical), but we hide this fact at
 121     //     the API level, since it is a mere implementation detail.
 122
 123 #if wxUSE_STREAMS
 124     virtual bool DoCanRead( wxInputStream& stream );
 125 #endif // wxUSE_STREAMS
 126
 127 private:
 128     DECLARE_DYNAMIC_CLASS(wxCURHandler)
 129 };
 130 // ----------------------------------------------------------------------------
 131 // wxANIHandler
 132 // ----------------------------------------------------------------------------
 133
 134 class WXDLLEXPORT wxANIHandler : public wxCURHandler
 135 {
 136 public:
 137     wxANIHandler()
 138     {
 139         m_name = _T("Windows animated cursor file");
 140         m_extension = _T("ani");
 141         m_type = wxBITMAP_TYPE_ANI;
 142         m_mime = _T("image/x-ani");
 143     };
 144
 145
 146 #if wxUSE_STREAMS
 147     virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE ) {return FALSE ;};
 148     virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 );
 149     virtual bool DoCanRead( wxInputStream& stream );
 150     virtual int GetImageCount( wxInputStream& stream );
 151 #endif // wxUSE_STREAMS
 152
 153 private:
 154     DECLARE_DYNAMIC_CLASS(wxANIHandler)
 155 };
 156
 157 #endif // wxUSE_ICO_CUR
 158 #endif // _WX_IMAGBMP_H_