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 WX_BEGIN_FLAGS( wxButtonStyle
)
54 // new style border flags, we put them first to
55 // use them for streaming out
56 WX_FLAGS_MEMBER(wxBORDER_SIMPLE
)
57 WX_FLAGS_MEMBER(wxBORDER_SUNKEN
)
58 WX_FLAGS_MEMBER(wxBORDER_DOUBLE
)
59 WX_FLAGS_MEMBER(wxBORDER_RAISED
)
60 WX_FLAGS_MEMBER(wxBORDER_STATIC
)
61 WX_FLAGS_MEMBER(wxBORDER_NONE
)
63 // old style border flags
64 WX_FLAGS_MEMBER(wxSIMPLE_BORDER
)
65 WX_FLAGS_MEMBER(wxSUNKEN_BORDER
)
66 WX_FLAGS_MEMBER(wxDOUBLE_BORDER
)
67 WX_FLAGS_MEMBER(wxRAISED_BORDER
)
68 WX_FLAGS_MEMBER(wxSTATIC_BORDER
)
69 WX_FLAGS_MEMBER(wxNO_BORDER
)
71 WX_FLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
72 WX_FLAGS_MEMBER(wxWANTS_CHARS
)
73 WX_FLAGS_MEMBER(wxNO_FULL_REPAINT_ON_RESIZE
)
75 WX_FLAGS_MEMBER(wxBU_LEFT
)
76 WX_FLAGS_MEMBER(wxBU_RIGHT
)
77 WX_FLAGS_MEMBER(wxBU_TOP
)
78 WX_FLAGS_MEMBER(wxBU_BOTTOM
)
79 WX_FLAGS_MEMBER(wxBU_EXACTFIT
)
80 WX_END_FLAGS( wxButtonStyle
)
82 IMPLEMENT_DYNAMIC_CLASS_XTI(wxButton
, wxControl
,"wx/button.h")
84 WX_BEGIN_PROPERTIES_TABLE(wxButton
)
85 WX_DELEGATE( OnClick
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
)
87 WX_PROPERTY( Font
, wxFont
, SetFont
, GetFont
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
88 WX_PROPERTY( Label
, wxString
, SetLabel
, GetLabel
, wxEmptyString
, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
90 WX_PROPERTY_FLAGS( WindowStyle
, wxButtonStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
92 WX_END_PROPERTIES_TABLE()
94 WX_BEGIN_HANDLERS_TABLE(wxButton
)
95 WX_END_HANDLERS_TABLE()
97 WX_CONSTRUCTOR_6( wxButton
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Label
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
101 IMPLEMENT_DYNAMIC_CLASS(wxButton
, wxControl
)
104 // this macro tries to adjust the default button height to a reasonable value
105 // using the char height as the base
106 #define BUTTON_HEIGHT_FROM_CHAR_HEIGHT(cy) (11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)/10)
108 // ============================================================================
110 // ============================================================================
112 // ----------------------------------------------------------------------------
113 // creation/destruction
114 // ----------------------------------------------------------------------------
116 bool wxButton::Create(wxWindow
*parent
,
118 const wxString
& label
,
122 const wxValidator
& validator
,
123 const wxString
& name
)
125 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
129 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
132 // if the label contains several lines we must explicitly tell the button
133 // about it or it wouldn't draw it correctly ("\n"s would just appear as
136 // NB: we do it here and not in MSWGetStyle() because we need the label
137 // value and m_label is not set yet when MSWGetStyle() is called;
138 // besides changing BS_MULTILINE during run-time is pointless anyhow
139 if ( label
.find(_T('\n')) != wxString::npos
)
141 msStyle
|= BS_MULTILINE
;
145 return MSWCreateControl(_T("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
148 wxButton::~wxButton()
152 // ----------------------------------------------------------------------------
154 // ----------------------------------------------------------------------------
156 WXDWORD
wxButton::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
158 // buttons never have an external border, they draw their own one
159 WXDWORD msStyle
= wxControl::MSWGetStyle
161 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
164 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
165 // each other in any resizeable dialog which has more than one button in
167 msStyle
|= WS_CLIPSIBLINGS
;
170 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
171 // and wxBU_RIGHT to get BS_CENTER!
172 if ( style
& wxBU_LEFT
)
174 if ( style
& wxBU_RIGHT
)
176 if ( style
& wxBU_TOP
)
178 if ( style
& wxBU_BOTTOM
)
179 msStyle
|= BS_BOTTOM
;
185 // ----------------------------------------------------------------------------
186 // size management including autosizing
187 // ----------------------------------------------------------------------------
189 wxSize
wxButton::DoGetBestSize() const
192 GetTextExtent(wxGetWindowText(GetHWND()), &wBtn
, NULL
);
195 wxGetCharSize(GetHWND(), &wChar
, &hChar
, &GetFont());
197 // add a margin -- the button is wider than just its label
200 // the button height is proportional to the height of the font used
201 int hBtn
= BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar
);
203 // all buttons have at least the standard size unless the user explicitly
204 // wants them to be of smaller size and used wxBU_EXACTFIT style when
205 // creating the button
206 if ( !HasFlag(wxBU_EXACTFIT
) )
208 wxSize sz
= GetDefaultSize();
217 return wxSize(wBtn
, hBtn
);
221 wxSize
wxButtonBase::GetDefaultSize()
223 static wxSize s_sizeBtn
;
225 if ( s_sizeBtn
.x
== 0 )
228 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
230 // the size of a standard button in the dialog units is 50x14,
231 // translate this to pixels
232 // NB1: the multipliers come from the Windows convention
233 // NB2: the extra +1/+2 were needed to get the size be the same as the
234 // size of the buttons in the standard dialog - I don't know how
235 // this happens, but on my system this size is 75x23 in pixels and
236 // 23*8 isn't even divisible by 14... Would be nice to understand
237 // why these constants are needed though!
238 s_sizeBtn
.x
= (50 * (dc
.GetCharWidth() + 1))/4;
239 s_sizeBtn
.y
= ((14 * dc
.GetCharHeight()) + 2)/8;
245 // ----------------------------------------------------------------------------
246 // default button handling
247 // ----------------------------------------------------------------------------
250 "Everything you ever wanted to know about the default buttons" or "Why do we
251 have to do all this?"
253 In MSW the default button should be activated when the user presses Enter
254 and the current control doesn't process Enter itself somehow. This is
255 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
256 Another aspect of "defaultness" is that the default button has different
257 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
258 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
259 be unset if our parent window is not active so it should be unset whenever
260 we lose activation and set back when we regain it.
262 Final complication is that when a button is active, it should be the default
263 one, i.e. pressing Enter on a button always activates it and not another
266 We handle this by maintaining a permanent and a temporary default items in
267 wxControlContainer (both may be NULL). When a button becomes the current
268 control (i.e. gets focus) it sets itself as the temporary default which
269 ensures that it has the right appearance and that Enter will be redirected
270 to it. When the button loses focus, it unsets the temporary default and so
271 the default item will be the permanent default -- that is the default button
272 if any had been set or none otherwise, which is just what we want.
274 NB: all this is quite complicated by now and the worst is that normally
275 it shouldn't be necessary at all as for the normal Windows programs
276 DefWindowProc() and IsDialogMessage() take care of all this
277 automatically -- however in wxWindows programs this doesn't work for
278 nested hierarchies (i.e. a notebook inside a notebook) for unknown
279 reason and so we have to reproduce all this code ourselves. It would be
280 very nice if we could avoid doing it.
283 // set this button as the (permanently) default one in its panel
284 void wxButton::SetDefault()
286 wxWindow
*parent
= GetParent();
288 wxCHECK_RET( parent
, _T("button without parent?") );
290 // set this one as the default button both for wxWindows ...
291 wxWindow
*winOldDefault
= parent
->SetDefaultItem(this);
294 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), FALSE
);
295 SetDefaultStyle(this, TRUE
);
298 // set this button as being currently default
299 void wxButton::SetTmpDefault()
301 wxWindow
*parent
= GetParent();
303 wxCHECK_RET( parent
, _T("button without parent?") );
305 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
306 parent
->SetTmpDefaultItem(this);
308 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), FALSE
);
309 SetDefaultStyle(this, TRUE
);
312 // unset this button as currently default, it may still stay permanent default
313 void wxButton::UnsetTmpDefault()
315 wxWindow
*parent
= GetParent();
317 wxCHECK_RET( parent
, _T("button without parent?") );
319 parent
->SetTmpDefaultItem(NULL
);
321 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
323 SetDefaultStyle(this, FALSE
);
324 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), TRUE
);
329 wxButton::SetDefaultStyle(wxButton
*btn
, bool on
)
331 // we may be called with NULL pointer -- simpler to do the check here than
332 // in the caller which does wxDynamicCast()
336 // first, let DefDlgProc() know about the new default button
339 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
340 // focus at all any more
341 if ( !wxTheApp
->IsActive() )
344 // look for a panel-like window
345 wxWindow
*win
= btn
->GetParent();
346 while ( win
&& !win
->HasFlag(wxTAB_TRAVERSAL
) )
347 win
= win
->GetParent();
351 ::SendMessage(GetHwndOf(win
), DM_SETDEFID
, btn
->GetId(), 0L);
353 // sending DM_SETDEFID also changes the button style to
354 // BS_DEFPUSHBUTTON so there is nothing more to do
358 // then also change the style as needed
359 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
360 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
362 // don't do it with the owner drawn buttons because it will
363 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
364 // BS_DEFPUSHBUTTON != 0)!
365 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
367 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
368 on
? style
| BS_DEFPUSHBUTTON
369 : style
& ~BS_DEFPUSHBUTTON
,
374 // redraw the button - it will notice itself that it's
375 // [not] the default one [any longer]
379 //else: already has correct style
382 // ----------------------------------------------------------------------------
384 // ----------------------------------------------------------------------------
386 bool wxButton::SendClickEvent()
388 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
389 event
.SetEventObject(this);
391 return ProcessCommand(event
);
394 void wxButton::Command(wxCommandEvent
& event
)
396 ProcessCommand(event
);
399 // ----------------------------------------------------------------------------
400 // event/message handlers
401 // ----------------------------------------------------------------------------
403 bool wxButton::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
405 bool processed
= FALSE
;
408 // NOTE: Apparently older versions (NT 4?) of the common controls send
409 // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
410 // buttons, so in order to send two EVET_BUTTON events we should
411 // catch both types. Currently (Feb 2003) up-to-date versions of
412 // win98, win2k and winXP all send two BN_CLICKED messages for
413 // all button types, so we don't catch BN_DOUBLECLICKED anymore
414 // in order to not get 3 EVT_BUTTON events. If this is a problem
415 // then we need to figure out which version of the comctl32 changed
416 // this behaviour and test for it.
418 case 1: // message came from an accelerator
419 case BN_CLICKED
: // normal buttons send this
420 processed
= SendClickEvent();
427 long wxButton::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
429 // when we receive focus, we want to temporary become the default button in
430 // our parent panel so that pressing "Enter" would activate us -- and when
431 // losing it we should restore the previous default button as well
432 if ( nMsg
== WM_SETFOCUS
)
436 // let the default processing take place too
438 else if ( nMsg
== WM_KILLFOCUS
)
442 else if ( nMsg
== WM_LBUTTONDBLCLK
)
444 // emulate a click event to force an owner-drawn button to change its
445 // appearance - without this, it won't do it
446 (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
448 // and continue with processing the message normally as well
451 // let the base class do all real processing
452 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
455 // ----------------------------------------------------------------------------
456 // owner-drawn buttons support
457 // ----------------------------------------------------------------------------
463 static void DrawButtonText(HDC hdc
,
465 const wxString
& text
,
468 COLORREF colOld
= SetTextColor(hdc
, col
);
469 int modeOld
= SetBkMode(hdc
, TRANSPARENT
);
471 // Note: we must have DT_SINGLELINE for DT_VCENTER to work.
472 ::DrawText(hdc
, text
, text
.length(), pRect
, DT_SINGLELINE
| DT_CENTER
| DT_VCENTER
);
474 SetBkMode(hdc
, modeOld
);
475 SetTextColor(hdc
, colOld
);
478 static void DrawRect(HDC hdc
, const RECT
& r
)
480 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
481 wxDrawLine(hdc
, r
.right
, r
.top
, r
.right
, r
.bottom
);
482 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.left
, r
.bottom
);
483 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.left
, r
.top
);
486 void wxButton::MakeOwnerDrawn()
488 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
489 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
492 style
|= BS_OWNERDRAW
;
493 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
497 bool wxButton::SetBackgroundColour(const wxColour
&colour
)
499 if ( !wxControl::SetBackgroundColour(colour
) )
512 bool wxButton::SetForegroundColour(const wxColour
&colour
)
514 if ( !wxControl::SetForegroundColour(colour
) )
528 The button frame looks like this normally:
531 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
532 WH GB H = light grey (LIGHT)
533 WH GB G = dark grey (SHADOW)
534 WH GB B = black (DKSHADOW)
539 When the button is selected, the button becomes like this (the total button
540 size doesn't change):
551 When the button is pushed (while selected) it is like:
563 static void DrawButtonFrame(HDC hdc
, const RECT
& rectBtn
,
564 bool selected
, bool pushed
)
567 CopyRect(&r
, &rectBtn
);
569 HPEN hpenBlack
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DDKSHADOW
)),
570 hpenGrey
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DSHADOW
)),
571 hpenLightGr
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DLIGHT
)),
572 hpenWhite
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DHILIGHT
));
574 HPEN hpenOld
= (HPEN
)SelectObject(hdc
, hpenBlack
);
583 (void)SelectObject(hdc
, hpenGrey
);
584 InflateRect(&r
, -1, -1);
594 InflateRect(&r
, -1, -1);
597 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.right
, r
.bottom
);
598 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.right
, r
.top
- 1);
600 (void)SelectObject(hdc
, hpenWhite
);
601 wxDrawLine(hdc
, r
.left
, r
.bottom
- 1, r
.left
, r
.top
);
602 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
604 (void)SelectObject(hdc
, hpenLightGr
);
605 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 2, r
.left
+ 1, r
.top
+ 1);
606 wxDrawLine(hdc
, r
.left
+ 1, r
.top
+ 1, r
.right
- 1, r
.top
+ 1);
608 (void)SelectObject(hdc
, hpenGrey
);
609 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 1, r
.right
- 1, r
.bottom
- 1);
610 wxDrawLine(hdc
, r
.right
- 1, r
.bottom
- 1, r
.right
- 1, r
.top
);
613 (void)SelectObject(hdc
, hpenOld
);
614 DeleteObject(hpenWhite
);
615 DeleteObject(hpenLightGr
);
616 DeleteObject(hpenGrey
);
617 DeleteObject(hpenBlack
);
620 bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
622 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
625 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
627 COLORREF colBg
= wxColourToRGB(GetBackgroundColour()),
628 colFg
= wxColourToRGB(GetForegroundColour());
630 HDC hdc
= lpDIS
->hDC
;
631 UINT state
= lpDIS
->itemState
;
633 // first, draw the background
634 HBRUSH hbrushBackground
= ::CreateSolidBrush(colBg
);
636 FillRect(hdc
, &rectBtn
, hbrushBackground
);
638 // draw the border for the current state
639 bool selected
= (state
& ODS_SELECTED
) != 0;
642 wxPanel
*panel
= wxDynamicCast(GetParent(), wxPanel
);
645 selected
= panel
->GetDefaultItem() == this;
648 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
650 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
652 // draw the focus rect if needed
653 if ( state
& ODS_FOCUS
)
656 CopyRect(&rectFocus
, &rectBtn
);
658 // I don't know where does this constant come from, but this is how
659 // Windows draws them
660 InflateRect(&rectFocus
, -4, -4);
662 DrawFocusRect(hdc
, &rectFocus
);
667 // the label is shifted by 1 pixel to create "pushed" effect
668 OffsetRect(&rectBtn
, 1, 1);
671 DrawButtonText(hdc
, &rectBtn
, GetLabel(),
672 state
& ODS_DISABLED
? GetSysColor(COLOR_GRAYTEXT
)
675 ::DeleteObject(hbrushBackground
);
682 #endif // wxUSE_BUTTON