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 wxDC;
  24 class WXDLLEXPORT wxControl;
  25 class WXDLLEXPORT wxBitmap;
  26 class WXDLLEXPORT wxBitmapHandler;
  27 class WXDLLEXPORT wxIcon;
  28 class WXDLLEXPORT wxMask;
  29 class WXDLLEXPORT wxCursor;
  30 class WXDLLEXPORT wxControl;
  31
  32 // ----------------------------------------------------------------------------
  33 // Bitmap data
  34 //
  35 // NB: this class is private, but declared here to make it possible inline
  36 //     wxBitmap functions accessing it
  37 // ----------------------------------------------------------------------------
  38
  39 class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
  40 {
  41 public:
  42     wxBitmapRefData();
  43     virtual ~wxBitmapRefData() { Free(); }
  44
  45     virtual void Free();
  46
  47 public:
  48     int           m_numColors;
  49     wxPalette     m_bitmapPalette;
  50     int           m_quality;
  51
  52     // MSW-specific
  53     // ------------
  54
  55     // this field is solely for error checking: we detect selecting a bitmap
  56     // into more than one DC at once or deleting a bitmap still selected into a
  57     // DC (both are serious programming errors under Windows)
  58     wxDC         *m_selectedInto;
  59
  60     // optional mask for transparent drawing
  61     wxMask       *m_bitmapMask;
  62 };
  63
  64 // ----------------------------------------------------------------------------
  65 // wxBitmap: a mono or colour bitmap
  66 // ----------------------------------------------------------------------------
  67
  68 class WXDLLEXPORT wxBitmap : public wxGDIImage
  69 {
  70 public:
  71     // default ctor creates an invalid bitmap, you must Create() it later
  72     wxBitmap() { Init(); }
  73
  74     // Copy constructors
  75     wxBitmap(const wxBitmap& bitmap) { Init(); Ref(bitmap); }
  76
  77     // Initialize with raw data
  78     wxBitmap(const char bits[], int width, int height, int depth = 1);
  79
  80     // Initialize with XPM data
  81     wxBitmap(char **data, wxControl *anItem = NULL);
  82
  83     // Load a file or resource
  84     wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
  85
  86     // New constructor for generalised creation from data
  87     wxBitmap(void *data, long type, int width, int height, int depth = 1);
  88
  89     // If depth is omitted, will create a bitmap compatible with the display
  90     wxBitmap(int width, int height, int depth = -1);
  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) { Init(); CopyFromIcon(icon); }
  95
  96     wxBitmap& operator=(const wxBitmap& bitmap)
  97     {
  98         if ( m_refData != bitmap.m_refData )
  99             Ref(bitmap);
 100         return *this;
 101     }
 102
 103     wxBitmap& operator=(const wxIcon& icon)
 104     {
 105         (void)CopyFromIcon(icon);
 106
 107         return *this;
 108     }
 109
 110     wxBitmap& operator=(const wxCursor& cursor)
 111     {
 112         (void)CopyFromCursor(cursor);
 113
 114         return *this;
 115     }
 116
 117     virtual ~wxBitmap();
 118
 119     // copies the contents and mask of the given (colour) icon to the bitmap
 120     bool CopyFromIcon(const wxIcon& icon);
 121
 122     // copies the contents and mask of the given cursor to the bitmap
 123     bool CopyFromCursor(const wxCursor& cursor);
 124
 125     virtual bool Create(int width, int height, int depth = -1);
 126     virtual bool Create(void *data, long type, int width, int height, int depth = 1);
 127     virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
 128     virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
 129
 130     wxBitmapRefData *GetBitmapData() const { return (wxBitmapRefData *)m_refData; }
 131
 132     int GetQuality() const { return (GetBitmapData() ? GetBitmapData()->m_quality : 0); }
 133     void SetQuality(int q);
 134
 135     wxPalette* GetPalette() const { return (GetBitmapData() ? (& GetBitmapData()->m_bitmapPalette) : (wxPalette*) NULL); }
 136     void SetPalette(const wxPalette& palette);
 137
 138     wxMask *GetMask() const { return (GetBitmapData() ? GetBitmapData()->m_bitmapMask : (wxMask*) NULL); }
 139     void SetMask(wxMask *mask) ;
 140
 141     bool operator==(const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; }
 142     bool operator!=(const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; }
 143
 144 #if WXWIN_COMPATIBILITY_2
 145     void SetOk(bool isOk);
 146 #endif // WXWIN_COMPATIBILITY_2
 147
 148 #if WXWIN_COMPATIBILITY
 149     wxPalette *GetColourMap() const { return GetPalette(); }
 150     void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
 151 #endif // WXWIN_COMPATIBILITY
 152
 153     // Implementation
 154 public:
 155     void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
 156     WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
 157
 158     void SetSelectedInto(wxDC *dc) { if (GetBitmapData()) GetBitmapData()->m_selectedInto = dc; }
 159     wxDC *GetSelectedInto() const { return (GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC*) NULL); }
 160
 161     // Creates a bitmap that matches the device context's depth, from an
 162     // arbitray bitmap. At present, the original bitmap must have an associated
 163     // palette. (TODO: use a default palette if no palette exists.) This
 164     // function is necessary for you to Blit an arbitrary bitmap (which may
 165     // have the wrong depth). wxDC::SelectObject will compare the depth of the
 166     // bitmap with the DC's depth, and create a new bitmap if the depths
 167     // differ. Eventually we should perhaps make this a public API function so
 168     // that an app can efficiently produce bitmaps of the correct depth. The
 169     // Windows solution is to use SetDibBits to blit an arbotrary DIB directly
 170     // to a DC, but this is too Windows-specific, hence this solution of
 171     // quietly converting the wxBitmap. Contributed by Frederic Villeneuve
 172     // <frederic.villeneuve@natinst.com>
 173     wxBitmap GetBitmapForDC(wxDC& dc) const;
 174
 175 protected:
 176     // common part of all ctors
 177     void Init();
 178
 179     virtual wxGDIImageRefData *CreateData() const
 180         { return new wxBitmapRefData; }
 181
 182 private:
 183 #ifdef __WIN32__
 184     // common part of CopyFromIcon/CopyFromCursor for Win32
 185     bool CopyFromIconOrCursor(const wxGDIImage& icon);
 186 #endif // __WIN32__
 187
 188     DECLARE_DYNAMIC_CLASS(wxBitmap)
 189 };
 190
 191 // ----------------------------------------------------------------------------
 192 // wxMask: a mono bitmap used for drawing bitmaps transparently.
 193 // ----------------------------------------------------------------------------
 194
 195 class WXDLLEXPORT wxMask : public wxObject
 196 {
 197 public:
 198     wxMask();
 199
 200     // Construct a mask from a bitmap and a colour indicating the transparent
 201     // area
 202     wxMask(const wxBitmap& bitmap, const wxColour& colour);
 203
 204     // Construct a mask from a bitmap and a palette index indicating the
 205     // transparent area
 206     wxMask(const wxBitmap& bitmap, int paletteIndex);
 207
 208     // Construct a mask from a mono bitmap (copies the bitmap).
 209     wxMask(const wxBitmap& bitmap);
 210
 211     // construct a mask from the givne bitmap handle
 212     wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; }
 213
 214     virtual ~wxMask();
 215
 216     bool Create(const wxBitmap& bitmap, const wxColour& colour);
 217     bool Create(const wxBitmap& bitmap, int paletteIndex);
 218     bool Create(const wxBitmap& bitmap);
 219
 220     // Implementation
 221     WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
 222     void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
 223
 224 protected:
 225     WXHBITMAP m_maskBitmap;
 226
 227     DECLARE_DYNAMIC_CLASS(wxMask)
 228 };
 229
 230 // ----------------------------------------------------------------------------
 231 // wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
 232 // ----------------------------------------------------------------------------
 233
 234 class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
 235 {
 236 public:
 237     wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
 238     wxBitmapHandler(const wxString& name, const wxString& ext, long type)
 239         : wxGDIImageHandler(name, ext, type)
 240     {
 241     }
 242
 243     // keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
 244     // old class which worked only with bitmaps
 245     virtual bool Create(wxBitmap *bitmap,
 246                         void *data,
 247                         long flags,
 248                         int width, int height, int depth = 1);
 249     virtual bool LoadFile(wxBitmap *bitmap,
 250                           const wxString& name,
 251                           long flags,
 252                           int desiredWidth, int desiredHeight);
 253     virtual bool SaveFile(wxBitmap *bitmap,
 254                           const wxString& name,
 255                           int type,
 256                           const wxPalette *palette = NULL);
 257
 258     virtual bool Create(wxGDIImage *image,
 259                         void *data,
 260                         long flags,
 261                         int width, int height, int depth = 1);
 262     virtual bool Load(wxGDIImage *image,
 263                       const wxString& name,
 264                       long flags,
 265                       int desiredWidth, int desiredHeight);
 266     virtual bool Save(wxGDIImage *image,
 267                       const wxString& name,
 268                       int type);
 269
 270 private:
 271     DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
 272 };
 273
 274 #endif
 275   // _WX_BITMAP_H_