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