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