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/msw/private.h"
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
49 #if wxUSE_EXTENDED_RTTI
51 WX_DEFINE_FLAGS( wxButtonStyle
)
53 wxBEGIN_FLAGS( wxButtonStyle
)
54 // new style border flags, we put them first to
55 // use them for streaming out
56 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
57 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
58 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
59 wxFLAGS_MEMBER(wxBORDER_RAISED
)
60 wxFLAGS_MEMBER(wxBORDER_STATIC
)
61 wxFLAGS_MEMBER(wxBORDER_NONE
)
63 // old style border flags
64 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
65 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
66 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
67 wxFLAGS_MEMBER(wxRAISED_BORDER
)
68 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
69 wxFLAGS_MEMBER(wxBORDER
)
71 // standard window styles
72 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
73 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
74 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
75 wxFLAGS_MEMBER(wxWANTS_CHARS
)
76 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
77 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
78 wxFLAGS_MEMBER(wxVSCROLL
)
79 wxFLAGS_MEMBER(wxHSCROLL
)
81 wxFLAGS_MEMBER(wxBU_LEFT
)
82 wxFLAGS_MEMBER(wxBU_RIGHT
)
83 wxFLAGS_MEMBER(wxBU_TOP
)
84 wxFLAGS_MEMBER(wxBU_BOTTOM
)
85 wxFLAGS_MEMBER(wxBU_EXACTFIT
)
86 wxEND_FLAGS( wxButtonStyle
)
88 IMPLEMENT_DYNAMIC_CLASS_XTI(wxButton
, wxControl
,"wx/button.h")
90 wxBEGIN_PROPERTIES_TABLE(wxButton
)
91 wxEVENT_PROPERTY( Click
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
)
93 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
94 wxPROPERTY( Label
, wxString
, SetLabel
, GetLabel
, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
96 wxPROPERTY_FLAGS( WindowStyle
, wxButtonStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
98 wxEND_PROPERTIES_TABLE()
100 wxBEGIN_HANDLERS_TABLE(wxButton
)
101 wxEND_HANDLERS_TABLE()
103 wxCONSTRUCTOR_6( wxButton
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Label
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
107 IMPLEMENT_DYNAMIC_CLASS(wxButton
, wxControl
)
110 // this macro tries to adjust the default button height to a reasonable value
111 // using the char height as the base
112 #define BUTTON_HEIGHT_FROM_CHAR_HEIGHT(cy) (11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)/10)
114 // ============================================================================
116 // ============================================================================
118 // ----------------------------------------------------------------------------
119 // creation/destruction
120 // ----------------------------------------------------------------------------
122 bool wxButton::Create(wxWindow
*parent
,
124 const wxString
& label
,
128 const wxValidator
& validator
,
129 const wxString
& name
)
131 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
135 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
138 // if the label contains several lines we must explicitly tell the button
139 // about it or it wouldn't draw it correctly ("\n"s would just appear as
142 // NB: we do it here and not in MSWGetStyle() because we need the label
143 // value and m_label is not set yet when MSWGetStyle() is called;
144 // besides changing BS_MULTILINE during run-time is pointless anyhow
145 if ( label
.find(_T('\n')) != wxString::npos
)
147 msStyle
|= BS_MULTILINE
;
151 return MSWCreateControl(_T("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
154 wxButton::~wxButton()
158 // ----------------------------------------------------------------------------
160 // ----------------------------------------------------------------------------
162 WXDWORD
wxButton::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
164 // buttons never have an external border, they draw their own one
165 WXDWORD msStyle
= wxControl::MSWGetStyle
167 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
170 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
171 // each other in any resizeable dialog which has more than one button in
173 msStyle
|= WS_CLIPSIBLINGS
;
176 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
177 // and wxBU_RIGHT to get BS_CENTER!
178 if ( style
& wxBU_LEFT
)
180 if ( style
& wxBU_RIGHT
)
182 if ( style
& wxBU_TOP
)
184 if ( style
& wxBU_BOTTOM
)
185 msStyle
|= BS_BOTTOM
;
187 if ( style
& wxNO_BORDER
)
194 // ----------------------------------------------------------------------------
195 // size management including autosizing
196 // ----------------------------------------------------------------------------
198 wxSize
wxButton::DoGetBestSize() const
201 GetTextExtent(wxGetWindowText(GetHWND()), &wBtn
, NULL
);
204 wxGetCharSize(GetHWND(), &wChar
, &hChar
, &GetFont());
206 // add a margin -- the button is wider than just its label
209 // the button height is proportional to the height of the font used
210 int hBtn
= BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar
);
212 // all buttons have at least the standard size unless the user explicitly
213 // wants them to be of smaller size and used wxBU_EXACTFIT style when
214 // creating the button
215 if ( !HasFlag(wxBU_EXACTFIT
) )
217 wxSize sz
= GetDefaultSize();
226 return wxSize(wBtn
, hBtn
);
230 wxSize
wxButtonBase::GetDefaultSize()
232 static wxSize s_sizeBtn
;
234 if ( s_sizeBtn
.x
== 0 )
237 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
239 // the size of a standard button in the dialog units is 50x14,
240 // translate this to pixels
241 // NB1: the multipliers come from the Windows convention
242 // NB2: the extra +1/+2 were needed to get the size be the same as the
243 // size of the buttons in the standard dialog - I don't know how
244 // this happens, but on my system this size is 75x23 in pixels and
245 // 23*8 isn't even divisible by 14... Would be nice to understand
246 // why these constants are needed though!
247 s_sizeBtn
.x
= (50 * (dc
.GetCharWidth() + 1))/4;
248 s_sizeBtn
.y
= ((14 * dc
.GetCharHeight()) + 2)/8;
254 // ----------------------------------------------------------------------------
255 // default button handling
256 // ----------------------------------------------------------------------------
259 "Everything you ever wanted to know about the default buttons" or "Why do we
260 have to do all this?"
262 In MSW the default button should be activated when the user presses Enter
263 and the current control doesn't process Enter itself somehow. This is
264 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
265 Another aspect of "defaultness" is that the default button has different
266 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
267 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
268 be unset if our parent window is not active so it should be unset whenever
269 we lose activation and set back when we regain it.
271 Final complication is that when a button is active, it should be the default
272 one, i.e. pressing Enter on a button always activates it and not another
275 We handle this by maintaining a permanent and a temporary default items in
276 wxControlContainer (both may be NULL). When a button becomes the current
277 control (i.e. gets focus) it sets itself as the temporary default which
278 ensures that it has the right appearance and that Enter will be redirected
279 to it. When the button loses focus, it unsets the temporary default and so
280 the default item will be the permanent default -- that is the default button
281 if any had been set or none otherwise, which is just what we want.
283 NB: all this is quite complicated by now and the worst is that normally
284 it shouldn't be necessary at all as for the normal Windows programs
285 DefWindowProc() and IsDialogMessage() take care of all this
286 automatically -- however in wxWindows programs this doesn't work for
287 nested hierarchies (i.e. a notebook inside a notebook) for unknown
288 reason and so we have to reproduce all this code ourselves. It would be
289 very nice if we could avoid doing it.
292 // set this button as the (permanently) default one in its panel
293 void wxButton::SetDefault()
295 wxWindow
*parent
= GetParent();
297 wxCHECK_RET( parent
, _T("button without parent?") );
299 // set this one as the default button both for wxWindows ...
300 wxWindow
*winOldDefault
= parent
->SetDefaultItem(this);
303 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), FALSE
);
304 SetDefaultStyle(this, TRUE
);
307 // set this button as being currently default
308 void wxButton::SetTmpDefault()
310 wxWindow
*parent
= GetParent();
312 wxCHECK_RET( parent
, _T("button without parent?") );
314 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
315 parent
->SetTmpDefaultItem(this);
317 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), FALSE
);
318 SetDefaultStyle(this, TRUE
);
321 // unset this button as currently default, it may still stay permanent default
322 void wxButton::UnsetTmpDefault()
324 wxWindow
*parent
= GetParent();
326 wxCHECK_RET( parent
, _T("button without parent?") );
328 parent
->SetTmpDefaultItem(NULL
);
330 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
332 SetDefaultStyle(this, FALSE
);
333 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), TRUE
);
338 wxButton::SetDefaultStyle(wxButton
*btn
, bool on
)
340 // we may be called with NULL pointer -- simpler to do the check here than
341 // in the caller which does wxDynamicCast()
345 // first, let DefDlgProc() know about the new default button
348 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
349 // focus at all any more
350 if ( !wxTheApp
->IsActive() )
353 // look for a panel-like window
354 wxWindow
*win
= btn
->GetParent();
355 while ( win
&& !win
->HasFlag(wxTAB_TRAVERSAL
) )
356 win
= win
->GetParent();
360 ::SendMessage(GetHwndOf(win
), DM_SETDEFID
, btn
->GetId(), 0L);
362 // sending DM_SETDEFID also changes the button style to
363 // BS_DEFPUSHBUTTON so there is nothing more to do
367 // then also change the style as needed
368 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
369 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
371 // don't do it with the owner drawn buttons because it will
372 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
373 // BS_DEFPUSHBUTTON != 0)!
374 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
376 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
377 on
? style
| BS_DEFPUSHBUTTON
378 : style
& ~BS_DEFPUSHBUTTON
,
383 // redraw the button - it will notice itself that it's
384 // [not] the default one [any longer]
388 //else: already has correct style
391 // ----------------------------------------------------------------------------
393 // ----------------------------------------------------------------------------
395 bool wxButton::SendClickEvent()
397 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
398 event
.SetEventObject(this);
400 return ProcessCommand(event
);
403 void wxButton::Command(wxCommandEvent
& event
)
405 ProcessCommand(event
);
408 // ----------------------------------------------------------------------------
409 // event/message handlers
410 // ----------------------------------------------------------------------------
412 bool wxButton::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
414 bool processed
= FALSE
;
417 // NOTE: Apparently older versions (NT 4?) of the common controls send
418 // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
419 // buttons, so in order to send two EVET_BUTTON events we should
420 // catch both types. Currently (Feb 2003) up-to-date versions of
421 // win98, win2k and winXP all send two BN_CLICKED messages for
422 // all button types, so we don't catch BN_DOUBLECLICKED anymore
423 // in order to not get 3 EVT_BUTTON events. If this is a problem
424 // then we need to figure out which version of the comctl32 changed
425 // this behaviour and test for it.
427 case 1: // message came from an accelerator
428 case BN_CLICKED
: // normal buttons send this
429 processed
= SendClickEvent();
436 long wxButton::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
438 // when we receive focus, we want to temporary become the default button in
439 // our parent panel so that pressing "Enter" would activate us -- and when
440 // losing it we should restore the previous default button as well
441 if ( nMsg
== WM_SETFOCUS
)
445 // let the default processing take place too
447 else if ( nMsg
== WM_KILLFOCUS
)
451 else if ( nMsg
== WM_LBUTTONDBLCLK
)
453 // emulate a click event to force an owner-drawn button to change its
454 // appearance - without this, it won't do it
455 (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
457 // and continue with processing the message normally as well
460 // let the base class do all real processing
461 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
464 // ----------------------------------------------------------------------------
465 // owner-drawn buttons support
466 // ----------------------------------------------------------------------------
472 static void DrawButtonText(HDC hdc
,
474 const wxString
& text
,
477 COLORREF colOld
= SetTextColor(hdc
, col
);
478 int modeOld
= SetBkMode(hdc
, TRANSPARENT
);
480 // Note: we must have DT_SINGLELINE for DT_VCENTER to work.
481 ::DrawText(hdc
, text
, text
.length(), pRect
, DT_SINGLELINE
| DT_CENTER
| DT_VCENTER
);
483 SetBkMode(hdc
, modeOld
);
484 SetTextColor(hdc
, colOld
);
487 static void DrawRect(HDC hdc
, const RECT
& r
)
489 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
490 wxDrawLine(hdc
, r
.right
, r
.top
, r
.right
, r
.bottom
);
491 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.left
, r
.bottom
);
492 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.left
, r
.top
);
495 void wxButton::MakeOwnerDrawn()
497 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
498 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
501 style
|= BS_OWNERDRAW
;
502 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
506 bool wxButton::SetBackgroundColour(const wxColour
&colour
)
508 if ( !wxControl::SetBackgroundColour(colour
) )
521 bool wxButton::SetForegroundColour(const wxColour
&colour
)
523 if ( !wxControl::SetForegroundColour(colour
) )
537 The button frame looks like this normally:
540 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
541 WH GB H = light grey (LIGHT)
542 WH GB G = dark grey (SHADOW)
543 WH GB B = black (DKSHADOW)
548 When the button is selected, the button becomes like this (the total button
549 size doesn't change):
560 When the button is pushed (while selected) it is like:
572 static void DrawButtonFrame(HDC hdc
, const RECT
& rectBtn
,
573 bool selected
, bool pushed
)
576 CopyRect(&r
, &rectBtn
);
578 HPEN hpenBlack
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DDKSHADOW
)),
579 hpenGrey
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DSHADOW
)),
580 hpenLightGr
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DLIGHT
)),
581 hpenWhite
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DHILIGHT
));
583 HPEN hpenOld
= (HPEN
)SelectObject(hdc
, hpenBlack
);
592 (void)SelectObject(hdc
, hpenGrey
);
593 InflateRect(&r
, -1, -1);
603 InflateRect(&r
, -1, -1);
606 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.right
, r
.bottom
);
607 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.right
, r
.top
- 1);
609 (void)SelectObject(hdc
, hpenWhite
);
610 wxDrawLine(hdc
, r
.left
, r
.bottom
- 1, r
.left
, r
.top
);
611 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
613 (void)SelectObject(hdc
, hpenLightGr
);
614 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 2, r
.left
+ 1, r
.top
+ 1);
615 wxDrawLine(hdc
, r
.left
+ 1, r
.top
+ 1, r
.right
- 1, r
.top
+ 1);
617 (void)SelectObject(hdc
, hpenGrey
);
618 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 1, r
.right
- 1, r
.bottom
- 1);
619 wxDrawLine(hdc
, r
.right
- 1, r
.bottom
- 1, r
.right
- 1, r
.top
);
622 (void)SelectObject(hdc
, hpenOld
);
623 DeleteObject(hpenWhite
);
624 DeleteObject(hpenLightGr
);
625 DeleteObject(hpenGrey
);
626 DeleteObject(hpenBlack
);
629 bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
631 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
634 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
636 COLORREF colBg
= wxColourToRGB(GetBackgroundColour()),
637 colFg
= wxColourToRGB(GetForegroundColour());
639 HDC hdc
= lpDIS
->hDC
;
640 UINT state
= lpDIS
->itemState
;
642 // first, draw the background
643 HBRUSH hbrushBackground
= ::CreateSolidBrush(colBg
);
645 FillRect(hdc
, &rectBtn
, hbrushBackground
);
647 // draw the border for the current state
648 bool selected
= (state
& ODS_SELECTED
) != 0;
651 wxPanel
*panel
= wxDynamicCast(GetParent(), wxPanel
);
654 selected
= panel
->GetDefaultItem() == this;
657 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
659 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
661 // draw the focus rect if needed
662 if ( state
& ODS_FOCUS
)
665 CopyRect(&rectFocus
, &rectBtn
);
667 // I don't know where does this constant come from, but this is how
668 // Windows draws them
669 InflateRect(&rectFocus
, -4, -4);
671 DrawFocusRect(hdc
, &rectFocus
);
676 // the label is shifted by 1 pixel to create "pushed" effect
677 OffsetRect(&rectBtn
, 1, 1);
680 DrawButtonText(hdc
, &rectBtn
, GetLabel(),
681 state
& ODS_DISABLED
? GetSysColor(COLOR_GRAYTEXT
)
684 ::DeleteObject(hbrushBackground
);
691 #endif // wxUSE_BUTTON