]> git.saurik.com Git - wxWidgets.git/blob - src/msw/ownerdrw.cpp
corrected misleading comment about DllGetVersion()
[wxWidgets.git] / 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 // VC++ 6 gives a warning here:
107 //
108 // return type for 'OwnerDrawnSet_wxImplementation_HashTable::iterator::
109 // operator ->' is 'class wxOwnerDrawn ** ' (ie; not a UDT or reference to
110 // a UDT. Will produce errors if applied using infix notation.
111 //
112 // shut it down
113 #ifdef __VISUALC__
114 #if __VISUALC__ <= 1300
115 #pragma warning(push)
116 #pragma warning(disable: 4284)
117 #define POP_WARNINGS
118 #endif
119 #endif
120
121 #include "wx/hashset.h"
122 WX_DECLARE_HASH_SET(wxOwnerDrawn*, wxPointerHash, wxPointerEqual, OwnerDrawnSet);
123
124 #ifdef POP_WARNINGS
125 #pragma warning(pop)
126 #endif
127
128 static OwnerDrawnSet gs_menuItems;
129
130 // ============================================================================
131 // implementation of wxOwnerDrawn class
132 // ============================================================================
133
134 // ctor
135 // ----
136 wxOwnerDrawn::wxOwnerDrawn(const wxString& str,
137 bool bCheckable,
138 bool bMenuItem)
139 : m_strName(str)
140 {
141 if (ms_nDefaultMarginWidth == 0)
142 {
143 ms_nDefaultMarginWidth = ::GetSystemMetrics(SM_CXMENUCHECK) +
144 wxSystemSettings::GetMetric(wxSYS_EDGE_X);
145 ms_nLastMarginWidth = ms_nDefaultMarginWidth;
146 }
147
148 m_bCheckable = bCheckable;
149 m_bOwnerDrawn = false;
150 m_nHeight = 0;
151 m_nMarginWidth = ms_nLastMarginWidth;
152 m_nMinHeight = wxMSWSystemMenuFontModule::ms_systemMenuHeight;
153
154 m_bmpDisabled = wxNullBitmap;
155
156 // TODO: we can't add new m_isMenuItem field in 2.6, so we use this hack
157 // with the map, but do add m_isMenuItem in 2.7
158 if ( bMenuItem )
159 {
160 gs_menuItems.insert(this);
161 }
162 }
163
164 wxOwnerDrawn::~wxOwnerDrawn()
165 {
166 // TODO: remove this in 2.7
167 gs_menuItems.erase(this);
168 }
169
170 bool wxOwnerDrawn::IsMenuItem() const
171 {
172 // TODO: in 2.7, replace this with simple "return m_isMenuItem"
173 return gs_menuItems.count(this) == 1;
174 }
175
176
177 // these items will be set during the first invocation of the c'tor,
178 // because the values will be determined by checking the system settings,
179 // which is a chunk of code
180 size_t wxOwnerDrawn::ms_nDefaultMarginWidth = 0;
181 size_t wxOwnerDrawn::ms_nLastMarginWidth = 0;
182
183
184 // drawing
185 // -------
186
187 wxFont wxOwnerDrawn::GetFontToUse() const
188 {
189 wxFont font = m_font;
190 if ( !font.Ok() )
191 {
192 if ( IsMenuItem() )
193 font = *wxMSWSystemMenuFontModule::ms_systemMenuFont;
194
195 if ( !font.Ok() )
196 font = *wxNORMAL_FONT;
197 }
198
199 return font;
200 }
201
202 // get size of the item
203 // The item size includes the menu string, the accel string,
204 // the bitmap and size for a submenu expansion arrow...
205 bool wxOwnerDrawn::OnMeasureItem(size_t *pwidth, size_t *pheight)
206 {
207 if ( IsOwnerDrawn() )
208 {
209 wxMemoryDC dc;
210
211 wxString str = wxStripMenuCodes(m_strName);
212
213 // if we have a valid accel string, then pad out
214 // the menu string so that the menu and accel string are not
215 // placed on top of each other.
216 if ( !m_strAccel.empty() )
217 {
218 str.Pad(str.Length()%8);
219 str += m_strAccel;
220 }
221
222 dc.SetFont(GetFontToUse());
223
224 dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
225
226 // add space at the end of the menu for the submenu expansion arrow
227 // this will also allow offsetting the accel string from the right edge
228 *pwidth += GetMarginWidth() + 16;
229 }
230 else // don't draw the text, just the bitmap (if any)
231 {
232 *pwidth =
233 *pheight = 0;
234 }
235
236 // increase size to accommodate bigger bitmaps if necessary
237 if (m_bmpChecked.Ok())
238 {
239 // Is BMP height larger then text height?
240 size_t adjustedHeight = m_bmpChecked.GetHeight() +
241 2*wxSystemSettings::GetMetric(wxSYS_EDGE_Y);
242 if (*pheight < adjustedHeight)
243 *pheight = adjustedHeight;
244
245 const size_t widthBmp = m_bmpChecked.GetWidth();
246 if ( IsOwnerDrawn() )
247 {
248 // widen the margin to fit the bitmap if necessary
249 if ((size_t)GetMarginWidth() < widthBmp)
250 SetMarginWidth(widthBmp);
251 }
252 else // we must allocate enough space for the bitmap
253 {
254 *pwidth += widthBmp;
255 }
256 }
257
258 // add a 4-pixel separator, otherwise menus look cluttered
259 *pwidth += 4;
260
261 // make sure that this item is at least as tall as the system menu height
262 if ( *pheight < m_nMinHeight )
263 *pheight = m_nMinHeight;
264
265 // remember height for use in OnDrawItem
266 m_nHeight = *pheight;
267
268 return true;
269 }
270
271 // draw the item
272 bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
273 const wxRect& rc,
274 wxODAction act,
275 wxODStatus st)
276 {
277 // we do nothing on focus change
278 if ( act == wxODFocusChanged )
279 return true;
280
281
282 // this flag determines whether or not an edge will
283 // be drawn around the bitmap. In most "windows classic"
284 // applications, a 1-pixel highlight edge is drawn around
285 // the bitmap of an item when it is selected. However,
286 // with the new "luna" theme, no edge is drawn around
287 // the bitmap because the background is white (this applies
288 // only to "non-XP style" menus w/ bitmaps --
289 // see IE 6 menus for an example)
290
291 bool draw_bitmap_edge = true;
292
293 // set the colors
294 // --------------
295 DWORD colBack, colText;
296 if ( st & wxODSelected )
297 {
298 colBack = GetSysColor(COLOR_HIGHLIGHT);
299 if (!(st & wxODDisabled))
300 {
301 colText = GetSysColor(COLOR_HIGHLIGHTTEXT);
302 }
303 else
304 {
305 colText = GetSysColor(COLOR_GRAYTEXT);
306 }
307 }
308 else
309 {
310 // fall back to default colors if none explicitly specified
311 colBack = m_colBack.Ok() ? wxColourToPalRGB(m_colBack)
312 : GetSysColor(COLOR_MENU);
313 colText = m_colText.Ok() ? wxColourToPalRGB(m_colText)
314 : GetSysColor(COLOR_MENUTEXT);
315 }
316
317 if ( IsOwnerDrawn() )
318 {
319 // don't draw an edge around the bitmap, if background is white ...
320 DWORD menu_bg_color = GetSysColor(COLOR_MENU);
321 if ( ( GetRValue( menu_bg_color ) >= 0xf0 &&
322 GetGValue( menu_bg_color ) >= 0xf0 &&
323 GetBValue( menu_bg_color ) >= 0xf0 )
324 )
325 {
326 draw_bitmap_edge = false;
327 }
328 }
329 else // edge doesn't look well with default Windows drawing
330 {
331 draw_bitmap_edge = false;
332 }
333
334
335 HDC hdc = GetHdcOf(dc);
336 COLORREF colOldText = ::SetTextColor(hdc, colText),
337 colOldBack = ::SetBkColor(hdc, colBack);
338
339 // *2, as in wxSYS_EDGE_Y
340 int margin = GetMarginWidth() + 2 * wxSystemSettings::GetMetric(wxSYS_EDGE_X);
341
342 // select the font and draw the text
343 // ---------------------------------
344
345
346 // determine where to draw and leave space for a check-mark.
347 // + 1 pixel to separate the edge from the highlight rectangle
348 int xText = rc.x + margin + 1;
349
350
351 // using native API because it recognizes '&'
352 if ( IsOwnerDrawn() )
353 {
354 int nPrevMode = SetBkMode(hdc, TRANSPARENT);
355 AutoHBRUSH hbr(colBack);
356 SelectInHDC selBrush(hdc, hbr);
357
358 RECT rectFill = { rc.GetLeft(), rc.GetTop(),
359 rc.GetRight() + 1, rc.GetBottom() + 1 };
360
361 if ( (st & wxODSelected) && m_bmpChecked.Ok() && draw_bitmap_edge )
362 {
363 // only draw the highlight under the text, not under
364 // the bitmap or checkmark
365 rectFill.left = xText;
366 }
367
368 FillRect(hdc, &rectFill, hbr);
369
370 // use default font if no font set
371 wxFont fontToUse = GetFontToUse();
372 SelectInHDC selFont(hdc, GetHfontOf(fontToUse));
373
374 wxString strMenuText = m_strName.BeforeFirst('\t');
375
376 xText += 3; // separate text from the highlight rectangle
377
378 SIZE sizeRect;
379 ::GetTextExtentPoint32(hdc, strMenuText.c_str(), strMenuText.Length(), &sizeRect);
380 ::DrawState(hdc, NULL, NULL,
381 (LPARAM)strMenuText.c_str(), strMenuText.length(),
382 xText, rc.y + (int) ((rc.GetHeight()-sizeRect.cy)/2.0), // centre text vertically
383 rc.GetWidth()-margin, sizeRect.cy,
384 DST_PREFIXTEXT |
385 (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0) |
386 (((st & wxODHidePrefix) && !wxMSWSystemMenuFontModule::ms_showCues) ? 512 : 0)); // 512 == DSS_HIDEPREFIX
387
388 // ::SetTextAlign(hdc, TA_RIGHT) doesn't work with DSS_DISABLED or DSS_MONO
389 // as the last parameter in DrawState() (at least with Windows98). So we have
390 // to take care of right alignment ourselves.
391 if ( !m_strAccel.empty() )
392 {
393 int accel_width, accel_height;
394 dc.GetTextExtent(m_strAccel, &accel_width, &accel_height);
395 // right align accel string with right edge of menu ( offset by the
396 // margin width )
397 ::DrawState(hdc, NULL, NULL,
398 (LPARAM)m_strAccel.c_str(), m_strAccel.length(),
399 rc.GetWidth()-16-accel_width, rc.y+(int) ((rc.GetHeight()-sizeRect.cy)/2.0),
400 0, 0,
401 DST_TEXT |
402 (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0));
403 }
404
405 (void)SetBkMode(hdc, nPrevMode);
406 }
407
408
409 // draw the bitmap
410 // ---------------
411 if ( IsCheckable() && !m_bmpChecked.Ok() )
412 {
413 if ( st & wxODChecked )
414 {
415 // what goes on: DrawFrameControl creates a b/w mask,
416 // then we copy it to screen to have right colors
417
418 // first create a monochrome bitmap in a memory DC
419 HDC hdcMem = CreateCompatibleDC(hdc);
420 HBITMAP hbmpCheck = CreateBitmap(margin, m_nHeight, 1, 1, 0);
421 SelectObject(hdcMem, hbmpCheck);
422
423 // then draw a check mark into it
424 RECT rect = { 0, 0, margin, m_nHeight };
425 if ( m_nHeight > 0 )
426 {
427 ::DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
428 }
429
430 // finally copy it to screen DC and clean up
431 BitBlt(hdc, rc.x, rc.y, margin, m_nHeight, hdcMem, 0, 0, SRCCOPY);
432
433 DeleteDC(hdcMem);
434 DeleteObject(hbmpCheck);
435 }
436 }
437 else
438 {
439 wxBitmap bmp;
440
441 if ( st & wxODDisabled )
442 {
443 bmp = GetDisabledBitmap();
444 }
445
446 if ( !bmp.Ok() )
447 {
448 // for not checkable bitmaps we should always use unchecked one because
449 // their checked bitmap is not set
450 bmp = GetBitmap(!IsCheckable() || (st & wxODChecked));
451 }
452
453 if ( bmp.Ok() )
454 {
455 wxMemoryDC dcMem(&dc);
456 dcMem.SelectObject(bmp);
457
458 // center bitmap
459 int nBmpWidth = bmp.GetWidth(),
460 nBmpHeight = bmp.GetHeight();
461
462 // there should be enough space!
463 wxASSERT((nBmpWidth <= rc.GetWidth()) && (nBmpHeight <= rc.GetHeight()));
464
465 int heightDiff = m_nHeight - nBmpHeight;
466 dc.Blit(rc.x + (margin - nBmpWidth) / 2,
467 rc.y + heightDiff / 2,
468 nBmpWidth, nBmpHeight,
469 &dcMem, 0, 0, wxCOPY, true /* use mask */);
470
471 if ( ( st & wxODSelected ) && !( st & wxODDisabled ) && draw_bitmap_edge )
472 {
473 RECT rectBmp = { rc.GetLeft(), rc.GetTop(),
474 rc.GetLeft() + margin,
475 rc.GetTop() + m_nHeight };
476 SetBkColor(hdc, colBack);
477
478 DrawEdge(hdc, &rectBmp, BDR_RAISEDINNER, BF_RECT);
479 }
480 }
481 }
482
483 ::SetTextColor(hdc, colOldText);
484 ::SetBkColor(hdc, colOldBack);
485
486 return true;
487 }
488
489
490 #endif // wxUSE_OWNER_DRAWN
491