]> git.saurik.com Git - wxWidgets.git/blob - src/msw/bmpbuttn.cpp
Ensure the tooltip has been created before enabling or setting the delay, or they...
[wxWidgets.git] / src / msw / bmpbuttn.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/bmpbuttn.cpp
3 // Purpose: wxBitmapButton
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 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
14
15 #ifdef __BORLANDC__
16 #pragma hdrstop
17 #endif
18
19 #if wxUSE_BMPBUTTON
20
21 #include "wx/bmpbuttn.h"
22
23 #ifndef WX_PRECOMP
24 #include "wx/log.h"
25 #include "wx/dcmemory.h"
26 #include "wx/image.h"
27 #endif
28
29 #include "wx/msw/private.h"
30 #include "wx/msw/dc.h" // for wxDCTemp
31
32 #include "wx/msw/uxtheme.h"
33
34 #if wxUSE_UXTHEME
35 // no need to include tmschema.h
36 #ifndef BP_PUSHBUTTON
37 #define BP_PUSHBUTTON 1
38
39 #define PBS_NORMAL 1
40 #define PBS_HOT 2
41 #define PBS_PRESSED 3
42 #define PBS_DISABLED 4
43 #define PBS_DEFAULTED 5
44
45 #define TMT_CONTENTMARGINS 3602
46 #endif
47 #endif // wxUSE_UXTHEME
48
49 #ifndef ODS_NOFOCUSRECT
50 #define ODS_NOFOCUSRECT 0x0200
51 #endif
52
53 // ----------------------------------------------------------------------------
54 // macros
55 // ----------------------------------------------------------------------------
56
57 #if wxUSE_EXTENDED_RTTI
58
59 WX_DEFINE_FLAGS( wxBitmapButtonStyle )
60
61 wxBEGIN_FLAGS( wxBitmapButtonStyle )
62 // new style border flags, we put them first to
63 // use them for streaming out
64 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
65 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
66 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
67 wxFLAGS_MEMBER(wxBORDER_RAISED)
68 wxFLAGS_MEMBER(wxBORDER_STATIC)
69 wxFLAGS_MEMBER(wxBORDER_NONE)
70
71 // old style border flags
72 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
73 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
74 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
75 wxFLAGS_MEMBER(wxRAISED_BORDER)
76 wxFLAGS_MEMBER(wxSTATIC_BORDER)
77 wxFLAGS_MEMBER(wxBORDER)
78
79 // standard window styles
80 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
81 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
82 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
83 wxFLAGS_MEMBER(wxWANTS_CHARS)
84 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
85 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
86 wxFLAGS_MEMBER(wxVSCROLL)
87 wxFLAGS_MEMBER(wxHSCROLL)
88
89 wxFLAGS_MEMBER(wxBU_AUTODRAW)
90 wxFLAGS_MEMBER(wxBU_LEFT)
91 wxFLAGS_MEMBER(wxBU_RIGHT)
92 wxFLAGS_MEMBER(wxBU_TOP)
93 wxFLAGS_MEMBER(wxBU_BOTTOM)
94 wxEND_FLAGS( wxBitmapButtonStyle )
95
96 IMPLEMENT_DYNAMIC_CLASS_XTI(wxBitmapButton, wxButton,"wx/bmpbuttn.h")
97
98 wxBEGIN_PROPERTIES_TABLE(wxBitmapButton)
99 wxPROPERTY_FLAGS( WindowStyle , wxBitmapButtonStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
100 wxEND_PROPERTIES_TABLE()
101
102 wxBEGIN_HANDLERS_TABLE(wxBitmapButton)
103 wxEND_HANDLERS_TABLE()
104
105 wxCONSTRUCTOR_5( wxBitmapButton , wxWindow* , Parent , wxWindowID , Id , wxBitmap , Bitmap , wxPoint , Position , wxSize , Size )
106
107 #else
108 IMPLEMENT_DYNAMIC_CLASS(wxBitmapButton, wxButton)
109 #endif
110
111 BEGIN_EVENT_TABLE(wxBitmapButton, wxBitmapButtonBase)
112 EVT_SYS_COLOUR_CHANGED(wxBitmapButton::OnSysColourChanged)
113 EVT_ENTER_WINDOW(wxBitmapButton::OnMouseEnterOrLeave)
114 EVT_LEAVE_WINDOW(wxBitmapButton::OnMouseEnterOrLeave)
115 END_EVENT_TABLE()
116
117 /*
118 TODO PROPERTIES :
119
120 long "style" , wxBU_AUTODRAW
121 bool "default" , 0
122 bitmap "selected" ,
123 bitmap "focus" ,
124 bitmap "disabled" ,
125 */
126
127 bool wxBitmapButton::Create(wxWindow *parent,
128 wxWindowID id,
129 const wxBitmap& bitmap,
130 const wxPoint& pos,
131 const wxSize& size, long style,
132 const wxValidator& wxVALIDATOR_PARAM(validator),
133 const wxString& name)
134 {
135 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
136 return false;
137
138 SetBitmapLabel(bitmap);
139
140 if ( style & wxBU_AUTODRAW )
141 SetMargins(4, 4);
142
143 return MSWCreateControl(_T("BUTTON"), wxEmptyString, pos, size);
144 }
145
146 WXDWORD wxBitmapButton::MSWGetStyle(long style, WXDWORD *exstyle) const
147 {
148 WXDWORD msStyle = wxButton::MSWGetStyle(style, exstyle);
149
150 msStyle |= BS_OWNERDRAW;
151
152 if ( style & wxBU_LEFT )
153 msStyle |= BS_LEFT;
154 if ( style & wxBU_RIGHT )
155 msStyle |= BS_RIGHT;
156 if ( style & wxBU_TOP )
157 msStyle |= BS_TOP;
158 if ( style & wxBU_BOTTOM )
159 msStyle |= BS_BOTTOM;
160
161 return msStyle;
162 }
163
164 bool wxBitmapButton::SetBackgroundColour(const wxColour& colour)
165 {
166 if ( !wxBitmapButtonBase::SetBackgroundColour(colour) )
167 {
168 // didn't change
169 return false;
170 }
171
172 // invalidate the brush, it will be recreated the next time it's needed
173 m_brushDisabled = wxNullBrush;
174
175 return true;
176 }
177
178 void wxBitmapButton::OnSysColourChanged(wxSysColourChangedEvent& event)
179 {
180 m_brushDisabled = wxNullBrush;
181
182 if ( !IsEnabled() )
183 {
184 // this change affects our current state
185 Refresh();
186 }
187
188 event.Skip();
189 }
190
191 void wxBitmapButton::OnMouseEnterOrLeave(wxMouseEvent& event)
192 {
193 if ( IsEnabled() && m_bmpHover.Ok() )
194 Refresh();
195
196 event.Skip();
197 }
198
199 void wxBitmapButton::SetBitmapLabel(const wxBitmap& bitmap)
200 {
201 #if wxUSE_IMAGE
202 if ( !HasFlag(wxBU_AUTODRAW) && !m_disabledSetByUser && bitmap.IsOk() )
203 {
204 m_bmpDisabled = wxBitmap(bitmap.ConvertToImage().ConvertToGreyscale());
205 }
206 #endif // wxUSE_IMAGE
207
208 wxBitmapButtonBase::SetBitmapLabel(bitmap);
209 }
210
211 void wxBitmapButton::SetBitmapFocus(const wxBitmap& focus)
212 {
213 // if the focus bitmap is specified but hover one isn't, use the focus
214 // bitmap for hovering as well if this is consistent with the current
215 // Windows version look and feel
216 //
217 // rationale: this is compatible with the old wxGTK behaviour and also
218 // makes it much easier to do "the right thing" for all platforms (some of
219 // them, such as Windows XP, have "hot" buttons while others don't)
220 if ( focus.Ok() && !m_hoverSetByUser )
221 m_bmpHover = m_bmpFocus;
222
223 wxBitmapButtonBase::SetBitmapFocus(focus);
224 }
225
226 void wxBitmapButton::SetBitmapDisabled(const wxBitmap& disabled)
227 {
228 if ( disabled.IsOk() )
229 m_disabledSetByUser = true;
230
231 wxBitmapButtonBase::SetBitmapDisabled(disabled);
232 }
233
234 void wxBitmapButton::SetBitmapHover(const wxBitmap& hover)
235 {
236 if ( hover.IsOk() )
237 m_hoverSetByUser = true;
238
239 wxBitmapButtonBase::SetBitmapHover(hover);
240 }
241
242 #if wxUSE_UXTHEME
243 static
244 void MSWDrawXPBackground(wxButton *button, WXDRAWITEMSTRUCT *wxdis)
245 {
246 LPDRAWITEMSTRUCT lpDIS = (LPDRAWITEMSTRUCT)wxdis;
247 HDC hdc = lpDIS->hDC;
248 UINT state = lpDIS->itemState;
249 RECT rectBtn;
250 CopyRect(&rectBtn, &lpDIS->rcItem);
251
252 wxUxThemeHandle theme(button, L"BUTTON");
253 int iState;
254
255 if ( state & ODS_SELECTED )
256 {
257 iState = PBS_PRESSED;
258 }
259 else if ( button->HasCapture() || button->IsMouseInWindow() )
260 {
261 iState = PBS_HOT;
262 }
263 else if ( state & ODS_FOCUS )
264 {
265 iState = PBS_DEFAULTED;
266 }
267 else if ( state & ODS_DISABLED )
268 {
269 iState = PBS_DISABLED;
270 }
271 else
272 {
273 iState = PBS_NORMAL;
274 }
275
276 // draw parent background if needed
277 if ( wxUxThemeEngine::Get()->IsThemeBackgroundPartiallyTransparent(theme,
278 BP_PUSHBUTTON,
279 iState) )
280 {
281 wxUxThemeEngine::Get()->DrawThemeParentBackground(GetHwndOf(button), hdc, &rectBtn);
282 }
283
284 // draw background
285 wxUxThemeEngine::Get()->DrawThemeBackground(theme, hdc, BP_PUSHBUTTON, iState,
286 &rectBtn, NULL);
287
288 // calculate content area margins
289 MARGINS margins;
290 wxUxThemeEngine::Get()->GetThemeMargins(theme, hdc, BP_PUSHBUTTON, iState,
291 TMT_CONTENTMARGINS, &rectBtn, &margins);
292 RECT rectClient;
293 ::CopyRect(&rectClient, &rectBtn);
294 ::InflateRect(&rectClient, -margins.cxLeftWidth, -margins.cyTopHeight);
295
296 // if focused and !nofocus rect
297 if ( (state & ODS_FOCUS) && !(state & ODS_NOFOCUSRECT) )
298 {
299 DrawFocusRect(hdc, &rectClient);
300 }
301
302 if ( button->UseBgCol() )
303 {
304 COLORREF colBg = wxColourToRGB(button->GetBackgroundColour());
305 HBRUSH hbrushBackground = ::CreateSolidBrush(colBg);
306
307 // don't overwrite the focus rect
308 ::InflateRect(&rectClient, -1, -1);
309 FillRect(hdc, &rectClient, hbrushBackground);
310 ::DeleteObject(hbrushBackground);
311 }
312 }
313 #endif // wxUSE_UXTHEME
314
315 // VZ: should be at the very least less than wxDEFAULT_BUTTON_MARGIN
316 #define FOCUS_MARGIN 3
317
318 bool wxBitmapButton::MSWOnDraw(WXDRAWITEMSTRUCT *item)
319 {
320 #ifndef __WXWINCE__
321 long style = GetWindowLong((HWND) GetHWND(), GWL_STYLE);
322 if (style & BS_BITMAP)
323 {
324 // Let default procedure draw the bitmap, which is defined
325 // in the Windows resource.
326 return false;
327 }
328 #endif
329
330 LPDRAWITEMSTRUCT lpDIS = (LPDRAWITEMSTRUCT) item;
331 HDC hDC = lpDIS->hDC;
332 UINT state = lpDIS->itemState;
333 bool isSelected = (state & ODS_SELECTED) != 0;
334 bool autoDraw = (GetWindowStyleFlag() & wxBU_AUTODRAW) != 0;
335
336
337 // choose the bitmap to use depending on the button state
338 wxBitmap *bitmap;
339
340 if ( isSelected && m_bmpSelected.Ok() )
341 bitmap = &m_bmpSelected;
342 else if ( m_bmpHover.Ok() && IsMouseInWindow() )
343 bitmap = &m_bmpHover;
344 else if ((state & ODS_FOCUS) && m_bmpFocus.Ok())
345 bitmap = &m_bmpFocus;
346 else if ((state & ODS_DISABLED) && m_bmpDisabled.Ok())
347 bitmap = &m_bmpDisabled;
348 else
349 bitmap = &m_bmpNormal;
350
351 if ( !bitmap->Ok() )
352 return false;
353
354 // centre the bitmap in the control area
355 int x = lpDIS->rcItem.left;
356 int y = lpDIS->rcItem.top;
357 int width = lpDIS->rcItem.right - x;
358 int height = lpDIS->rcItem.bottom - y;
359 int wBmp = bitmap->GetWidth();
360 int hBmp = bitmap->GetHeight();
361
362 #if wxUSE_UXTHEME
363 if ( autoDraw && wxUxThemeEngine::GetIfActive() )
364 {
365 MSWDrawXPBackground(this, item);
366 wxUxThemeHandle theme(this, L"BUTTON");
367
368 // calculate content area margins
369 // assuming here that each state is the same size
370 MARGINS margins;
371 wxUxThemeEngine::Get()->GetThemeMargins(theme, NULL,
372 BP_PUSHBUTTON, PBS_NORMAL,
373 TMT_CONTENTMARGINS, NULL,
374 &margins);
375 int marginX = margins.cxLeftWidth + 1;
376 int marginY = margins.cyTopHeight + 1;
377 int x1,y1;
378
379 if ( m_windowStyle & wxBU_LEFT )
380 {
381 x1 = x + marginX;
382 }
383 else if ( m_windowStyle & wxBU_RIGHT )
384 {
385 x1 = x + (width - wBmp) - marginX;
386 }
387 else
388 {
389 x1 = x + (width - wBmp) / 2;
390 }
391
392 if ( m_windowStyle & wxBU_TOP )
393 {
394 y1 = y + marginY;
395 }
396 else if ( m_windowStyle & wxBU_BOTTOM )
397 {
398 y1 = y + (height - hBmp) - marginY;
399 }
400 else
401 {
402 y1 = y + (height - hBmp) / 2;
403 }
404
405 // draw the bitmap
406 wxDCTemp dst((WXHDC)hDC);
407 dst.DrawBitmap(*bitmap, x1, y1, true);
408
409 return true;
410 }
411 #endif // wxUSE_UXTHEME
412
413 int x1,y1;
414
415 if(m_windowStyle & wxBU_LEFT)
416 x1 = x + (FOCUS_MARGIN+1);
417 else if(m_windowStyle & wxBU_RIGHT)
418 x1 = x + (width - wBmp) - (FOCUS_MARGIN+1);
419 else
420 x1 = x + (width - wBmp) / 2;
421
422 if(m_windowStyle & wxBU_TOP)
423 y1 = y + (FOCUS_MARGIN+1);
424 else if(m_windowStyle & wxBU_BOTTOM)
425 y1 = y + (height - hBmp) - (FOCUS_MARGIN+1);
426 else
427 y1 = y + (height - hBmp) / 2;
428
429 if ( isSelected && autoDraw )
430 {
431 x1++;
432 y1++;
433 }
434
435 // draw the face, if auto-drawing
436 if ( autoDraw )
437 {
438 DrawFace((WXHDC) hDC,
439 lpDIS->rcItem.left, lpDIS->rcItem.top,
440 lpDIS->rcItem.right, lpDIS->rcItem.bottom,
441 isSelected);
442 }
443
444 // draw the bitmap
445 wxDCTemp dst((WXHDC)hDC);
446 dst.DrawBitmap(*bitmap, x1, y1, true);
447
448 // draw focus / disabled state, if auto-drawing
449 if ( (state & ODS_DISABLED) && autoDraw )
450 {
451 DrawButtonDisable((WXHDC) hDC,
452 lpDIS->rcItem.left, lpDIS->rcItem.top,
453 lpDIS->rcItem.right, lpDIS->rcItem.bottom,
454 true);
455 }
456 else if ( (state & ODS_FOCUS) && autoDraw )
457 {
458 DrawButtonFocus((WXHDC) hDC,
459 lpDIS->rcItem.left,
460 lpDIS->rcItem.top,
461 lpDIS->rcItem.right,
462 lpDIS->rcItem.bottom,
463 isSelected);
464 }
465
466 return true;
467 }
468
469 // GRG Feb/2000, support for bmp buttons with Win95/98 standard LNF
470
471 void wxBitmapButton::DrawFace( WXHDC dc, int left, int top,
472 int right, int bottom, bool sel )
473 {
474 HPEN oldp;
475 HPEN penHiLight;
476 HPEN penLight;
477 HPEN penShadow;
478 HPEN penDkShadow;
479 HBRUSH brushFace;
480
481 // create needed pens and brush
482 penHiLight = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DHILIGHT));
483 penLight = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DLIGHT));
484 penShadow = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DSHADOW));
485 penDkShadow = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DDKSHADOW));
486 brushFace = CreateSolidBrush(GetSysColor(COLOR_BTNFACE));
487
488 // draw the rectangle
489 RECT rect;
490 rect.left = left;
491 rect.right = right;
492 rect.top = top;
493 rect.bottom = bottom;
494 FillRect((HDC) dc, &rect, brushFace);
495
496 // draw the border
497 oldp = (HPEN) SelectObject( (HDC) dc, sel? penDkShadow : penHiLight);
498
499 wxDrawLine((HDC) dc, left, top, right-1, top);
500 wxDrawLine((HDC) dc, left, top+1, left, bottom-1);
501
502 SelectObject( (HDC) dc, sel? penShadow : penLight);
503 wxDrawLine((HDC) dc, left+1, top+1, right-2, top+1);
504 wxDrawLine((HDC) dc, left+1, top+2, left+1, bottom-2);
505
506 SelectObject( (HDC) dc, sel? penLight : penShadow);
507 wxDrawLine((HDC) dc, left+1, bottom-2, right-1, bottom-2);
508 wxDrawLine((HDC) dc, right-2, bottom-3, right-2, top);
509
510 SelectObject( (HDC) dc, sel? penHiLight : penDkShadow);
511 wxDrawLine((HDC) dc, left, bottom-1, right+2, bottom-1);
512 wxDrawLine((HDC) dc, right-1, bottom-2, right-1, top-1);
513
514 // delete allocated resources
515 SelectObject((HDC) dc,oldp);
516 DeleteObject(penHiLight);
517 DeleteObject(penLight);
518 DeleteObject(penShadow);
519 DeleteObject(penDkShadow);
520 DeleteObject(brushFace);
521 }
522
523 void wxBitmapButton::DrawButtonFocus( WXHDC dc, int left, int top, int right,
524 int bottom, bool WXUNUSED(sel) )
525 {
526 RECT rect;
527 rect.left = left;
528 rect.top = top;
529 rect.right = right;
530 rect.bottom = bottom;
531 InflateRect( &rect, - FOCUS_MARGIN, - FOCUS_MARGIN );
532
533 // GRG: the focus rectangle should not move when the button is pushed!
534 /*
535 if ( sel )
536 OffsetRect( &rect, 1, 1 );
537 */
538
539 DrawFocusRect( (HDC) dc, &rect );
540 }
541
542 void
543 wxBitmapButton::DrawButtonDisable( WXHDC dc,
544 int left, int top, int right, int bottom,
545 bool with_marg )
546 {
547 if ( !m_brushDisabled.Ok() )
548 {
549 // draw a bitmap with two black and two background colour pixels
550 wxBitmap bmp(2, 2);
551 wxMemoryDC dc;
552 dc.SelectObject(bmp);
553 dc.SetPen(*wxBLACK_PEN);
554 dc.DrawPoint(0, 0);
555 dc.DrawPoint(1, 1);
556 dc.SetPen(GetBackgroundColour());
557 dc.DrawPoint(0, 1);
558 dc.DrawPoint(1, 0);
559
560 m_brushDisabled = wxBrush(bmp);
561 }
562
563 SelectInHDC selectBrush((HDC)dc, GetHbrushOf(m_brushDisabled));
564
565 // ROP for "dest |= pattern" operation -- as it doesn't have a standard
566 // name, give it our own
567 static const DWORD PATTERNPAINT = 0xFA0089UL;
568
569 if ( with_marg )
570 {
571 left += m_marginX;
572 top += m_marginY;
573 right -= 2 * m_marginX;
574 bottom -= 2 * m_marginY;
575 }
576
577 ::PatBlt( (HDC) dc, left, top, right, bottom, PATTERNPAINT);
578 }
579
580 wxSize wxBitmapButton::DoGetBestSize() const
581 {
582 if ( m_bmpNormal.Ok() )
583 {
584 int width = m_bmpNormal.GetWidth(),
585 height = m_bmpNormal.GetHeight();
586 int marginH = 0,
587 marginV = 0;
588
589 #if wxUSE_UXTHEME
590 if ( wxUxThemeEngine::GetIfActive() )
591 {
592 wxUxThemeHandle theme((wxBitmapButton *)this, L"BUTTON");
593
594 MARGINS margins;
595 wxUxThemeEngine::Get()->GetThemeMargins(theme, NULL,
596 BP_PUSHBUTTON, PBS_NORMAL,
597 TMT_CONTENTMARGINS, NULL,
598 &margins);
599
600 // XP doesn't draw themed buttons correctly when the client area is
601 // smaller than 8x8 - enforce this minimum size for small bitmaps
602 if ( width < 8 )
603 width = 8;
604 if ( height < 8 )
605 height = 8;
606
607 // don't add margins for the borderless buttons, they don't need
608 // them and it just makes them appear larger than needed
609 if ( !HasFlag(wxBORDER_NONE) )
610 {
611 // we need 2 extra pixels for the focus rectangle, without them
612 // it's overwritten by the bitmap itself
613 marginH = margins.cxLeftWidth + margins.cxRightWidth + 2;
614 marginV = margins.cyTopHeight + margins.cyBottomHeight + 2;
615 }
616 }
617 else
618 #endif // wxUSE_UXTHEME
619 {
620 if ( !HasFlag(wxBORDER_NONE) )
621 {
622 marginH = 2*m_marginX;
623 marginV = 2*m_marginY;
624 }
625 }
626
627 wxSize best(width + marginH, height + marginV);
628 CacheBestSize(best);
629 return best;
630 }
631
632 // no idea what our best size should be, defer to the base class
633 return wxBitmapButtonBase::DoGetBestSize();
634 }
635
636 #endif // wxUSE_BMPBUTTON