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
)
453 m_authNeeded
= false;
456 if (label
.empty() && wxIsStockID(id
))
458 // On Windows, some buttons aren't supposed to have mnemonics
459 label
= wxGetStockLabel
462 id
== wxID_OK
|| id
== wxID_CANCEL
|| id
== wxID_CLOSE
464 : wxSTOCK_WITH_MNEMONIC
468 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
472 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
474 // if the label contains several lines we must explicitly tell the button
475 // about it or it wouldn't draw it correctly ("\n"s would just appear as
478 // NB: we do it here and not in MSWGetStyle() because we need the label
479 // value and the label is not set yet when MSWGetStyle() is called
480 msStyle
|= wxMSWButton::GetMultilineStyle(label
);
482 return MSWCreateControl(wxT("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
485 wxButton::~wxButton()
487 wxTopLevelWindow
*tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
488 if ( tlw
&& tlw
->GetTmpDefaultItem() == this )
496 // ----------------------------------------------------------------------------
498 // ----------------------------------------------------------------------------
500 WXDWORD
wxButton::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
502 // buttons never have an external border, they draw their own one
503 WXDWORD msStyle
= wxControl::MSWGetStyle
505 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
508 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
509 // each other in any resizeable dialog which has more than one button in
511 msStyle
|= WS_CLIPSIBLINGS
;
513 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
514 // and wxBU_RIGHT to get BS_CENTER!
515 if ( style
& wxBU_LEFT
)
517 if ( style
& wxBU_RIGHT
)
519 if ( style
& wxBU_TOP
)
521 if ( style
& wxBU_BOTTOM
)
522 msStyle
|= BS_BOTTOM
;
525 if ( style
& wxNO_BORDER
)
527 #endif // __WXWINCE__
532 void wxButton::SetLabel(const wxString
& label
)
534 wxMSWButton::UpdateMultilineStyle(GetHwnd(), label
);
536 wxButtonBase::SetLabel(label
);
539 // ----------------------------------------------------------------------------
540 // size management including autosizing
541 // ----------------------------------------------------------------------------
543 void wxButton::AdjustForBitmapSize(wxSize
&size
) const
545 wxCHECK_RET( m_imageData
, wxT("shouldn't be called if no image") );
547 // account for the bitmap size
548 const wxSize sizeBmp
= m_imageData
->GetBitmap(State_Normal
).GetSize();
549 const wxDirection dirBmp
= m_imageData
->GetBitmapPosition();
550 if ( dirBmp
== wxLEFT
|| dirBmp
== wxRIGHT
)
553 if ( sizeBmp
.y
> size
.y
)
556 else // bitmap on top/below the text
559 if ( sizeBmp
.x
> size
.x
)
563 // account for the user-specified margins
564 size
+= 2*m_imageData
->GetBitmapMargins();
566 // and also for the margins we always add internally (unless we have no
567 // border at all in which case the button has exactly the same size as
568 // bitmap and so no margins should be used)
569 if ( !HasFlag(wxBORDER_NONE
) )
574 if ( wxUxThemeEngine::GetIfActive() )
576 wxUxThemeHandle
theme(const_cast<wxButton
*>(this), L
"BUTTON");
579 wxUxThemeEngine::Get()->GetThemeMargins(theme
, NULL
,
586 // XP doesn't draw themed buttons correctly when the client
587 // area is smaller than 8x8 - enforce this minimum size for
589 size
.IncTo(wxSize(8, 8));
591 marginH
= margins
.cxLeftWidth
+ margins
.cxRightWidth
592 + 2*XP_BUTTON_EXTRA_MARGIN
;
593 marginV
= margins
.cyTopHeight
+ margins
.cyBottomHeight
594 + 2*XP_BUTTON_EXTRA_MARGIN
;
597 #endif // wxUSE_UXTHEME
600 marginV
= OD_BUTTON_MARGIN
;
603 size
.IncBy(marginH
, marginV
);
607 wxSize
wxButton::DoGetBestSize() const
609 wxButton
* const self
= const_cast<wxButton
*>(this);
613 // Account for the text part if we have it.
617 if ( GetAuthNeeded() )
618 flags
|= wxMSWButton::Size_AuthNeeded
;
620 size
= wxMSWButton::ComputeBestFittingSize(self
, flags
);
624 AdjustForBitmapSize(size
);
626 return wxMSWButton::IncreaseToStdSizeAndCache(self
, size
);
630 wxSize
wxButtonBase::GetDefaultSize()
632 static wxSize s_sizeBtn
;
634 if ( s_sizeBtn
.x
== 0 )
637 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
639 // The size of a standard button in the dialog units is 50x14,
640 // translate this to pixels.
642 // Windows' computes dialog units using average character width over
643 // upper- and lower-case ASCII alphabet and not using the average
644 // character width metadata stored in the font; see
645 // http://support.microsoft.com/default.aspx/kb/145994 for detailed
648 // NB: wxMulDivInt32() is used, because it correctly rounds the result
650 const wxSize base
= wxPrivate::GetAverageASCIILetterSize(dc
);
651 s_sizeBtn
.x
= wxMulDivInt32(50, base
.x
, 4);
652 s_sizeBtn
.y
= wxMulDivInt32(14, base
.y
, 8);
658 // ----------------------------------------------------------------------------
659 // default button handling
660 // ----------------------------------------------------------------------------
663 The comment below and all this code is probably due to not using WM_NEXTDLGCTL
664 message when changing focus (but just SetFocus() which is not enough), see
665 http://blogs.msdn.com/oldnewthing/archive/2004/08/02/205624.aspx for the
668 TODO: Do use WM_NEXTDLGCTL and get rid of all this code.
671 "Everything you ever wanted to know about the default buttons" or "Why do we
672 have to do all this?"
674 In MSW the default button should be activated when the user presses Enter
675 and the current control doesn't process Enter itself somehow. This is
676 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
677 Another aspect of "defaultness" is that the default button has different
678 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
679 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
680 be unset if our parent window is not active so it should be unset whenever
681 we lose activation and set back when we regain it.
683 Final complication is that when a button is active, it should be the default
684 one, i.e. pressing Enter on a button always activates it and not another
687 We handle this by maintaining a permanent and a temporary default items in
688 wxControlContainer (both may be NULL). When a button becomes the current
689 control (i.e. gets focus) it sets itself as the temporary default which
690 ensures that it has the right appearance and that Enter will be redirected
691 to it. When the button loses focus, it unsets the temporary default and so
692 the default item will be the permanent default -- that is the default button
693 if any had been set or none otherwise, which is just what we want.
695 NB: all this is quite complicated by now and the worst is that normally
696 it shouldn't be necessary at all as for the normal Windows programs
697 DefWindowProc() and IsDialogMessage() take care of all this
698 automatically -- however in wxWidgets programs this doesn't work for
699 nested hierarchies (i.e. a notebook inside a notebook) for unknown
700 reason and so we have to reproduce all this code ourselves. It would be
701 very nice if we could avoid doing it.
704 // set this button as the (permanently) default one in its panel
705 wxWindow
*wxButton::SetDefault()
707 // set this one as the default button both for wxWidgets ...
708 wxWindow
*winOldDefault
= wxButtonBase::SetDefault();
711 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
712 SetDefaultStyle(this, true);
714 return winOldDefault
;
717 // return the top level parent window if it's not being deleted yet, otherwise
719 static wxTopLevelWindow
*GetTLWParentIfNotBeingDeleted(wxWindow
*win
)
723 // IsTopLevel() will return false for a wxTLW being deleted, so we also
724 // need the parent test for this case
725 wxWindow
* const parent
= win
->GetParent();
726 if ( !parent
|| win
->IsTopLevel() )
728 if ( win
->IsBeingDeleted() )
737 wxASSERT_MSG( win
, wxT("button without top level parent?") );
739 wxTopLevelWindow
* const tlw
= wxDynamicCast(win
, wxTopLevelWindow
);
740 wxASSERT_MSG( tlw
, wxT("logic error in GetTLWParentIfNotBeingDeleted()") );
745 // set this button as being currently default
746 void wxButton::SetTmpDefault()
748 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
752 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
753 tlw
->SetTmpDefaultItem(this);
755 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
756 SetDefaultStyle(this, true);
759 // unset this button as currently default, it may still stay permanent default
760 void wxButton::UnsetTmpDefault()
762 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
766 tlw
->SetTmpDefaultItem(NULL
);
768 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
770 SetDefaultStyle(this, false);
771 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), true);
776 wxButton::SetDefaultStyle(wxButton
*btn
, bool on
)
778 // we may be called with NULL pointer -- simpler to do the check here than
779 // in the caller which does wxDynamicCast()
783 // first, let DefDlgProc() know about the new default button
786 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
787 // focus at all any more
788 if ( !wxTheApp
->IsActive() )
791 wxWindow
* const tlw
= wxGetTopLevelParent(btn
);
792 wxCHECK_RET( tlw
, wxT("button without top level window?") );
794 ::SendMessage(GetHwndOf(tlw
), DM_SETDEFID
, btn
->GetId(), 0L);
796 // sending DM_SETDEFID also changes the button style to
797 // BS_DEFPUSHBUTTON so there is nothing more to do
800 // then also change the style as needed
801 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
802 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
804 // don't do it with the owner drawn buttons because it will
805 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
806 // BS_DEFPUSHBUTTON != 0)!
807 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
809 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
810 on
? style
| BS_DEFPUSHBUTTON
811 : style
& ~BS_DEFPUSHBUTTON
,
816 // redraw the button - it will notice itself that it's
817 // [not] the default one [any longer]
821 //else: already has correct style
824 // ----------------------------------------------------------------------------
826 // ----------------------------------------------------------------------------
828 bool wxButton::SendClickEvent()
830 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
831 event
.SetEventObject(this);
833 return ProcessCommand(event
);
836 void wxButton::Command(wxCommandEvent
& event
)
838 ProcessCommand(event
);
841 // ----------------------------------------------------------------------------
842 // event/message handlers
843 // ----------------------------------------------------------------------------
845 bool wxButton::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
847 bool processed
= false;
850 // NOTE: Apparently older versions (NT 4?) of the common controls send
851 // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
852 // buttons, so in order to send two EVT_BUTTON events we should
853 // catch both types. Currently (Feb 2003) up-to-date versions of
854 // win98, win2k and winXP all send two BN_CLICKED messages for
855 // all button types, so we don't catch BN_DOUBLECLICKED anymore
856 // in order to not get 3 EVT_BUTTON events. If this is a problem
857 // then we need to figure out which version of the comctl32 changed
858 // this behaviour and test for it.
860 case 1: // message came from an accelerator
861 case BN_CLICKED
: // normal buttons send this
862 processed
= SendClickEvent();
869 WXLRESULT
wxButton::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
871 // when we receive focus, we want to temporarily become the default button in
872 // our parent panel so that pressing "Enter" would activate us -- and when
873 // losing it we should restore the previous default button as well
874 if ( nMsg
== WM_SETFOCUS
)
878 // let the default processing take place too
880 else if ( nMsg
== WM_KILLFOCUS
)
884 else if ( nMsg
== WM_LBUTTONDBLCLK
)
886 // emulate a click event to force an owner-drawn button to change its
887 // appearance - without this, it won't do it
888 (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
890 // and continue with processing the message normally as well
893 else if ( nMsg
== WM_THEMECHANGED
)
895 // need to recalculate the best size here
896 // as the theme size might have changed
897 InvalidateBestSize();
899 #endif // wxUSE_UXTHEME
900 // must use m_mouseInWindow here instead of IsMouseInWindow()
901 // since we need to know the first time the mouse enters the window
902 // and IsMouseInWindow() would return true in this case
903 else if ( (nMsg
== WM_MOUSEMOVE
&& !m_mouseInWindow
) ||
904 nMsg
== WM_MOUSELEAVE
)
910 wxUxThemeEngine::GetIfActive() ||
911 #endif // wxUSE_UXTHEME
912 (m_imageData
&& m_imageData
->GetBitmap(State_Current
).IsOk())
920 // let the base class do all real processing
921 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
924 // ----------------------------------------------------------------------------
925 // authentication needed handling
926 // ----------------------------------------------------------------------------
928 bool wxButton::DoGetAuthNeeded() const
933 void wxButton::DoSetAuthNeeded(bool show
)
935 // show/hide UAC symbol on Windows Vista and later
936 if ( wxGetWinVersion() >= wxWinVersion_6
)
939 ::SendMessage(GetHwnd(), BCM_SETSHIELD
, 0, show
);
940 InvalidateBestSize();
944 // ----------------------------------------------------------------------------
946 // ----------------------------------------------------------------------------
948 wxBitmap
wxButton::DoGetBitmap(State which
) const
950 return m_imageData
? m_imageData
->GetBitmap(which
) : wxBitmap();
953 void wxButton::DoSetBitmap(const wxBitmap
& bitmap
, State which
)
955 // allocate the image data when the first bitmap is set
959 // using image list doesn't work correctly if we don't have any label
960 // (even if we use BUTTON_IMAGELIST_ALIGN_CENTER alignment and
961 // BS_BITMAP style), at least under Windows 2003 so use owner drawn
962 // strategy for bitmap-only buttons
963 if ( ShowsLabel() && wxUxThemeEngine::GetIfActive() )
965 m_imageData
= new wxXPButtonImageData(this, bitmap
);
968 #endif // wxUSE_UXTHEME
970 m_imageData
= new wxODButtonImageData(this, bitmap
);
976 m_imageData
->SetBitmap(bitmap
, which
);
979 // it should be enough to only invalidate the best size when the normal
980 // bitmap changes as all bitmaps assigned to the button should be of the
982 if ( which
== State_Normal
)
983 InvalidateBestSize();
988 wxSize
wxButton::DoGetBitmapMargins() const
990 return m_imageData
? m_imageData
->GetBitmapMargins() : wxSize(0, 0);
993 void wxButton::DoSetBitmapMargins(wxCoord x
, wxCoord y
)
995 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
997 m_imageData
->SetBitmapMargins(x
, y
);
998 InvalidateBestSize();
1001 void wxButton::DoSetBitmapPosition(wxDirection dir
)
1003 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
1005 m_imageData
->SetBitmapPosition(dir
);
1006 InvalidateBestSize();
1009 // ----------------------------------------------------------------------------
1010 // owner-drawn buttons support
1011 // ----------------------------------------------------------------------------
1017 // return the button state using both the ODS_XXX flags specified in state
1018 // parameter and the current button state
1019 wxButton::State
GetButtonState(wxButton
*btn
, UINT state
)
1021 if ( state
& ODS_DISABLED
)
1022 return wxButton::State_Disabled
;
1024 if ( state
& ODS_SELECTED
)
1025 return wxButton::State_Pressed
;
1027 if ( btn
->HasCapture() || btn
->IsMouseInWindow() )
1028 return wxButton::State_Current
;
1030 if ( state
& ODS_FOCUS
)
1031 return wxButton::State_Focused
;
1033 return wxButton::State_Normal
;
1036 void DrawButtonText(HDC hdc
,
1038 const wxString
& text
,
1042 wxTextColoursChanger
changeFg(hdc
, col
, CLR_INVALID
);
1043 wxBkModeChanger
changeBkMode(hdc
, wxBRUSHSTYLE_TRANSPARENT
);
1045 // center text horizontally in any case
1048 if ( text
.find(wxT('\n')) != wxString::npos
)
1050 // draw multiline label
1052 // first we need to compute its bounding rect
1054 ::CopyRect(&rc
, pRect
);
1055 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
,
1056 DT_CENTER
| DT_CALCRECT
);
1058 // now center this rect inside the entire button area
1059 const LONG w
= rc
.right
- rc
.left
;
1060 const LONG h
= rc
.bottom
- rc
.top
;
1061 rc
.left
= (pRect
->right
- pRect
->left
)/2 - w
/2;
1062 rc
.right
= rc
.left
+w
;
1063 rc
.top
= (pRect
->bottom
- pRect
->top
)/2 - h
/2;
1064 rc
.bottom
= rc
.top
+h
;
1066 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
, flags
);
1068 else // single line label
1070 // centre text vertically too (notice that we must have DT_SINGLELINE
1071 // for DT_VCENTER to work)
1072 ::DrawText(hdc
, text
.wx_str(), text
.length(), pRect
,
1073 flags
| DT_SINGLELINE
| DT_VCENTER
);
1077 void DrawRect(HDC hdc
, const RECT
& r
)
1079 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1080 wxDrawLine(hdc
, r
.right
, r
.top
, r
.right
, r
.bottom
);
1081 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.left
, r
.bottom
);
1082 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.left
, r
.top
);
1086 The button frame looks like this normally:
1089 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
1090 WH GB H = light grey (LIGHT)
1091 WH GB G = dark grey (SHADOW)
1092 WH GB B = black (DKSHADOW)
1097 When the button is selected, the button becomes like this (the total button
1098 size doesn't change):
1109 When the button is pushed (while selected) it is like:
1120 void DrawButtonFrame(HDC hdc
, RECT
& rectBtn
,
1121 bool selected
, bool pushed
)
1124 CopyRect(&r
, &rectBtn
);
1126 AutoHPEN
hpenBlack(GetSysColor(COLOR_3DDKSHADOW
)),
1127 hpenGrey(GetSysColor(COLOR_3DSHADOW
)),
1128 hpenLightGr(GetSysColor(COLOR_3DLIGHT
)),
1129 hpenWhite(GetSysColor(COLOR_3DHILIGHT
));
1131 SelectInHDC
selectPen(hdc
, hpenBlack
);
1140 (void)SelectObject(hdc
, hpenGrey
);
1141 ::InflateRect(&r
, -1, -1);
1151 ::InflateRect(&r
, -1, -1);
1154 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.right
, r
.bottom
);
1155 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.right
, r
.top
- 1);
1157 (void)SelectObject(hdc
, hpenWhite
);
1158 wxDrawLine(hdc
, r
.left
, r
.bottom
- 1, r
.left
, r
.top
);
1159 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1161 (void)SelectObject(hdc
, hpenLightGr
);
1162 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 2, r
.left
+ 1, r
.top
+ 1);
1163 wxDrawLine(hdc
, r
.left
+ 1, r
.top
+ 1, r
.right
- 1, r
.top
+ 1);
1165 (void)SelectObject(hdc
, hpenGrey
);
1166 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 1, r
.right
- 1, r
.bottom
- 1);
1167 wxDrawLine(hdc
, r
.right
- 1, r
.bottom
- 1, r
.right
- 1, r
.top
);
1170 InflateRect(&rectBtn
, -OD_BUTTON_MARGIN
, -OD_BUTTON_MARGIN
);
1174 void DrawXPBackground(wxButton
*button
, HDC hdc
, RECT
& rectBtn
, UINT state
)
1176 wxUxThemeHandle
theme(button
, L
"BUTTON");
1178 // this array is indexed by wxButton::State values and so must be kept in
1180 static const int uxStates
[] =
1182 PBS_NORMAL
, PBS_HOT
, PBS_PRESSED
, PBS_DISABLED
, PBS_DEFAULTED
1185 int iState
= uxStates
[GetButtonState(button
, state
)];
1187 wxUxThemeEngine
* const engine
= wxUxThemeEngine::Get();
1189 // draw parent background if needed
1190 if ( engine
->IsThemeBackgroundPartiallyTransparent
1197 engine
->DrawThemeParentBackground(GetHwndOf(button
), hdc
, &rectBtn
);
1201 engine
->DrawThemeBackground(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1204 // calculate content area margins
1206 engine
->GetThemeMargins(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1207 TMT_CONTENTMARGINS
, &rectBtn
, &margins
);
1208 ::InflateRect(&rectBtn
, -margins
.cxLeftWidth
, -margins
.cyTopHeight
);
1209 ::InflateRect(&rectBtn
, -XP_BUTTON_EXTRA_MARGIN
, -XP_BUTTON_EXTRA_MARGIN
);
1211 if ( button
->UseBgCol() )
1213 COLORREF colBg
= wxColourToRGB(button
->GetBackgroundColour());
1214 AutoHBRUSH
hbrushBackground(colBg
);
1216 // don't overwrite the focus rect
1218 ::CopyRect(&rectClient
, &rectBtn
);
1219 ::InflateRect(&rectClient
, -1, -1);
1220 FillRect(hdc
, &rectClient
, hbrushBackground
);
1223 #endif // wxUSE_UXTHEME
1225 } // anonymous namespace
1227 // ----------------------------------------------------------------------------
1228 // owner drawn buttons support
1229 // ----------------------------------------------------------------------------
1231 void wxButton::MakeOwnerDrawn()
1233 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
1234 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
1237 style
|= BS_OWNERDRAW
;
1238 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
1242 bool wxButton::SetBackgroundColour(const wxColour
&colour
)
1244 if ( !wxControl::SetBackgroundColour(colour
) )
1257 bool wxButton::SetForegroundColour(const wxColour
&colour
)
1259 if ( !wxControl::SetForegroundColour(colour
) )
1272 bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
1274 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
1275 HDC hdc
= lpDIS
->hDC
;
1277 UINT state
= lpDIS
->itemState
;
1278 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
1281 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
1283 // draw the button background
1284 if ( !HasFlag(wxBORDER_NONE
) )
1287 if ( wxUxThemeEngine::GetIfActive() )
1289 DrawXPBackground(this, hdc
, rectBtn
, state
);
1292 #endif // wxUSE_UXTHEME
1294 COLORREF colBg
= wxColourToRGB(GetBackgroundColour());
1296 // first, draw the background
1297 AutoHBRUSH
hbrushBackground(colBg
);
1298 FillRect(hdc
, &rectBtn
, hbrushBackground
);
1300 // draw the border for the current state
1301 bool selected
= (state
& ODS_SELECTED
) != 0;
1305 tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
1308 selected
= tlw
->GetDefaultItem() == this;
1312 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
1315 // draw the focus rectangle if we need it
1316 if ( (state
& ODS_FOCUS
) && !(state
& ODS_NOFOCUSRECT
) )
1318 DrawFocusRect(hdc
, &rectBtn
);
1321 if ( !wxUxThemeEngine::GetIfActive() )
1322 #endif // wxUSE_UXTHEME
1326 // the label is shifted by 1 pixel to create "pushed" effect
1327 OffsetRect(&rectBtn
, 1, 1);
1334 // draw the image, if any
1337 wxBitmap bmp
= m_imageData
->GetBitmap(GetButtonState(this, state
));
1339 bmp
= m_imageData
->GetBitmap(State_Normal
);
1341 const wxSize sizeBmp
= bmp
.GetSize();
1342 const wxSize margin
= m_imageData
->GetBitmapMargins();
1343 const wxSize
sizeBmpWithMargins(sizeBmp
+ 2*margin
);
1344 wxRect
rectButton(wxRectFromRECT(rectBtn
));
1346 // for simplicity, we start with centred rectangle and then move it to
1347 // the appropriate edge
1348 wxRect rectBitmap
= wxRect(sizeBmp
).CentreIn(rectButton
);
1350 // move bitmap only if we have a label, otherwise keep it centered
1353 switch ( m_imageData
->GetBitmapPosition() )
1356 wxFAIL_MSG( "invalid direction" );
1360 rectBitmap
.x
= rectButton
.x
+ margin
.x
;
1361 rectButton
.x
+= sizeBmpWithMargins
.x
;
1362 rectButton
.width
-= sizeBmpWithMargins
.x
;
1366 rectBitmap
.x
= rectButton
.GetRight() - sizeBmp
.x
- margin
.x
;
1367 rectButton
.width
-= sizeBmpWithMargins
.x
;
1371 rectBitmap
.y
= rectButton
.y
+ margin
.y
;
1372 rectButton
.y
+= sizeBmpWithMargins
.y
;
1373 rectButton
.height
-= sizeBmpWithMargins
.y
;
1377 rectBitmap
.y
= rectButton
.GetBottom() - sizeBmp
.y
- margin
.y
;
1378 rectButton
.height
-= sizeBmpWithMargins
.y
;
1383 wxDCTemp
dst((WXHDC
)hdc
);
1384 dst
.DrawBitmap(bmp
, rectBitmap
.GetPosition(), true);
1386 wxCopyRectToRECT(rectButton
, rectBtn
);
1390 // finally draw the label
1393 COLORREF colFg
= state
& ODS_DISABLED
1394 ? ::GetSysColor(COLOR_GRAYTEXT
)
1395 : wxColourToRGB(GetForegroundColour());
1397 // notice that DT_HIDEPREFIX doesn't work on old (pre-Windows 2000)
1398 // systems but by happy coincidence ODS_NOACCEL is not used under them
1399 // neither so DT_HIDEPREFIX should never be used there
1400 DrawButtonText(hdc
, &rectBtn
, GetLabel(), colFg
,
1401 state
& ODS_NOACCEL
? DT_HIDEPREFIX
: 0);
1407 #endif // wxUSE_BUTTON