include/wx/imagbmp.h

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