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"
40 #include "wx/msw/wrapcctl.h"
41 #include "wx/msw/private.h"
42 #include "wx/msw/missing.h"
45 #include "wx/imaglist.h"
46 #include "wx/stockitem.h"
47 #include "wx/msw/private/button.h"
48 #include "wx/msw/private/dc.h"
49 #include "wx/private/window.h"
51 using namespace wxMSWImpl
;
54 #include "wx/msw/uxtheme.h"
56 // no need to include tmschema.h
58 #define BP_PUSHBUTTON 1
63 #define PBS_DISABLED 4
64 #define PBS_DEFAULTED 5
66 #define TMT_CONTENTMARGINS 3602
69 // provide the necessary declarations ourselves if they're missing from
71 #ifndef BCM_SETIMAGELIST
72 #define BCM_SETIMAGELIST 0x1602
73 #define BCM_SETTEXTMARGIN 0x1604
77 BUTTON_IMAGELIST_ALIGN_LEFT
,
78 BUTTON_IMAGELIST_ALIGN_RIGHT
,
79 BUTTON_IMAGELIST_ALIGN_TOP
,
80 BUTTON_IMAGELIST_ALIGN_BOTTOM
83 struct BUTTON_IMAGELIST
90 #endif // wxUSE_UXTHEME
92 #ifndef WM_THEMECHANGED
93 #define WM_THEMECHANGED 0x031A
97 #define ODS_NOACCEL 0x0100
100 #ifndef ODS_NOFOCUSRECT
101 #define ODS_NOFOCUSRECT 0x0200
104 #ifndef DT_HIDEPREFIX
105 #define DT_HIDEPREFIX 0x00100000
108 // set the value for BCM_SETSHIELD (for the UAC shield) if it's not defined in
110 #ifndef BCM_SETSHIELD
111 #define BCM_SETSHIELD 0x160c
114 // ----------------------------------------------------------------------------
116 // ----------------------------------------------------------------------------
118 // we use different data classes for owner drawn buttons and for themed XP ones
120 class wxButtonImageData
123 wxButtonImageData() { }
124 virtual ~wxButtonImageData() { }
126 virtual wxBitmap
GetBitmap(wxButton
::State which
) const = 0;
127 virtual void SetBitmap(const wxBitmap
& bitmap
, wxButton
::State which
) = 0;
129 virtual wxSize
GetBitmapMargins() const = 0;
130 virtual void SetBitmapMargins(wxCoord x
, wxCoord y
) = 0;
132 virtual wxDirection
GetBitmapPosition() const = 0;
133 virtual void SetBitmapPosition(wxDirection dir
) = 0;
136 wxDECLARE_NO_COPY_CLASS(wxButtonImageData
);
142 // the gap between button edge and the interior area used by Windows for the
144 const int OD_BUTTON_MARGIN
= 4;
146 class wxODButtonImageData
: public wxButtonImageData
149 wxODButtonImageData(wxButton
*btn
, const wxBitmap
& bitmap
)
151 SetBitmap(bitmap
, wxButton
::State_Normal
);
155 // we use margins when we have both bitmap and text, but when we have
156 // only the bitmap it should take up the entire button area
157 if ( btn
->ShowsLabel() )
159 m_margin
.x
= btn
->GetCharWidth();
160 m_margin
.y
= btn
->GetCharHeight() / 2;
164 virtual wxBitmap
GetBitmap(wxButton
::State which
) const
166 return m_bitmaps
[which
];
169 virtual void SetBitmap(const wxBitmap
& bitmap
, wxButton
::State which
)
171 m_bitmaps
[which
] = bitmap
;
174 virtual wxSize
GetBitmapMargins() const
179 virtual void SetBitmapMargins(wxCoord x
, wxCoord y
)
181 m_margin
= wxSize(x
, y
);
184 virtual wxDirection
GetBitmapPosition() const
189 virtual void SetBitmapPosition(wxDirection dir
)
195 // just store the values passed to us to be able to retrieve them later
196 // from the drawing code
197 wxBitmap m_bitmaps
[wxButton
::State_Max
];
201 wxDECLARE_NO_COPY_CLASS(wxODButtonImageData
);
206 // somehow the margin is one pixel greater than the value returned by
207 // GetThemeMargins() call
208 const int XP_BUTTON_EXTRA_MARGIN
= 1;
210 class wxXPButtonImageData
: public wxButtonImageData
213 // we must be constructed with the size of our images as we need to create
215 wxXPButtonImageData(wxButton
*btn
, const wxBitmap
& bitmap
)
216 : m_iml(bitmap
.GetWidth(), bitmap
.GetHeight(), true /* use mask */,
217 wxButton
::State_Max
),
218 m_hwndBtn(GetHwndOf(btn
))
220 // initialize all bitmaps to normal state
221 for ( int n
= 0; n
< wxButton
::State_Max
; n
++ )
226 m_data
.himl
= GetHimagelistOf(&m_iml
);
228 // no margins by default
230 m_data
.margin
.right
=
232 m_data
.margin
.bottom
= 0;
234 // use default alignment
235 m_data
.uAlign
= BUTTON_IMAGELIST_ALIGN_LEFT
;
240 virtual wxBitmap
GetBitmap(wxButton
::State which
) const
242 return m_iml
.GetBitmap(which
);
245 virtual void SetBitmap(const wxBitmap
& bitmap
, wxButton
::State which
)
247 m_iml
.Replace(which
, bitmap
);
252 virtual wxSize
GetBitmapMargins() const
254 return wxSize(m_data
.margin
.left
, m_data
.margin
.top
);
257 virtual void SetBitmapMargins(wxCoord x
, wxCoord y
)
259 RECT
& margin
= m_data
.margin
;
265 if ( !::SendMessage(m_hwndBtn
, BCM_SETTEXTMARGIN
, 0, (LPARAM
)&margin
) )
267 wxLogDebug("SendMessage(BCM_SETTEXTMARGIN) failed");
271 virtual wxDirection
GetBitmapPosition() const
273 switch ( m_data
.uAlign
)
276 wxFAIL_MSG( "invalid image alignment" );
279 case BUTTON_IMAGELIST_ALIGN_LEFT
:
282 case BUTTON_IMAGELIST_ALIGN_RIGHT
:
285 case BUTTON_IMAGELIST_ALIGN_TOP
:
288 case BUTTON_IMAGELIST_ALIGN_BOTTOM
:
293 virtual void SetBitmapPosition(wxDirection dir
)
299 wxFAIL_MSG( "invalid direction" );
303 alignNew
= BUTTON_IMAGELIST_ALIGN_LEFT
;
307 alignNew
= BUTTON_IMAGELIST_ALIGN_RIGHT
;
311 alignNew
= BUTTON_IMAGELIST_ALIGN_TOP
;
315 alignNew
= BUTTON_IMAGELIST_ALIGN_BOTTOM
;
319 if ( alignNew
!= m_data
.uAlign
)
321 m_data
.uAlign
= alignNew
;
327 void UpdateImageInfo()
329 if ( !::SendMessage(m_hwndBtn
, BCM_SETIMAGELIST
, 0, (LPARAM
)&m_data
) )
331 wxLogDebug("SendMessage(BCM_SETIMAGELIST) failed");
335 // we store image list separately to be able to use convenient wxImageList
336 // methods instead of working with raw HIMAGELIST
339 // store the rest of the data in BCM_SETIMAGELIST-friendly form
340 BUTTON_IMAGELIST m_data
;
342 // the button we're associated with
343 const HWND m_hwndBtn
;
346 wxDECLARE_NO_COPY_CLASS(wxXPButtonImageData
);
349 #endif // wxUSE_UXTHEME
351 } // anonymous namespace
353 // ----------------------------------------------------------------------------
355 // ----------------------------------------------------------------------------
357 // ============================================================================
359 // ============================================================================
361 // ----------------------------------------------------------------------------
362 // helper functions from wx/msw/private/button.h
363 // ----------------------------------------------------------------------------
365 void wxMSWButton
::UpdateMultilineStyle(HWND hwnd
, const wxString
& label
)
367 // update BS_MULTILINE style depending on the new label (resetting it
368 // doesn't seem to do anything very useful but it shouldn't hurt and we do
369 // have to set it whenever the label becomes multi line as otherwise it
370 // wouldn't be shown correctly as we don't use BS_MULTILINE when creating
371 // the control unless it already has new lines in its label)
372 long styleOld
= ::GetWindowLong(hwnd
, GWL_STYLE
),
374 if ( label
.find(wxT('\n')) != wxString
::npos
)
375 styleNew
= styleOld
| BS_MULTILINE
;
377 styleNew
= styleOld
& ~BS_MULTILINE
;
379 if ( styleNew
!= styleOld
)
380 ::SetWindowLong(hwnd
, GWL_STYLE
, styleNew
);
383 wxSize wxMSWButton
::GetFittingSize(wxWindow
*win
,
384 const wxSize
& sizeLabel
,
387 // FIXME: this is pure guesswork, need to retrieve the real button margins
388 wxSize sizeBtn
= sizeLabel
;
390 sizeBtn
.x
+= 3*win
->GetCharWidth();
392 // account for the shield UAC icon if we have it
393 if ( flags
& Size_AuthNeeded
)
394 sizeBtn
.x
+= wxSystemSettings
::GetMetric(wxSYS_SMALLICON_X
);
399 wxSize wxMSWButton
::ComputeBestFittingSize(wxControl
*btn
, int flags
)
404 dc
.GetMultiLineTextExtent(btn
->GetLabelText(), &sizeBtn
.x
, &sizeBtn
.y
);
406 return GetFittingSize(btn
, sizeBtn
, flags
);
409 wxSize wxMSWButton
::IncreaseToStdSizeAndCache(wxControl
*btn
, const wxSize
& size
)
411 wxSize
sizeBtn(size
);
413 // All buttons have at least the standard height and, unless the user
414 // explicitly wants them to be as small as possible and used wxBU_EXACTFIT
415 // style to indicate this, of at least the standard width too.
417 // Notice that we really want to make all buttons equally high, otherwise
418 // they look ugly and the existing code using wxBU_EXACTFIT only uses it to
419 // control width and not height.
421 // The 50x14 button size is documented in the "Recommended sizing and
422 // spacing" section of MSDN layout article.
424 // Note that we intentionally don't use GetDefaultSize() here, because
425 // it's inexact -- dialog units depend on this dialog's font.
426 const wxSize sizeDef
= btn
->ConvertDialogToPixels(wxSize(50, 14));
427 if ( !btn
->HasFlag(wxBU_EXACTFIT
) )
429 if ( sizeBtn
.x
< sizeDef
.x
)
430 sizeBtn
.x
= sizeDef
.x
;
432 if ( sizeBtn
.y
< sizeDef
.y
)
433 sizeBtn
.y
= sizeDef
.y
;
435 btn
->CacheBestSize(sizeBtn
);
440 // ----------------------------------------------------------------------------
441 // creation/destruction
442 // ----------------------------------------------------------------------------
444 bool wxButton
::Create(wxWindow
*parent
,
450 const wxValidator
& validator
,
451 const wxString
& name
)
454 if (label
.empty() && wxIsStockID(id
))
456 // On Windows, some buttons aren't supposed to have mnemonics
457 label
= wxGetStockLabel
460 id
== wxID_OK
|| id
== wxID_CANCEL
|| id
== wxID_CLOSE
462 : wxSTOCK_WITH_MNEMONIC
466 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
470 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
472 // if the label contains several lines we must explicitly tell the button
473 // about it or it wouldn't draw it correctly ("\n"s would just appear as
476 // NB: we do it here and not in MSWGetStyle() because we need the label
477 // value and the label is not set yet when MSWGetStyle() is called
478 msStyle
|= wxMSWButton
::GetMultilineStyle(label
);
480 return MSWCreateControl(wxT("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
483 wxButton
::~wxButton()
485 wxTopLevelWindow
*tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
486 if ( tlw
&& tlw
->GetTmpDefaultItem() == this )
494 // ----------------------------------------------------------------------------
496 // ----------------------------------------------------------------------------
498 WXDWORD wxButton
::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
500 // buttons never have an external border, they draw their own one
501 WXDWORD msStyle
= wxControl
::MSWGetStyle
503 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
506 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
507 // each other in any resizeable dialog which has more than one button in
509 msStyle
|= WS_CLIPSIBLINGS
;
511 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
512 // and wxBU_RIGHT to get BS_CENTER!
513 if ( style
& wxBU_LEFT
)
515 if ( style
& wxBU_RIGHT
)
517 if ( style
& wxBU_TOP
)
519 if ( style
& wxBU_BOTTOM
)
520 msStyle
|= BS_BOTTOM
;
523 if ( style
& wxNO_BORDER
)
525 #endif // __WXWINCE__
530 void wxButton
::SetLabel(const wxString
& label
)
532 wxMSWButton
::UpdateMultilineStyle(GetHwnd(), label
);
534 wxButtonBase
::SetLabel(label
);
537 // ----------------------------------------------------------------------------
538 // size management including autosizing
539 // ----------------------------------------------------------------------------
541 void wxButton
::AdjustForBitmapSize(wxSize
&size
) const
543 wxCHECK_RET( m_imageData
, wxT("shouldn't be called if no image") );
545 // account for the bitmap size
546 const wxSize sizeBmp
= m_imageData
->GetBitmap(State_Normal
).GetSize();
547 const wxDirection dirBmp
= m_imageData
->GetBitmapPosition();
548 if ( dirBmp
== wxLEFT
|| dirBmp
== wxRIGHT
)
551 if ( sizeBmp
.y
> size
.y
)
554 else // bitmap on top/below the text
557 if ( sizeBmp
.x
> size
.x
)
561 // account for the user-specified margins
562 size
+= 2*m_imageData
->GetBitmapMargins();
564 // and also for the margins we always add internally (unless we have no
565 // border at all in which case the button has exactly the same size as
566 // bitmap and so no margins should be used)
567 if ( !HasFlag(wxBORDER_NONE
) )
572 if ( wxUxThemeEngine
::GetIfActive() )
574 wxUxThemeHandle
theme(const_cast<wxButton
*>(this), L
"BUTTON");
577 wxUxThemeEngine
::Get()->GetThemeMargins(theme
, NULL
,
584 // XP doesn't draw themed buttons correctly when the client
585 // area is smaller than 8x8 - enforce this minimum size for
587 size
.IncTo(wxSize(8, 8));
589 marginH
= margins
.cxLeftWidth
+ margins
.cxRightWidth
590 + 2*XP_BUTTON_EXTRA_MARGIN
;
591 marginV
= margins
.cyTopHeight
+ margins
.cyBottomHeight
592 + 2*XP_BUTTON_EXTRA_MARGIN
;
595 #endif // wxUSE_UXTHEME
598 marginV
= OD_BUTTON_MARGIN
;
601 size
.IncBy(marginH
, marginV
);
605 wxSize wxButton
::DoGetBestSize() const
607 wxButton
* const self
= const_cast<wxButton
*>(this);
611 // Account for the text part if we have it.
615 if ( GetAuthNeeded() )
616 flags
|= wxMSWButton
::Size_AuthNeeded
;
618 size
= wxMSWButton
::ComputeBestFittingSize(self
, flags
);
622 AdjustForBitmapSize(size
);
624 return wxMSWButton
::IncreaseToStdSizeAndCache(self
, size
);
628 wxSize wxButtonBase
::GetDefaultSize()
630 static wxSize s_sizeBtn
;
632 if ( s_sizeBtn
.x
== 0 )
635 dc
.SetFont(wxSystemSettings
::GetFont(wxSYS_DEFAULT_GUI_FONT
));
637 // The size of a standard button in the dialog units is 50x14,
638 // translate this to pixels.
640 // Windows' computes dialog units using average character width over
641 // upper- and lower-case ASCII alphabet and not using the average
642 // character width metadata stored in the font; see
643 // http://support.microsoft.com/default.aspx/kb/145994 for detailed
646 // NB: wxMulDivInt32() is used, because it correctly rounds the result
648 const wxSize base
= wxPrivate
::GetAverageASCIILetterSize(dc
);
649 s_sizeBtn
.x
= wxMulDivInt32(50, base
.x
, 4);
650 s_sizeBtn
.y
= wxMulDivInt32(14, base
.y
, 8);
656 // ----------------------------------------------------------------------------
657 // default button handling
658 // ----------------------------------------------------------------------------
661 The comment below and all this code is probably due to not using WM_NEXTDLGCTL
662 message when changing focus (but just SetFocus() which is not enough), see
663 http://blogs.msdn.com/oldnewthing/archive/2004/08/02/205624.aspx for the
666 TODO: Do use WM_NEXTDLGCTL and get rid of all this code.
669 "Everything you ever wanted to know about the default buttons" or "Why do we
670 have to do all this?"
672 In MSW the default button should be activated when the user presses Enter
673 and the current control doesn't process Enter itself somehow. This is
674 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
675 Another aspect of "defaultness" is that the default button has different
676 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
677 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
678 be unset if our parent window is not active so it should be unset whenever
679 we lose activation and set back when we regain it.
681 Final complication is that when a button is active, it should be the default
682 one, i.e. pressing Enter on a button always activates it and not another
685 We handle this by maintaining a permanent and a temporary default items in
686 wxControlContainer (both may be NULL). When a button becomes the current
687 control (i.e. gets focus) it sets itself as the temporary default which
688 ensures that it has the right appearance and that Enter will be redirected
689 to it. When the button loses focus, it unsets the temporary default and so
690 the default item will be the permanent default -- that is the default button
691 if any had been set or none otherwise, which is just what we want.
693 NB: all this is quite complicated by now and the worst is that normally
694 it shouldn't be necessary at all as for the normal Windows programs
695 DefWindowProc() and IsDialogMessage() take care of all this
696 automatically -- however in wxWidgets programs this doesn't work for
697 nested hierarchies (i.e. a notebook inside a notebook) for unknown
698 reason and so we have to reproduce all this code ourselves. It would be
699 very nice if we could avoid doing it.
702 // set this button as the (permanently) default one in its panel
703 wxWindow
*wxButton
::SetDefault()
705 // set this one as the default button both for wxWidgets ...
706 wxWindow
*winOldDefault
= wxButtonBase
::SetDefault();
709 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
710 SetDefaultStyle(this, true);
712 return winOldDefault
;
715 // return the top level parent window if it's not being deleted yet, otherwise
717 static wxTopLevelWindow
*GetTLWParentIfNotBeingDeleted(wxWindow
*win
)
721 // IsTopLevel() will return false for a wxTLW being deleted, so we also
722 // need the parent test for this case
723 wxWindow
* const parent
= win
->GetParent();
724 if ( !parent
|| win
->IsTopLevel() )
726 if ( win
->IsBeingDeleted() )
735 wxASSERT_MSG( win
, wxT("button without top level parent?") );
737 wxTopLevelWindow
* const tlw
= wxDynamicCast(win
, wxTopLevelWindow
);
738 wxASSERT_MSG( tlw
, wxT("logic error in GetTLWParentIfNotBeingDeleted()") );
743 // set this button as being currently default
744 void wxButton
::SetTmpDefault()
746 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
750 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
751 tlw
->SetTmpDefaultItem(this);
753 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
754 SetDefaultStyle(this, true);
757 // unset this button as currently default, it may still stay permanent default
758 void wxButton
::UnsetTmpDefault()
760 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
764 tlw
->SetTmpDefaultItem(NULL
);
766 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
768 SetDefaultStyle(this, false);
769 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), true);
774 wxButton
::SetDefaultStyle(wxButton
*btn
, bool on
)
776 // we may be called with NULL pointer -- simpler to do the check here than
777 // in the caller which does wxDynamicCast()
781 // first, let DefDlgProc() know about the new default button
784 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
785 // focus at all any more
786 if ( !wxTheApp
->IsActive() )
789 wxWindow
* const tlw
= wxGetTopLevelParent(btn
);
790 wxCHECK_RET( tlw
, wxT("button without top level window?") );
792 ::SendMessage(GetHwndOf(tlw
), DM_SETDEFID
, btn
->GetId(), 0L);
794 // sending DM_SETDEFID also changes the button style to
795 // BS_DEFPUSHBUTTON so there is nothing more to do
798 // then also change the style as needed
799 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
800 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
802 // don't do it with the owner drawn buttons because it will
803 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
804 // BS_DEFPUSHBUTTON != 0)!
805 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
807 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
808 on ? style
| BS_DEFPUSHBUTTON
809 : style
& ~BS_DEFPUSHBUTTON
,
814 // redraw the button - it will notice itself that it's
815 // [not] the default one [any longer]
819 //else: already has correct style
822 // ----------------------------------------------------------------------------
824 // ----------------------------------------------------------------------------
826 bool wxButton
::SendClickEvent()
828 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
829 event
.SetEventObject(this);
831 return ProcessCommand(event
);
834 void wxButton
::Command(wxCommandEvent
& event
)
836 ProcessCommand(event
);
839 // ----------------------------------------------------------------------------
840 // event/message handlers
841 // ----------------------------------------------------------------------------
843 bool wxButton
::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
845 bool processed
= false;
848 // NOTE: Apparently older versions (NT 4?) of the common controls send
849 // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
850 // buttons, so in order to send two EVT_BUTTON events we should
851 // catch both types. Currently (Feb 2003) up-to-date versions of
852 // win98, win2k and winXP all send two BN_CLICKED messages for
853 // all button types, so we don't catch BN_DOUBLECLICKED anymore
854 // in order to not get 3 EVT_BUTTON events. If this is a problem
855 // then we need to figure out which version of the comctl32 changed
856 // this behaviour and test for it.
858 case 1: // message came from an accelerator
859 case BN_CLICKED
: // normal buttons send this
860 processed
= SendClickEvent();
867 WXLRESULT wxButton
::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
869 // when we receive focus, we want to temporarily become the default button in
870 // our parent panel so that pressing "Enter" would activate us -- and when
871 // losing it we should restore the previous default button as well
872 if ( nMsg
== WM_SETFOCUS
)
876 // let the default processing take place too
878 else if ( nMsg
== WM_KILLFOCUS
)
882 else if ( nMsg
== WM_LBUTTONDBLCLK
)
884 // emulate a click event to force an owner-drawn button to change its
885 // appearance - without this, it won't do it
886 (void)wxControl
::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
888 // and continue with processing the message normally as well
891 else if ( nMsg
== WM_THEMECHANGED
)
893 // need to recalculate the best size here
894 // as the theme size might have changed
895 InvalidateBestSize();
897 #endif // wxUSE_UXTHEME
898 // must use m_mouseInWindow here instead of IsMouseInWindow()
899 // since we need to know the first time the mouse enters the window
900 // and IsMouseInWindow() would return true in this case
901 else if ( (nMsg
== WM_MOUSEMOVE
&& !m_mouseInWindow
) ||
902 nMsg
== WM_MOUSELEAVE
)
908 wxUxThemeEngine
::GetIfActive() ||
909 #endif // wxUSE_UXTHEME
910 (m_imageData
&& m_imageData
->GetBitmap(State_Current
).IsOk())
918 // let the base class do all real processing
919 return wxControl
::MSWWindowProc(nMsg
, wParam
, lParam
);
922 // ----------------------------------------------------------------------------
923 // authentication needed handling
924 // ----------------------------------------------------------------------------
926 bool wxButton
::DoGetAuthNeeded() const
931 void wxButton
::DoSetAuthNeeded(bool show
)
933 // show/hide UAC symbol on Windows Vista and later
934 if ( wxGetWinVersion() >= wxWinVersion_6
)
937 ::SendMessage(GetHwnd(), BCM_SETSHIELD
, 0, show
);
938 InvalidateBestSize();
942 // ----------------------------------------------------------------------------
944 // ----------------------------------------------------------------------------
946 wxBitmap wxButton
::DoGetBitmap(State which
) const
948 return m_imageData ? m_imageData
->GetBitmap(which
) : wxBitmap();
951 void wxButton
::DoSetBitmap(const wxBitmap
& bitmap
, State which
)
953 // allocate the image data when the first bitmap is set
957 // using image list doesn't work correctly if we don't have any label
958 // (even if we use BUTTON_IMAGELIST_ALIGN_CENTER alignment and
959 // BS_BITMAP style), at least under Windows 2003 so use owner drawn
960 // strategy for bitmap-only buttons
961 if ( ShowsLabel() && wxUxThemeEngine
::GetIfActive() )
963 m_imageData
= new wxXPButtonImageData(this, bitmap
);
966 #endif // wxUSE_UXTHEME
968 m_imageData
= new wxODButtonImageData(this, bitmap
);
974 m_imageData
->SetBitmap(bitmap
, which
);
977 // it should be enough to only invalidate the best size when the normal
978 // bitmap changes as all bitmaps assigned to the button should be of the
980 if ( which
== State_Normal
)
981 InvalidateBestSize();
986 wxSize wxButton
::DoGetBitmapMargins() const
988 return m_imageData ? m_imageData
->GetBitmapMargins() : wxSize(0, 0);
991 void wxButton
::DoSetBitmapMargins(wxCoord x
, wxCoord y
)
993 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
995 m_imageData
->SetBitmapMargins(x
, y
);
996 InvalidateBestSize();
999 void wxButton
::DoSetBitmapPosition(wxDirection dir
)
1001 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
1003 m_imageData
->SetBitmapPosition(dir
);
1004 InvalidateBestSize();
1007 // ----------------------------------------------------------------------------
1008 // owner-drawn buttons support
1009 // ----------------------------------------------------------------------------
1015 // return the button state using both the ODS_XXX flags specified in state
1016 // parameter and the current button state
1017 wxButton
::State
GetButtonState(wxButton
*btn
, UINT state
)
1019 if ( state
& ODS_DISABLED
)
1020 return wxButton
::State_Disabled
;
1022 if ( state
& ODS_SELECTED
)
1023 return wxButton
::State_Pressed
;
1025 if ( btn
->HasCapture() || btn
->IsMouseInWindow() )
1026 return wxButton
::State_Current
;
1028 if ( state
& ODS_FOCUS
)
1029 return wxButton
::State_Focused
;
1031 return wxButton
::State_Normal
;
1034 void DrawButtonText(HDC hdc
,
1036 const wxString
& text
,
1040 wxTextColoursChanger
changeFg(hdc
, col
, CLR_INVALID
);
1041 wxBkModeChanger
changeBkMode(hdc
, wxBRUSHSTYLE_TRANSPARENT
);
1043 // center text horizontally in any case
1046 if ( text
.find(wxT('\n')) != wxString
::npos
)
1048 // draw multiline label
1050 // first we need to compute its bounding rect
1052 ::CopyRect(&rc
, pRect
);
1053 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
,
1054 DT_CENTER
| DT_CALCRECT
);
1056 // now center this rect inside the entire button area
1057 const LONG w
= rc
.right
- rc
.left
;
1058 const LONG h
= rc
.bottom
- rc
.top
;
1059 rc
.left
= (pRect
->right
- pRect
->left
)/2 - w
/2;
1060 rc
.right
= rc
.left
+w
;
1061 rc
.top
= (pRect
->bottom
- pRect
->top
)/2 - h
/2;
1062 rc
.bottom
= rc
.top
+h
;
1064 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
, flags
);
1066 else // single line label
1068 // centre text vertically too (notice that we must have DT_SINGLELINE
1069 // for DT_VCENTER to work)
1070 ::DrawText(hdc
, text
.wx_str(), text
.length(), pRect
,
1071 flags
| DT_SINGLELINE
| DT_VCENTER
);
1075 void DrawRect(HDC hdc
, const RECT
& r
)
1077 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1078 wxDrawLine(hdc
, r
.right
, r
.top
, r
.right
, r
.bottom
);
1079 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.left
, r
.bottom
);
1080 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.left
, r
.top
);
1084 The button frame looks like this normally:
1087 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
1088 WH GB H = light grey (LIGHT)
1089 WH GB G = dark grey (SHADOW)
1090 WH GB B = black (DKSHADOW)
1095 When the button is selected, the button becomes like this (the total button
1096 size doesn't change):
1107 When the button is pushed (while selected) it is like:
1118 void DrawButtonFrame(HDC hdc
, RECT
& rectBtn
,
1119 bool selected
, bool pushed
)
1122 CopyRect(&r
, &rectBtn
);
1124 AutoHPEN
hpenBlack(GetSysColor(COLOR_3DDKSHADOW
)),
1125 hpenGrey(GetSysColor(COLOR_3DSHADOW
)),
1126 hpenLightGr(GetSysColor(COLOR_3DLIGHT
)),
1127 hpenWhite(GetSysColor(COLOR_3DHILIGHT
));
1129 SelectInHDC
selectPen(hdc
, hpenBlack
);
1138 (void)SelectObject(hdc
, hpenGrey
);
1139 ::InflateRect(&r
, -1, -1);
1149 ::InflateRect(&r
, -1, -1);
1152 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.right
, r
.bottom
);
1153 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.right
, r
.top
- 1);
1155 (void)SelectObject(hdc
, hpenWhite
);
1156 wxDrawLine(hdc
, r
.left
, r
.bottom
- 1, r
.left
, r
.top
);
1157 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1159 (void)SelectObject(hdc
, hpenLightGr
);
1160 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 2, r
.left
+ 1, r
.top
+ 1);
1161 wxDrawLine(hdc
, r
.left
+ 1, r
.top
+ 1, r
.right
- 1, r
.top
+ 1);
1163 (void)SelectObject(hdc
, hpenGrey
);
1164 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 1, r
.right
- 1, r
.bottom
- 1);
1165 wxDrawLine(hdc
, r
.right
- 1, r
.bottom
- 1, r
.right
- 1, r
.top
);
1168 InflateRect(&rectBtn
, -OD_BUTTON_MARGIN
, -OD_BUTTON_MARGIN
);
1172 void DrawXPBackground(wxButton
*button
, HDC hdc
, RECT
& rectBtn
, UINT state
)
1174 wxUxThemeHandle
theme(button
, L
"BUTTON");
1176 // this array is indexed by wxButton::State values and so must be kept in
1178 static const int uxStates
[] =
1180 PBS_NORMAL
, PBS_HOT
, PBS_PRESSED
, PBS_DISABLED
, PBS_DEFAULTED
1183 int iState
= uxStates
[GetButtonState(button
, state
)];
1185 wxUxThemeEngine
* const engine
= wxUxThemeEngine
::Get();
1187 // draw parent background if needed
1188 if ( engine
->IsThemeBackgroundPartiallyTransparent
1195 engine
->DrawThemeParentBackground(GetHwndOf(button
), hdc
, &rectBtn
);
1199 engine
->DrawThemeBackground(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1202 // calculate content area margins
1204 engine
->GetThemeMargins(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1205 TMT_CONTENTMARGINS
, &rectBtn
, &margins
);
1206 ::InflateRect(&rectBtn
, -margins
.cxLeftWidth
, -margins
.cyTopHeight
);
1207 ::InflateRect(&rectBtn
, -XP_BUTTON_EXTRA_MARGIN
, -XP_BUTTON_EXTRA_MARGIN
);
1209 if ( button
->UseBgCol() )
1211 COLORREF colBg
= wxColourToRGB(button
->GetBackgroundColour());
1212 AutoHBRUSH
hbrushBackground(colBg
);
1214 // don't overwrite the focus rect
1216 ::CopyRect(&rectClient
, &rectBtn
);
1217 ::InflateRect(&rectClient
, -1, -1);
1218 FillRect(hdc
, &rectClient
, hbrushBackground
);
1221 #endif // wxUSE_UXTHEME
1223 } // anonymous namespace
1225 // ----------------------------------------------------------------------------
1226 // owner drawn buttons support
1227 // ----------------------------------------------------------------------------
1229 void wxButton
::MakeOwnerDrawn()
1231 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
1232 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
1235 style
|= BS_OWNERDRAW
;
1236 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
1240 bool wxButton
::SetBackgroundColour(const wxColour
&colour
)
1242 if ( !wxControl
::SetBackgroundColour(colour
) )
1255 bool wxButton
::SetForegroundColour(const wxColour
&colour
)
1257 if ( !wxControl
::SetForegroundColour(colour
) )
1270 bool wxButton
::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
1272 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
1273 HDC hdc
= lpDIS
->hDC
;
1275 UINT state
= lpDIS
->itemState
;
1276 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
1279 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
1281 // draw the button background
1282 if ( !HasFlag(wxBORDER_NONE
) )
1285 if ( wxUxThemeEngine
::GetIfActive() )
1287 DrawXPBackground(this, hdc
, rectBtn
, state
);
1290 #endif // wxUSE_UXTHEME
1292 COLORREF colBg
= wxColourToRGB(GetBackgroundColour());
1294 // first, draw the background
1295 AutoHBRUSH
hbrushBackground(colBg
);
1296 FillRect(hdc
, &rectBtn
, hbrushBackground
);
1298 // draw the border for the current state
1299 bool selected
= (state
& ODS_SELECTED
) != 0;
1303 tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
1306 selected
= tlw
->GetDefaultItem() == this;
1310 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
1313 // draw the focus rectangle if we need it
1314 if ( (state
& ODS_FOCUS
) && !(state
& ODS_NOFOCUSRECT
) )
1316 DrawFocusRect(hdc
, &rectBtn
);
1319 if ( !wxUxThemeEngine
::GetIfActive() )
1320 #endif // wxUSE_UXTHEME
1324 // the label is shifted by 1 pixel to create "pushed" effect
1325 OffsetRect(&rectBtn
, 1, 1);
1332 // draw the image, if any
1335 wxBitmap bmp
= m_imageData
->GetBitmap(GetButtonState(this, state
));
1337 bmp
= m_imageData
->GetBitmap(State_Normal
);
1339 const wxSize sizeBmp
= bmp
.GetSize();
1340 const wxSize margin
= m_imageData
->GetBitmapMargins();
1341 const wxSize
sizeBmpWithMargins(sizeBmp
+ 2*margin
);
1342 wxRect
rectButton(wxRectFromRECT(rectBtn
));
1344 // for simplicity, we start with centred rectangle and then move it to
1345 // the appropriate edge
1346 wxRect rectBitmap
= wxRect(sizeBmp
).CentreIn(rectButton
);
1348 // move bitmap only if we have a label, otherwise keep it centered
1351 switch ( m_imageData
->GetBitmapPosition() )
1354 wxFAIL_MSG( "invalid direction" );
1358 rectBitmap
.x
= rectButton
.x
+ margin
.x
;
1359 rectButton
.x
+= sizeBmpWithMargins
.x
;
1360 rectButton
.width
-= sizeBmpWithMargins
.x
;
1364 rectBitmap
.x
= rectButton
.GetRight() - sizeBmp
.x
- margin
.x
;
1365 rectButton
.width
-= sizeBmpWithMargins
.x
;
1369 rectBitmap
.y
= rectButton
.y
+ margin
.y
;
1370 rectButton
.y
+= sizeBmpWithMargins
.y
;
1371 rectButton
.height
-= sizeBmpWithMargins
.y
;
1375 rectBitmap
.y
= rectButton
.GetBottom() - sizeBmp
.y
- margin
.y
;
1376 rectButton
.height
-= sizeBmpWithMargins
.y
;
1381 wxDCTemp
dst((WXHDC
)hdc
);
1382 dst
.DrawBitmap(bmp
, rectBitmap
.GetPosition(), true);
1384 wxCopyRectToRECT(rectButton
, rectBtn
);
1388 // finally draw the label
1391 COLORREF colFg
= state
& ODS_DISABLED
1392 ?
::GetSysColor(COLOR_GRAYTEXT
)
1393 : wxColourToRGB(GetForegroundColour());
1395 // notice that DT_HIDEPREFIX doesn't work on old (pre-Windows 2000)
1396 // systems but by happy coincidence ODS_NOACCEL is not used under them
1397 // neither so DT_HIDEPREFIX should never be used there
1398 DrawButtonText(hdc
, &rectBtn
, GetLabel(), colFg
,
1399 state
& ODS_NOACCEL ? DT_HIDEPREFIX
: 0);
1405 #endif // wxUSE_BUTTON