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