| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: src/msw/imaglist.cpp |
| 3 | // Purpose: wxImageList implementation for Win32 |
| 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 | // For compilers that support precompilation, includes "wx.h". |
| 21 | #include "wx/wxprec.h" |
| 22 | |
| 23 | #ifdef __BORLANDC__ |
| 24 | #pragma hdrstop |
| 25 | #endif |
| 26 | |
| 27 | #ifndef WX_PRECOMP |
| 28 | #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly" |
| 29 | #include "wx/window.h" |
| 30 | #include "wx/icon.h" |
| 31 | #include "wx/dc.h" |
| 32 | #include "wx/string.h" |
| 33 | #include "wx/dcmemory.h" |
| 34 | #include "wx/intl.h" |
| 35 | #include "wx/log.h" |
| 36 | #include "wx/image.h" |
| 37 | #include <stdio.h> |
| 38 | #endif |
| 39 | |
| 40 | #include "wx/imaglist.h" |
| 41 | #include "wx/dc.h" |
| 42 | #include "wx/msw/dc.h" |
| 43 | #include "wx/msw/private.h" |
| 44 | |
| 45 | // ---------------------------------------------------------------------------- |
| 46 | // wxWin macros |
| 47 | // ---------------------------------------------------------------------------- |
| 48 | |
| 49 | IMPLEMENT_DYNAMIC_CLASS(wxImageList, wxObject) |
| 50 | |
| 51 | #define GetHImageList() ((HIMAGELIST)m_hImageList) |
| 52 | |
| 53 | // ---------------------------------------------------------------------------- |
| 54 | // private functions |
| 55 | // ---------------------------------------------------------------------------- |
| 56 | |
| 57 | // returns the mask if it's valid, otherwise the bitmap mask and, if it's not |
| 58 | // valid neither, a "solid" mask (no transparent zones at all) |
| 59 | static HBITMAP GetMaskForImage(const wxBitmap& bitmap, const wxBitmap& mask); |
| 60 | |
| 61 | // ============================================================================ |
| 62 | // implementation |
| 63 | // ============================================================================ |
| 64 | |
| 65 | // ---------------------------------------------------------------------------- |
| 66 | // wxImageList creation/destruction |
| 67 | // ---------------------------------------------------------------------------- |
| 68 | |
| 69 | wxImageList::wxImageList() |
| 70 | { |
| 71 | m_hImageList = 0; |
| 72 | } |
| 73 | |
| 74 | // Creates an image list |
| 75 | bool wxImageList::Create(int width, int height, bool mask, int initial) |
| 76 | { |
| 77 | UINT flags = 0; |
| 78 | |
| 79 | // set appropriate color depth |
| 80 | #ifdef __WXWINCE__ |
| 81 | flags |= ILC_COLOR; |
| 82 | #else |
| 83 | int dd = wxDisplayDepth(); |
| 84 | |
| 85 | if (dd <= 4) flags |= ILC_COLOR; // 16 color |
| 86 | else if (dd <= 8) flags |= ILC_COLOR8; // 256 color |
| 87 | else if (dd <= 16) flags |= ILC_COLOR16; // 64k hi-color |
| 88 | else if (dd <= 24) flags |= ILC_COLOR24; // 16m truecolor |
| 89 | else if (dd <= 32) flags |= ILC_COLOR32; // 16m truecolor |
| 90 | #endif |
| 91 | |
| 92 | if ( mask ) |
| 93 | flags |= ILC_MASK; |
| 94 | |
| 95 | // Grow by 1, I guess this is reasonable behaviour most of the time |
| 96 | m_hImageList = (WXHIMAGELIST) ImageList_Create(width, height, flags, |
| 97 | initial, 1); |
| 98 | if ( !m_hImageList ) |
| 99 | { |
| 100 | wxLogLastError(wxT("ImageList_Create()")); |
| 101 | } |
| 102 | |
| 103 | return m_hImageList != 0; |
| 104 | } |
| 105 | |
| 106 | wxImageList::~wxImageList() |
| 107 | { |
| 108 | if ( m_hImageList ) |
| 109 | { |
| 110 | ImageList_Destroy(GetHImageList()); |
| 111 | m_hImageList = 0; |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | // ---------------------------------------------------------------------------- |
| 116 | // wxImageList attributes |
| 117 | // ---------------------------------------------------------------------------- |
| 118 | |
| 119 | // Returns the number of images in the image list. |
| 120 | int wxImageList::GetImageCount() const |
| 121 | { |
| 122 | wxASSERT_MSG( m_hImageList, _T("invalid image list") ); |
| 123 | |
| 124 | return ImageList_GetImageCount(GetHImageList()); |
| 125 | } |
| 126 | |
| 127 | // Returns the size (same for all images) of the images in the list |
| 128 | bool wxImageList::GetSize(int WXUNUSED(index), int &width, int &height) const |
| 129 | { |
| 130 | wxASSERT_MSG( m_hImageList, _T("invalid image list") ); |
| 131 | |
| 132 | return ImageList_GetIconSize(GetHImageList(), &width, &height) != 0; |
| 133 | } |
| 134 | |
| 135 | // ---------------------------------------------------------------------------- |
| 136 | // wxImageList operations |
| 137 | // ---------------------------------------------------------------------------- |
| 138 | |
| 139 | // Adds a bitmap, and optionally a mask bitmap. |
| 140 | // Note that wxImageList creates new bitmaps, so you may delete |
| 141 | // 'bitmap' and 'mask'. |
| 142 | int wxImageList::Add(const wxBitmap& bitmap, const wxBitmap& mask) |
| 143 | { |
| 144 | HBITMAP hbmpMask = GetMaskForImage(bitmap, mask); |
| 145 | |
| 146 | int index = ImageList_Add(GetHImageList(), GetHbitmapOf(bitmap), hbmpMask); |
| 147 | if ( index == -1 ) |
| 148 | { |
| 149 | wxLogError(_("Couldn't add an image to the image list.")); |
| 150 | } |
| 151 | |
| 152 | ::DeleteObject(hbmpMask); |
| 153 | |
| 154 | return index; |
| 155 | } |
| 156 | |
| 157 | // Adds a bitmap, using the specified colour to create the mask bitmap |
| 158 | // Note that wxImageList creates new bitmaps, so you may delete |
| 159 | // 'bitmap'. |
| 160 | int wxImageList::Add(const wxBitmap& bitmap, const wxColour& maskColour) |
| 161 | { |
| 162 | int index = ImageList_AddMasked(GetHImageList(), |
| 163 | GetHbitmapOf(bitmap), |
| 164 | wxColourToRGB(maskColour)); |
| 165 | if ( index == -1 ) |
| 166 | { |
| 167 | wxLogError(_("Couldn't add an image to the image list.")); |
| 168 | } |
| 169 | |
| 170 | return index; |
| 171 | } |
| 172 | |
| 173 | // Adds a bitmap and mask from an icon. |
| 174 | int wxImageList::Add(const wxIcon& icon) |
| 175 | { |
| 176 | int index = ImageList_AddIcon(GetHImageList(), GetHiconOf(icon)); |
| 177 | if ( index == -1 ) |
| 178 | { |
| 179 | wxLogError(_("Couldn't add an image to the image list.")); |
| 180 | } |
| 181 | |
| 182 | return index; |
| 183 | } |
| 184 | |
| 185 | // Replaces a bitmap, optionally passing a mask bitmap. |
| 186 | // Note that wxImageList creates new bitmaps, so you may delete |
| 187 | // 'bitmap' and 'mask'. |
| 188 | bool wxImageList::Replace(int index, |
| 189 | const wxBitmap& bitmap, const wxBitmap& mask) |
| 190 | { |
| 191 | HBITMAP hbmpMask = GetMaskForImage(bitmap, mask); |
| 192 | |
| 193 | bool ok = ImageList_Replace(GetHImageList(), index, |
| 194 | GetHbitmapOf(bitmap), hbmpMask) != 0; |
| 195 | if ( !ok ) |
| 196 | { |
| 197 | wxLogLastError(wxT("ImageList_Replace()")); |
| 198 | } |
| 199 | |
| 200 | ::DeleteObject(hbmpMask); |
| 201 | |
| 202 | return ok; |
| 203 | } |
| 204 | |
| 205 | // Replaces a bitmap and mask from an icon. |
| 206 | bool wxImageList::Replace(int i, const wxIcon& icon) |
| 207 | { |
| 208 | bool ok = ImageList_ReplaceIcon(GetHImageList(), i, GetHiconOf(icon)) != -1; |
| 209 | if ( !ok ) |
| 210 | { |
| 211 | wxLogLastError(wxT("ImageList_ReplaceIcon()")); |
| 212 | } |
| 213 | |
| 214 | return ok; |
| 215 | } |
| 216 | |
| 217 | // Removes the image at the given index. |
| 218 | bool wxImageList::Remove(int index) |
| 219 | { |
| 220 | bool ok = ImageList_Remove(GetHImageList(), index) != 0; |
| 221 | if ( !ok ) |
| 222 | { |
| 223 | wxLogLastError(wxT("ImageList_Remove()")); |
| 224 | } |
| 225 | |
| 226 | return ok; |
| 227 | } |
| 228 | |
| 229 | // Remove all images |
| 230 | bool wxImageList::RemoveAll() |
| 231 | { |
| 232 | // don't use ImageList_RemoveAll() because mingw32 headers don't have it |
| 233 | return Remove(-1); |
| 234 | } |
| 235 | |
| 236 | // Draws the given image on a dc at the specified position. |
| 237 | // If 'solidBackground' is true, Draw sets the image list background |
| 238 | // colour to the background colour of the wxDC, to speed up |
| 239 | // drawing by eliminating masked drawing where possible. |
| 240 | bool wxImageList::Draw(int index, |
| 241 | wxDC& dc, |
| 242 | int x, int y, |
| 243 | int flags, |
| 244 | bool solidBackground) |
| 245 | { |
| 246 | wxDCImpl *impl = dc.GetImpl(); |
| 247 | wxMSWDCImpl *msw_impl = wxDynamicCast( impl, wxMSWDCImpl ); |
| 248 | if (!msw_impl) |
| 249 | return false; |
| 250 | |
| 251 | HDC hDC = GetHdcOf(*msw_impl); |
| 252 | wxCHECK_MSG( hDC, false, _T("invalid wxDC in wxImageList::Draw") ); |
| 253 | |
| 254 | COLORREF clr = CLR_NONE; // transparent by default |
| 255 | if ( solidBackground ) |
| 256 | { |
| 257 | const wxBrush& brush = dc.GetBackground(); |
| 258 | if ( brush.Ok() ) |
| 259 | { |
| 260 | clr = wxColourToRGB(brush.GetColour()); |
| 261 | } |
| 262 | } |
| 263 | |
| 264 | ImageList_SetBkColor(GetHImageList(), clr); |
| 265 | |
| 266 | UINT style = 0; |
| 267 | if ( flags & wxIMAGELIST_DRAW_NORMAL ) |
| 268 | style |= ILD_NORMAL; |
| 269 | if ( flags & wxIMAGELIST_DRAW_TRANSPARENT ) |
| 270 | style |= ILD_TRANSPARENT; |
| 271 | if ( flags & wxIMAGELIST_DRAW_SELECTED ) |
| 272 | style |= ILD_SELECTED; |
| 273 | if ( flags & wxIMAGELIST_DRAW_FOCUSED ) |
| 274 | style |= ILD_FOCUS; |
| 275 | |
| 276 | bool ok = ImageList_Draw(GetHImageList(), index, hDC, x, y, style) != 0; |
| 277 | if ( !ok ) |
| 278 | { |
| 279 | wxLogLastError(wxT("ImageList_Draw()")); |
| 280 | } |
| 281 | |
| 282 | return ok; |
| 283 | } |
| 284 | |
| 285 | // Get the bitmap |
| 286 | wxBitmap wxImageList::GetBitmap(int index) const |
| 287 | { |
| 288 | #if wxUSE_WXDIB && wxUSE_IMAGE |
| 289 | int bmp_width = 0, bmp_height = 0; |
| 290 | GetSize(index, bmp_width, bmp_height); |
| 291 | |
| 292 | wxBitmap bitmap(bmp_width, bmp_height); |
| 293 | wxMemoryDC dc; |
| 294 | dc.SelectObject(bitmap); |
| 295 | |
| 296 | // draw it the first time to find a suitable mask colour |
| 297 | ((wxImageList*)this)->Draw(index, dc, 0, 0, wxIMAGELIST_DRAW_TRANSPARENT); |
| 298 | dc.SelectObject(wxNullBitmap); |
| 299 | |
| 300 | // find the suitable mask colour |
| 301 | wxImage image = bitmap.ConvertToImage(); |
| 302 | unsigned char r = 0, g = 0, b = 0; |
| 303 | image.FindFirstUnusedColour(&r, &g, &b); |
| 304 | |
| 305 | // redraw whole image and bitmap in the mask colour |
| 306 | image.Create(bmp_width, bmp_height); |
| 307 | image.Replace(0, 0, 0, r, g, b); |
| 308 | bitmap = wxBitmap(image); |
| 309 | |
| 310 | // redraw icon over the mask colour to actually draw it |
| 311 | dc.SelectObject(bitmap); |
| 312 | ((wxImageList*)this)->Draw(index, dc, 0, 0, wxIMAGELIST_DRAW_TRANSPARENT); |
| 313 | dc.SelectObject(wxNullBitmap); |
| 314 | |
| 315 | // get the image, set the mask colour and convert back to get transparent bitmap |
| 316 | image = bitmap.ConvertToImage(); |
| 317 | image.SetMaskColour(r, g, b); |
| 318 | bitmap = wxBitmap(image); |
| 319 | #else |
| 320 | wxBitmap bitmap; |
| 321 | #endif |
| 322 | return bitmap; |
| 323 | } |
| 324 | |
| 325 | // Get the icon |
| 326 | wxIcon wxImageList::GetIcon(int index) const |
| 327 | { |
| 328 | HICON hIcon = ImageList_ExtractIcon(0, GetHImageList(), index); |
| 329 | if (hIcon) |
| 330 | { |
| 331 | wxIcon icon; |
| 332 | icon.SetHICON((WXHICON)hIcon); |
| 333 | |
| 334 | int iconW, iconH; |
| 335 | GetSize(index, iconW, iconH); |
| 336 | icon.SetSize(iconW, iconH); |
| 337 | |
| 338 | return icon; |
| 339 | } |
| 340 | else |
| 341 | return wxNullIcon; |
| 342 | } |
| 343 | |
| 344 | // ---------------------------------------------------------------------------- |
| 345 | // helpers |
| 346 | // ---------------------------------------------------------------------------- |
| 347 | |
| 348 | static HBITMAP GetMaskForImage(const wxBitmap& bitmap, const wxBitmap& mask) |
| 349 | { |
| 350 | #if wxUSE_IMAGE |
| 351 | wxBitmap bitmapWithMask; |
| 352 | #endif // wxUSE_IMAGE |
| 353 | |
| 354 | HBITMAP hbmpMask; |
| 355 | wxMask *pMask; |
| 356 | bool deleteMask = false; |
| 357 | |
| 358 | if ( mask.Ok() ) |
| 359 | { |
| 360 | hbmpMask = GetHbitmapOf(mask); |
| 361 | pMask = NULL; |
| 362 | } |
| 363 | else |
| 364 | { |
| 365 | pMask = bitmap.GetMask(); |
| 366 | |
| 367 | #if wxUSE_IMAGE |
| 368 | // check if we don't have alpha in this bitmap -- we can create a mask |
| 369 | // from it (and we need to do it for the older systems which don't |
| 370 | // support 32bpp bitmaps natively) |
| 371 | if ( !pMask ) |
| 372 | { |
| 373 | wxImage img(bitmap.ConvertToImage()); |
| 374 | if ( img.HasAlpha() ) |
| 375 | { |
| 376 | img.ConvertAlphaToMask(); |
| 377 | bitmapWithMask = wxBitmap(img); |
| 378 | pMask = bitmapWithMask.GetMask(); |
| 379 | } |
| 380 | } |
| 381 | #endif // wxUSE_IMAGE |
| 382 | |
| 383 | if ( !pMask ) |
| 384 | { |
| 385 | // use the light grey count as transparent: the trouble here is |
| 386 | // that the light grey might have been changed by Windows behind |
| 387 | // our back, so use the standard colour map to get its real value |
| 388 | wxCOLORMAP *cmap = wxGetStdColourMap(); |
| 389 | wxColour col; |
| 390 | wxRGBToColour(col, cmap[wxSTD_COL_BTNFACE].from); |
| 391 | |
| 392 | pMask = new wxMask(bitmap, col); |
| 393 | |
| 394 | deleteMask = true; |
| 395 | } |
| 396 | |
| 397 | hbmpMask = (HBITMAP)pMask->GetMaskBitmap(); |
| 398 | } |
| 399 | |
| 400 | // windows mask convention is opposite to the wxWidgets one |
| 401 | HBITMAP hbmpMaskInv = wxInvertMask(hbmpMask); |
| 402 | |
| 403 | if ( deleteMask ) |
| 404 | { |
| 405 | delete pMask; |
| 406 | } |
| 407 | |
| 408 | return hbmpMaskInv; |
| 409 | } |