src/msw/ownerdrw.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/ownerdrw.cpp
   3 // Purpose:     implementation of wxOwnerDrawn class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     13.11.97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13 #pragma implementation
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18 #include "wx/msw/private.h"
  19
  20 #ifdef __BORLANDC__
  21 #pragma hdrstop
  22 #endif
  23
  24 #ifndef WX_PRECOMP
  25   #include "wx/window.h"
  26   #include "wx/msw/private.h"
  27   #include "wx/font.h"
  28   #include "wx/bitmap.h"
  29   #include "wx/dcmemory.h"
  30   #include "wx/menu.h"
  31   #include "wx/utils.h"
  32 #endif
  33
  34 #include "wx/settings.h"
  35 #include "wx/ownerdrw.h"
  36 #include "wx/menuitem.h"
  37 #include "wx/fontutil.h"
  38 #include "wx/module.h"
  39
  40 #if wxUSE_OWNER_DRAWN
  41
  42 #ifndef SPI_GETKEYBOARDCUES
  43 #define SPI_GETKEYBOARDCUES 0x100A
  44 #endif
  45
  46 class wxMSWSystemMenuFontModule : public wxModule
  47 {
  48 public:
  49
  50     virtual bool OnInit()
  51     {
  52         ms_systemMenuFont = new wxFont;
  53
  54 #if defined(__WXMSW__) && defined(__WIN32__) && defined(SM_CXMENUCHECK)
  55         NONCLIENTMETRICS nm;
  56         nm.cbSize = sizeof(NONCLIENTMETRICS);
  57         SystemParametersInfo(SPI_GETNONCLIENTMETRICS,0,&nm,0);
  58
  59         ms_systemMenuButtonWidth = nm.iMenuHeight;
  60         ms_systemMenuHeight = nm.iMenuHeight;
  61
  62         // create menu font
  63         wxNativeFontInfo info;
  64         memcpy(&info.lf, &nm.lfMenuFont, sizeof(LOGFONT));
  65         ms_systemMenuFont->Create(info);
  66
  67         if (SystemParametersInfo(SPI_GETKEYBOARDCUES, 0, &ms_showCues, 0) == 0)
  68             ms_showCues = true;
  69 #endif
  70
  71         return true;
  72     }
  73
  74     virtual void OnExit()
  75     {
  76         delete ms_systemMenuFont;
  77         ms_systemMenuFont = NULL;
  78     }
  79
  80     static wxFont* ms_systemMenuFont;
  81     static int ms_systemMenuButtonWidth;   // windows clean install default
  82     static int ms_systemMenuHeight;        // windows clean install default
  83     static bool ms_showCues;
  84 private:
  85     DECLARE_DYNAMIC_CLASS(wxMSWSystemMenuFontModule)
  86 };
  87
  88 // these static variables are from the wxMSWSystemMenuFontModule object
  89 // and reflect the system settings returned by the Win32 API's
  90 // SystemParametersInfo() call.
  91
  92 wxFont* wxMSWSystemMenuFontModule::ms_systemMenuFont = NULL;
  93 int wxMSWSystemMenuFontModule::ms_systemMenuButtonWidth = 18;   // windows clean install default
  94 int wxMSWSystemMenuFontModule::ms_systemMenuHeight = 18;        // windows clean install default
  95 bool wxMSWSystemMenuFontModule::ms_showCues = true;
  96
  97 IMPLEMENT_DYNAMIC_CLASS(wxMSWSystemMenuFontModule, wxModule)
  98
  99
 100 // temporary hack to implement wxOwnerDrawn::IsMenuItem() without breaking
 101 // backwards compatibility
 102 #if wxCHECK_VERSION(2, 7, 0)
 103     #pragma warning "TODO: remove gs_menuItems hack"
 104 #endif
 105
 106 #include "wx/hashset.h"
 107 WX_DECLARE_HASH_SET(wxOwnerDrawn*, wxPointerHash, wxPointerEqual, OwnerDrawnSet);
 108
 109 static OwnerDrawnSet gs_menuItems;
 110
 111 // ============================================================================
 112 // implementation of wxOwnerDrawn class
 113 // ============================================================================
 114
 115 // ctor
 116 // ----
 117 wxOwnerDrawn::wxOwnerDrawn(const wxString& str,
 118                            bool bCheckable,
 119                            bool bMenuItem)
 120             : m_strName(str)
 121 {
 122     if (ms_nDefaultMarginWidth == 0)
 123     {
 124        ms_nDefaultMarginWidth = ::GetSystemMetrics(SM_CXMENUCHECK) +
 125                                 wxSystemSettings::GetMetric(wxSYS_EDGE_X);
 126        ms_nLastMarginWidth = ms_nDefaultMarginWidth;
 127     }
 128
 129     m_bCheckable   = bCheckable;
 130     m_bOwnerDrawn  = false;
 131     m_nHeight      = 0;
 132     m_nMarginWidth = ms_nLastMarginWidth;
 133     m_nMinHeight   = wxMSWSystemMenuFontModule::ms_systemMenuHeight;
 134
 135     m_bmpDisabled = wxNullBitmap;
 136
 137     // TODO: we can't add new m_isMenuItem field in 2.6, so we use this hack
 138     //       with the map, but do add m_isMenuItem in 2.7
 139     if ( bMenuItem )
 140     {
 141         gs_menuItems.insert(this);
 142     }
 143 }
 144
 145 wxOwnerDrawn::~wxOwnerDrawn()
 146 {
 147     // TODO: remove this in 2.7
 148     gs_menuItems.erase(this);
 149 }
 150
 151 bool wxOwnerDrawn::IsMenuItem() const
 152 {
 153     // TODO: in 2.7, replace this with simple "return m_isMenuItem"
 154     return gs_menuItems.count(this) == 1;
 155 }
 156
 157
 158 // these items will be set during the first invocation of the c'tor,
 159 // because the values will be determined by checking the system settings,
 160 // which is a chunk of code
 161 size_t wxOwnerDrawn::ms_nDefaultMarginWidth = 0;
 162 size_t wxOwnerDrawn::ms_nLastMarginWidth = 0;
 163
 164
 165 // drawing
 166 // -------
 167
 168 wxFont wxOwnerDrawn::GetFontToUse() const
 169 {
 170     wxFont font = m_font;
 171     if ( !font.Ok() )
 172     {
 173         if ( IsMenuItem() )
 174             font = *wxMSWSystemMenuFontModule::ms_systemMenuFont;
 175
 176         if ( !font.Ok() )
 177             font = *wxNORMAL_FONT;
 178     }
 179
 180     return font;
 181 }
 182
 183 // get size of the item
 184 // The item size includes the menu string, the accel string,
 185 // the bitmap and size for a submenu expansion arrow...
 186 bool wxOwnerDrawn::OnMeasureItem(size_t *pwidth, size_t *pheight)
 187 {
 188     if ( IsOwnerDrawn() )
 189     {
 190         wxMemoryDC dc;
 191
 192         wxString str = wxStripMenuCodes(m_strName);
 193
 194         // if we have a valid accel string, then pad out
 195         // the menu string so that the menu and accel string are not
 196         // placed on top of each other.
 197         if ( !m_strAccel.empty() )
 198         {
 199             str.Pad(str.Length()%8);
 200             str += m_strAccel;
 201         }
 202
 203         dc.SetFont(GetFontToUse());
 204
 205         dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
 206
 207         // add space at the end of the menu for the submenu expansion arrow
 208         // this will also allow offsetting the accel string from the right edge
 209         *pwidth += GetMarginWidth() + 16;
 210     }
 211     else // don't draw the text, just the bitmap (if any)
 212     {
 213         *pwidth =
 214         *pheight = 0;
 215     }
 216
 217     // increase size to accommodate bigger bitmaps if necessary
 218     if (m_bmpChecked.Ok())
 219     {
 220         // Is BMP height larger then text height?
 221         size_t adjustedHeight = m_bmpChecked.GetHeight() +
 222                                   2*wxSystemSettings::GetMetric(wxSYS_EDGE_Y);
 223         if (*pheight < adjustedHeight)
 224             *pheight = adjustedHeight;
 225
 226         const size_t widthBmp = m_bmpChecked.GetWidth();
 227         if ( IsOwnerDrawn() )
 228         {
 229             // widen the margin to fit the bitmap if necessary
 230             if ((size_t)GetMarginWidth() < widthBmp)
 231                 SetMarginWidth(widthBmp);
 232         }
 233         else // we must allocate enough space for the bitmap
 234         {
 235             *pwidth += widthBmp;
 236         }
 237     }
 238
 239     // add a 4-pixel separator, otherwise menus look cluttered
 240     *pwidth += 4;
 241
 242     // make sure that this item is at least as tall as the system menu height
 243     if ( *pheight < m_nMinHeight )
 244       *pheight = m_nMinHeight;
 245
 246     // remember height for use in OnDrawItem
 247     m_nHeight = *pheight;
 248
 249     return true;
 250 }
 251
 252 // draw the item
 253 bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
 254                               const wxRect& rc,
 255                               wxODAction act,
 256                               wxODStatus st)
 257 {
 258   // we do nothing on focus change
 259   if ( act == wxODFocusChanged )
 260     return true;
 261
 262
 263   // this flag determines whether or not an edge will
 264   // be drawn around the bitmap. In most "windows classic"
 265   // applications, a 1-pixel highlight edge is drawn around
 266   // the bitmap of an item when it is selected.  However,
 267   // with the new "luna" theme, no edge is drawn around
 268   // the bitmap because the background is white (this applies
 269   // only to "non-XP style" menus w/ bitmaps --
 270   // see IE 6 menus for an example)
 271
 272   bool draw_bitmap_edge = true;
 273
 274   // set the colors
 275   // --------------
 276   DWORD colBack, colText;
 277   if ( st & wxODSelected ) {
 278     colBack = GetSysColor(COLOR_HIGHLIGHT);
 279     if (!(st & wxODDisabled))
 280     {
 281         colText = GetSysColor(COLOR_HIGHLIGHTTEXT);
 282     }
 283      else
 284     {
 285         colText = GetSysColor(COLOR_GRAYTEXT);
 286     }
 287   }
 288   else {
 289     // fall back to default colors if none explicitly specified
 290     colBack = m_colBack.Ok() ? wxColourToPalRGB(m_colBack)
 291                              : GetSysColor(COLOR_MENU);
 292     colText = m_colText.Ok() ? wxColourToPalRGB(m_colText)
 293                              : GetSysColor(COLOR_MENUTEXT);
 294   }
 295
 296
 297   // don't draw an edge around the bitmap, if background is white ...
 298   DWORD menu_bg_color = GetSysColor(COLOR_MENU);
 299   if (    ( GetRValue( menu_bg_color ) >= 0xf0 &&
 300             GetGValue( menu_bg_color ) >= 0xf0 &&
 301             GetBValue( menu_bg_color ) >= 0xf0 )
 302     )
 303   {
 304       draw_bitmap_edge = false;
 305   }
 306
 307
 308   HDC hdc = GetHdcOf(dc);
 309   COLORREF colOldText = ::SetTextColor(hdc, colText),
 310            colOldBack = ::SetBkColor(hdc, colBack);
 311
 312   // *2, as in wxSYS_EDGE_Y
 313   int margin = GetMarginWidth() + 2 * wxSystemSettings::GetMetric(wxSYS_EDGE_X);
 314
 315   // select the font and draw the text
 316   // ---------------------------------
 317
 318
 319   // determine where to draw and leave space for a check-mark.
 320   // + 1 pixel to separate the edge from the highlight rectangle
 321   int xText = rc.x + margin + 1;
 322
 323
 324   // using native API because it recognizes '&'
 325   if ( IsOwnerDrawn() )
 326   {
 327     int nPrevMode = SetBkMode(hdc, TRANSPARENT);
 328     AutoHBRUSH hbr(colBack);
 329     SelectInHDC selBrush(hdc, hbr);
 330
 331     RECT rectFill = { rc.GetLeft(), rc.GetTop(),
 332                         rc.GetRight() + 1, rc.GetBottom() + 1 };
 333
 334     if ( (st & wxODSelected) && m_bmpChecked.Ok() && draw_bitmap_edge ) {
 335         // only draw the highlight under the text, not under
 336         // the bitmap or checkmark
 337         rectFill.left = xText;
 338     }
 339
 340     FillRect(hdc, &rectFill, hbr);
 341
 342     // use default font if no font set
 343     wxFont fontToUse = GetFontToUse();
 344     SelectInHDC selFont(hdc, GetHfontOf(fontToUse));
 345
 346     wxString strMenuText = m_strName.BeforeFirst('\t');
 347
 348     xText += 3; // separate text from the highlight rectangle
 349
 350     SIZE sizeRect;
 351     ::GetTextExtentPoint32(hdc, strMenuText.c_str(), strMenuText.Length(), &sizeRect);
 352     ::DrawState(hdc, NULL, NULL,
 353                 (LPARAM)strMenuText.c_str(), strMenuText.length(),
 354                 xText, rc.y + (int) ((rc.GetHeight()-sizeRect.cy)/2.0), // centre text vertically
 355                 rc.GetWidth()-margin, sizeRect.cy,
 356                 DST_PREFIXTEXT |
 357                 (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0) |
 358                 (((st & wxODHidePrefix) && !wxMSWSystemMenuFontModule::ms_showCues) ? 512 : 0)); // 512 == DSS_HIDEPREFIX
 359
 360     // ::SetTextAlign(hdc, TA_RIGHT) doesn't work with DSS_DISABLED or DSS_MONO
 361     // as the last parameter in DrawState() (at least with Windows98). So we have
 362     // to take care of right alignment ourselves.
 363     if ( !m_strAccel.empty() )
 364     {
 365         int accel_width, accel_height;
 366         dc.GetTextExtent(m_strAccel, &accel_width, &accel_height);
 367         // right align accel string with right edge of menu ( offset by the
 368         // margin width )
 369         ::DrawState(hdc, NULL, NULL,
 370                 (LPARAM)m_strAccel.c_str(), m_strAccel.length(),
 371                 rc.GetWidth()-16-accel_width, rc.y+(int) ((rc.GetHeight()-sizeRect.cy)/2.0),
 372                 0, 0,
 373                 DST_TEXT |
 374                 (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0));
 375     }
 376
 377     (void)SetBkMode(hdc, nPrevMode);
 378   }
 379
 380
 381   // draw the bitmap
 382   // ---------------
 383   if ( IsCheckable() && !m_bmpChecked.Ok() ) {
 384     if ( st & wxODChecked ) {
 385       // what goes on: DrawFrameControl creates a b/w mask,
 386       // then we copy it to screen to have right colors
 387
 388         // first create a monochrome bitmap in a memory DC
 389       HDC hdcMem = CreateCompatibleDC(hdc);
 390       HBITMAP hbmpCheck = CreateBitmap(margin, m_nHeight, 1, 1, 0);
 391       SelectObject(hdcMem, hbmpCheck);
 392
 393         // then draw a check mark into it
 394       RECT rect = { 0, 0, margin, m_nHeight };
 395       if ( m_nHeight > 0 )
 396       {
 397         ::DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
 398       }
 399
 400         // finally copy it to screen DC and clean up
 401       BitBlt(hdc, rc.x, rc.y, margin, m_nHeight,
 402              hdcMem, 0, 0, SRCCOPY);
 403
 404       DeleteDC(hdcMem);
 405       DeleteObject(hbmpCheck);
 406     }
 407   }
 408   else {
 409     wxBitmap bmp;
 410
 411     if ( st & wxODDisabled )
 412     {
 413         bmp = GetDisabledBitmap();
 414     }
 415
 416     if ( !bmp.Ok() )
 417     {
 418         // for not checkable bitmaps we should always use unchecked one because
 419         // their checked bitmap is not set
 420         bmp = GetBitmap(!IsCheckable() || (st & wxODChecked));
 421     }
 422
 423     if ( bmp.Ok() ) {
 424       wxMemoryDC dcMem(&dc);
 425       dcMem.SelectObject(bmp);
 426
 427       // center bitmap
 428       int nBmpWidth = bmp.GetWidth(),
 429           nBmpHeight = bmp.GetHeight();
 430
 431       // there should be enough space!
 432       wxASSERT((nBmpWidth <= rc.GetWidth()) && (nBmpHeight <= rc.GetHeight()));
 433
 434       int heightDiff = m_nHeight - nBmpHeight;
 435       dc.Blit(rc.x + (margin - nBmpWidth) / 2,
 436               rc.y + heightDiff / 2,
 437               nBmpWidth, nBmpHeight,
 438               &dcMem, 0, 0, wxCOPY, true /* use mask */);
 439
 440       if ( ( st & wxODSelected ) && !( st & wxODDisabled ) && draw_bitmap_edge ) {
 441           RECT rectBmp = { rc.GetLeft(), rc.GetTop(),
 442                            rc.GetLeft() + margin,
 443                            rc.GetTop() + m_nHeight };
 444           SetBkColor(hdc, colBack);
 445
 446           DrawEdge(hdc, &rectBmp, BDR_RAISEDINNER, BF_RECT);
 447       }
 448     }
 449   }
 450
 451   ::SetTextColor(hdc, colOldText);
 452   ::SetBkColor(hdc, colOldBack);
 453
 454   return true;
 455 }
 456
 457
 458 #endif // wxUSE_OWNER_DRAWN
 459