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