]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/bitmap.cpp
Several corrections to wxDocManager fields documentation.
[wxWidgets.git] / src / msw / bitmap.cpp
index 307c67bada721baf44f2500a9b284dde080044a5..10756fee7ca3cbb1e2bd3bb850efac72e281a58e 100644 (file)
@@ -56,7 +56,7 @@
 #endif // no CLR_INVALID
 
 // ----------------------------------------------------------------------------
-// Bitmap data
+// wxBitmapRefData
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
@@ -92,12 +92,12 @@ public:
     // MSW-specific
     // ------------
 
-#ifdef __WXDEBUG__
+#if wxDEBUG_LEVEL
     // this field is solely for error checking: we detect selecting a bitmap
     // into more than one DC at once or deleting a bitmap still selected into a
     // DC (both are serious programming errors under Windows)
     wxDC         *m_selectedInto;
-#endif // __WXDEBUG__
+#endif // wxDEBUG_LEVEL
 
 #if wxUSE_WXDIB
     // when GetRawData() is called for a DDB we need to convert it to a DIB
@@ -185,7 +185,7 @@ IMPLEMENT_DYNAMIC_CLASS(wxBitmapHandler, wxObject)
 
 wxBitmapRefData::wxBitmapRefData()
 {
-#ifdef __WXDEBUG__
+#if wxDEBUG_LEVEL
     m_selectedInto = NULL;
 #endif
     m_bitmapMask = NULL;
@@ -202,7 +202,7 @@ wxBitmapRefData::wxBitmapRefData()
 wxBitmapRefData::wxBitmapRefData(const wxBitmapRefData& data)
                : wxGDIImageRefData(data)
 {
-#ifdef __WXDEBUG__
+#if wxDEBUG_LEVEL
     m_selectedInto = NULL;
 #endif
 
@@ -215,7 +215,7 @@ wxBitmapRefData::wxBitmapRefData(const wxBitmapRefData& data)
     //        CloneGDIRefData()
 
     wxASSERT_MSG( !data.m_isDIB,
-                    _T("can't copy bitmap locked for raw access!") );
+                    wxT("can't copy bitmap locked for raw access!") );
     m_isDIB = false;
 
     m_hasAlpha = data.m_hasAlpha;
@@ -227,7 +227,7 @@ void wxBitmapRefData::Free()
                   wxT("deleting bitmap still selected into wxMemoryDC") );
 
 #if wxUSE_WXDIB
-    wxASSERT_MSG( !m_dib, _T("forgot to call wxBitmap::UngetRawData()!") );
+    wxASSERT_MSG( !m_dib, wxT("forgot to call wxBitmap::UngetRawData()!") );
 #endif
 
     if ( m_hBitmap)
@@ -238,8 +238,7 @@ void wxBitmapRefData::Free()
         }
     }
 
-    delete m_bitmapMask;
-    m_bitmapMask = NULL;
+    wxDELETE(m_bitmapMask);
 }
 
 // ----------------------------------------------------------------------------
@@ -254,7 +253,7 @@ wxGDIImageRefData *wxBitmap::CreateData() const
 wxGDIRefData *wxBitmap::CloneGDIRefData(const wxGDIRefData *dataOrig) const
 {
     const wxBitmapRefData *
-        data = wx_static_cast(const wxBitmapRefData *, dataOrig);
+        data = static_cast<const wxBitmapRefData *>(dataOrig);
     if ( !data )
         return NULL;
 
@@ -262,7 +261,7 @@ wxGDIRefData *wxBitmap::CloneGDIRefData(const wxGDIRefData *dataOrig) const
     //        wxBitmapRefData using its copy ctor but instead it modifies this
     //        bitmap itself and then returns its m_refData -- which works, of
     //        course (except in !wxUSE_WXDIB), but is completely illogical
-    wxBitmap *self = wx_const_cast(wxBitmap *, this);
+    wxBitmap *self = const_cast<wxBitmap *>(this);
 
     wxBitmapRefData *selfdata;
 #if wxUSE_WXDIB
@@ -272,7 +271,7 @@ wxGDIRefData *wxBitmap::CloneGDIRefData(const wxGDIRefData *dataOrig) const
         wxDIB dib((HBITMAP)(data->m_hBitmap));
         self->CopyFromDIB(dib);
 
-        selfdata = wx_static_cast(wxBitmapRefData *, m_refData);
+        selfdata = static_cast<wxBitmapRefData *>(m_refData);
         selfdata->m_hasAlpha = data->m_hasAlpha;
     }
     else
@@ -323,7 +322,7 @@ bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon,
     switch ( transp )
     {
         default:
-            wxFAIL_MSG( _T("unknown wxBitmapTransparency value") );
+            wxFAIL_MSG( wxT("unknown wxBitmapTransparency value") );
 
         case wxBitmapTransparency_None:
             // nothing to do, refData->m_hasAlpha is false by default
@@ -388,7 +387,7 @@ bool wxBitmap::CopyFromCursor(const wxCursor& cursor, wxBitmapTransparency trans
 {
     UnRef();
 
-    if ( !cursor.Ok() )
+    if ( !cursor.IsOk() )
         return false;
 
     return CopyFromIconOrCursor(cursor, transp);
@@ -398,7 +397,7 @@ bool wxBitmap::CopyFromIcon(const wxIcon& icon, wxBitmapTransparency transp)
 {
     UnRef();
 
-    if ( !icon.Ok() )
+    if ( !icon.IsOk() )
         return false;
 
     return CopyFromIconOrCursor(icon, transp);
@@ -408,14 +407,14 @@ bool wxBitmap::CopyFromIcon(const wxIcon& icon, wxBitmapTransparency transp)
 
 bool wxBitmap::CopyFromDIB(const wxDIB& dib)
 {
-    wxCHECK_MSG( dib.IsOk(), false, _T("invalid DIB in CopyFromDIB") );
+    wxCHECK_MSG( dib.IsOk(), false, wxT("invalid DIB in CopyFromDIB") );
 
 #ifdef SOMETIMES_USE_DIB
     HBITMAP hbitmap = dib.CreateDDB();
     if ( !hbitmap )
         return false;
 #else // ALWAYS_USE_DIB
-    HBITMAP hbitmap = ((wxDIB &)dib).Detach();  // const_cast
+    HBITMAP hbitmap = const_cast<wxDIB &>(dib).Detach();
 #endif // SOMETIMES_USE_DIB/ALWAYS_USE_DIB
 
     UnRef();
@@ -494,7 +493,7 @@ wxBitmap::wxBitmap(const char bits[], int width, int height, int depth)
     else
     {
         // bits should already be in Windows standard format
-        data = (char *)bits;    // const_cast is harmless
+        data = const_cast<char *>(bits);
     }
 
     HBITMAP hbmp = ::CreateBitmap(width, height, 1, depth, data);
@@ -512,11 +511,6 @@ wxBitmap::wxBitmap(const char bits[], int width, int height, int depth)
 #endif
 }
 
-wxBitmap::wxBitmap(int w, int h, int d)
-{
-    (void)Create(w, h, d);
-}
-
 wxBitmap::wxBitmap(int w, int h, const wxDC& dc)
 {
     (void)Create(w, h, dc);
@@ -539,7 +533,7 @@ bool wxBitmap::Create(int width, int height, int depth)
 
 bool wxBitmap::Create(int width, int height, const wxDC& dc)
 {
-    wxCHECK_MSG( dc.IsOk(), false, _T("invalid HDC in wxBitmap::Create()") );
+    wxCHECK_MSG( dc.IsOk(), false, wxT("invalid HDC in wxBitmap::Create()") );
 
     const wxMSWDCImpl *impl = wxDynamicCast( dc.GetImpl(), wxMSWDCImpl );
 
@@ -611,7 +605,7 @@ bool wxBitmap::DoCreate(int w, int h, int d, WXHDC hdc)
 
     SetHBITMAP((WXHBITMAP)hbmp);
 
-    return Ok();
+    return IsOk();
 }
 
 #if wxUSE_IMAGE
@@ -745,7 +739,7 @@ wxImage wxBitmap::ConvertToImage() const
     // so the 'depth' argument is ignored.
     // TODO: transparency (create a mask image)
 
-    if (!Ok())
+    if (!IsOk())
     {
         wxFAIL_MSG( wxT("bitmap is invalid") );
         return wxNullImage;
@@ -753,7 +747,7 @@ wxImage wxBitmap::ConvertToImage() const
 
     wxImage image;
 
-    wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") );
+    wxCHECK_MSG( IsOk(), wxNullImage, wxT("invalid bitmap") );
 
     // create an wxImage object
     int width = GetWidth();
@@ -815,7 +809,7 @@ bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
 bool wxBitmap::CreateFromImage(const wxImage& image, const wxDC& dc)
 {
     wxCHECK_MSG( dc.IsOk(), false,
-                    _T("invalid HDC in wxBitmap::CreateFromImage()") );
+                    wxT("invalid HDC in wxBitmap::CreateFromImage()") );
 
     const wxMSWDCImpl *impl = wxDynamicCast( dc.GetImpl(), wxMSWDCImpl );
 
@@ -829,7 +823,7 @@ bool wxBitmap::CreateFromImage(const wxImage& image, const wxDC& dc)
 
 bool wxBitmap::CreateFromImage(const wxImage& image, int depth, WXHDC hdc)
 {
-    wxCHECK_MSG( image.Ok(), false, wxT("invalid image") );
+    wxCHECK_MSG( image.IsOk(), false, wxT("invalid image") );
 
     UnRef();
 
@@ -842,7 +836,7 @@ bool wxBitmap::CreateFromImage(const wxImage& image, int depth, WXHDC hdc)
         return false;
 
     const bool hasAlpha = image.HasAlpha();
-    
+
     if (depth == -1)
       depth = dib.GetDepth();
 
@@ -910,7 +904,7 @@ bool wxBitmap::CreateFromImage(const wxImage& image, int depth, WXHDC hdc)
         hbitmap = ::CreateBitmap(w, h, 1, 1, data);
         if ( !hbitmap )
         {
-            wxLogLastError(_T("CreateBitmap(mask)"));
+            wxLogLastError(wxT("CreateBitmap(mask)"));
         }
         else
         {
@@ -935,7 +929,7 @@ wxImage wxBitmap::ConvertToImage() const
 
     // and then DIB to our wxImage
     wxImage image = dib.ConvertToImage();
-    if ( !image.Ok() )
+    if ( !image.IsOk() )
     {
         return wxNullImage;
     }
@@ -1045,7 +1039,7 @@ bool wxBitmap::LoadFile(const wxString& filename, wxBitmapType type)
     else // no bitmap handler found
     {
         wxImage image;
-        if ( image.LoadFile( filename, type ) && image.Ok() )
+        if ( image.LoadFile( filename, type ) && image.IsOk() )
         {
             *this = wxBitmap(image);
 
@@ -1090,7 +1084,7 @@ bool wxBitmap::SaveFile(const wxString& filename,
     {
         // FIXME what about palette? shouldn't we use it?
         wxImage image = ConvertToImage();
-        if ( image.Ok() )
+        if ( image.IsOk() )
         {
             return image.SaveFile(filename, type);
         }
@@ -1112,14 +1106,14 @@ wxBitmap wxBitmap::GetSubBitmap( const wxRect& rect ) const
 
 wxBitmap wxBitmap::GetSubBitmapOfHDC( const wxRect& rect, WXHDC hdc ) const
 {
-    wxCHECK_MSG( Ok() &&
+    wxCHECK_MSG( IsOk() &&
                  (rect.x >= 0) && (rect.y >= 0) &&
                  (rect.x+rect.width <= GetWidth()) &&
                  (rect.y+rect.height <= GetHeight()),
                  wxNullBitmap, wxT("Invalid bitmap or bitmap region") );
 
     wxBitmap ret( rect.width, rect.height, GetDepth() );
-    wxASSERT_MSG( ret.Ok(), wxT("GetSubBitmap error") );
+    wxASSERT_MSG( ret.IsOk(), wxT("GetSubBitmap error") );
 
 #ifndef __WXMICROWIN__
     // handle alpha channel, if any
@@ -1135,13 +1129,13 @@ wxBitmap wxBitmap::GetSubBitmapOfHDC( const wxRect& rect, WXHDC hdc ) const
 
         if ( !selectDst )
         {
-            wxLogLastError(_T("SelectObject(destBitmap)"));
+            wxLogLastError(wxT("SelectObject(destBitmap)"));
         }
 
         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
                        (HDC)hdc, rect.x, rect.y, SRCCOPY) )
         {
-            wxLogLastError(_T("BitBlt"));
+            wxLogLastError(wxT("BitBlt"));
         }
     }
 
@@ -1156,7 +1150,7 @@ wxBitmap wxBitmap::GetSubBitmapOfHDC( const wxRect& rect, WXHDC hdc ) const
         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
                        dcSrc, rect.x, rect.y, SRCCOPY) )
         {
-            wxLogLastError(_T("BitBlt"));
+            wxLogLastError(wxT("BitBlt"));
         }
 
         wxMask *mask = new wxMask((WXHBITMAP) hbmpMask);
@@ -1175,13 +1169,13 @@ wxBitmap wxBitmap::GetSubBitmapOfHDC( const wxRect& rect, WXHDC hdc ) const
 wxPalette* wxBitmap::GetPalette() const
 {
     return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette
-                           : (wxPalette *) NULL;
+                           : NULL;
 }
 #endif
 
 wxMask *wxBitmap::GetMask() const
 {
-    return GetBitmapData() ? GetBitmapData()->GetMask() : (wxMask *) NULL;
+    return GetBitmapData() ? GetBitmapData()->GetMask() : NULL;
 }
 
 wxBitmap wxBitmap::GetMaskBitmap() const
@@ -1193,14 +1187,14 @@ wxBitmap wxBitmap::GetMaskBitmap() const
     return bmp;
 }
 
-#ifdef __WXDEBUG__
-
 wxDC *wxBitmap::GetSelectedInto() const
 {
-    return GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC *) NULL;
-}
-
+#if wxDEBUG_LEVEL
+    return GetBitmapData() ? GetBitmapData()->m_selectedInto : NULL;
+#else
+    return NULL;
 #endif
+}
 
 void wxBitmap::UseAlpha()
 {
@@ -1217,15 +1211,15 @@ bool wxBitmap::HasAlpha() const
 // wxBitmap setters
 // ----------------------------------------------------------------------------
 
-#ifdef __WXDEBUG__
-
 void wxBitmap::SetSelectedInto(wxDC *dc)
 {
+#if wxDEBUG_LEVEL
     if ( GetBitmapData() )
         GetBitmapData()->m_selectedInto = dc;
-}
-
+#else
+    wxUnusedVar(dc);
 #endif
+}
 
 #if wxUSE_PALETTE
 
@@ -1254,7 +1248,7 @@ void wxBitmap::SetMask(wxMask *mask)
 void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
 {
 #if wxUSE_WXDIB
-    if ( !Ok() )
+    if ( !IsOk() )
     {
         // no bitmap, no data (raw or otherwise)
         return NULL;
@@ -1267,7 +1261,7 @@ void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
     if ( !GetBitmapData()->m_isDIB )
     {
         wxCHECK_MSG( !GetBitmapData()->m_dib, NULL,
-                        _T("GetRawData() may be called only once") );
+                        wxT("GetRawData() may be called only once") );
 
         wxDIB *dib = new wxDIB(*this);
         if ( !dib->IsOk() )
@@ -1290,7 +1284,7 @@ void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
     DIBSECTION ds;
     if ( ::GetObject(hDIB, sizeof(ds), &ds) != sizeof(DIBSECTION) )
     {
-        wxFAIL_MSG( _T("failed to get DIBSECTION from a DIB?") );
+        wxFAIL_MSG( wxT("failed to get DIBSECTION from a DIB?") );
 
         return NULL;
     }
@@ -1298,7 +1292,7 @@ void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
     // check that the bitmap is in correct format
     if ( ds.dsBm.bmBitsPixel != bpp )
     {
-        wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
+        wxFAIL_MSG( wxT("incorrect bitmap type in wxBitmap::GetRawData()") );
 
         return NULL;
     }
@@ -1332,7 +1326,7 @@ void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
 void wxBitmap::UngetRawData(wxPixelDataBase& dataBase)
 {
 #if wxUSE_WXDIB
-    if ( !Ok() )
+    if ( !IsOk() )
         return;
 
     if ( !&dataBase )
@@ -1433,8 +1427,8 @@ wxMask::~wxMask()
 bool wxMask::Create(const wxBitmap& bitmap)
 {
 #ifndef __WXMICROWIN__
-    wxCHECK_MSG( bitmap.Ok() && bitmap.GetDepth() == 1, false,
-                 _T("can't create mask from invalid or not monochrome bitmap") );
+    wxCHECK_MSG( bitmap.IsOk() && bitmap.GetDepth() == 1, false,
+                 wxT("can't create mask from invalid or not monochrome bitmap") );
 
     if ( m_maskBitmap )
     {
@@ -1474,7 +1468,7 @@ bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
     }
 
 #if wxUSE_PALETTE
-    if (bitmap.Ok() && bitmap.GetPalette()->Ok())
+    if (bitmap.IsOk() && bitmap.GetPalette()->IsOk())
     {
         unsigned char red, green, blue;
         if (bitmap.GetPalette()->GetRGB(paletteIndex, &red, &green, &blue))
@@ -1493,7 +1487,7 @@ bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
 bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
 {
 #ifndef __WXMICROWIN__
-    wxCHECK_MSG( bitmap.Ok(), false, _T("invalid bitmap in wxMask::Create") );
+    wxCHECK_MSG( bitmap.IsOk(), false, wxT("invalid bitmap in wxMask::Create") );
 
     if ( m_maskBitmap )
     {
@@ -1520,7 +1514,7 @@ bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
 
     // SelectObject() will fail
     wxASSERT_MSG( !bitmap.GetSelectedInto(),
-                  _T("bitmap can't be selected in another DC") );
+                  wxT("bitmap can't be selected in another DC") );
 
     HGDIOBJ hbmpSrcOld = ::SelectObject(srcDC, GetHbitmapOf(bitmap));
     if ( !hbmpSrcOld )
@@ -1631,7 +1625,7 @@ HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
                              int hotSpotX,
                              int hotSpotY)
 {
-    if ( !bmp.Ok() )
+    if ( !bmp.IsOk() )
     {
         // we can't create an icon/cursor form nothing
         return 0;
@@ -1639,9 +1633,25 @@ HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
 
     if ( bmp.HasAlpha() )
     {
+        HBITMAP hbmp;
+
+#if wxUSE_WXDIB && wxUSE_IMAGE
+        // CreateIconIndirect() requires non-pre-multiplied pixel data on input
+        // as it does pre-multiplication internally itself so we need to create
+        // a special DIB in such format to pass to it. This is inefficient but
+        // better than creating an icon with wrong colours.
+        AutoHBITMAP hbmpRelease;
+        hbmp = wxDIB(bmp.ConvertToImage(),
+                     wxDIB::PixelFormat_NotPreMultiplied).Detach();
+        hbmpRelease.Init(hbmp);
+#else // !(wxUSE_WXDIB && wxUSE_IMAGE)
+        hbmp = GetHbitmapOf(bmp);
+#endif // wxUSE_WXDIB && wxUSE_IMAGE
+
         // Create an empty mask bitmap.
         // it doesn't seem to work if we mess with the mask at all.
-        HBITMAP hMonoBitmap = CreateBitmap(bmp.GetWidth(),bmp.GetHeight(),1,1,NULL);
+        AutoHBITMAP
+            hMonoBitmap(CreateBitmap(bmp.GetWidth(),bmp.GetHeight(),1,1,NULL));
 
         ICONINFO iconInfo;
         wxZeroMemory(iconInfo);
@@ -1653,13 +1663,9 @@ HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
         }
 
         iconInfo.hbmMask = hMonoBitmap;
-        iconInfo.hbmColor = GetHbitmapOf(bmp);
-
-        HICON hicon = ::CreateIconIndirect(&iconInfo);
-
-        ::DeleteObject(hMonoBitmap);
+        iconInfo.hbmColor = hbmp;
 
-        return hicon;
+        return ::CreateIconIndirect(&iconInfo);
     }
 
     wxMask* mask = bmp.GetMask();
@@ -1680,7 +1686,8 @@ HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
         iconInfo.yHotspot = hotSpotY;
     }
 
-    iconInfo.hbmMask = wxInvertMask((HBITMAP)mask->GetMaskBitmap());
+    AutoHBITMAP hbmpMask(wxInvertMask((HBITMAP)mask->GetMaskBitmap()));
+    iconInfo.hbmMask = hbmpMask;
     iconInfo.hbmColor = GetHbitmapOf(bmp);
 
     // black out the transparent area to preserve background colour, because
@@ -1694,7 +1701,7 @@ HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
         if ( !::BitBlt(dcDst, 0, 0, bmp.GetWidth(), bmp.GetHeight(),
                        dcSrc, 0, 0, SRCAND) )
         {
-            wxLogLastError(_T("BitBlt"));
+            wxLogLastError(wxT("BitBlt"));
         }
     }
 
@@ -1706,9 +1713,6 @@ HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
         delete mask;
     }
 
-    // delete the inverted mask bitmap we created as well
-    ::DeleteObject(iconInfo.hbmMask);
-
     return hicon;
 }
 
@@ -1725,7 +1729,7 @@ HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY)
 HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h)
 {
 #ifndef __WXMICROWIN__
-    wxCHECK_MSG( hbmpMask, 0, _T("invalid bitmap in wxInvertMask") );
+    wxCHECK_MSG( hbmpMask, 0, wxT("invalid bitmap in wxInvertMask") );
 
     // get width/height from the bitmap if not given
     if ( !w || !h )