include/wx/msw/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/bitmap.h
   3 // Purpose:     wxBitmap class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BITMAP_H_
  13 #define _WX_BITMAP_H_
  14
  15 #include "wx/msw/gdiimage.h"
  16 #include "wx/palette.h"
  17
  18 class WXDLLEXPORT wxBitmap;
  19 class WXDLLEXPORT wxBitmapHandler;
  20 class WXDLLEXPORT wxBitmapRefData;
  21 class WXDLLEXPORT wxControl;
  22 class WXDLLEXPORT wxCursor;
  23 class WXDLLEXPORT wxDC;
  24 #if wxUSE_WXDIB
  25 class WXDLLEXPORT wxDIB;
  26 #endif
  27 class WXDLLEXPORT wxIcon;
  28 class WXDLLEXPORT wxImage;
  29 class WXDLLEXPORT wxMask;
  30 class WXDLLEXPORT wxPalette;
  31 class WXDLLEXPORT wxPixelDataBase;
  32
  33 // ----------------------------------------------------------------------------
  34 // wxBitmap: a mono or colour bitmap
  35 // ----------------------------------------------------------------------------
  36
  37 class WXDLLEXPORT wxBitmap : public wxGDIImage
  38 {
  39 public:
  40     // default ctor creates an invalid bitmap, you must Create() it later
  41     wxBitmap() { }
  42
  43     // Initialize with raw data
  44     wxBitmap(const char bits[], int width, int height, int depth = 1);
  45
  46     // Initialize with XPM data
  47     wxBitmap(const char* const* data);
  48 #ifdef wxNEEDS_CHARPP
  49     wxBitmap(char** data)
  50     {
  51         *this = wxBitmap(wx_const_cast(const char* const*, data));
  52     }
  53 #endif
  54
  55     // Load a file or resource
  56     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
  57
  58     // New constructor for generalised creation from data
  59     wxBitmap(const void* data, long type, int width, int height, int depth = 1);
  60
  61     // Create a new, uninitialized bitmap of the given size and depth (if it
  62     // is omitted, will create a bitmap compatible with the display)
  63     //
  64     // NB: this ctor will create a DIB for 24 and 32bpp bitmaps, use ctor
  65     //     taking a DC argument if you want to force using DDB in this case
  66     wxBitmap(int width, int height, int depth = -1);
  67
  68     // Create a bitmap compatible with the given DC
  69     wxBitmap(int width, int height, const wxDC& dc);
  70
  71 #if wxUSE_IMAGE
  72     // Convert from wxImage
  73     wxBitmap(const wxImage& image, int depth = -1)
  74         { (void)CreateFromImage(image, depth); }
  75
  76     // Create a DDB compatible with the given DC from wxImage
  77     wxBitmap(const wxImage& image, const wxDC& dc)
  78         { (void)CreateFromImage(image, dc); }
  79 #endif // wxUSE_IMAGE
  80
  81     // we must have this, otherwise icons are silently copied into bitmaps using
  82     // the copy ctor but the resulting bitmap is invalid!
  83     wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
  84
  85     wxBitmap& operator=(const wxIcon& icon)
  86     {
  87         (void)CopyFromIcon(icon);
  88
  89         return *this;
  90     }
  91
  92     wxBitmap& operator=(const wxCursor& cursor)
  93     {
  94         (void)CopyFromCursor(cursor);
  95
  96         return *this;
  97     }
  98
  99     virtual ~wxBitmap();
 100
 101 #if wxUSE_IMAGE
 102     wxImage ConvertToImage() const;
 103 #endif // wxUSE_IMAGE
 104
 105     // get the given part of bitmap
 106     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 107
 108     // copies the contents and mask of the given (colour) icon to the bitmap
 109     bool CopyFromIcon(const wxIcon& icon);
 110
 111     // copies the contents and mask of the given cursor to the bitmap
 112     bool CopyFromCursor(const wxCursor& cursor);
 113
 114 #if wxUSE_WXDIB
 115     // copies from a device independent bitmap
 116     bool CopyFromDIB(const wxDIB& dib);
 117 #endif
 118
 119     virtual bool Create(int width, int height, int depth = -1);
 120     virtual bool Create(int width, int height, const wxDC& dc);
 121     virtual bool Create(const void* data, long type, int width, int height, int depth = 1);
 122     virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
 123     virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
 124
 125     wxBitmapRefData *GetBitmapData() const
 126         { return (wxBitmapRefData *)m_refData; }
 127
 128     // raw bitmap access support functions
 129     void *GetRawData(wxPixelDataBase& data, int bpp);
 130     void UngetRawData(wxPixelDataBase& data);
 131
 132 #if wxUSE_PALETTE
 133     wxPalette* GetPalette() const;
 134     void SetPalette(const wxPalette& palette);
 135 #endif // wxUSE_PALETTE
 136
 137     wxMask *GetMask() const;
 138     wxBitmap GetMaskBitmap() const;
 139     void SetMask(wxMask *mask);
 140
 141     // these functions are internal and shouldn't be used, they risk to
 142     // disappear in the future
 143     bool HasAlpha() const;
 144     void UseAlpha();
 145
 146 #if WXWIN_COMPATIBILITY_2_4
 147     // these functions do nothing and are only there for backwards
 148     // compatibility
 149     wxDEPRECATED( int GetQuality() const );
 150     wxDEPRECATED( void SetQuality(int quality) );
 151 #endif // WXWIN_COMPATIBILITY_2_4
 152
 153     // implementation only from now on
 154     // -------------------------------
 155
 156 public:
 157     void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
 158     WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
 159
 160 #ifdef __WXDEBUG__
 161     void SetSelectedInto(wxDC *dc);
 162     wxDC *GetSelectedInto() const;
 163 #endif // __WXDEBUG__
 164
 165 protected:
 166     virtual wxGDIImageRefData *CreateData() const;
 167     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 168
 169     // creates an uninitialized bitmap, called from Create()s above
 170     bool DoCreate(int w, int h, int depth, WXHDC hdc);
 171
 172 #if wxUSE_IMAGE
 173     // creates the bitmap from wxImage, supposed to be called from ctor
 174     bool CreateFromImage(const wxImage& image, int depth);
 175
 176     // creates a DDB from wxImage, supposed to be called from ctor
 177     bool CreateFromImage(const wxImage& image, const wxDC& dc);
 178
 179     // common part of the 2 methods above (hdc may be 0)
 180     bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc);
 181 #endif // wxUSE_IMAGE
 182
 183 private:
 184     // common part of CopyFromIcon/CopyFromCursor for Win32
 185     bool CopyFromIconOrCursor(const wxGDIImage& icon);
 186
 187
 188     DECLARE_DYNAMIC_CLASS(wxBitmap)
 189 };
 190
 191 // ----------------------------------------------------------------------------
 192 // wxMask: a mono bitmap used for drawing bitmaps transparently.
 193 // ----------------------------------------------------------------------------
 194
 195 class WXDLLEXPORT wxMask : public wxObject
 196 {
 197 public:
 198     wxMask();
 199
 200     // Copy constructor
 201     wxMask(const wxMask &mask);
 202
 203     // Construct a mask from a bitmap and a colour indicating the transparent
 204     // area
 205     wxMask(const wxBitmap& bitmap, const wxColour& colour);
 206
 207     // Construct a mask from a bitmap and a palette index indicating the
 208     // transparent area
 209     wxMask(const wxBitmap& bitmap, int paletteIndex);
 210
 211     // Construct a mask from a mono bitmap (copies the bitmap).
 212     wxMask(const wxBitmap& bitmap);
 213
 214     // construct a mask from the givne bitmap handle
 215     wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; }
 216
 217     virtual ~wxMask();
 218
 219     bool Create(const wxBitmap& bitmap, const wxColour& colour);
 220     bool Create(const wxBitmap& bitmap, int paletteIndex);
 221     bool Create(const wxBitmap& bitmap);
 222
 223     // Implementation
 224     WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
 225     void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
 226
 227 protected:
 228     WXHBITMAP m_maskBitmap;
 229
 230     DECLARE_DYNAMIC_CLASS(wxMask)
 231 };
 232
 233 // ----------------------------------------------------------------------------
 234 // wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
 235 // ----------------------------------------------------------------------------
 236
 237 class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
 238 {
 239 public:
 240     wxBitmapHandler() { }
 241     wxBitmapHandler(const wxString& name, const wxString& ext, long type)
 242         : wxGDIImageHandler(name, ext, type)
 243     {
 244     }
 245
 246     // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
 247     // old class which worked only with bitmaps
 248     virtual bool Create(wxBitmap *bitmap,
 249                         const void* data,
 250                         long flags,
 251                         int width, int height, int depth = 1);
 252     virtual bool LoadFile(wxBitmap *bitmap,
 253                           const wxString& name,
 254                           long flags,
 255                           int desiredWidth, int desiredHeight);
 256     virtual bool SaveFile(wxBitmap *bitmap,
 257                           const wxString& name,
 258                           int type,
 259                           const wxPalette *palette = NULL);
 260
 261     virtual bool Create(wxGDIImage *image,
 262                         const void* data,
 263                         long flags,
 264                         int width, int height, int depth = 1);
 265     virtual bool Load(wxGDIImage *image,
 266                       const wxString& name,
 267                       long flags,
 268                       int desiredWidth, int desiredHeight);
 269     virtual bool Save(wxGDIImage *image,
 270                       const wxString& name,
 271                       int type);
 272
 273 private:
 274     DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 275 };
 276
 277 #endif
 278   // _WX_BITMAP_H_