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