1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/button.cpp
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "button.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
34 #include "wx/button.h"
37 #include "wx/bmpbuttn.h"
38 #include "wx/settings.h"
39 #include "wx/dcscreen.h"
42 #include "wx/msw/private.h"
44 // ----------------------------------------------------------------------------
46 // ----------------------------------------------------------------------------
48 IMPLEMENT_DYNAMIC_CLASS(wxButton
, wxControl
)
50 // this macro tries to adjust the default button height to a reasonable value
51 // using the char height as the base
52 #define BUTTON_HEIGHT_FROM_CHAR_HEIGHT(cy) (11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)/10)
54 // ============================================================================
56 // ============================================================================
58 // ----------------------------------------------------------------------------
59 // creation/destruction
60 // ----------------------------------------------------------------------------
62 bool wxButton::Create(wxWindow
*parent
,
64 const wxString
& label
,
68 const wxValidator
& validator
,
71 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
75 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
78 // if the label contains several lines we must explicitly tell the button
79 // about it or it wouldn't draw it correctly ("\n"s would just appear as
82 // NB: we do it here and not in MSWGetStyle() because we need the label
83 // value and m_label is not set yet when MSWGetStyle() is called;
84 // besides changing BS_MULTILINE during run-time is pointless anyhow
85 if ( label
.find(_T('\n')) != wxString::npos
)
87 msStyle
|= BS_MULTILINE
;
91 return MSWCreateControl(_T("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
98 // ----------------------------------------------------------------------------
100 // ----------------------------------------------------------------------------
102 WXDWORD
wxButton::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
104 // buttons never have an external border, they draw their own one
105 WXDWORD msStyle
= wxControl::MSWGetStyle
107 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
110 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
111 // each other in any resizeable dialog which has more than one button in
113 msStyle
|= WS_CLIPSIBLINGS
;
116 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
117 // and wxBU_RIGHT to get BS_CENTER!
118 if ( style
& wxBU_LEFT
)
120 if ( style
& wxBU_RIGHT
)
122 if ( style
& wxBU_TOP
)
124 if ( style
& wxBU_BOTTOM
)
125 msStyle
|= BS_BOTTOM
;
131 // ----------------------------------------------------------------------------
132 // size management including autosizing
133 // ----------------------------------------------------------------------------
135 wxSize
wxButton::DoGetBestSize() const
138 GetTextExtent(wxGetWindowText(GetHWND()), &wBtn
, NULL
);
141 wxGetCharSize(GetHWND(), &wChar
, &hChar
, &GetFont());
143 // add a margin -- the button is wider than just its label
146 // the button height is proportional to the height of the font used
147 int hBtn
= BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar
);
149 // all buttons have at least the standard size unless the user explicitly
150 // wants them to be of smaller size and used wxBU_EXACTFIT style when
151 // creating the button
152 if ( !HasFlag(wxBU_EXACTFIT
) )
154 wxSize sz
= GetDefaultSize();
163 return wxSize(wBtn
, hBtn
);
167 wxSize
wxButtonBase::GetDefaultSize()
169 static wxSize s_sizeBtn
;
171 if ( s_sizeBtn
.x
== 0 )
174 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
176 // the size of a standard button in the dialog units is 50x14,
177 // translate this to pixels
178 // NB1: the multipliers come from the Windows convention
179 // NB2: the extra +1/+2 were needed to get the size be the same as the
180 // size of the buttons in the standard dialog - I don't know how
181 // this happens, but on my system this size is 75x23 in pixels and
182 // 23*8 isn't even divisible by 14... Would be nice to understand
183 // why these constants are needed though!
184 s_sizeBtn
.x
= (50 * (dc
.GetCharWidth() + 1))/4;
185 s_sizeBtn
.y
= ((14 * dc
.GetCharHeight()) + 2)/8;
191 // ----------------------------------------------------------------------------
192 // default button handling
193 // ----------------------------------------------------------------------------
196 "Everything you ever wanted to know about the default buttons" or "Why do we
197 have to do all this?"
199 In MSW the default button should be activated when the user presses Enter
200 and the current control doesn't process Enter itself somehow. This is
201 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
202 Another aspect of "defaultness" is that the default button has different
203 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
204 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
205 be unset if our parent window is not active so it should be unset whenever
206 we lose activation and set back when we regain it.
208 Final complication is that when a button is active, it should be the default
209 one, i.e. pressing Enter on a button always activates it and not another
212 We handle this by maintaining a permanent and a temporary default items in
213 wxControlContainer (both may be NULL). When a button becomes the current
214 control (i.e. gets focus) it sets itself as the temporary default which
215 ensures that it has the right appearance and that Enter will be redirected
216 to it. When the button loses focus, it unsets the temporary default and so
217 the default item will be the permanent default -- that is the default button
218 if any had been set or none otherwise, which is just what we want.
220 NB: all this is quite complicated by now and the worst is that normally
221 it shouldn't be necessary at all as for the normal Windows programs
222 DefWindowProc() and IsDialogMessage() take care of all this
223 automatically -- however in wxWindows programs this doesn't work for
224 nested hierarchies (i.e. a notebook inside a notebook) for unknown
225 reason and so we have to reproduce all this code ourselves. It would be
226 very nice if we could avoid doing it.
229 // set this button as the (permanently) default one in its panel
230 void wxButton::SetDefault()
232 wxWindow
*parent
= GetParent();
234 wxCHECK_RET( parent
, _T("button without parent?") );
236 // set this one as the default button both for wxWindows ...
237 wxWindow
*winOldDefault
= parent
->SetDefaultItem(this);
240 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), FALSE
);
241 SetDefaultStyle(this, TRUE
);
244 // set this button as being currently default
245 void wxButton::SetTmpDefault()
247 wxWindow
*parent
= GetParent();
249 wxCHECK_RET( parent
, _T("button without parent?") );
251 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
252 parent
->SetTmpDefaultItem(this);
254 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), FALSE
);
255 SetDefaultStyle(this, TRUE
);
258 // unset this button as currently default, it may still stay permanent default
259 void wxButton::UnsetTmpDefault()
261 wxWindow
*parent
= GetParent();
263 wxCHECK_RET( parent
, _T("button without parent?") );
265 parent
->SetTmpDefaultItem(NULL
);
267 wxWindow
*winOldDefault
= parent
->GetDefaultItem();
269 SetDefaultStyle(this, FALSE
);
270 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), TRUE
);
275 wxButton::SetDefaultStyle(wxButton
*btn
, bool on
)
277 // we may be called with NULL pointer -- simpler to do the check here than
278 // in the caller which does wxDynamicCast()
282 // first, let DefDlgProc() know about the new default button
285 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
286 // focus at all any more
287 if ( !wxTheApp
->IsActive() )
290 // look for a panel-like window
291 wxWindow
*win
= btn
->GetParent();
292 while ( win
&& !win
->HasFlag(wxTAB_TRAVERSAL
) )
293 win
= win
->GetParent();
297 ::SendMessage(GetHwndOf(win
), DM_SETDEFID
, btn
->GetId(), 0L);
299 // sending DM_SETDEFID also changes the button style to
300 // BS_DEFPUSHBUTTON so there is nothing more to do
304 // then also change the style as needed
305 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
306 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
308 // don't do it with the owner drawn buttons because it will
309 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
310 // BS_DEFPUSHBUTTON != 0)!
311 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
313 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
314 on
? style
| BS_DEFPUSHBUTTON
315 : style
& ~BS_DEFPUSHBUTTON
,
320 // redraw the button - it will notice itself that it's
321 // [not] the default one [any longer]
325 //else: already has correct style
328 // ----------------------------------------------------------------------------
330 // ----------------------------------------------------------------------------
332 bool wxButton::SendClickEvent()
334 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
335 event
.SetEventObject(this);
337 return ProcessCommand(event
);
340 void wxButton::Command(wxCommandEvent
& event
)
342 ProcessCommand(event
);
345 // ----------------------------------------------------------------------------
346 // event/message handlers
347 // ----------------------------------------------------------------------------
349 bool wxButton::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
351 bool processed
= FALSE
;
354 case 1: // message came from an accelerator
355 case BN_CLICKED
: // normal buttons send this
356 case BN_DOUBLECLICKED
: // owner-drawn ones also send this
357 processed
= SendClickEvent();
364 long wxButton::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
366 // when we receive focus, we want to temporary become the default button in
367 // our parent panel so that pressing "Enter" would activate us -- and when
368 // losing it we should restore the previous default button as well
369 if ( nMsg
== WM_SETFOCUS
)
373 // let the default processing take place too
375 else if ( nMsg
== WM_KILLFOCUS
)
379 else if ( nMsg
== WM_LBUTTONDBLCLK
)
381 // emulate a click event to force an owner-drawn button to change its
382 // appearance - without this, it won't do it
383 (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
385 // and continue with processing the message normally as well
388 // let the base class do all real processing
389 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
392 // ----------------------------------------------------------------------------
393 // owner-drawn buttons support
394 // ----------------------------------------------------------------------------
400 static void DrawButtonText(HDC hdc
,
402 const wxString
& text
,
405 COLORREF colOld
= SetTextColor(hdc
, col
);
406 int modeOld
= SetBkMode(hdc
, TRANSPARENT
);
408 DrawText(hdc
, text
, text
.length(), pRect
,
409 DT_CENTER
| DT_VCENTER
| DT_SINGLELINE
);
411 SetBkMode(hdc
, modeOld
);
412 SetTextColor(hdc
, colOld
);
415 static void DrawRect(HDC hdc
, const RECT
& r
)
417 MoveToEx(hdc
, r
.left
, r
.top
, NULL
);
418 LineTo(hdc
, r
.right
, r
.top
);
419 LineTo(hdc
, r
.right
, r
.bottom
);
420 LineTo(hdc
, r
.left
, r
.bottom
);
421 LineTo(hdc
, r
.left
, r
.top
);
424 void wxButton::MakeOwnerDrawn()
426 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
427 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
430 style
|= BS_OWNERDRAW
;
431 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
435 bool wxButton::SetBackgroundColour(const wxColour
&colour
)
437 if ( !wxControl::SetBackgroundColour(colour
) )
450 bool wxButton::SetForegroundColour(const wxColour
&colour
)
452 if ( !wxControl::SetForegroundColour(colour
) )
466 The button frame looks like this normally:
469 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
470 WH GB H = light grey (LIGHT)
471 WH GB G = dark grey (SHADOW)
472 WH GB B = black (DKSHADOW)
477 When the button is selected, the button becomes like this (the total button
478 size doesn't change):
489 When the button is pushed (while selected) it is like:
501 static void DrawButtonFrame(HDC hdc
, const RECT
& rectBtn
,
502 bool selected
, bool pushed
)
505 CopyRect(&r
, &rectBtn
);
507 HPEN hpenBlack
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DDKSHADOW
)),
508 hpenGrey
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DSHADOW
)),
509 hpenLightGr
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DLIGHT
)),
510 hpenWhite
= CreatePen(PS_SOLID
, 1, GetSysColor(COLOR_3DHILIGHT
));
512 HPEN hpenOld
= (HPEN
)SelectObject(hdc
, hpenBlack
);
521 (void)SelectObject(hdc
, hpenGrey
);
522 InflateRect(&r
, -1, -1);
532 InflateRect(&r
, -1, -1);
535 MoveToEx(hdc
, r
.left
, r
.bottom
, NULL
);
536 LineTo(hdc
, r
.right
, r
.bottom
);
537 LineTo(hdc
, r
.right
, r
.top
- 1);
539 (void)SelectObject(hdc
, hpenWhite
);
540 MoveToEx(hdc
, r
.left
, r
.bottom
- 1, NULL
);
541 LineTo(hdc
, r
.left
, r
.top
);
542 LineTo(hdc
, r
.right
, r
.top
);
544 (void)SelectObject(hdc
, hpenLightGr
);
545 MoveToEx(hdc
, r
.left
+ 1, r
.bottom
- 2, NULL
);
546 LineTo(hdc
, r
.left
+ 1, r
.top
+ 1);
547 LineTo(hdc
, r
.right
- 1, r
.top
+ 1);
549 (void)SelectObject(hdc
, hpenGrey
);
550 MoveToEx(hdc
, r
.left
+ 1, r
.bottom
- 1, NULL
);
551 LineTo(hdc
, r
.right
- 1, r
.bottom
- 1);
552 LineTo(hdc
, r
.right
- 1, r
.top
);
555 (void)SelectObject(hdc
, hpenOld
);
556 DeleteObject(hpenWhite
);
557 DeleteObject(hpenLightGr
);
558 DeleteObject(hpenGrey
);
559 DeleteObject(hpenBlack
);
562 bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
564 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
567 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
569 COLORREF colBg
= wxColourToRGB(GetBackgroundColour()),
570 colFg
= wxColourToRGB(GetForegroundColour());
572 HDC hdc
= lpDIS
->hDC
;
573 UINT state
= lpDIS
->itemState
;
575 // first, draw the background
576 HBRUSH hbrushBackground
= ::CreateSolidBrush(colBg
);
578 FillRect(hdc
, &rectBtn
, hbrushBackground
);
580 // draw the border for the current state
581 bool selected
= (state
& ODS_SELECTED
) != 0;
584 wxPanel
*panel
= wxDynamicCast(GetParent(), wxPanel
);
587 selected
= panel
->GetDefaultItem() == this;
590 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
592 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
594 // draw the focus rect if needed
595 if ( state
& ODS_FOCUS
)
598 CopyRect(&rectFocus
, &rectBtn
);
600 // I don't know where does this constant come from, but this is how
601 // Windows draws them
602 InflateRect(&rectFocus
, -4, -4);
604 DrawFocusRect(hdc
, &rectFocus
);
609 // the label is shifted by 1 pixel to create "pushed" effect
610 OffsetRect(&rectBtn
, 1, 1);
613 DrawButtonText(hdc
, &rectBtn
, GetLabel(),
614 state
& ODS_DISABLED
? GetSysColor(COLOR_GRAYTEXT
)
617 ::DeleteObject(hbrushBackground
);
624 #endif // wxUSE_BUTTON