src/msw/bitmap.cpp

   1 ////////////////////////////////////////////////////////////////////////////
   2 // Name:        bitmap.cpp
   3 // Purpose:     wxBitmap
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "bitmap.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include <stdio.h>
  33
  34     #include "wx/list.h"
  35     #include "wx/utils.h"
  36     #include "wx/app.h"
  37     #include "wx/palette.h"
  38     #include "wx/dcmemory.h"
  39     #include "wx/bitmap.h"
  40     #include "wx/icon.h"
  41 #endif
  42
  43 #include "wx/msw/private.h"
  44 #include "wx/log.h"
  45
  46 #if wxUSE_WXDIB
  47 #include "wx/msw/dib.h"
  48 #endif
  49
  50 #include "wx/image.h"
  51 #include "wx/xpmdecod.h"
  52
  53 #ifdef wxHAVE_RAW_BITMAP
  54 #include "wx/rawbmp.h"
  55 #endif
  56
  57 // missing from mingw32 header
  58 #ifndef CLR_INVALID
  59     #define CLR_INVALID ((COLORREF)-1)
  60 #endif // no CLR_INVALID
  61
  62 // ----------------------------------------------------------------------------
  63 // Bitmap data
  64 // ----------------------------------------------------------------------------
  65
  66 class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
  67 {
  68 public:
  69     wxBitmapRefData();
  70     wxBitmapRefData(const wxBitmapRefData& data);
  71     virtual ~wxBitmapRefData() { Free(); }
  72
  73     virtual void Free();
  74
  75     // set the mask object to use as the mask, we take ownership of it
  76     void SetMask(wxMask *mask)
  77     {
  78         delete m_bitmapMask;
  79         m_bitmapMask = mask;
  80     }
  81
  82     // set the HBITMAP to use as the mask
  83     void SetMask(HBITMAP hbmpMask)
  84     {
  85         SetMask(new wxMask((WXHBITMAP)hbmpMask));
  86     }
  87
  88     // return the mask
  89     wxMask *GetMask() const { return m_bitmapMask; }
  90
  91 public:
  92 #if wxUSE_PALETTE
  93     wxPalette     m_bitmapPalette;
  94 #endif // wxUSE_PALETTE
  95
  96     // MSW-specific
  97     // ------------
  98
  99 #ifdef __WXDEBUG__
 100     // this field is solely for error checking: we detect selecting a bitmap
 101     // into more than one DC at once or deleting a bitmap still selected into a
 102     // DC (both are serious programming errors under Windows)
 103     wxDC         *m_selectedInto;
 104 #endif // __WXDEBUG__
 105
 106 #if wxUSE_WXDIB
 107     // when GetRawData() is called for a DDB we need to convert it to a DIB
 108     // first to be able to provide direct access to it and we cache that DIB
 109     // here and convert it back to DDB when UngetRawData() is called
 110     wxDIB *m_dib;
 111 #endif
 112
 113     // true if we have alpha transparency info and can be drawn using
 114     // AlphaBlend()
 115     bool m_hasAlpha;
 116
 117     // true if our HBITMAP is a DIB section, false if it is a DDB
 118     bool m_isDIB;
 119
 120 private:
 121     // optional mask for transparent drawing
 122     wxMask       *m_bitmapMask;
 123
 124
 125     // not implemented
 126     wxBitmapRefData& operator=(const wxBitmapRefData&);
 127 };
 128
 129 // ----------------------------------------------------------------------------
 130 // macros
 131 // ----------------------------------------------------------------------------
 132
 133 IMPLEMENT_DYNAMIC_CLASS(wxBitmap, wxGDIObject)
 134 IMPLEMENT_DYNAMIC_CLASS(wxMask, wxObject)
 135
 136 IMPLEMENT_DYNAMIC_CLASS(wxBitmapHandler, wxObject)
 137
 138 // ============================================================================
 139 // implementation
 140 // ============================================================================
 141
 142 // ----------------------------------------------------------------------------
 143 // helper functions
 144 // ----------------------------------------------------------------------------
 145
 146 // decide whether we should create a DIB or a DDB for the given parameters
 147 //
 148 // NB: we always use DIBs under Windows CE as this is much simpler (even if
 149 //     also less efficient...) and we obviously can't use them if there is no
 150 //     DIB support compiled in at all
 151 #ifdef __WXWINCE__
 152     static inline bool wxShouldCreateDIB(int, int, int, WXHDC) { return true; }
 153
 154     #define ALWAYS_USE_DIB
 155 #elif !wxUSE_WXDIB
 156     // no sense in defining wxShouldCreateDIB() as we can't compile code
 157     // executed if it is true, so we have to use #if's anyhow
 158     #define NEVER_USE_DIB
 159 #else // wxUSE_WXDIB && !__WXWINCE__
 160     static inline bool wxShouldCreateDIB(int w, int h, int d, WXHDC hdc)
 161     {
 162         // here is the logic:
 163         //
 164         //  (a) if hdc is specified, the caller explicitly wants DDB
 165         //  (b) otherwise, create a DIB if depth >= 24 (we don't support 16bpp
 166         //      or less DIBs anyhow)
 167         //  (c) finally, create DIBs under Win9x even if the depth hasn't been
 168         //      explicitly specified but the current display depth is 24 or
 169         //      more and the image is "big", i.e. > 16Mb which is the
 170         //      theoretical limit for DDBs under Win9x
 171         //
 172         // consequences (all of which seem to make sense):
 173         //
 174         //  (i)     by default, DDBs are created (depth == -1 usually)
 175         //  (ii)    DIBs can be created by explicitly specifying the depth
 176         //  (iii)   using a DC always forces creating a DDB
 177         return !hdc &&
 178                 (d >= 24 ||
 179                     (d == -1 &&
 180                         wxDIB::GetLineSize(w, wxDisplayDepth())*h > 16*1024*1024));
 181     }
 182
 183     #define SOMETIMES_USE_DIB
 184 #endif // different DIB usage scenarious
 185
 186 // ----------------------------------------------------------------------------
 187 // wxBitmapRefData
 188 // ----------------------------------------------------------------------------
 189
 190 wxBitmapRefData::wxBitmapRefData()
 191 {
 192 #ifdef __WXDEBUG__
 193     m_selectedInto = NULL;
 194 #endif
 195     m_bitmapMask = NULL;
 196
 197     m_hBitmap = (WXHBITMAP) NULL;
 198 #if wxUSE_WXDIB
 199     m_dib = NULL;
 200 #endif
 201
 202     m_isDIB =
 203     m_hasAlpha = false;
 204 }
 205
 206 wxBitmapRefData::wxBitmapRefData(const wxBitmapRefData& data)
 207                : wxGDIImageRefData(data)
 208 {
 209 #ifdef __WXDEBUG__
 210     m_selectedInto = NULL;
 211 #endif
 212
 213     // can't copy the mask as the other bitmap destroys it
 214     m_bitmapMask = NULL;
 215
 216     wxASSERT_MSG( !data.m_isDIB,
 217                     _T("can't copy bitmap locked for raw access!") );
 218     m_isDIB = false;
 219
 220     m_hasAlpha = data.m_hasAlpha;
 221 }
 222
 223 void wxBitmapRefData::Free()
 224 {
 225     wxASSERT_MSG( !m_selectedInto,
 226                   wxT("deleting bitmap still selected into wxMemoryDC") );
 227
 228 #if wxUSE_WXDIB
 229     wxASSERT_MSG( !m_dib, _T("forgot to call wxBitmap::UngetRawData()!") );
 230 #endif
 231
 232     if ( m_hBitmap)
 233     {
 234         if ( !::DeleteObject((HBITMAP)m_hBitmap) )
 235         {
 236             wxLogLastError(wxT("DeleteObject(hbitmap)"));
 237         }
 238     }
 239
 240     delete m_bitmapMask;
 241     m_bitmapMask = NULL;
 242 }
 243
 244 // ----------------------------------------------------------------------------
 245 // wxBitmap creation
 246 // ----------------------------------------------------------------------------
 247
 248 // this function should be called from all wxBitmap ctors
 249 void wxBitmap::Init()
 250 {
 251     // m_refData = NULL; done in the base class ctor
 252 }
 253
 254 wxGDIImageRefData *wxBitmap::CreateData() const
 255 {
 256     return new wxBitmapRefData;
 257 }
 258
 259 wxObjectRefData *wxBitmap::CloneRefData(const wxObjectRefData *dataOrig) const
 260 {
 261     const wxBitmapRefData *
 262         data = wx_static_cast(const wxBitmapRefData *, dataOrig);
 263     if ( !data )
 264         return NULL;
 265
 266     wxBitmap *self = wx_const_cast(wxBitmap *, this);
 267
 268 #if wxUSE_WXDIB
 269     // copy the other bitmap
 270     if ( data->m_hBitmap )
 271     {
 272         wxDIB dib((HBITMAP)(data->m_hBitmap));
 273         self->CopyFromDIB(dib);
 274     }
 275     else
 276 #endif // wxUSE_WXDIB
 277     {
 278         // don't copy the bitmap data, but do copy the size, depth, ...
 279         self->m_refData = new wxBitmapRefData(*data);
 280     }
 281
 282     return m_refData;
 283 }
 284
 285 #ifdef __WIN32__
 286
 287 bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon)
 288 {
 289 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 290     // it may be either HICON or HCURSOR
 291     HICON hicon = (HICON)icon.GetHandle();
 292
 293     ICONINFO iconInfo;
 294     if ( !::GetIconInfo(hicon, &iconInfo) )
 295     {
 296         wxLogLastError(wxT("GetIconInfo"));
 297
 298         return false;
 299     }
 300
 301     wxBitmapRefData *refData = new wxBitmapRefData;
 302     m_refData = refData;
 303
 304     int w = icon.GetWidth(),
 305         h = icon.GetHeight();
 306
 307     refData->m_width = w;
 308     refData->m_height = h;
 309     refData->m_depth = wxDisplayDepth();
 310
 311     refData->m_hBitmap = (WXHBITMAP)iconInfo.hbmColor;
 312
 313     // the mask returned by GetIconInfo() is inversed compared to the usual
 314     // wxWin convention
 315     refData->SetMask(wxInvertMask(iconInfo.hbmMask, w, h));
 316
 317
 318     // delete the old one now as we don't need it any more
 319     ::DeleteObject(iconInfo.hbmMask);
 320
 321     return true;
 322 #else
 323     wxUnusedVar(icon);
 324     return false;
 325 #endif
 326 }
 327
 328 #endif // Win32
 329
 330 bool wxBitmap::CopyFromCursor(const wxCursor& cursor)
 331 {
 332     UnRef();
 333
 334     if ( !cursor.Ok() )
 335         return false;
 336
 337     return CopyFromIconOrCursor(cursor);
 338 }
 339
 340 bool wxBitmap::CopyFromIcon(const wxIcon& icon)
 341 {
 342     UnRef();
 343
 344     if ( !icon.Ok() )
 345         return false;
 346
 347     return CopyFromIconOrCursor(icon);
 348 }
 349
 350 #ifndef NEVER_USE_DIB
 351
 352 bool wxBitmap::CopyFromDIB(const wxDIB& dib)
 353 {
 354     wxCHECK_MSG( dib.IsOk(), false, _T("invalid DIB in CopyFromDIB") );
 355
 356 #ifdef SOMETIMES_USE_DIB
 357     HBITMAP hbitmap = dib.CreateDDB();
 358     if ( !hbitmap )
 359         return false;
 360 #else // ALWAYS_USE_DIB
 361     HBITMAP hbitmap = ((wxDIB &)dib).Detach();  // const_cast
 362 #endif // SOMETIMES_USE_DIB/ALWAYS_USE_DIB
 363
 364     UnRef();
 365
 366     wxBitmapRefData *refData = new wxBitmapRefData;
 367     m_refData = refData;
 368
 369     refData->m_width = dib.GetWidth();
 370     refData->m_height = dib.GetHeight();
 371     refData->m_depth = dib.GetDepth();
 372
 373     refData->m_hBitmap = (WXHBITMAP)hbitmap;
 374
 375 #if wxUSE_PALETTE
 376     wxPalette *palette = dib.CreatePalette();
 377     if ( palette )
 378     {
 379         refData->m_bitmapPalette = *palette;
 380     }
 381
 382     delete palette;
 383 #endif // wxUSE_PALETTE
 384
 385     return true;
 386 }
 387
 388 #endif // NEVER_USE_DIB
 389
 390 wxBitmap::~wxBitmap()
 391 {
 392 }
 393
 394 wxBitmap::wxBitmap(const char bits[], int width, int height, int depth)
 395 {
 396     Init();
 397
 398 #ifndef __WXMICROWIN__
 399     wxBitmapRefData *refData = new wxBitmapRefData;
 400     m_refData = refData;
 401
 402     refData->m_width = width;
 403     refData->m_height = height;
 404     refData->m_depth = depth;
 405
 406     char *data;
 407     if ( depth == 1 )
 408     {
 409         // we assume that it is in XBM format which is not quite the same as
 410         // the format CreateBitmap() wants because the order of bytes in the
 411         // line is inversed!
 412         const size_t bytesPerLine = (width + 7) / 8;
 413         const size_t padding = bytesPerLine % 2;
 414         const size_t len = height * ( padding + bytesPerLine );
 415         data = (char *)malloc(len);
 416         const char *src = bits;
 417         char *dst = data;
 418
 419         for ( int rows = 0; rows < height; rows++ )
 420         {
 421             for ( size_t cols = 0; cols < bytesPerLine; cols++ )
 422             {
 423                 unsigned char val = *src++;
 424                 unsigned char reversed = 0;
 425
 426                 for ( int bits = 0; bits < 8; bits++)
 427                 {
 428                     reversed <<= 1;
 429                     reversed |= (unsigned char)(val & 0x01);
 430                     val >>= 1;
 431                 }
 432                 *dst++ = reversed;
 433             }
 434
 435             if ( padding )
 436                 *dst++ = 0;
 437         }
 438     }
 439     else
 440     {
 441         // bits should already be in Windows standard format
 442         data = (char *)bits;    // const_cast is harmless
 443     }
 444
 445     HBITMAP hbmp = ::CreateBitmap(width, height, 1, depth, data);
 446     if ( !hbmp )
 447     {
 448         wxLogLastError(wxT("CreateBitmap"));
 449     }
 450
 451     if ( data != bits )
 452     {
 453         free(data);
 454     }
 455
 456     SetHBITMAP((WXHBITMAP)hbmp);
 457 #endif
 458 }
 459
 460 // Create from XPM data
 461 bool wxBitmap::CreateFromXpm(const char **data)
 462 {
 463 #if wxUSE_IMAGE && wxUSE_XPM
 464     Init();
 465
 466     wxCHECK_MSG( data != NULL, false, wxT("invalid bitmap data") )
 467
 468     wxXPMDecoder decoder;
 469     wxImage img = decoder.ReadData(data);
 470     wxCHECK_MSG( img.Ok(), false, wxT("invalid bitmap data") )
 471
 472     *this = wxBitmap(img);
 473     return true;
 474 #else
 475     wxUnusedVar(data);
 476     return false;
 477 #endif
 478 }
 479
 480 wxBitmap::wxBitmap(int w, int h, int d)
 481 {
 482     Init();
 483
 484     (void)Create(w, h, d);
 485 }
 486
 487 wxBitmap::wxBitmap(int w, int h, const wxDC& dc)
 488 {
 489     Init();
 490
 491     (void)Create(w, h, dc);
 492 }
 493
 494 wxBitmap::wxBitmap(void *data, long type, int width, int height, int depth)
 495 {
 496     Init();
 497
 498     (void)Create(data, type, width, height, depth);
 499 }
 500
 501 wxBitmap::wxBitmap(const wxString& filename, wxBitmapType type)
 502 {
 503     Init();
 504
 505     LoadFile(filename, (int)type);
 506 }
 507
 508 bool wxBitmap::Create(int width, int height, int depth)
 509 {
 510     return DoCreate(width, height, depth, 0);
 511 }
 512
 513 bool wxBitmap::Create(int width, int height, const wxDC& dc)
 514 {
 515     wxCHECK_MSG( dc.Ok(), false, _T("invalid HDC in wxBitmap::Create()") );
 516
 517     return DoCreate(width, height, -1, dc.GetHDC());
 518 }
 519
 520 bool wxBitmap::DoCreate(int w, int h, int d, WXHDC hdc)
 521 {
 522     UnRef();
 523
 524     m_refData = new wxBitmapRefData;
 525
 526     GetBitmapData()->m_width = w;
 527     GetBitmapData()->m_height = h;
 528
 529     HBITMAP hbmp    wxDUMMY_INITIALIZE(0);
 530
 531 #ifndef NEVER_USE_DIB
 532     if ( wxShouldCreateDIB(w, h, d, hdc) )
 533     {
 534         if ( d == -1 )
 535         {
 536             // create DIBs without alpha channel by default
 537             d = 24;
 538         }
 539
 540         wxDIB dib(w, h, d);
 541         if ( !dib.IsOk() )
 542            return false;
 543
 544         // don't delete the DIB section in dib object dtor
 545         hbmp = dib.Detach();
 546
 547         GetBitmapData()->m_isDIB = true;
 548         GetBitmapData()->m_depth = d;
 549     }
 550     else // create a DDB
 551 #endif // NEVER_USE_DIB
 552     {
 553 #ifndef ALWAYS_USE_DIB
 554 #ifndef __WXMICROWIN__
 555         if ( d > 0 )
 556         {
 557             hbmp = ::CreateBitmap(w, h, 1, d, NULL);
 558             if ( !hbmp )
 559             {
 560                 wxLogLastError(wxT("CreateBitmap"));
 561             }
 562
 563             GetBitmapData()->m_depth = d;
 564         }
 565         else // d == 0, create bitmap compatible with the screen
 566 #endif // !__WXMICROWIN__
 567         {
 568             ScreenHDC dc;
 569             hbmp = ::CreateCompatibleBitmap(dc, w, h);
 570             if ( !hbmp )
 571             {
 572                 wxLogLastError(wxT("CreateCompatibleBitmap"));
 573             }
 574
 575             GetBitmapData()->m_depth = wxDisplayDepth();
 576         }
 577 #endif // !ALWAYS_USE_DIB
 578     }
 579
 580     SetHBITMAP((WXHBITMAP)hbmp);
 581
 582     return Ok();
 583 }
 584
 585 #if wxUSE_IMAGE
 586
 587 // ----------------------------------------------------------------------------
 588 // wxImage to/from conversions for Microwin
 589 // ----------------------------------------------------------------------------
 590
 591 // Microwin versions are so different from normal ones that it really doesn't
 592 // make sense to use #ifdefs inside the function bodies
 593 #ifdef __WXMICROWIN__
 594
 595 bool wxBitmap::CreateFromImage(const wxImage& image, int depth, const wxDC& dc)
 596 {
 597     // Set this to 1 to experiment with mask code,
 598     // which currently doesn't work
 599     #define USE_MASKS 0
 600
 601     m_refData = new wxBitmapRefData();
 602
 603     // Initial attempt at a simple-minded implementation.
 604     // The bitmap will always be created at the screen depth,
 605     // so the 'depth' argument is ignored.
 606
 607     HDC hScreenDC = ::GetDC(NULL);
 608     int screenDepth = ::GetDeviceCaps(hScreenDC, BITSPIXEL);
 609
 610     HBITMAP hBitmap = ::CreateCompatibleBitmap(hScreenDC, image.GetWidth(), image.GetHeight());
 611     HBITMAP hMaskBitmap = NULL;
 612     HBITMAP hOldMaskBitmap = NULL;
 613     HDC hMaskDC = NULL;
 614     unsigned char maskR = 0;
 615     unsigned char maskG = 0;
 616     unsigned char maskB = 0;
 617
 618     //    printf("Created bitmap %d\n", (int) hBitmap);
 619     if (hBitmap == NULL)
 620     {
 621         ::ReleaseDC(NULL, hScreenDC);
 622         return false;
 623     }
 624     HDC hMemDC = ::CreateCompatibleDC(hScreenDC);
 625
 626     HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap);
 627     ::ReleaseDC(NULL, hScreenDC);
 628
 629     // created an mono-bitmap for the possible mask
 630     bool hasMask = image.HasMask();
 631
 632     if ( hasMask )
 633     {
 634 #if USE_MASKS
 635         // FIXME: we should be able to pass bpp = 1, but
 636         // GdBlit can't handle a different depth
 637 #if 0
 638         hMaskBitmap = ::CreateBitmap( (WORD)image.GetWidth(), (WORD)image.GetHeight(), 1, 1, NULL );
 639 #else
 640         hMaskBitmap = ::CreateCompatibleBitmap( hMemDC, (WORD)image.GetWidth(), (WORD)image.GetHeight());
 641 #endif
 642         maskR = image.GetMaskRed();
 643         maskG = image.GetMaskGreen();
 644         maskB = image.GetMaskBlue();
 645
 646         if (!hMaskBitmap)
 647         {
 648             hasMask = false;
 649         }
 650         else
 651         {
 652             hScreenDC = ::GetDC(NULL);
 653             hMaskDC = ::CreateCompatibleDC(hScreenDC);
 654            ::ReleaseDC(NULL, hScreenDC);
 655
 656             hOldMaskBitmap = ::SelectObject( hMaskDC, hMaskBitmap);
 657         }
 658 #else
 659         hasMask = false;
 660 #endif
 661     }
 662
 663     int i, j;
 664     for (i = 0; i < image.GetWidth(); i++)
 665     {
 666         for (j = 0; j < image.GetHeight(); j++)
 667         {
 668             unsigned char red = image.GetRed(i, j);
 669             unsigned char green = image.GetGreen(i, j);
 670             unsigned char blue = image.GetBlue(i, j);
 671
 672             ::SetPixel(hMemDC, i, j, PALETTERGB(red, green, blue));
 673
 674             if (hasMask)
 675             {
 676                 // scan the bitmap for the transparent colour and set the corresponding
 677                 // pixels in the mask to BLACK and the rest to WHITE
 678                 if (maskR == red && maskG == green && maskB == blue)
 679                     ::SetPixel(hMaskDC, i, j, PALETTERGB(0, 0, 0));
 680                 else
 681                     ::SetPixel(hMaskDC, i, j, PALETTERGB(255, 255, 255));
 682             }
 683         }
 684     }
 685
 686     ::SelectObject(hMemDC, hOldBitmap);
 687     ::DeleteDC(hMemDC);
 688     if (hasMask)
 689     {
 690         ::SelectObject(hMaskDC, hOldMaskBitmap);
 691         ::DeleteDC(hMaskDC);
 692
 693         ((wxBitmapRefData*)m_refData)->SetMask(hMaskBitmap);
 694     }
 695
 696     SetWidth(image.GetWidth());
 697     SetHeight(image.GetHeight());
 698     SetDepth(screenDepth);
 699     SetHBITMAP( (WXHBITMAP) hBitmap );
 700
 701 #if wxUSE_PALETTE
 702     // Copy the palette from the source image
 703     SetPalette(image.GetPalette());
 704 #endif // wxUSE_PALETTE
 705
 706     return true;
 707 }
 708
 709 wxImage wxBitmap::ConvertToImage() const
 710 {
 711     // Initial attempt at a simple-minded implementation.
 712     // The bitmap will always be created at the screen depth,
 713     // so the 'depth' argument is ignored.
 714     // TODO: transparency (create a mask image)
 715
 716     if (!Ok())
 717     {
 718         wxFAIL_MSG( wxT("bitmap is invalid") );
 719         return wxNullImage;
 720     }
 721
 722     wxImage image;
 723
 724     wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") );
 725
 726     // create an wxImage object
 727     int width = GetWidth();
 728     int height = GetHeight();
 729     image.Create( width, height );
 730     unsigned char *data = image.GetData();
 731     if( !data )
 732     {
 733         wxFAIL_MSG( wxT("could not allocate data for image") );
 734         return wxNullImage;
 735     }
 736
 737     HDC hScreenDC = ::GetDC(NULL);
 738
 739     HDC hMemDC = ::CreateCompatibleDC(hScreenDC);
 740     ::ReleaseDC(NULL, hScreenDC);
 741
 742     HBITMAP hBitmap = (HBITMAP) GetHBITMAP();
 743
 744     HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap);
 745
 746     int i, j;
 747     for (i = 0; i < GetWidth(); i++)
 748     {
 749         for (j = 0; j < GetHeight(); j++)
 750         {
 751             COLORREF color = ::GetPixel(hMemDC, i, j);
 752             unsigned char red = GetRValue(color);
 753             unsigned char green = GetGValue(color);
 754             unsigned char blue = GetBValue(color);
 755
 756             image.SetRGB(i, j, red, green, blue);
 757         }
 758     }
 759
 760     ::SelectObject(hMemDC, hOldBitmap);
 761     ::DeleteDC(hMemDC);
 762
 763 #if wxUSE_PALETTE
 764     // Copy the palette from the source image
 765     if (GetPalette())
 766         image.SetPalette(* GetPalette());
 767 #endif // wxUSE_PALETTE
 768
 769     return image;
 770 }
 771
 772 #endif // __WXMICROWIN__
 773
 774 // ----------------------------------------------------------------------------
 775 // wxImage to/from conversions
 776 // ----------------------------------------------------------------------------
 777
 778 #if wxUSE_WXDIB
 779
 780 bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
 781 {
 782     return CreateFromImage(image, depth, 0);
 783 }
 784
 785 bool wxBitmap::CreateFromImage(const wxImage& image, const wxDC& dc)
 786 {
 787     wxCHECK_MSG( dc.Ok(), false,
 788                     _T("invalid HDC in wxBitmap::CreateFromImage()") );
 789
 790     return CreateFromImage(image, -1, dc.GetHDC());
 791 }
 792
 793 bool wxBitmap::CreateFromImage(const wxImage& image, int depth, WXHDC hdc)
 794 {
 795     wxCHECK_MSG( image.Ok(), false, wxT("invalid image") );
 796
 797     UnRef();
 798
 799     // first convert the image to DIB
 800     const int h = image.GetHeight();
 801     const int w = image.GetWidth();
 802
 803     wxDIB dib(image);
 804     if ( !dib.IsOk() )
 805         return false;
 806
 807
 808     // store the bitmap parameters
 809     wxBitmapRefData *refData = new wxBitmapRefData;
 810     refData->m_width = w;
 811     refData->m_height = h;
 812     refData->m_hasAlpha = image.HasAlpha();
 813
 814     m_refData = refData;
 815
 816
 817     // next either store DIB as is or create a DDB from it
 818     HBITMAP hbitmap     wxDUMMY_INITIALIZE(0);
 819
 820     // are we going to use DIB?
 821     //
 822     // NB: DDBs don't support alpha so if we have alpha channel we must use DIB
 823     if ( image.HasAlpha() || wxShouldCreateDIB(w, h, depth, hdc) )
 824     {
 825         // don't delete the DIB section in dib object dtor
 826         hbitmap = dib.Detach();
 827
 828         refData->m_isDIB = true;
 829         refData->m_depth = dib.GetDepth();
 830     }
 831 #ifndef ALWAYS_USE_DIB
 832     else // we need to convert DIB to DDB
 833     {
 834         hbitmap = dib.CreateDDB((HDC)hdc);
 835
 836         refData->m_depth = depth == -1 ? dib.GetDepth() : depth;
 837     }
 838 #endif // !ALWAYS_USE_DIB
 839
 840     // validate this object
 841     SetHBITMAP((WXHBITMAP)hbitmap);
 842
 843     // finally also set the mask if we have one
 844     if ( image.HasMask() )
 845     {
 846         SetMask(new wxMask(*this, wxColour(image.GetMaskRed(),
 847                                            image.GetMaskGreen(),
 848                                            image.GetMaskBlue())));
 849     }
 850
 851     return true;
 852 }
 853
 854 wxImage wxBitmap::ConvertToImage() const
 855 {
 856     // convert DDB to DIB
 857     wxDIB dib(*this);
 858
 859     if ( !dib.IsOk() )
 860     {
 861         return wxNullImage;
 862     }
 863
 864     // and then DIB to our wxImage
 865     wxImage image = dib.ConvertToImage();
 866     if ( !image.Ok() )
 867     {
 868         return wxNullImage;
 869     }
 870
 871     // now do the same for the mask, if we have any
 872     HBITMAP hbmpMask = GetMask() ? (HBITMAP) GetMask()->GetMaskBitmap() : NULL;
 873     if ( hbmpMask )
 874     {
 875         wxDIB dibMask(hbmpMask);
 876         if ( dibMask.IsOk() )
 877         {
 878             // TODO: use wxRawBitmap to iterate over DIB
 879
 880             // we hard code the mask colour for now but we could also make an
 881             // effort (and waste time) to choose a colour not present in the
 882             // image already to avoid having to fudge the pixels below --
 883             // whether it's worth to do it is unclear however
 884             static const int MASK_RED = 1;
 885             static const int MASK_GREEN = 2;
 886             static const int MASK_BLUE = 3;
 887             static const int MASK_BLUE_REPLACEMENT = 2;
 888
 889             const int h = dibMask.GetHeight();
 890             const int w = dibMask.GetWidth();
 891             const int bpp = dibMask.GetDepth();
 892             const int maskBytesPerPixel = bpp >> 3;
 893             const int maskBytesPerLine = wxDIB::GetLineSize(w, bpp);
 894             unsigned char *data = image.GetData();
 895
 896             // remember that DIBs are stored in bottom to top order
 897             unsigned char *
 898                 maskLineStart = dibMask.GetData() + ((h - 1) * maskBytesPerLine);
 899
 900             for ( int y = 0; y < h; y++, maskLineStart -= maskBytesPerLine )
 901             {
 902                 // traverse one mask DIB line
 903                 unsigned char *mask = maskLineStart;
 904                 for ( int x = 0; x < w; x++, mask += maskBytesPerPixel )
 905                 {
 906                     // should this pixel be transparent?
 907                     if ( *mask )
 908                     {
 909                         // no, check that it isn't transparent by accident
 910                         if ( (data[0] == MASK_RED) &&
 911                                 (data[1] == MASK_GREEN) &&
 912                                     (data[2] == MASK_BLUE) )
 913                         {
 914                             // we have to fudge the colour a bit to prevent
 915                             // this pixel from appearing transparent
 916                             data[2] = MASK_BLUE_REPLACEMENT;
 917                         }
 918
 919                         data += 3;
 920                     }
 921                     else // yes, transparent pixel
 922                     {
 923                         *data++ = MASK_RED;
 924                         *data++ = MASK_GREEN;
 925                         *data++ = MASK_BLUE;
 926                     }
 927                 }
 928             }
 929
 930             image.SetMaskColour(MASK_RED, MASK_GREEN, MASK_BLUE);
 931         }
 932     }
 933
 934     return image;
 935 }
 936
 937 #endif // wxUSE_WXDIB
 938
 939 #endif // wxUSE_IMAGE
 940
 941 // ----------------------------------------------------------------------------
 942 // loading and saving bitmaps
 943 // ----------------------------------------------------------------------------
 944
 945 bool wxBitmap::LoadFile(const wxString& filename, long type)
 946 {
 947     UnRef();
 948
 949     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
 950
 951     if ( handler )
 952     {
 953         m_refData = new wxBitmapRefData;
 954
 955         return handler->LoadFile(this, filename, type, -1, -1);
 956     }
 957 #if wxUSE_IMAGE
 958     else // no bitmap handler found
 959     {
 960         wxImage image;
 961         if ( image.LoadFile( filename, type ) && image.Ok() )
 962         {
 963             *this = wxBitmap(image);
 964
 965             return true;
 966         }
 967     }
 968 #endif // wxUSE_IMAGE
 969
 970     return false;
 971 }
 972
 973 bool wxBitmap::Create(void *data, long type, int width, int height, int depth)
 974 {
 975     UnRef();
 976
 977     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
 978
 979     if ( !handler )
 980     {
 981         wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %ld defined."), type);
 982
 983         return false;
 984     }
 985
 986     m_refData = new wxBitmapRefData;
 987
 988     return handler->Create(this, data, type, width, height, depth);
 989 }
 990
 991 bool wxBitmap::SaveFile(const wxString& filename,
 992                         int type,
 993                         const wxPalette *palette)
 994 {
 995     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
 996
 997     if ( handler )
 998     {
 999         return handler->SaveFile(this, filename, type, palette);
1000     }
1001 #if wxUSE_IMAGE
1002     else // no bitmap handler found
1003     {
1004         // FIXME what about palette? shouldn't we use it?
1005         wxImage image = ConvertToImage();
1006         if ( image.Ok() )
1007         {
1008             return image.SaveFile(filename, type);
1009         }
1010     }
1011 #endif // wxUSE_IMAGE
1012
1013     return false;
1014 }
1015
1016 // ----------------------------------------------------------------------------
1017 // sub bitmap extraction
1018 // ----------------------------------------------------------------------------
1019
1020 wxBitmap wxBitmap::GetSubBitmap( const wxRect& rect) const
1021 {
1022     wxCHECK_MSG( Ok() &&
1023                  (rect.x >= 0) && (rect.y >= 0) &&
1024                  (rect.x+rect.width <= GetWidth()) &&
1025                  (rect.y+rect.height <= GetHeight()),
1026                  wxNullBitmap, wxT("Invalid bitmap or bitmap region") );
1027
1028     wxBitmap ret( rect.width, rect.height, GetDepth() );
1029     wxASSERT_MSG( ret.Ok(), wxT("GetSubBitmap error") );
1030
1031 #ifndef __WXMICROWIN__
1032     // handle alpha channel, if any
1033     if (HasAlpha())
1034     ret.UseAlpha();
1035
1036     // copy bitmap data
1037     MemoryHDC dcSrc,
1038               dcDst;
1039
1040     {
1041         SelectInHDC selectSrc(dcSrc, GetHbitmap()),
1042                     selectDst(dcDst, GetHbitmapOf(ret));
1043
1044         if ( !selectSrc || !selectDst )
1045         {
1046             wxLogLastError(_T("SelectObjct(hBitmap)"));
1047         }
1048
1049         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
1050                        dcSrc, rect.x, rect.y, SRCCOPY) )
1051         {
1052             wxLogLastError(_T("BitBlt"));
1053         }
1054     }
1055
1056     // copy mask if there is one
1057     if ( GetMask() )
1058     {
1059         HBITMAP hbmpMask = ::CreateBitmap(rect.width, rect.height, 1, 1, 0);
1060
1061         SelectInHDC selectSrc(dcSrc, (HBITMAP) GetMask()->GetMaskBitmap()),
1062                     selectDst(dcDst, hbmpMask);
1063
1064         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
1065                        dcSrc, rect.x, rect.y, SRCCOPY) )
1066         {
1067             wxLogLastError(_T("BitBlt"));
1068         }
1069
1070         wxMask *mask = new wxMask((WXHBITMAP) hbmpMask);
1071         ret.SetMask(mask);
1072     }
1073 #endif // !__WXMICROWIN__
1074
1075     return ret;
1076 }
1077
1078 // ----------------------------------------------------------------------------
1079 // wxBitmap accessors
1080 // ----------------------------------------------------------------------------
1081
1082 #if wxUSE_PALETTE
1083 wxPalette* wxBitmap::GetPalette() const
1084 {
1085     return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette
1086                            : (wxPalette *) NULL;
1087 }
1088 #endif
1089
1090 wxMask *wxBitmap::GetMask() const
1091 {
1092     return GetBitmapData() ? GetBitmapData()->GetMask() : (wxMask *) NULL;
1093 }
1094
1095 #ifdef __WXDEBUG__
1096
1097 wxDC *wxBitmap::GetSelectedInto() const
1098 {
1099     return GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC *) NULL;
1100 }
1101
1102 #endif
1103
1104 #if WXWIN_COMPATIBILITY_2_4
1105
1106 int wxBitmap::GetQuality() const
1107 {
1108     return 0;
1109 }
1110
1111 #endif // WXWIN_COMPATIBILITY_2_4
1112
1113 void wxBitmap::UseAlpha()
1114 {
1115     if ( GetBitmapData() )
1116         GetBitmapData()->m_hasAlpha = true;
1117 }
1118
1119 bool wxBitmap::HasAlpha() const
1120 {
1121     return GetBitmapData() && GetBitmapData()->m_hasAlpha;
1122 }
1123
1124 // ----------------------------------------------------------------------------
1125 // wxBitmap setters
1126 // ----------------------------------------------------------------------------
1127
1128 #ifdef __WXDEBUG__
1129
1130 void wxBitmap::SetSelectedInto(wxDC *dc)
1131 {
1132     if ( GetBitmapData() )
1133         GetBitmapData()->m_selectedInto = dc;
1134 }
1135
1136 #endif
1137
1138 #if wxUSE_PALETTE
1139
1140 void wxBitmap::SetPalette(const wxPalette& palette)
1141 {
1142     AllocExclusive();
1143
1144     GetBitmapData()->m_bitmapPalette = palette;
1145 }
1146
1147 #endif // wxUSE_PALETTE
1148
1149 void wxBitmap::SetMask(wxMask *mask)
1150 {
1151     AllocExclusive();
1152
1153     GetBitmapData()->SetMask(mask);
1154 }
1155
1156 #if WXWIN_COMPATIBILITY_2_4
1157
1158 void wxBitmap::SetQuality(int WXUNUSED(quality))
1159 {
1160 }
1161
1162 #endif // WXWIN_COMPATIBILITY_2_4
1163
1164 // ----------------------------------------------------------------------------
1165 // raw bitmap access support
1166 // ----------------------------------------------------------------------------
1167
1168 #ifdef wxHAVE_RAW_BITMAP
1169 void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
1170 {
1171 #if wxUSE_WXDIB
1172     if ( !Ok() )
1173     {
1174         // no bitmap, no data (raw or otherwise)
1175         return NULL;
1176     }
1177
1178     // if we're already a DIB we can access our data directly, but if not we
1179     // need to convert this DDB to a DIB section and use it for raw access and
1180     // then convert it back
1181     HBITMAP hDIB;
1182     if ( !GetBitmapData()->m_isDIB )
1183     {
1184         wxCHECK_MSG( !GetBitmapData()->m_dib, FALSE,
1185                         _T("GetRawData() may be called only once") );
1186
1187         wxDIB *dib = new wxDIB(*this);
1188         if ( !dib->IsOk() )
1189         {
1190             delete dib;
1191
1192             return NULL;
1193         }
1194
1195         // we'll free it in UngetRawData()
1196         GetBitmapData()->m_dib = dib;
1197
1198         hDIB = dib->GetHandle();
1199     }
1200     else // we're a DIB
1201     {
1202         hDIB = GetHbitmap();
1203     }
1204
1205     DIBSECTION ds;
1206     if ( ::GetObject(hDIB, sizeof(ds), &ds) != sizeof(DIBSECTION) )
1207     {
1208         wxFAIL_MSG( _T("failed to get DIBSECTION from a DIB?") );
1209
1210         return NULL;
1211     }
1212
1213     // check that the bitmap is in correct format
1214     if ( ds.dsBm.bmBitsPixel != bpp )
1215     {
1216         wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
1217
1218         return NULL;
1219     }
1220
1221     // ok, store the relevant info in wxPixelDataBase
1222     const LONG h = ds.dsBm.bmHeight;
1223
1224     data.m_width = ds.dsBm.bmWidth;
1225     data.m_height = h;
1226
1227     // remember that DIBs are stored in top to bottom order!
1228     // (We can't just use ds.dsBm.bmWidthBytes here, because it isn't always a
1229     // multiple of 2, as required by the documentation.  So we use the official
1230     // formula, which we already use elsewhere.)
1231     const LONG bytesPerRow =
1232         wxDIB::GetLineSize(ds.dsBm.bmWidth, ds.dsBm.bmBitsPixel);
1233     data.m_stride = -bytesPerRow;
1234
1235     char *bits = (char *)ds.dsBm.bmBits;
1236     if ( h > 1 )
1237     {
1238         bits += (h - 1)*bytesPerRow;
1239     }
1240
1241     return bits;
1242 #else
1243     return NULL;
1244 #endif
1245 }
1246
1247 void wxBitmap::UngetRawData(wxPixelDataBase& dataBase)
1248 {
1249 #if wxUSE_WXDIB
1250     if ( !Ok() )
1251         return;
1252
1253     if ( !&dataBase )
1254     {
1255         // invalid data, don't crash -- but don't assert neither as we're
1256         // called automatically from wxPixelDataBase dtor and so there is no
1257         // way to prevent this from happening
1258         return;
1259     }
1260
1261     // if we're a DDB we need to convert DIB back to DDB now to make the
1262     // changes made via raw bitmap access effective
1263     if ( !GetBitmapData()->m_isDIB )
1264     {
1265         wxDIB *dib = GetBitmapData()->m_dib;
1266         GetBitmapData()->m_dib = NULL;
1267
1268         // TODO: convert
1269
1270         delete dib;
1271     }
1272 #endif // wxUSE_WXDIB
1273 }
1274 #endif // #ifdef wxHAVE_RAW_BITMAP
1275
1276 // ----------------------------------------------------------------------------
1277 // wxMask
1278 // ----------------------------------------------------------------------------
1279
1280 wxMask::wxMask()
1281 {
1282     m_maskBitmap = 0;
1283 }
1284
1285 // Construct a mask from a bitmap and a colour indicating
1286 // the transparent area
1287 wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour)
1288 {
1289     m_maskBitmap = 0;
1290     Create(bitmap, colour);
1291 }
1292
1293 // Construct a mask from a bitmap and a palette index indicating
1294 // the transparent area
1295 wxMask::wxMask(const wxBitmap& bitmap, int paletteIndex)
1296 {
1297     m_maskBitmap = 0;
1298     Create(bitmap, paletteIndex);
1299 }
1300
1301 // Construct a mask from a mono bitmap (copies the bitmap).
1302 wxMask::wxMask(const wxBitmap& bitmap)
1303 {
1304     m_maskBitmap = 0;
1305     Create(bitmap);
1306 }
1307
1308 wxMask::~wxMask()
1309 {
1310     if ( m_maskBitmap )
1311         ::DeleteObject((HBITMAP) m_maskBitmap);
1312 }
1313
1314 // Create a mask from a mono bitmap (copies the bitmap).
1315 bool wxMask::Create(const wxBitmap& bitmap)
1316 {
1317 #ifndef __WXMICROWIN__
1318     wxCHECK_MSG( bitmap.Ok() && bitmap.GetDepth() == 1, false,
1319                  _T("can't create mask from invalid or not monochrome bitmap") );
1320
1321     if ( m_maskBitmap )
1322     {
1323         ::DeleteObject((HBITMAP) m_maskBitmap);
1324         m_maskBitmap = 0;
1325     }
1326
1327     m_maskBitmap = (WXHBITMAP) CreateBitmap(
1328                                             bitmap.GetWidth(),
1329                                             bitmap.GetHeight(),
1330                                             1, 1, 0
1331                                            );
1332     HDC srcDC = CreateCompatibleDC(0);
1333     SelectObject(srcDC, (HBITMAP) bitmap.GetHBITMAP());
1334     HDC destDC = CreateCompatibleDC(0);
1335     SelectObject(destDC, (HBITMAP) m_maskBitmap);
1336     BitBlt(destDC, 0, 0, bitmap.GetWidth(), bitmap.GetHeight(), srcDC, 0, 0, SRCCOPY);
1337     SelectObject(srcDC, 0);
1338     DeleteDC(srcDC);
1339     SelectObject(destDC, 0);
1340     DeleteDC(destDC);
1341     return true;
1342 #else
1343     wxUnusedVar(bitmap);
1344     return false;
1345 #endif
1346 }
1347
1348 // Create a mask from a bitmap and a palette index indicating
1349 // the transparent area
1350 bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
1351 {
1352     if ( m_maskBitmap )
1353     {
1354         ::DeleteObject((HBITMAP) m_maskBitmap);
1355         m_maskBitmap = 0;
1356     }
1357
1358 #if wxUSE_PALETTE
1359     if (bitmap.Ok() && bitmap.GetPalette()->Ok())
1360     {
1361         unsigned char red, green, blue;
1362         if (bitmap.GetPalette()->GetRGB(paletteIndex, &red, &green, &blue))
1363         {
1364             wxColour transparentColour(red, green, blue);
1365             return Create(bitmap, transparentColour);
1366         }
1367     }
1368 #endif // wxUSE_PALETTE
1369
1370     return false;
1371 }
1372
1373 // Create a mask from a bitmap and a colour indicating
1374 // the transparent area
1375 bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
1376 {
1377 #ifndef __WXMICROWIN__
1378     wxCHECK_MSG( bitmap.Ok(), false, _T("invalid bitmap in wxMask::Create") );
1379
1380     if ( m_maskBitmap )
1381     {
1382         ::DeleteObject((HBITMAP) m_maskBitmap);
1383         m_maskBitmap = 0;
1384     }
1385
1386     int width = bitmap.GetWidth(),
1387         height = bitmap.GetHeight();
1388
1389     // scan the bitmap for the transparent colour and set the corresponding
1390     // pixels in the mask to BLACK and the rest to WHITE
1391     COLORREF maskColour = wxColourToPalRGB(colour);
1392     m_maskBitmap = (WXHBITMAP)::CreateBitmap(width, height, 1, 1, 0);
1393
1394     HDC srcDC = ::CreateCompatibleDC(NULL);
1395     HDC destDC = ::CreateCompatibleDC(NULL);
1396     if ( !srcDC || !destDC )
1397     {
1398         wxLogLastError(wxT("CreateCompatibleDC"));
1399     }
1400
1401     bool ok = true;
1402
1403     // SelectObject() will fail
1404     wxASSERT_MSG( !bitmap.GetSelectedInto(),
1405                   _T("bitmap can't be selected in another DC") );
1406
1407     HGDIOBJ hbmpSrcOld = ::SelectObject(srcDC, GetHbitmapOf(bitmap));
1408     if ( !hbmpSrcOld )
1409     {
1410         wxLogLastError(wxT("SelectObject"));
1411
1412         ok = false;
1413     }
1414
1415     HGDIOBJ hbmpDstOld = ::SelectObject(destDC, (HBITMAP)m_maskBitmap);
1416     if ( !hbmpDstOld )
1417     {
1418         wxLogLastError(wxT("SelectObject"));
1419
1420         ok = false;
1421     }
1422
1423     if ( ok )
1424     {
1425         // this will create a monochrome bitmap with 0 points for the pixels
1426         // which have the same value as the background colour and 1 for the
1427         // others
1428         ::SetBkColor(srcDC, maskColour);
1429         ::BitBlt(destDC, 0, 0, width, height, srcDC, 0, 0, NOTSRCCOPY);
1430     }
1431
1432     ::SelectObject(srcDC, hbmpSrcOld);
1433     ::DeleteDC(srcDC);
1434     ::SelectObject(destDC, hbmpDstOld);
1435     ::DeleteDC(destDC);
1436
1437     return ok;
1438 #else // __WXMICROWIN__
1439     wxUnusedVar(bitmap);
1440     wxUnusedVar(colour);
1441     return false;
1442 #endif // __WXMICROWIN__/!__WXMICROWIN__
1443 }
1444
1445 // ----------------------------------------------------------------------------
1446 // wxBitmapHandler
1447 // ----------------------------------------------------------------------------
1448
1449 bool wxBitmapHandler::Create(wxGDIImage *image,
1450                              void *data,
1451                              long flags,
1452                              int width, int height, int depth)
1453 {
1454     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1455
1456     return bitmap ? Create(bitmap, data, flags, width, height, depth) : false;
1457 }
1458
1459 bool wxBitmapHandler::Load(wxGDIImage *image,
1460                            const wxString& name,
1461                            long flags,
1462                            int width, int height)
1463 {
1464     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1465
1466     return bitmap ? LoadFile(bitmap, name, flags, width, height) : false;
1467 }
1468
1469 bool wxBitmapHandler::Save(wxGDIImage *image,
1470                            const wxString& name,
1471                            int type)
1472 {
1473     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1474
1475     return bitmap ? SaveFile(bitmap, name, type) : false;
1476 }
1477
1478 bool wxBitmapHandler::Create(wxBitmap *WXUNUSED(bitmap),
1479                              void *WXUNUSED(data),
1480                              long WXUNUSED(type),
1481                              int WXUNUSED(width),
1482                              int WXUNUSED(height),
1483                              int WXUNUSED(depth))
1484 {
1485     return false;
1486 }
1487
1488 bool wxBitmapHandler::LoadFile(wxBitmap *WXUNUSED(bitmap),
1489                                const wxString& WXUNUSED(name),
1490                                long WXUNUSED(type),
1491                                int WXUNUSED(desiredWidth),
1492                                int WXUNUSED(desiredHeight))
1493 {
1494     return false;
1495 }
1496
1497 bool wxBitmapHandler::SaveFile(wxBitmap *WXUNUSED(bitmap),
1498                                const wxString& WXUNUSED(name),
1499                                int WXUNUSED(type),
1500                                const wxPalette *WXUNUSED(palette))
1501 {
1502     return false;
1503 }
1504
1505 // ----------------------------------------------------------------------------
1506 // DIB functions
1507 // ----------------------------------------------------------------------------
1508
1509 #ifndef __WXMICROWIN__
1510 bool wxCreateDIB(long xSize, long ySize, long bitsPerPixel,
1511                  HPALETTE hPal, LPBITMAPINFO* lpDIBHeader)
1512 {
1513    unsigned long   i, headerSize;
1514
1515    // Allocate space for a DIB header
1516    headerSize = (sizeof(BITMAPINFOHEADER) + (256 * sizeof(PALETTEENTRY)));
1517    LPBITMAPINFO lpDIBheader = (BITMAPINFO *) malloc(headerSize);
1518    LPPALETTEENTRY lpPe = (PALETTEENTRY *)((BYTE*)lpDIBheader + sizeof(BITMAPINFOHEADER));
1519
1520    GetPaletteEntries(hPal, 0, 256, lpPe);
1521
1522    memset(lpDIBheader, 0x00, sizeof(BITMAPINFOHEADER));
1523
1524    // Fill in the static parts of the DIB header
1525    lpDIBheader->bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
1526    lpDIBheader->bmiHeader.biWidth = xSize;
1527    lpDIBheader->bmiHeader.biHeight = ySize;
1528    lpDIBheader->bmiHeader.biPlanes = 1;
1529
1530    // this value must be 1, 4, 8 or 24 so PixelDepth can only be
1531    lpDIBheader->bmiHeader.biBitCount = (WORD)(bitsPerPixel);
1532    lpDIBheader->bmiHeader.biCompression = BI_RGB;
1533    lpDIBheader->bmiHeader.biSizeImage = xSize * abs(ySize) * bitsPerPixel >> 3;
1534    lpDIBheader->bmiHeader.biClrUsed = 256;
1535
1536
1537    // Initialize the DIB palette
1538    for (i = 0; i < 256; i++) {
1539       lpDIBheader->bmiColors[i].rgbReserved = lpPe[i].peFlags;
1540       lpDIBheader->bmiColors[i].rgbRed = lpPe[i].peRed;
1541       lpDIBheader->bmiColors[i].rgbGreen = lpPe[i].peGreen;
1542       lpDIBheader->bmiColors[i].rgbBlue = lpPe[i].peBlue;
1543    }
1544
1545    *lpDIBHeader = lpDIBheader;
1546
1547    return true;
1548 }
1549
1550 void wxFreeDIB(LPBITMAPINFO lpDIBHeader)
1551 {
1552     free(lpDIBHeader);
1553 }
1554 #endif
1555
1556 // ----------------------------------------------------------------------------
1557 // global helper functions implemented here
1558 // ----------------------------------------------------------------------------
1559
1560 // helper of wxBitmapToHICON/HCURSOR
1561 static
1562 HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
1563                              bool iconWanted,
1564                              int hotSpotX,
1565                              int hotSpotY)
1566 {
1567     if ( !bmp.Ok() )
1568     {
1569         // we can't create an icon/cursor form nothing
1570         return 0;
1571     }
1572
1573     wxMask *mask = bmp.GetMask();
1574     if ( !mask )
1575     {
1576         // we must have a mask for an icon, so even if it's probably incorrect,
1577         // do create it (grey is the "standard" transparent colour)
1578         mask = new wxMask(bmp, *wxLIGHT_GREY);
1579     }
1580
1581     ICONINFO iconInfo;
1582     wxZeroMemory(iconInfo);
1583     iconInfo.fIcon = iconWanted;  // do we want an icon or a cursor?
1584     if ( !iconWanted )
1585     {
1586         iconInfo.xHotspot = hotSpotX;
1587         iconInfo.yHotspot = hotSpotY;
1588     }
1589
1590     iconInfo.hbmMask = wxInvertMask((HBITMAP)mask->GetMaskBitmap());
1591     iconInfo.hbmColor = GetHbitmapOf(bmp);
1592
1593     // black out the transparent area to preserve background colour, because
1594     // Windows blits the original bitmap using SRCINVERT (XOR) after applying
1595     // the mask to the dest rect.
1596     {
1597         MemoryHDC dcSrc, dcDst;
1598         SelectInHDC selectMask(dcSrc, (HBITMAP)mask->GetMaskBitmap()),
1599                     selectBitmap(dcDst, iconInfo.hbmColor);
1600
1601         if ( !::BitBlt(dcDst, 0, 0, bmp.GetWidth(), bmp.GetHeight(),
1602                        dcSrc, 0, 0, SRCAND) )
1603         {
1604             wxLogLastError(_T("BitBlt"));
1605         }
1606     }
1607
1608     HICON hicon = ::CreateIconIndirect(&iconInfo);
1609
1610     if ( !bmp.GetMask() )
1611     {
1612         // we created the mask, now delete it
1613         delete mask;
1614     }
1615
1616     // delete the inverted mask bitmap we created as well
1617     ::DeleteObject(iconInfo.hbmMask);
1618
1619     return hicon;
1620 }
1621
1622 HICON wxBitmapToHICON(const wxBitmap& bmp)
1623 {
1624     return wxBitmapToIconOrCursor(bmp, true, 0, 0);
1625 }
1626
1627 HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY)
1628 {
1629     return (HCURSOR)wxBitmapToIconOrCursor(bmp, false, hotSpotX, hotSpotY);
1630 }
1631
1632 HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h)
1633 {
1634 #ifndef __WXMICROWIN__
1635     wxCHECK_MSG( hbmpMask, 0, _T("invalid bitmap in wxInvertMask") );
1636
1637     // get width/height from the bitmap if not given
1638     if ( !w || !h )
1639     {
1640         BITMAP bm;
1641         ::GetObject(hbmpMask, sizeof(BITMAP), (LPVOID)&bm);
1642         w = bm.bmWidth;
1643         h = bm.bmHeight;
1644     }
1645
1646     HDC hdcSrc = ::CreateCompatibleDC(NULL);
1647     HDC hdcDst = ::CreateCompatibleDC(NULL);
1648     if ( !hdcSrc || !hdcDst )
1649     {
1650         wxLogLastError(wxT("CreateCompatibleDC"));
1651     }
1652
1653     HBITMAP hbmpInvMask = ::CreateBitmap(w, h, 1, 1, 0);
1654     if ( !hbmpInvMask )
1655     {
1656         wxLogLastError(wxT("CreateBitmap"));
1657     }
1658
1659     HGDIOBJ srcTmp = ::SelectObject(hdcSrc, hbmpMask);
1660     HGDIOBJ dstTmp = ::SelectObject(hdcDst, hbmpInvMask);
1661     if ( !::BitBlt(hdcDst, 0, 0, w, h,
1662                    hdcSrc, 0, 0,
1663                    NOTSRCCOPY) )
1664     {
1665         wxLogLastError(wxT("BitBlt"));
1666     }
1667
1668     // Deselect objects
1669     SelectObject(hdcSrc,srcTmp);
1670     SelectObject(hdcDst,dstTmp);
1671
1672     ::DeleteDC(hdcSrc);
1673     ::DeleteDC(hdcDst);
1674
1675     return hbmpInvMask;
1676 #else
1677     return 0;
1678 #endif
1679 }