1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/button.cpp
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "button.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
35 #include "wx/button.h"
38 #include "wx/bmpbuttn.h"
39 #include "wx/settings.h"
40 #include "wx/dcscreen.h"
43 #include "wx/stockitem.h"
44 #include "wx/tokenzr.h"
45 #include "wx/msw/private.h"
47 // ----------------------------------------------------------------------------
49 // ----------------------------------------------------------------------------
51 #if wxUSE_EXTENDED_RTTI
53 WX_DEFINE_FLAGS( wxButtonStyle
)
55 wxBEGIN_FLAGS( wxButtonStyle
)
56 // new style border flags, we put them first to
57 // use them for streaming out
58 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
59 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
60 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
61 wxFLAGS_MEMBER(wxBORDER_RAISED
)
62 wxFLAGS_MEMBER(wxBORDER_STATIC
)
63 wxFLAGS_MEMBER(wxBORDER_NONE
)
65 // old style border flags
66 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
67 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
68 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
69 wxFLAGS_MEMBER(wxRAISED_BORDER
)
70 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
71 wxFLAGS_MEMBER(wxBORDER
)
73 // standard window styles
74 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
75 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
76 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
77 wxFLAGS_MEMBER(wxWANTS_CHARS
)
78 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
79 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
80 wxFLAGS_MEMBER(wxVSCROLL
)
81 wxFLAGS_MEMBER(wxHSCROLL
)
83 wxFLAGS_MEMBER(wxBU_LEFT
)
84 wxFLAGS_MEMBER(wxBU_RIGHT
)
85 wxFLAGS_MEMBER(wxBU_TOP
)
86 wxFLAGS_MEMBER(wxBU_BOTTOM
)
87 wxFLAGS_MEMBER(wxBU_EXACTFIT
)
88 wxEND_FLAGS( wxButtonStyle
)
90 IMPLEMENT_DYNAMIC_CLASS_XTI(wxButton
, wxControl
,"wx/button.h")
92 wxBEGIN_PROPERTIES_TABLE(wxButton
)
93 wxEVENT_PROPERTY( Click
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
)
95 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
96 wxPROPERTY( Label
, wxString
, SetLabel
, GetLabel
, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
98 wxPROPERTY_FLAGS( WindowStyle
, wxButtonStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
100 wxEND_PROPERTIES_TABLE()
102 wxBEGIN_HANDLERS_TABLE(wxButton
)
103 wxEND_HANDLERS_TABLE()
105 wxCONSTRUCTOR_6( wxButton
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Label
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
109 IMPLEMENT_DYNAMIC_CLASS(wxButton
, wxControl
)
112 // this macro tries to adjust the default button height to a reasonable value
113 // using the char height as the base
114 #define BUTTON_HEIGHT_FROM_CHAR_HEIGHT(cy) (11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)/10)
116 // ============================================================================
118 // ============================================================================
120 // ----------------------------------------------------------------------------
121 // creation/destruction
122 // ----------------------------------------------------------------------------
124 bool wxButton::Create(wxWindow
*parent
,
130 const wxValidator
& validator
,
131 const wxString
& name
)
134 if (label
.empty() && wxIsStockID(id
))
136 // On Windows, some buttons aren't supposed to have
137 // mnemonics, so strip them out.
139 label
= wxGetStockLabel(id
140 #if defined(__WXMSW__) || defined(__WXWINCE__)
148 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
152 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
155 // if the label contains several lines we must explicitly tell the button
156 // about it or it wouldn't draw it correctly ("\n"s would just appear as
159 // NB: we do it here and not in MSWGetStyle() because we need the label
160 // value and m_label is not set yet when MSWGetStyle() is called;
161 // besides changing BS_MULTILINE during run-time is pointless anyhow
162 if ( label
.find(_T('\n')) != wxString::npos
)
164 msStyle
|= BS_MULTILINE
;
168 return MSWCreateControl(_T("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
171 wxButton::~wxButton()
175 // ----------------------------------------------------------------------------
177 // ----------------------------------------------------------------------------
179 WXDWORD
wxButton::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
181 // buttons never have an external border, they draw their own one
182 WXDWORD msStyle
= wxControl::MSWGetStyle
184 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
187 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
188 // each other in any resizeable dialog which has more than one button in
190 msStyle
|= WS_CLIPSIBLINGS
;
193 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
194 // and wxBU_RIGHT to get BS_CENTER!
195 if ( style
& wxBU_LEFT
)
197 if ( style
& wxBU_RIGHT
)
199 if ( style
& wxBU_TOP
)
201 if ( style
& wxBU_BOTTOM
)
202 msStyle
|= BS_BOTTOM
;
205 if ( style
& wxNO_BORDER
)
207 #endif // __WXWINCE__
213 // ----------------------------------------------------------------------------
214 // size management including autosizing
215 // ----------------------------------------------------------------------------
217 wxSize
wxButton::DoGetBestSize() const
219 wxClientDC
dc(wx_const_cast(wxButton
*, this));
220 dc
.SetFont(GetFont());
224 dc
.GetMultiLineTextExtent(GetLabel(), &wBtn
, &hBtn
);
226 // add a margin -- the button is wider than just its label
227 wBtn
+= 3*GetCharWidth();
228 hBtn
= BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hBtn
);
230 // all buttons have at least the standard size unless the user explicitly
231 // wants them to be of smaller size and used wxBU_EXACTFIT style when
232 // creating the button
233 if ( !HasFlag(wxBU_EXACTFIT
) )
235 wxSize sz
= GetDefaultSize();
244 wxSize
best(wBtn
, hBtn
);
250 wxSize
wxButtonBase::GetDefaultSize()
252 static wxSize s_sizeBtn
;
254 if ( s_sizeBtn
.x
== 0 )
257 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
259 // the size of a standard button in the dialog units is 50x14,
260 // translate this to pixels
261 // NB1: the multipliers come from the Windows convention
262 // NB2: the extra +1/+2 were needed to get the size be the same as the
263 // size of the buttons in the standard dialog - I don't know how
264 // this happens, but on my system this size is 75x23 in pixels and
265 // 23*8 isn't even divisible by 14... Would be nice to understand
266 // why these constants are needed though!
267 s_sizeBtn
.x
= (50 * (dc
.GetCharWidth() + 1))/4;
268 s_sizeBtn
.y
= ((14 * dc
.GetCharHeight()) + 2)/8;
274 // ----------------------------------------------------------------------------
275 // default button handling
276 // ----------------------------------------------------------------------------
279 "Everything you ever wanted to know about the default buttons" or "Why do we
280 have to do all this?"
282 In MSW the default button should be activated when the user presses Enter
283 and the current control doesn't process Enter itself somehow. This is
284 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
285 Another aspect of "defaultness" is that the default button has different
286 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
287 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
288 be unset if our parent window is not active so it should be unset whenever
289 we lose activation and set back when we regain it.
291 Final complication is that when a button is active, it should be the default
292 one, i.e. pressing Enter on a button always activates it and not another
295 We handle this by maintaining a permanent and a temporary default items in
296 wxControlContainer (both may be NULL). When a button becomes the current
297 control (i.e. gets focus) it sets itself as the temporary default which
298 ensures that it has the right appearance and that Enter will be redirected
299 to it. When the button loses focus, it unsets the temporary default and so
300 the default item will be the permanent default -- that is the default button
301 if any had been set or none otherwise, which is just what we want.
303 NB: all this is quite complicated by now and the worst is that normally
304 it shouldn't be necessary at all as for the normal Windows programs
305 DefWindowProc() and IsDialogMessage() take care of all this
306 automatically -- however in wxWidgets programs this doesn't work for
307 nested hierarchies (i.e. a notebook inside a notebook) for unknown
308 reason and so we have to reproduce all this code ourselves. It would be
309 very nice if we could avoid doing it.
312 // set this button as the (permanently) default one in its panel
313 void wxButton::SetDefault()
315 wxWindow
*parent
= GetParent();
317 wxCHECK_RET( parent
, _T("button without parent?") );
319 // set this one as the default button both for wxWidgets ...
320 wxWindow
*winOldDefault
= parent
->SetDefaultItem(this);
323 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
324 SetDefaultStyle(this, true);
327 // set this button as being currently default
328 void wxButton::SetTmpDefault()
330 wxWindow
*parent
= GetParent();
332 wxCHECK_RET( parent
, _T("button without parent?") );
334 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
335 parent
->SetTmpDefaultItem(this);
337 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
338 SetDefaultStyle(this, true);
341 // unset this button as currently default, it may still stay permanent default
342 void wxButton::UnsetTmpDefault()
344 wxWindow
*parent
= GetParent();
346 wxCHECK_RET( parent
, _T("button without parent?") );
348 parent
->SetTmpDefaultItem(NULL
);
350 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
352 SetDefaultStyle(this, false);
353 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), true);
358 wxButton::SetDefaultStyle(wxButton
*btn
, bool on
)
360 // we may be called with NULL pointer -- simpler to do the check here than
361 // in the caller which does wxDynamicCast()
365 // first, let DefDlgProc() know about the new default button
368 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
369 // focus at all any more
370 if ( !wxTheApp
->IsActive() )
373 // look for a panel-like window
374 wxWindow
*win
= btn
->GetParent();
375 while ( win
&& !win
->HasFlag(wxTAB_TRAVERSAL
) )
376 win
= win
->GetParent();
380 ::SendMessage(GetHwndOf(win
), DM_SETDEFID
, btn
->GetId(), 0L);
382 // sending DM_SETDEFID also changes the button style to
383 // BS_DEFPUSHBUTTON so there is nothing more to do
387 // then also change the style as needed
388 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
389 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
391 // don't do it with the owner drawn buttons because it will
392 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
393 // BS_DEFPUSHBUTTON != 0)!
394 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
396 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
397 on
? style
| BS_DEFPUSHBUTTON
398 : style
& ~BS_DEFPUSHBUTTON
,
403 // redraw the button - it will notice itself that it's
404 // [not] the default one [any longer]
408 //else: already has correct style
411 // ----------------------------------------------------------------------------
413 // ----------------------------------------------------------------------------
415 bool wxButton::SendClickEvent()
417 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
418 event
.SetEventObject(this);
420 return ProcessCommand(event
);
423 void wxButton::Command(wxCommandEvent
& event
)
425 ProcessCommand(event
);
428 // ----------------------------------------------------------------------------
429 // event/message handlers
430 // ----------------------------------------------------------------------------
432 bool wxButton::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
434 bool processed
= false;
437 // NOTE: Apparently older versions (NT 4?) of the common controls send
438 // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
439 // buttons, so in order to send two EVT_BUTTON events we should
440 // catch both types. Currently (Feb 2003) up-to-date versions of
441 // win98, win2k and winXP all send two BN_CLICKED messages for
442 // all button types, so we don't catch BN_DOUBLECLICKED anymore
443 // in order to not get 3 EVT_BUTTON events. If this is a problem
444 // then we need to figure out which version of the comctl32 changed
445 // this behaviour and test for it.
447 case 1: // message came from an accelerator
448 case BN_CLICKED
: // normal buttons send this
449 processed
= SendClickEvent();
456 WXLRESULT
wxButton::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
458 // when we receive focus, we want to temporarily become the default button in
459 // our parent panel so that pressing "Enter" would activate us -- and when
460 // losing it we should restore the previous default button as well
461 if ( nMsg
== WM_SETFOCUS
)
465 // let the default processing take place too
467 else if ( nMsg
== WM_KILLFOCUS
)
471 else if ( nMsg
== WM_LBUTTONDBLCLK
)
473 // emulate a click event to force an owner-drawn button to change its
474 // appearance - without this, it won't do it
475 (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
477 // and continue with processing the message normally as well
480 // let the base class do all real processing
481 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
484 // ----------------------------------------------------------------------------
485 // owner-drawn buttons support
486 // ----------------------------------------------------------------------------
492 static void DrawButtonText(HDC hdc
,
494 const wxString
& text
,
497 COLORREF colOld
= SetTextColor(hdc
, col
);
498 int modeOld
= SetBkMode(hdc
, TRANSPARENT
);
500 if ( text
.find(_T('\n')) != wxString::npos
)
502 // draw multiline label
504 // first we need to compute its bounding rect
506 ::CopyRect(&rc
, pRect
);
507 ::DrawText(hdc
, text
, text
.length(), &rc
, DT_CENTER
| DT_CALCRECT
);
509 // now center this rect inside the entire button area
510 const LONG w
= rc
.right
- rc
.left
;
511 const LONG h
= rc
.bottom
- rc
.top
;
512 rc
.left
= (pRect
->right
- pRect
->left
)/2 - w
/2;
513 rc
.right
= rc
.left
+w
;
514 rc
.top
= (pRect
->bottom
- pRect
->top
)/2 - h
/2;
515 rc
.bottom
= rc
.top
+h
;
517 ::DrawText(hdc
, text
, text
.length(), &rc
, DT_CENTER
);
519 else // single line label
521 // Note: we must have DT_SINGLELINE for DT_VCENTER to work.
522 ::DrawText(hdc
, text
, text
.length(), pRect
,
523 DT_SINGLELINE
| DT_CENTER
| DT_VCENTER
);
526 SetBkMode(hdc
, modeOld
);
527 SetTextColor(hdc
, colOld
);
530 static void DrawRect(HDC hdc
, const RECT
& r
)
532 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
533 wxDrawLine(hdc
, r
.right
, r
.top
, r
.right
, r
.bottom
);
534 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.left
, r
.bottom
);
535 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.left
, r
.top
);
538 void wxButton::MakeOwnerDrawn()
540 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
541 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
544 style
|= BS_OWNERDRAW
;
545 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
549 bool wxButton::SetBackgroundColour(const wxColour
&colour
)
551 if ( !wxControl::SetBackgroundColour(colour
) )
564 bool wxButton::SetForegroundColour(const wxColour
&colour
)
566 if ( !wxControl::SetForegroundColour(colour
) )
580 The button frame looks like this normally:
583 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
584 WH GB H = light grey (LIGHT)
585 WH GB G = dark grey (SHADOW)
586 WH GB B = black (DKSHADOW)
591 When the button is selected, the button becomes like this (the total button
592 size doesn't change):
603 When the button is pushed (while selected) it is like:
615 static void DrawButtonFrame(HDC hdc
, const RECT
& rectBtn
,
616 bool selected
, bool pushed
)
619 CopyRect(&r
, &rectBtn
);
621 HPEN hpenBlack
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DDKSHADOW
)),
622 hpenGrey
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DSHADOW
)),
623 hpenLightGr
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DLIGHT
)),
624 hpenWhite
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DHILIGHT
));
626 HPEN hpenOld
= (HPEN
)SelectObject(hdc
, hpenBlack
);
635 (void)SelectObject(hdc
, hpenGrey
);
636 ::InflateRect(&r
, -1, -1);
646 ::InflateRect(&r
, -1, -1);
649 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.right
, r
.bottom
);
650 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.right
, r
.top
- 1);
652 (void)SelectObject(hdc
, hpenWhite
);
653 wxDrawLine(hdc
, r
.left
, r
.bottom
- 1, r
.left
, r
.top
);
654 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
656 (void)SelectObject(hdc
, hpenLightGr
);
657 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 2, r
.left
+ 1, r
.top
+ 1);
658 wxDrawLine(hdc
, r
.left
+ 1, r
.top
+ 1, r
.right
- 1, r
.top
+ 1);
660 (void)SelectObject(hdc
, hpenGrey
);
661 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 1, r
.right
- 1, r
.bottom
- 1);
662 wxDrawLine(hdc
, r
.right
- 1, r
.bottom
- 1, r
.right
- 1, r
.top
);
665 (void)SelectObject(hdc
, hpenOld
);
666 DeleteObject(hpenWhite
);
667 DeleteObject(hpenLightGr
);
668 DeleteObject(hpenGrey
);
669 DeleteObject(hpenBlack
);
672 bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
674 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
677 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
679 COLORREF colBg
= wxColourToRGB(GetBackgroundColour()),
680 colFg
= wxColourToRGB(GetForegroundColour());
682 HDC hdc
= lpDIS
->hDC
;
683 UINT state
= lpDIS
->itemState
;
685 // first, draw the background
686 HBRUSH hbrushBackground
= ::CreateSolidBrush(colBg
);
688 FillRect(hdc
, &rectBtn
, hbrushBackground
);
690 // draw the border for the current state
691 bool selected
= (state
& ODS_SELECTED
) != 0;
694 wxPanel
*panel
= wxDynamicCast(GetParent(), wxPanel
);
697 selected
= panel
->GetDefaultItem() == this;
700 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
702 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
704 // draw the focus rect if needed
705 if ( state
& ODS_FOCUS
)
708 CopyRect(&rectFocus
, &rectBtn
);
710 // I don't know where does this constant come from, but this is how
711 // Windows draws them
712 InflateRect(&rectFocus
, -4, -4);
714 DrawFocusRect(hdc
, &rectFocus
);
719 // the label is shifted by 1 pixel to create "pushed" effect
720 OffsetRect(&rectBtn
, 1, 1);
723 DrawButtonText(hdc
, &rectBtn
, GetLabel(),
724 state
& ODS_DISABLED
? GetSysColor(COLOR_GRAYTEXT
)
727 ::DeleteObject(hbrushBackground
);
734 #endif // wxUSE_BUTTON