src/msw/imaglist.cpp

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