1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/button.cpp
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/button.h"
35 #include "wx/bmpbuttn.h"
36 #include "wx/settings.h"
37 #include "wx/dcscreen.h"
38 #include "wx/dcclient.h"
39 #include "wx/toplevel.h"
42 #include "wx/imaglist.h"
43 #include "wx/stockitem.h"
44 #include "wx/msw/private.h"
45 #include "wx/msw/private/button.h"
46 #include "wx/msw/private/dc.h"
48 using namespace wxMSWImpl
;
51 #include "wx/msw/uxtheme.h"
53 // no need to include tmschema.h
55 #define BP_PUSHBUTTON 1
60 #define PBS_DISABLED 4
61 #define PBS_DEFAULTED 5
63 #define TMT_CONTENTMARGINS 3602
66 // provide the necessary declarations ourselves if they're missing from
68 #ifndef BCM_SETIMAGELIST
69 #define BCM_SETIMAGELIST 0x1602
70 #define BCM_SETTEXTMARGIN 0x1604
74 BUTTON_IMAGELIST_ALIGN_LEFT
,
75 BUTTON_IMAGELIST_ALIGN_RIGHT
,
76 BUTTON_IMAGELIST_ALIGN_TOP
,
77 BUTTON_IMAGELIST_ALIGN_BOTTOM
80 struct BUTTON_IMAGELIST
87 #endif // wxUSE_UXTHEME
89 #ifndef WM_THEMECHANGED
90 #define WM_THEMECHANGED 0x031A
94 #define ODS_NOACCEL 0x0100
97 #ifndef ODS_NOFOCUSRECT
98 #define ODS_NOFOCUSRECT 0x0200
101 #ifndef DT_HIDEPREFIX
102 #define DT_HIDEPREFIX 0x00100000
105 // ----------------------------------------------------------------------------
107 // ----------------------------------------------------------------------------
109 // we use different data classes for owner drawn buttons and for themed XP ones
111 class wxButtonImageData
114 wxButtonImageData() { }
115 virtual ~wxButtonImageData() { }
117 virtual wxBitmap
GetBitmap(wxButton::State which
) const = 0;
118 virtual void SetBitmap(const wxBitmap
& bitmap
, wxButton::State which
) = 0;
120 virtual wxSize
GetBitmapMargins() const = 0;
121 virtual void SetBitmapMargins(wxCoord x
, wxCoord y
) = 0;
123 virtual wxDirection
GetBitmapPosition() const = 0;
124 virtual void SetBitmapPosition(wxDirection dir
) = 0;
127 wxDECLARE_NO_COPY_CLASS(wxButtonImageData
);
133 // the gap between button edge and the interior area used by Windows for the
135 const int OD_BUTTON_MARGIN
= 4;
137 class wxODButtonImageData
: public wxButtonImageData
140 wxODButtonImageData(wxButton
*btn
, const wxBitmap
& bitmap
)
142 SetBitmap(bitmap
, wxButton::State_Normal
);
146 // we use margins when we have both bitmap and text, but when we have
147 // only the bitmap it should take up the entire button area
148 if ( btn
->ShowsLabel() )
150 m_margin
.x
= btn
->GetCharWidth();
151 m_margin
.y
= btn
->GetCharHeight() / 2;
155 virtual wxBitmap
GetBitmap(wxButton::State which
) const
157 return m_bitmaps
[which
];
160 virtual void SetBitmap(const wxBitmap
& bitmap
, wxButton::State which
)
162 m_bitmaps
[which
] = bitmap
;
165 virtual wxSize
GetBitmapMargins() const
170 virtual void SetBitmapMargins(wxCoord x
, wxCoord y
)
172 m_margin
= wxSize(x
, y
);
175 virtual wxDirection
GetBitmapPosition() const
180 virtual void SetBitmapPosition(wxDirection dir
)
186 // just store the values passed to us to be able to retrieve them later
187 // from the drawing code
188 wxBitmap m_bitmaps
[wxButton::State_Max
];
192 wxDECLARE_NO_COPY_CLASS(wxODButtonImageData
);
197 // somehow the margin is one pixel greater than the value returned by
198 // GetThemeMargins() call
199 const int XP_BUTTON_EXTRA_MARGIN
= 1;
201 class wxXPButtonImageData
: public wxButtonImageData
204 // we must be constructed with the size of our images as we need to create
206 wxXPButtonImageData(wxButton
*btn
, const wxBitmap
& bitmap
)
207 : m_iml(bitmap
.GetWidth(), bitmap
.GetHeight(), true /* use mask */,
208 wxButton::State_Max
),
209 m_hwndBtn(GetHwndOf(btn
))
211 // initialize all bitmaps to normal state
212 for ( int n
= 0; n
< wxButton::State_Max
; n
++ )
217 m_data
.himl
= GetHimagelistOf(&m_iml
);
219 // use default margins
221 m_data
.margin
.right
= btn
->GetCharWidth();
223 m_data
.margin
.bottom
= btn
->GetCharHeight() / 2;
225 // and default alignment
226 m_data
.uAlign
= BUTTON_IMAGELIST_ALIGN_LEFT
;
231 virtual wxBitmap
GetBitmap(wxButton::State which
) const
233 return m_iml
.GetBitmap(which
);
236 virtual void SetBitmap(const wxBitmap
& bitmap
, wxButton::State which
)
238 m_iml
.Replace(which
, bitmap
);
243 virtual wxSize
GetBitmapMargins() const
245 return wxSize(m_data
.margin
.left
, m_data
.margin
.top
);
248 virtual void SetBitmapMargins(wxCoord x
, wxCoord y
)
250 RECT
& margin
= m_data
.margin
;
256 if ( !::SendMessage(m_hwndBtn
, BCM_SETTEXTMARGIN
, 0, (LPARAM
)&margin
) )
258 wxLogDebug("SendMessage(BCM_SETTEXTMARGIN) failed");
262 virtual wxDirection
GetBitmapPosition() const
264 switch ( m_data
.uAlign
)
267 wxFAIL_MSG( "invalid image alignment" );
270 case BUTTON_IMAGELIST_ALIGN_LEFT
:
273 case BUTTON_IMAGELIST_ALIGN_RIGHT
:
276 case BUTTON_IMAGELIST_ALIGN_TOP
:
279 case BUTTON_IMAGELIST_ALIGN_BOTTOM
:
284 virtual void SetBitmapPosition(wxDirection dir
)
290 wxFAIL_MSG( "invalid direction" );
294 alignNew
= BUTTON_IMAGELIST_ALIGN_LEFT
;
298 alignNew
= BUTTON_IMAGELIST_ALIGN_RIGHT
;
302 alignNew
= BUTTON_IMAGELIST_ALIGN_TOP
;
306 alignNew
= BUTTON_IMAGELIST_ALIGN_BOTTOM
;
310 if ( alignNew
!= m_data
.uAlign
)
312 m_data
.uAlign
= alignNew
;
318 void UpdateImageInfo()
320 if ( !::SendMessage(m_hwndBtn
, BCM_SETIMAGELIST
, 0, (LPARAM
)&m_data
) )
322 wxLogDebug("SendMessage(BCM_SETIMAGELIST) failed");
326 // we store image list separately to be able to use convenient wxImageList
327 // methods instead of working with raw HIMAGELIST
330 // store the rest of the data in BCM_SETIMAGELIST-friendly form
331 BUTTON_IMAGELIST m_data
;
333 // the button we're associated with
334 const HWND m_hwndBtn
;
337 wxDECLARE_NO_COPY_CLASS(wxXPButtonImageData
);
340 #endif // wxUSE_UXTHEME
342 } // anonymous namespace
344 // ----------------------------------------------------------------------------
346 // ----------------------------------------------------------------------------
348 #if wxUSE_EXTENDED_RTTI
350 WX_DEFINE_FLAGS( wxButtonStyle
)
352 wxBEGIN_FLAGS( wxButtonStyle
)
353 // new style border flags, we put them first to
354 // use them for streaming out
355 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
356 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
357 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
358 wxFLAGS_MEMBER(wxBORDER_RAISED
)
359 wxFLAGS_MEMBER(wxBORDER_STATIC
)
360 wxFLAGS_MEMBER(wxBORDER_NONE
)
362 // old style border flags
363 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
364 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
365 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
366 wxFLAGS_MEMBER(wxRAISED_BORDER
)
367 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
368 wxFLAGS_MEMBER(wxBORDER
)
370 // standard window styles
371 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
372 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
373 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
374 wxFLAGS_MEMBER(wxWANTS_CHARS
)
375 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
376 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
377 wxFLAGS_MEMBER(wxVSCROLL
)
378 wxFLAGS_MEMBER(wxHSCROLL
)
380 wxFLAGS_MEMBER(wxBU_LEFT
)
381 wxFLAGS_MEMBER(wxBU_RIGHT
)
382 wxFLAGS_MEMBER(wxBU_TOP
)
383 wxFLAGS_MEMBER(wxBU_BOTTOM
)
384 wxFLAGS_MEMBER(wxBU_EXACTFIT
)
385 wxEND_FLAGS( wxButtonStyle
)
387 IMPLEMENT_DYNAMIC_CLASS_XTI(wxButton
, wxControl
,"wx/button.h")
389 wxBEGIN_PROPERTIES_TABLE(wxButton
)
390 wxEVENT_PROPERTY( Click
, wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
)
392 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
393 wxPROPERTY( Label
, wxString
, SetLabel
, GetLabel
, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
395 wxPROPERTY_FLAGS( WindowStyle
, wxButtonStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
397 wxEND_PROPERTIES_TABLE()
399 wxBEGIN_HANDLERS_TABLE(wxButton
)
400 wxEND_HANDLERS_TABLE()
402 wxCONSTRUCTOR_6( wxButton
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Label
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
406 IMPLEMENT_DYNAMIC_CLASS(wxButton
, wxControl
)
409 // ============================================================================
411 // ============================================================================
413 // ----------------------------------------------------------------------------
414 // helper functions from wx/msw/private/button.h
415 // ----------------------------------------------------------------------------
417 void wxMSWButton::UpdateMultilineStyle(HWND hwnd
, const wxString
& label
)
419 // update BS_MULTILINE style depending on the new label (resetting it
420 // doesn't seem to do anything very useful but it shouldn't hurt and we do
421 // have to set it whenever the label becomes multi line as otherwise it
422 // wouldn't be shown correctly as we don't use BS_MULTILINE when creating
423 // the control unless it already has new lines in its label)
424 long styleOld
= ::GetWindowLong(hwnd
, GWL_STYLE
),
426 if ( label
.find(wxT('\n')) != wxString::npos
)
427 styleNew
= styleOld
| BS_MULTILINE
;
429 styleNew
= styleOld
& ~BS_MULTILINE
;
431 if ( styleNew
!= styleOld
)
432 ::SetWindowLong(hwnd
, GWL_STYLE
, styleNew
);
435 wxSize
wxMSWButton::GetFittingSize(wxWindow
*win
, const wxSize
& sizeLabel
)
437 // FIXME: this is pure guesswork, need to retrieve the real button margins
438 wxSize sizeBtn
= sizeLabel
;
440 sizeBtn
.x
+= 3*win
->GetCharWidth();
441 sizeBtn
.y
= 11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(sizeLabel
.y
)/10;
446 wxSize
wxMSWButton::ComputeBestSize(wxControl
*btn
)
451 dc
.GetMultiLineTextExtent(btn
->GetLabelText(), &sizeBtn
.x
, &sizeBtn
.y
);
453 sizeBtn
= GetFittingSize(btn
, sizeBtn
);
455 // all buttons have at least the standard size unless the user explicitly
456 // wants them to be of smaller size and used wxBU_EXACTFIT style when
457 // creating the button
458 if ( !btn
->HasFlag(wxBU_EXACTFIT
) )
460 wxSize sizeDef
= wxButton::GetDefaultSize();
461 if ( sizeBtn
.x
< sizeDef
.x
)
462 sizeBtn
.x
= sizeDef
.x
;
463 if ( sizeBtn
.y
< sizeDef
.y
)
464 sizeBtn
.y
= sizeDef
.y
;
467 btn
->CacheBestSize(sizeBtn
);
472 // ----------------------------------------------------------------------------
473 // creation/destruction
474 // ----------------------------------------------------------------------------
476 bool wxButton::Create(wxWindow
*parent
,
482 const wxValidator
& validator
,
483 const wxString
& name
)
486 if (label
.empty() && wxIsStockID(id
))
488 // On Windows, some buttons aren't supposed to have mnemonics
489 label
= wxGetStockLabel
492 id
== wxID_OK
|| id
== wxID_CANCEL
|| id
== wxID_CLOSE
494 : wxSTOCK_WITH_MNEMONIC
498 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
502 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
504 // if the label contains several lines we must explicitly tell the button
505 // about it or it wouldn't draw it correctly ("\n"s would just appear as
508 // NB: we do it here and not in MSWGetStyle() because we need the label
509 // value and the label is not set yet when MSWGetStyle() is called
510 msStyle
|= wxMSWButton::GetMultilineStyle(label
);
512 return MSWCreateControl(wxT("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
515 wxButton::~wxButton()
517 wxTopLevelWindow
*tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
518 if ( tlw
&& tlw
->GetTmpDefaultItem() == this )
526 // ----------------------------------------------------------------------------
528 // ----------------------------------------------------------------------------
530 WXDWORD
wxButton::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
532 // buttons never have an external border, they draw their own one
533 WXDWORD msStyle
= wxControl::MSWGetStyle
535 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
538 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
539 // each other in any resizeable dialog which has more than one button in
541 msStyle
|= WS_CLIPSIBLINGS
;
543 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
544 // and wxBU_RIGHT to get BS_CENTER!
545 if ( style
& wxBU_LEFT
)
547 if ( style
& wxBU_RIGHT
)
549 if ( style
& wxBU_TOP
)
551 if ( style
& wxBU_BOTTOM
)
552 msStyle
|= BS_BOTTOM
;
555 if ( style
& wxNO_BORDER
)
557 #endif // __WXWINCE__
562 void wxButton::SetLabel(const wxString
& label
)
564 wxMSWButton::UpdateMultilineStyle(GetHwnd(), label
);
566 wxButtonBase::SetLabel(label
);
569 // ----------------------------------------------------------------------------
570 // size management including autosizing
571 // ----------------------------------------------------------------------------
573 wxSize
wxButton::DoGetBestSize() const
577 // account for the text part if we have it or if we don't have any image at
578 // all (buttons initially created with empty label should still have a non
580 if ( ShowsLabel() || !m_imageData
)
582 size
= wxMSWButton::ComputeBestSize(const_cast<wxButton
*>(this));
587 // account for the bitmap size
588 const wxSize sizeBmp
= m_imageData
->GetBitmap(State_Normal
).GetSize();
589 const wxDirection dirBmp
= m_imageData
->GetBitmapPosition();
590 if ( dirBmp
== wxLEFT
|| dirBmp
== wxRIGHT
)
593 if ( sizeBmp
.y
> size
.y
)
596 else // bitmap on top/below the text
599 if ( sizeBmp
.x
> size
.x
)
603 // account for the user-specified margins
604 size
+= 2*m_imageData
->GetBitmapMargins();
606 // and also for the margins we always add internally (unless we have no
607 // border at all in which case the button has exactly the same size as
608 // bitmap and so no margins should be used)
609 if ( !HasFlag(wxBORDER_NONE
) )
614 if ( wxUxThemeEngine::GetIfActive() )
616 wxUxThemeHandle
theme(const_cast<wxButton
*>(this), L
"BUTTON");
619 wxUxThemeEngine::Get()->GetThemeMargins(theme
, NULL
,
626 // XP doesn't draw themed buttons correctly when the client
627 // area is smaller than 8x8 - enforce this minimum size for
629 size
.IncTo(wxSize(8, 8));
631 marginH
= margins
.cxLeftWidth
+ margins
.cxRightWidth
632 + 2*XP_BUTTON_EXTRA_MARGIN
;
633 marginV
= margins
.cyTopHeight
+ margins
.cyBottomHeight
634 + 2*XP_BUTTON_EXTRA_MARGIN
;
637 #endif // wxUSE_UXTHEME
640 marginV
= OD_BUTTON_MARGIN
;
643 size
.IncBy(marginH
, marginV
);
653 wxSize
wxButtonBase::GetDefaultSize()
655 static wxSize s_sizeBtn
;
657 if ( s_sizeBtn
.x
== 0 )
660 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
662 // the size of a standard button in the dialog units is 50x14,
663 // translate this to pixels
664 // NB1: the multipliers come from the Windows convention
665 // NB2: the extra +1/+2 were needed to get the size be the same as the
666 // size of the buttons in the standard dialog - I don't know how
667 // this happens, but on my system this size is 75x23 in pixels and
668 // 23*8 isn't even divisible by 14... Would be nice to understand
669 // why these constants are needed though!
670 s_sizeBtn
.x
= (50 * (dc
.GetCharWidth() + 1))/4;
671 s_sizeBtn
.y
= ((14 * dc
.GetCharHeight()) + 2)/8;
677 // ----------------------------------------------------------------------------
678 // default button handling
679 // ----------------------------------------------------------------------------
682 The comment below and all this code is probably due to not using WM_NEXTDLGCTL
683 message when changing focus (but just SetFocus() which is not enough), see
684 http://blogs.msdn.com/oldnewthing/archive/2004/08/02/205624.aspx for the
687 TODO: Do use WM_NEXTDLGCTL and get rid of all this code.
690 "Everything you ever wanted to know about the default buttons" or "Why do we
691 have to do all this?"
693 In MSW the default button should be activated when the user presses Enter
694 and the current control doesn't process Enter itself somehow. This is
695 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
696 Another aspect of "defaultness" is that the default button has different
697 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
698 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
699 be unset if our parent window is not active so it should be unset whenever
700 we lose activation and set back when we regain it.
702 Final complication is that when a button is active, it should be the default
703 one, i.e. pressing Enter on a button always activates it and not another
706 We handle this by maintaining a permanent and a temporary default items in
707 wxControlContainer (both may be NULL). When a button becomes the current
708 control (i.e. gets focus) it sets itself as the temporary default which
709 ensures that it has the right appearance and that Enter will be redirected
710 to it. When the button loses focus, it unsets the temporary default and so
711 the default item will be the permanent default -- that is the default button
712 if any had been set or none otherwise, which is just what we want.
714 NB: all this is quite complicated by now and the worst is that normally
715 it shouldn't be necessary at all as for the normal Windows programs
716 DefWindowProc() and IsDialogMessage() take care of all this
717 automatically -- however in wxWidgets programs this doesn't work for
718 nested hierarchies (i.e. a notebook inside a notebook) for unknown
719 reason and so we have to reproduce all this code ourselves. It would be
720 very nice if we could avoid doing it.
723 // set this button as the (permanently) default one in its panel
724 wxWindow
*wxButton::SetDefault()
726 // set this one as the default button both for wxWidgets ...
727 wxWindow
*winOldDefault
= wxButtonBase::SetDefault();
730 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
731 SetDefaultStyle(this, true);
733 return winOldDefault
;
736 // return the top level parent window if it's not being deleted yet, otherwise
738 static wxTopLevelWindow
*GetTLWParentIfNotBeingDeleted(wxWindow
*win
)
742 // IsTopLevel() will return false for a wxTLW being deleted, so we also
743 // need the parent test for this case
744 wxWindow
* const parent
= win
->GetParent();
745 if ( !parent
|| win
->IsTopLevel() )
747 if ( win
->IsBeingDeleted() )
756 wxASSERT_MSG( win
, wxT("button without top level parent?") );
758 wxTopLevelWindow
* const tlw
= wxDynamicCast(win
, wxTopLevelWindow
);
759 wxASSERT_MSG( tlw
, wxT("logic error in GetTLWParentIfNotBeingDeleted()") );
764 // set this button as being currently default
765 void wxButton::SetTmpDefault()
767 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
771 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
772 tlw
->SetTmpDefaultItem(this);
774 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
775 SetDefaultStyle(this, true);
778 // unset this button as currently default, it may still stay permanent default
779 void wxButton::UnsetTmpDefault()
781 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
785 tlw
->SetTmpDefaultItem(NULL
);
787 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
789 SetDefaultStyle(this, false);
790 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), true);
795 wxButton::SetDefaultStyle(wxButton
*btn
, bool on
)
797 // we may be called with NULL pointer -- simpler to do the check here than
798 // in the caller which does wxDynamicCast()
802 // first, let DefDlgProc() know about the new default button
805 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
806 // focus at all any more
807 if ( !wxTheApp
->IsActive() )
810 wxWindow
* const tlw
= wxGetTopLevelParent(btn
);
811 wxCHECK_RET( tlw
, wxT("button without top level window?") );
813 ::SendMessage(GetHwndOf(tlw
), DM_SETDEFID
, btn
->GetId(), 0L);
815 // sending DM_SETDEFID also changes the button style to
816 // BS_DEFPUSHBUTTON so there is nothing more to do
819 // then also change the style as needed
820 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
821 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
823 // don't do it with the owner drawn buttons because it will
824 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
825 // BS_DEFPUSHBUTTON != 0)!
826 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
828 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
829 on
? style
| BS_DEFPUSHBUTTON
830 : style
& ~BS_DEFPUSHBUTTON
,
835 // redraw the button - it will notice itself that it's
836 // [not] the default one [any longer]
840 //else: already has correct style
843 // ----------------------------------------------------------------------------
845 // ----------------------------------------------------------------------------
847 bool wxButton::SendClickEvent()
849 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
850 event
.SetEventObject(this);
852 return ProcessCommand(event
);
855 void wxButton::Command(wxCommandEvent
& event
)
857 ProcessCommand(event
);
860 // ----------------------------------------------------------------------------
861 // event/message handlers
862 // ----------------------------------------------------------------------------
864 bool wxButton::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
866 bool processed
= false;
869 // NOTE: Apparently older versions (NT 4?) of the common controls send
870 // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
871 // buttons, so in order to send two EVT_BUTTON events we should
872 // catch both types. Currently (Feb 2003) up-to-date versions of
873 // win98, win2k and winXP all send two BN_CLICKED messages for
874 // all button types, so we don't catch BN_DOUBLECLICKED anymore
875 // in order to not get 3 EVT_BUTTON events. If this is a problem
876 // then we need to figure out which version of the comctl32 changed
877 // this behaviour and test for it.
879 case 1: // message came from an accelerator
880 case BN_CLICKED
: // normal buttons send this
881 processed
= SendClickEvent();
888 WXLRESULT
wxButton::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
890 // when we receive focus, we want to temporarily become the default button in
891 // our parent panel so that pressing "Enter" would activate us -- and when
892 // losing it we should restore the previous default button as well
893 if ( nMsg
== WM_SETFOCUS
)
897 // let the default processing take place too
899 else if ( nMsg
== WM_KILLFOCUS
)
903 else if ( nMsg
== WM_LBUTTONDBLCLK
)
905 // emulate a click event to force an owner-drawn button to change its
906 // appearance - without this, it won't do it
907 (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
909 // and continue with processing the message normally as well
912 else if ( nMsg
== WM_THEMECHANGED
)
914 // need to recalculate the best size here
915 // as the theme size might have changed
916 InvalidateBestSize();
918 #endif // wxUSE_UXTHEME
919 // must use m_mouseInWindow here instead of IsMouseInWindow()
920 // since we need to know the first time the mouse enters the window
921 // and IsMouseInWindow() would return true in this case
922 else if ( (nMsg
== WM_MOUSEMOVE
&& !m_mouseInWindow
) ||
923 nMsg
== WM_MOUSELEAVE
)
929 wxUxThemeEngine::GetIfActive() ||
930 #endif // wxUSE_UXTHEME
931 m_imageData
&& m_imageData
->GetBitmap(State_Current
).IsOk()
939 // let the base class do all real processing
940 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
943 // ----------------------------------------------------------------------------
945 // ----------------------------------------------------------------------------
947 wxBitmap
wxButton::DoGetBitmap(State which
) const
949 return m_imageData
? m_imageData
->GetBitmap(which
) : wxBitmap();
952 void wxButton::DoSetBitmap(const wxBitmap
& bitmap
, State which
)
954 // allocate the image data when the first bitmap is set
958 // using image list doesn't work correctly if we don't have any label
959 // (even if we use BUTTON_IMAGELIST_ALIGN_CENTER alignment and
960 // BS_BITMAP style), at least under Windows 2003 so use owner drawn
961 // strategy for bitmap-only buttons
962 if ( ShowsLabel() && wxUxThemeEngine::GetIfActive() )
964 m_imageData
= new wxXPButtonImageData(this, bitmap
);
967 #endif // wxUSE_UXTHEME
969 m_imageData
= new wxODButtonImageData(this, bitmap
);
975 m_imageData
->SetBitmap(bitmap
, which
);
978 // it should be enough to only invalidate the best size when the normal
979 // bitmap changes as all bitmaps assigned to the button should be of the
981 if ( which
== State_Normal
)
982 InvalidateBestSize();
987 wxSize
wxButton::DoGetBitmapMargins() const
989 return m_imageData
? m_imageData
->GetBitmapMargins() : wxSize(0, 0);
992 void wxButton::DoSetBitmapMargins(wxCoord x
, wxCoord y
)
994 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
996 m_imageData
->SetBitmapMargins(x
, y
);
999 void wxButton::DoSetBitmapPosition(wxDirection dir
)
1001 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
1003 m_imageData
->SetBitmapPosition(dir
);
1006 // ----------------------------------------------------------------------------
1007 // owner-drawn buttons support
1008 // ----------------------------------------------------------------------------
1014 // return the button state using both the ODS_XXX flags specified in state
1015 // parameter and the current button state
1016 wxButton::State
GetButtonState(wxButton
*btn
, UINT state
)
1018 if ( state
& ODS_DISABLED
)
1019 return wxButton::State_Disabled
;
1021 if ( state
& ODS_SELECTED
)
1022 return wxButton::State_Pressed
;
1024 if ( btn
->HasCapture() || btn
->IsMouseInWindow() )
1025 return wxButton::State_Current
;
1027 if ( state
& ODS_FOCUS
)
1028 return wxButton::State_Focused
;
1030 return wxButton::State_Normal
;
1033 void DrawButtonText(HDC hdc
,
1035 const wxString
& text
,
1039 wxTextColoursChanger
changeFg(hdc
, col
, CLR_INVALID
);
1040 wxBkModeChanger
changeBkMode(hdc
, wxBRUSHSTYLE_TRANSPARENT
);
1042 // center text horizontally in any case
1045 if ( text
.find(wxT('\n')) != wxString::npos
)
1047 // draw multiline label
1049 // first we need to compute its bounding rect
1051 ::CopyRect(&rc
, pRect
);
1052 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
,
1053 DT_CENTER
| DT_CALCRECT
);
1055 // now center this rect inside the entire button area
1056 const LONG w
= rc
.right
- rc
.left
;
1057 const LONG h
= rc
.bottom
- rc
.top
;
1058 rc
.left
= (pRect
->right
- pRect
->left
)/2 - w
/2;
1059 rc
.right
= rc
.left
+w
;
1060 rc
.top
= (pRect
->bottom
- pRect
->top
)/2 - h
/2;
1061 rc
.bottom
= rc
.top
+h
;
1063 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
, flags
);
1065 else // single line label
1067 // centre text vertically too (notice that we must have DT_SINGLELINE
1068 // for DT_VCENTER to work)
1069 ::DrawText(hdc
, text
.wx_str(), text
.length(), pRect
,
1070 flags
| DT_SINGLELINE
| DT_VCENTER
);
1074 void DrawRect(HDC hdc
, const RECT
& r
)
1076 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1077 wxDrawLine(hdc
, r
.right
, r
.top
, r
.right
, r
.bottom
);
1078 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.left
, r
.bottom
);
1079 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.left
, r
.top
);
1083 The button frame looks like this normally:
1086 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
1087 WH GB H = light grey (LIGHT)
1088 WH GB G = dark grey (SHADOW)
1089 WH GB B = black (DKSHADOW)
1094 When the button is selected, the button becomes like this (the total button
1095 size doesn't change):
1106 When the button is pushed (while selected) it is like:
1117 void DrawButtonFrame(HDC hdc
, RECT
& rectBtn
,
1118 bool selected
, bool pushed
)
1121 CopyRect(&r
, &rectBtn
);
1123 AutoHPEN
hpenBlack(GetSysColor(COLOR_3DDKSHADOW
)),
1124 hpenGrey(GetSysColor(COLOR_3DSHADOW
)),
1125 hpenLightGr(GetSysColor(COLOR_3DLIGHT
)),
1126 hpenWhite(GetSysColor(COLOR_3DHILIGHT
));
1128 SelectInHDC
selectPen(hdc
, hpenBlack
);
1137 (void)SelectObject(hdc
, hpenGrey
);
1138 ::InflateRect(&r
, -1, -1);
1148 ::InflateRect(&r
, -1, -1);
1151 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.right
, r
.bottom
);
1152 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.right
, r
.top
- 1);
1154 (void)SelectObject(hdc
, hpenWhite
);
1155 wxDrawLine(hdc
, r
.left
, r
.bottom
- 1, r
.left
, r
.top
);
1156 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1158 (void)SelectObject(hdc
, hpenLightGr
);
1159 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 2, r
.left
+ 1, r
.top
+ 1);
1160 wxDrawLine(hdc
, r
.left
+ 1, r
.top
+ 1, r
.right
- 1, r
.top
+ 1);
1162 (void)SelectObject(hdc
, hpenGrey
);
1163 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 1, r
.right
- 1, r
.bottom
- 1);
1164 wxDrawLine(hdc
, r
.right
- 1, r
.bottom
- 1, r
.right
- 1, r
.top
);
1167 InflateRect(&rectBtn
, -OD_BUTTON_MARGIN
, -OD_BUTTON_MARGIN
);
1171 void DrawXPBackground(wxButton
*button
, HDC hdc
, RECT
& rectBtn
, UINT state
)
1173 wxUxThemeHandle
theme(button
, L
"BUTTON");
1175 // this array is indexed by wxButton::State values and so must be kept in
1177 static const int uxStates
[] =
1179 PBS_NORMAL
, PBS_HOT
, PBS_PRESSED
, PBS_DISABLED
, PBS_DEFAULTED
1182 int iState
= uxStates
[GetButtonState(button
, state
)];
1184 wxUxThemeEngine
* const engine
= wxUxThemeEngine::Get();
1186 // draw parent background if needed
1187 if ( engine
->IsThemeBackgroundPartiallyTransparent
1194 engine
->DrawThemeParentBackground(GetHwndOf(button
), hdc
, &rectBtn
);
1198 engine
->DrawThemeBackground(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1201 // calculate content area margins
1203 engine
->GetThemeMargins(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1204 TMT_CONTENTMARGINS
, &rectBtn
, &margins
);
1205 ::InflateRect(&rectBtn
, -margins
.cxLeftWidth
, -margins
.cyTopHeight
);
1206 ::InflateRect(&rectBtn
, -XP_BUTTON_EXTRA_MARGIN
, -XP_BUTTON_EXTRA_MARGIN
);
1208 if ( button
->UseBgCol() )
1210 COLORREF colBg
= wxColourToRGB(button
->GetBackgroundColour());
1211 AutoHBRUSH
hbrushBackground(colBg
);
1213 // don't overwrite the focus rect
1215 ::CopyRect(&rectClient
, &rectBtn
);
1216 ::InflateRect(&rectClient
, -1, -1);
1217 FillRect(hdc
, &rectClient
, hbrushBackground
);
1220 #endif // wxUSE_UXTHEME
1222 } // anonymous namespace
1224 // ----------------------------------------------------------------------------
1225 // owner drawn buttons support
1226 // ----------------------------------------------------------------------------
1228 void wxButton::MakeOwnerDrawn()
1230 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
1231 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
1234 style
|= BS_OWNERDRAW
;
1235 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
1239 bool wxButton::SetBackgroundColour(const wxColour
&colour
)
1241 if ( !wxControl::SetBackgroundColour(colour
) )
1254 bool wxButton::SetForegroundColour(const wxColour
&colour
)
1256 if ( !wxControl::SetForegroundColour(colour
) )
1269 bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
1271 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
1272 HDC hdc
= lpDIS
->hDC
;
1274 UINT state
= lpDIS
->itemState
;
1275 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
1278 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
1280 // draw the button background
1281 if ( !HasFlag(wxBORDER_NONE
) )
1284 if ( wxUxThemeEngine::GetIfActive() )
1286 DrawXPBackground(this, hdc
, rectBtn
, state
);
1289 #endif // wxUSE_UXTHEME
1291 COLORREF colBg
= wxColourToRGB(GetBackgroundColour());
1293 // first, draw the background
1294 AutoHBRUSH
hbrushBackground(colBg
);
1295 FillRect(hdc
, &rectBtn
, hbrushBackground
);
1297 // draw the border for the current state
1298 bool selected
= (state
& ODS_SELECTED
) != 0;
1302 tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
1305 selected
= tlw
->GetDefaultItem() == this;
1309 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
1312 // draw the focus rectangle if we need it
1313 if ( (state
& ODS_FOCUS
) && !(state
& ODS_NOFOCUSRECT
) )
1315 DrawFocusRect(hdc
, &rectBtn
);
1318 if ( !wxUxThemeEngine::GetIfActive() )
1319 #endif // wxUSE_UXTHEME
1323 // the label is shifted by 1 pixel to create "pushed" effect
1324 OffsetRect(&rectBtn
, 1, 1);
1331 // draw the image, if any
1334 wxBitmap bmp
= m_imageData
->GetBitmap(GetButtonState(this, state
));
1336 bmp
= m_imageData
->GetBitmap(State_Normal
);
1338 const wxSize sizeBmp
= bmp
.GetSize();
1339 const wxSize margin
= m_imageData
->GetBitmapMargins();
1340 const wxSize
sizeBmpWithMargins(sizeBmp
+ 2*margin
);
1341 wxRect
rectButton(wxRectFromRECT(rectBtn
));
1343 // for simplicity, we start with centred rectangle and then move it to
1344 // the appropriate edge
1345 wxRect rectBitmap
= wxRect(sizeBmp
).CentreIn(rectButton
);
1346 switch ( m_imageData
->GetBitmapPosition() )
1349 wxFAIL_MSG( "invalid direction" );
1353 rectBitmap
.x
= rectButton
.x
+ margin
.x
;
1354 rectButton
.x
+= sizeBmpWithMargins
.x
;
1355 rectButton
.width
-= sizeBmpWithMargins
.x
;
1359 rectBitmap
.x
= rectButton
.GetRight() - sizeBmp
.x
- margin
.x
;
1360 rectButton
.width
-= sizeBmpWithMargins
.x
;
1364 rectBitmap
.y
= rectButton
.y
+ margin
.y
;
1365 rectButton
.y
+= sizeBmpWithMargins
.y
;
1366 rectButton
.height
-= sizeBmpWithMargins
.y
;
1370 rectBitmap
.y
= rectButton
.GetBottom() - sizeBmp
.y
- margin
.y
;
1371 rectButton
.height
-= sizeBmpWithMargins
.y
;
1375 wxDCTemp
dst((WXHDC
)hdc
);
1376 dst
.DrawBitmap(bmp
, rectBitmap
.GetPosition(), true);
1378 wxCopyRectToRECT(rectButton
, rectBtn
);
1382 // finally draw the label
1385 COLORREF colFg
= state
& ODS_DISABLED
1386 ? ::GetSysColor(COLOR_GRAYTEXT
)
1387 : wxColourToRGB(GetForegroundColour());
1389 // notice that DT_HIDEPREFIX doesn't work on old (pre-Windows 2000)
1390 // systems but by happy coincidence ODS_NOACCEL is not used under them
1391 // neither so DT_HIDEPREFIX should never be used there
1392 DrawButtonText(hdc
, &rectBtn
, GetLabel(), colFg
,
1393 state
& ODS_NOACCEL
? DT_HIDEPREFIX
: 0);
1399 #endif // wxUSE_BUTTON