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 // use default margins
230 m_data
.margin
.right
= btn
->GetCharWidth();
232 m_data
.margin
.bottom
= btn
->GetCharHeight() / 2;
234 // and 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();
391 sizeBtn
.y
= 11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(sizeLabel
.y
)/10;
393 // account for the shield UAC icon if we have it
394 if ( flags
& Size_AuthNeeded
)
395 sizeBtn
.x
+= wxSystemSettings::GetMetric(wxSYS_SMALLICON_X
);
400 wxSize
wxMSWButton::ComputeBestSize(wxControl
*btn
, int flags
)
405 dc
.GetMultiLineTextExtent(btn
->GetLabelText(), &sizeBtn
.x
, &sizeBtn
.y
);
407 sizeBtn
= GetFittingSize(btn
, sizeBtn
, flags
);
409 // all buttons have at least the standard size unless the user explicitly
410 // wants them to be of smaller size and used wxBU_EXACTFIT style when
411 // creating the button
412 if ( !btn
->HasFlag(wxBU_EXACTFIT
) )
414 // The size of a standard button in the dialog units is 50x14, use it.
415 // Note that we intentionally don't use GetDefaultSize() here, because
416 // it's inexact -- dialog units depend on this dialog's font.
417 wxSize sizeDef
= btn
->ConvertDialogToPixels(wxSize(50, 14));
418 if ( sizeBtn
.x
< sizeDef
.x
)
419 sizeBtn
.x
= sizeDef
.x
;
420 if ( sizeBtn
.y
< sizeDef
.y
)
421 sizeBtn
.y
= sizeDef
.y
;
424 btn
->CacheBestSize(sizeBtn
);
429 // ----------------------------------------------------------------------------
430 // creation/destruction
431 // ----------------------------------------------------------------------------
433 bool wxButton::Create(wxWindow
*parent
,
439 const wxValidator
& validator
,
440 const wxString
& name
)
442 m_authNeeded
= false;
445 if (label
.empty() && wxIsStockID(id
))
447 // On Windows, some buttons aren't supposed to have mnemonics
448 label
= wxGetStockLabel
451 id
== wxID_OK
|| id
== wxID_CANCEL
|| id
== wxID_CLOSE
453 : wxSTOCK_WITH_MNEMONIC
457 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
461 WXDWORD msStyle
= MSWGetStyle(style
, &exstyle
);
463 // if the label contains several lines we must explicitly tell the button
464 // about it or it wouldn't draw it correctly ("\n"s would just appear as
467 // NB: we do it here and not in MSWGetStyle() because we need the label
468 // value and the label is not set yet when MSWGetStyle() is called
469 msStyle
|= wxMSWButton::GetMultilineStyle(label
);
471 return MSWCreateControl(wxT("BUTTON"), msStyle
, pos
, size
, label
, exstyle
);
474 wxButton::~wxButton()
476 wxTopLevelWindow
*tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
477 if ( tlw
&& tlw
->GetTmpDefaultItem() == this )
485 // ----------------------------------------------------------------------------
487 // ----------------------------------------------------------------------------
489 WXDWORD
wxButton::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
491 // buttons never have an external border, they draw their own one
492 WXDWORD msStyle
= wxControl::MSWGetStyle
494 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
497 // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
498 // each other in any resizeable dialog which has more than one button in
500 msStyle
|= WS_CLIPSIBLINGS
;
502 // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
503 // and wxBU_RIGHT to get BS_CENTER!
504 if ( style
& wxBU_LEFT
)
506 if ( style
& wxBU_RIGHT
)
508 if ( style
& wxBU_TOP
)
510 if ( style
& wxBU_BOTTOM
)
511 msStyle
|= BS_BOTTOM
;
514 if ( style
& wxNO_BORDER
)
516 #endif // __WXWINCE__
521 void wxButton::SetLabel(const wxString
& label
)
523 wxMSWButton::UpdateMultilineStyle(GetHwnd(), label
);
525 wxButtonBase::SetLabel(label
);
528 // ----------------------------------------------------------------------------
529 // size management including autosizing
530 // ----------------------------------------------------------------------------
532 void wxButton::AdjustForBitmapSize(wxSize
&size
) const
537 // account for the bitmap size
538 const wxSize sizeBmp
= m_imageData
->GetBitmap(State_Normal
).GetSize();
539 const wxDirection dirBmp
= m_imageData
->GetBitmapPosition();
540 if ( dirBmp
== wxLEFT
|| dirBmp
== wxRIGHT
)
543 if ( sizeBmp
.y
> size
.y
)
546 else // bitmap on top/below the text
549 if ( sizeBmp
.x
> size
.x
)
553 // account for the user-specified margins
554 size
+= 2*m_imageData
->GetBitmapMargins();
556 // and also for the margins we always add internally (unless we have no
557 // border at all in which case the button has exactly the same size as
558 // bitmap and so no margins should be used)
559 if ( !HasFlag(wxBORDER_NONE
) )
564 if ( wxUxThemeEngine::GetIfActive() )
566 wxUxThemeHandle
theme(const_cast<wxButton
*>(this), L
"BUTTON");
569 wxUxThemeEngine::Get()->GetThemeMargins(theme
, NULL
,
576 // XP doesn't draw themed buttons correctly when the client
577 // area is smaller than 8x8 - enforce this minimum size for
579 size
.IncTo(wxSize(8, 8));
581 marginH
= margins
.cxLeftWidth
+ margins
.cxRightWidth
582 + 2*XP_BUTTON_EXTRA_MARGIN
;
583 marginV
= margins
.cyTopHeight
+ margins
.cyBottomHeight
584 + 2*XP_BUTTON_EXTRA_MARGIN
;
587 #endif // wxUSE_UXTHEME
590 marginV
= OD_BUTTON_MARGIN
;
593 size
.IncBy(marginH
, marginV
);
597 wxSize
wxButton::DoGetBestSize() const
601 // account for the text part if we have it or if we don't have any image at
602 // all (buttons initially created with empty label should still have a non
604 if ( ShowsLabel() || !m_imageData
)
607 if ( GetAuthNeeded() )
608 flags
|= wxMSWButton::Size_AuthNeeded
;
610 size
= wxMSWButton::ComputeBestSize(const_cast<wxButton
*>(this), flags
);
615 AdjustForBitmapSize(size
);
624 wxSize
wxButtonBase::GetDefaultSize()
626 static wxSize s_sizeBtn
;
628 if ( s_sizeBtn
.x
== 0 )
631 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
633 // The size of a standard button in the dialog units is 50x14,
634 // translate this to pixels.
636 // Windows' computes dialog units using average character width over
637 // upper- and lower-case ASCII alphabet and not using the average
638 // character width metadata stored in the font; see
639 // http://support.microsoft.com/default.aspx/kb/145994 for detailed
642 // NB: wxMulDivInt32() is used, because it correctly rounds the result
644 const wxSize base
= wxPrivate::GetAverageASCIILetterSize(dc
);
645 s_sizeBtn
.x
= wxMulDivInt32(50, base
.x
, 4);
646 s_sizeBtn
.y
= wxMulDivInt32(14, base
.y
, 8);
652 // ----------------------------------------------------------------------------
653 // default button handling
654 // ----------------------------------------------------------------------------
657 The comment below and all this code is probably due to not using WM_NEXTDLGCTL
658 message when changing focus (but just SetFocus() which is not enough), see
659 http://blogs.msdn.com/oldnewthing/archive/2004/08/02/205624.aspx for the
662 TODO: Do use WM_NEXTDLGCTL and get rid of all this code.
665 "Everything you ever wanted to know about the default buttons" or "Why do we
666 have to do all this?"
668 In MSW the default button should be activated when the user presses Enter
669 and the current control doesn't process Enter itself somehow. This is
670 handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
671 Another aspect of "defaultness" is that the default button has different
672 appearance: this is due to BS_DEFPUSHBUTTON style which is completely
673 separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
674 be unset if our parent window is not active so it should be unset whenever
675 we lose activation and set back when we regain it.
677 Final complication is that when a button is active, it should be the default
678 one, i.e. pressing Enter on a button always activates it and not another
681 We handle this by maintaining a permanent and a temporary default items in
682 wxControlContainer (both may be NULL). When a button becomes the current
683 control (i.e. gets focus) it sets itself as the temporary default which
684 ensures that it has the right appearance and that Enter will be redirected
685 to it. When the button loses focus, it unsets the temporary default and so
686 the default item will be the permanent default -- that is the default button
687 if any had been set or none otherwise, which is just what we want.
689 NB: all this is quite complicated by now and the worst is that normally
690 it shouldn't be necessary at all as for the normal Windows programs
691 DefWindowProc() and IsDialogMessage() take care of all this
692 automatically -- however in wxWidgets programs this doesn't work for
693 nested hierarchies (i.e. a notebook inside a notebook) for unknown
694 reason and so we have to reproduce all this code ourselves. It would be
695 very nice if we could avoid doing it.
698 // set this button as the (permanently) default one in its panel
699 wxWindow
*wxButton::SetDefault()
701 // set this one as the default button both for wxWidgets ...
702 wxWindow
*winOldDefault
= wxButtonBase::SetDefault();
705 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
706 SetDefaultStyle(this, true);
708 return winOldDefault
;
711 // return the top level parent window if it's not being deleted yet, otherwise
713 static wxTopLevelWindow
*GetTLWParentIfNotBeingDeleted(wxWindow
*win
)
717 // IsTopLevel() will return false for a wxTLW being deleted, so we also
718 // need the parent test for this case
719 wxWindow
* const parent
= win
->GetParent();
720 if ( !parent
|| win
->IsTopLevel() )
722 if ( win
->IsBeingDeleted() )
731 wxASSERT_MSG( win
, wxT("button without top level parent?") );
733 wxTopLevelWindow
* const tlw
= wxDynamicCast(win
, wxTopLevelWindow
);
734 wxASSERT_MSG( tlw
, wxT("logic error in GetTLWParentIfNotBeingDeleted()") );
739 // set this button as being currently default
740 void wxButton::SetTmpDefault()
742 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
746 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
747 tlw
->SetTmpDefaultItem(this);
749 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), false);
750 SetDefaultStyle(this, true);
753 // unset this button as currently default, it may still stay permanent default
754 void wxButton::UnsetTmpDefault()
756 wxTopLevelWindow
* const tlw
= GetTLWParentIfNotBeingDeleted(GetParent());
760 tlw
->SetTmpDefaultItem(NULL
);
762 wxWindow
*winOldDefault
= tlw
->GetDefaultItem();
764 SetDefaultStyle(this, false);
765 SetDefaultStyle(wxDynamicCast(winOldDefault
, wxButton
), true);
770 wxButton::SetDefaultStyle(wxButton
*btn
, bool on
)
772 // we may be called with NULL pointer -- simpler to do the check here than
773 // in the caller which does wxDynamicCast()
777 // first, let DefDlgProc() know about the new default button
780 // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
781 // focus at all any more
782 if ( !wxTheApp
->IsActive() )
785 wxWindow
* const tlw
= wxGetTopLevelParent(btn
);
786 wxCHECK_RET( tlw
, wxT("button without top level window?") );
788 ::SendMessage(GetHwndOf(tlw
), DM_SETDEFID
, btn
->GetId(), 0L);
790 // sending DM_SETDEFID also changes the button style to
791 // BS_DEFPUSHBUTTON so there is nothing more to do
794 // then also change the style as needed
795 long style
= ::GetWindowLong(GetHwndOf(btn
), GWL_STYLE
);
796 if ( !(style
& BS_DEFPUSHBUTTON
) == on
)
798 // don't do it with the owner drawn buttons because it will
799 // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
800 // BS_DEFPUSHBUTTON != 0)!
801 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
803 ::SendMessage(GetHwndOf(btn
), BM_SETSTYLE
,
804 on
? style
| BS_DEFPUSHBUTTON
805 : style
& ~BS_DEFPUSHBUTTON
,
810 // redraw the button - it will notice itself that it's
811 // [not] the default one [any longer]
815 //else: already has correct style
818 // ----------------------------------------------------------------------------
820 // ----------------------------------------------------------------------------
822 bool wxButton::SendClickEvent()
824 wxCommandEvent
event(wxEVT_COMMAND_BUTTON_CLICKED
, GetId());
825 event
.SetEventObject(this);
827 return ProcessCommand(event
);
830 void wxButton::Command(wxCommandEvent
& event
)
832 ProcessCommand(event
);
835 // ----------------------------------------------------------------------------
836 // event/message handlers
837 // ----------------------------------------------------------------------------
839 bool wxButton::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
841 bool processed
= false;
844 // NOTE: Apparently older versions (NT 4?) of the common controls send
845 // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
846 // buttons, so in order to send two EVT_BUTTON events we should
847 // catch both types. Currently (Feb 2003) up-to-date versions of
848 // win98, win2k and winXP all send two BN_CLICKED messages for
849 // all button types, so we don't catch BN_DOUBLECLICKED anymore
850 // in order to not get 3 EVT_BUTTON events. If this is a problem
851 // then we need to figure out which version of the comctl32 changed
852 // this behaviour and test for it.
854 case 1: // message came from an accelerator
855 case BN_CLICKED
: // normal buttons send this
856 processed
= SendClickEvent();
863 WXLRESULT
wxButton::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
865 // when we receive focus, we want to temporarily become the default button in
866 // our parent panel so that pressing "Enter" would activate us -- and when
867 // losing it we should restore the previous default button as well
868 if ( nMsg
== WM_SETFOCUS
)
872 // let the default processing take place too
874 else if ( nMsg
== WM_KILLFOCUS
)
878 else if ( nMsg
== WM_LBUTTONDBLCLK
)
880 // emulate a click event to force an owner-drawn button to change its
881 // appearance - without this, it won't do it
882 (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN
, wParam
, lParam
);
884 // and continue with processing the message normally as well
887 else if ( nMsg
== WM_THEMECHANGED
)
889 // need to recalculate the best size here
890 // as the theme size might have changed
891 InvalidateBestSize();
893 #endif // wxUSE_UXTHEME
894 // must use m_mouseInWindow here instead of IsMouseInWindow()
895 // since we need to know the first time the mouse enters the window
896 // and IsMouseInWindow() would return true in this case
897 else if ( (nMsg
== WM_MOUSEMOVE
&& !m_mouseInWindow
) ||
898 nMsg
== WM_MOUSELEAVE
)
904 wxUxThemeEngine::GetIfActive() ||
905 #endif // wxUSE_UXTHEME
906 (m_imageData
&& m_imageData
->GetBitmap(State_Current
).IsOk())
914 // let the base class do all real processing
915 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
918 // ----------------------------------------------------------------------------
919 // authentication needed handling
920 // ----------------------------------------------------------------------------
922 bool wxButton::DoGetAuthNeeded() const
927 void wxButton::DoSetAuthNeeded(bool show
)
929 // show/hide UAC symbol on Windows Vista and later
930 if ( wxGetWinVersion() >= wxWinVersion_6
)
933 ::SendMessage(GetHwnd(), BCM_SETSHIELD
, 0, show
);
934 InvalidateBestSize();
938 // ----------------------------------------------------------------------------
940 // ----------------------------------------------------------------------------
942 wxBitmap
wxButton::DoGetBitmap(State which
) const
944 return m_imageData
? m_imageData
->GetBitmap(which
) : wxBitmap();
947 void wxButton::DoSetBitmap(const wxBitmap
& bitmap
, State which
)
949 // allocate the image data when the first bitmap is set
953 // using image list doesn't work correctly if we don't have any label
954 // (even if we use BUTTON_IMAGELIST_ALIGN_CENTER alignment and
955 // BS_BITMAP style), at least under Windows 2003 so use owner drawn
956 // strategy for bitmap-only buttons
957 if ( ShowsLabel() && wxUxThemeEngine::GetIfActive() )
959 m_imageData
= new wxXPButtonImageData(this, bitmap
);
962 #endif // wxUSE_UXTHEME
964 m_imageData
= new wxODButtonImageData(this, bitmap
);
970 m_imageData
->SetBitmap(bitmap
, which
);
973 // it should be enough to only invalidate the best size when the normal
974 // bitmap changes as all bitmaps assigned to the button should be of the
976 if ( which
== State_Normal
)
977 InvalidateBestSize();
982 wxSize
wxButton::DoGetBitmapMargins() const
984 return m_imageData
? m_imageData
->GetBitmapMargins() : wxSize(0, 0);
987 void wxButton::DoSetBitmapMargins(wxCoord x
, wxCoord y
)
989 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
991 m_imageData
->SetBitmapMargins(x
, y
);
992 InvalidateBestSize();
995 void wxButton::DoSetBitmapPosition(wxDirection dir
)
997 wxCHECK_RET( m_imageData
, "SetBitmap() must be called first" );
999 m_imageData
->SetBitmapPosition(dir
);
1000 InvalidateBestSize();
1003 // ----------------------------------------------------------------------------
1004 // owner-drawn buttons support
1005 // ----------------------------------------------------------------------------
1011 // return the button state using both the ODS_XXX flags specified in state
1012 // parameter and the current button state
1013 wxButton::State
GetButtonState(wxButton
*btn
, UINT state
)
1015 if ( state
& ODS_DISABLED
)
1016 return wxButton::State_Disabled
;
1018 if ( state
& ODS_SELECTED
)
1019 return wxButton::State_Pressed
;
1021 if ( btn
->HasCapture() || btn
->IsMouseInWindow() )
1022 return wxButton::State_Current
;
1024 if ( state
& ODS_FOCUS
)
1025 return wxButton::State_Focused
;
1027 return wxButton::State_Normal
;
1030 void DrawButtonText(HDC hdc
,
1032 const wxString
& text
,
1036 wxTextColoursChanger
changeFg(hdc
, col
, CLR_INVALID
);
1037 wxBkModeChanger
changeBkMode(hdc
, wxBRUSHSTYLE_TRANSPARENT
);
1039 // center text horizontally in any case
1042 if ( text
.find(wxT('\n')) != wxString::npos
)
1044 // draw multiline label
1046 // first we need to compute its bounding rect
1048 ::CopyRect(&rc
, pRect
);
1049 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
,
1050 DT_CENTER
| DT_CALCRECT
);
1052 // now center this rect inside the entire button area
1053 const LONG w
= rc
.right
- rc
.left
;
1054 const LONG h
= rc
.bottom
- rc
.top
;
1055 rc
.left
= (pRect
->right
- pRect
->left
)/2 - w
/2;
1056 rc
.right
= rc
.left
+w
;
1057 rc
.top
= (pRect
->bottom
- pRect
->top
)/2 - h
/2;
1058 rc
.bottom
= rc
.top
+h
;
1060 ::DrawText(hdc
, text
.wx_str(), text
.length(), &rc
, flags
);
1062 else // single line label
1064 // centre text vertically too (notice that we must have DT_SINGLELINE
1065 // for DT_VCENTER to work)
1066 ::DrawText(hdc
, text
.wx_str(), text
.length(), pRect
,
1067 flags
| DT_SINGLELINE
| DT_VCENTER
);
1071 void DrawRect(HDC hdc
, const RECT
& r
)
1073 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1074 wxDrawLine(hdc
, r
.right
, r
.top
, r
.right
, r
.bottom
);
1075 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.left
, r
.bottom
);
1076 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.left
, r
.top
);
1080 The button frame looks like this normally:
1083 WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
1084 WH GB H = light grey (LIGHT)
1085 WH GB G = dark grey (SHADOW)
1086 WH GB B = black (DKSHADOW)
1091 When the button is selected, the button becomes like this (the total button
1092 size doesn't change):
1103 When the button is pushed (while selected) it is like:
1114 void DrawButtonFrame(HDC hdc
, RECT
& rectBtn
,
1115 bool selected
, bool pushed
)
1118 CopyRect(&r
, &rectBtn
);
1120 AutoHPEN
hpenBlack(GetSysColor(COLOR_3DDKSHADOW
)),
1121 hpenGrey(GetSysColor(COLOR_3DSHADOW
)),
1122 hpenLightGr(GetSysColor(COLOR_3DLIGHT
)),
1123 hpenWhite(GetSysColor(COLOR_3DHILIGHT
));
1125 SelectInHDC
selectPen(hdc
, hpenBlack
);
1134 (void)SelectObject(hdc
, hpenGrey
);
1135 ::InflateRect(&r
, -1, -1);
1145 ::InflateRect(&r
, -1, -1);
1148 wxDrawLine(hdc
, r
.left
, r
.bottom
, r
.right
, r
.bottom
);
1149 wxDrawLine(hdc
, r
.right
, r
.bottom
, r
.right
, r
.top
- 1);
1151 (void)SelectObject(hdc
, hpenWhite
);
1152 wxDrawLine(hdc
, r
.left
, r
.bottom
- 1, r
.left
, r
.top
);
1153 wxDrawLine(hdc
, r
.left
, r
.top
, r
.right
, r
.top
);
1155 (void)SelectObject(hdc
, hpenLightGr
);
1156 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 2, r
.left
+ 1, r
.top
+ 1);
1157 wxDrawLine(hdc
, r
.left
+ 1, r
.top
+ 1, r
.right
- 1, r
.top
+ 1);
1159 (void)SelectObject(hdc
, hpenGrey
);
1160 wxDrawLine(hdc
, r
.left
+ 1, r
.bottom
- 1, r
.right
- 1, r
.bottom
- 1);
1161 wxDrawLine(hdc
, r
.right
- 1, r
.bottom
- 1, r
.right
- 1, r
.top
);
1164 InflateRect(&rectBtn
, -OD_BUTTON_MARGIN
, -OD_BUTTON_MARGIN
);
1168 void DrawXPBackground(wxButton
*button
, HDC hdc
, RECT
& rectBtn
, UINT state
)
1170 wxUxThemeHandle
theme(button
, L
"BUTTON");
1172 // this array is indexed by wxButton::State values and so must be kept in
1174 static const int uxStates
[] =
1176 PBS_NORMAL
, PBS_HOT
, PBS_PRESSED
, PBS_DISABLED
, PBS_DEFAULTED
1179 int iState
= uxStates
[GetButtonState(button
, state
)];
1181 wxUxThemeEngine
* const engine
= wxUxThemeEngine::Get();
1183 // draw parent background if needed
1184 if ( engine
->IsThemeBackgroundPartiallyTransparent
1191 engine
->DrawThemeParentBackground(GetHwndOf(button
), hdc
, &rectBtn
);
1195 engine
->DrawThemeBackground(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1198 // calculate content area margins
1200 engine
->GetThemeMargins(theme
, hdc
, BP_PUSHBUTTON
, iState
,
1201 TMT_CONTENTMARGINS
, &rectBtn
, &margins
);
1202 ::InflateRect(&rectBtn
, -margins
.cxLeftWidth
, -margins
.cyTopHeight
);
1203 ::InflateRect(&rectBtn
, -XP_BUTTON_EXTRA_MARGIN
, -XP_BUTTON_EXTRA_MARGIN
);
1205 if ( button
->UseBgCol() )
1207 COLORREF colBg
= wxColourToRGB(button
->GetBackgroundColour());
1208 AutoHBRUSH
hbrushBackground(colBg
);
1210 // don't overwrite the focus rect
1212 ::CopyRect(&rectClient
, &rectBtn
);
1213 ::InflateRect(&rectClient
, -1, -1);
1214 FillRect(hdc
, &rectClient
, hbrushBackground
);
1217 #endif // wxUSE_UXTHEME
1219 } // anonymous namespace
1221 // ----------------------------------------------------------------------------
1222 // owner drawn buttons support
1223 // ----------------------------------------------------------------------------
1225 void wxButton::MakeOwnerDrawn()
1227 long style
= GetWindowLong(GetHwnd(), GWL_STYLE
);
1228 if ( (style
& BS_OWNERDRAW
) != BS_OWNERDRAW
)
1231 style
|= BS_OWNERDRAW
;
1232 SetWindowLong(GetHwnd(), GWL_STYLE
, style
);
1236 bool wxButton::SetBackgroundColour(const wxColour
&colour
)
1238 if ( !wxControl::SetBackgroundColour(colour
) )
1251 bool wxButton::SetForegroundColour(const wxColour
&colour
)
1253 if ( !wxControl::SetForegroundColour(colour
) )
1266 bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT
*wxdis
)
1268 LPDRAWITEMSTRUCT lpDIS
= (LPDRAWITEMSTRUCT
)wxdis
;
1269 HDC hdc
= lpDIS
->hDC
;
1271 UINT state
= lpDIS
->itemState
;
1272 bool pushed
= (SendMessage(GetHwnd(), BM_GETSTATE
, 0, 0) & BST_PUSHED
) != 0;
1275 CopyRect(&rectBtn
, &lpDIS
->rcItem
);
1277 // draw the button background
1278 if ( !HasFlag(wxBORDER_NONE
) )
1281 if ( wxUxThemeEngine::GetIfActive() )
1283 DrawXPBackground(this, hdc
, rectBtn
, state
);
1286 #endif // wxUSE_UXTHEME
1288 COLORREF colBg
= wxColourToRGB(GetBackgroundColour());
1290 // first, draw the background
1291 AutoHBRUSH
hbrushBackground(colBg
);
1292 FillRect(hdc
, &rectBtn
, hbrushBackground
);
1294 // draw the border for the current state
1295 bool selected
= (state
& ODS_SELECTED
) != 0;
1299 tlw
= wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow
);
1302 selected
= tlw
->GetDefaultItem() == this;
1306 DrawButtonFrame(hdc
, rectBtn
, selected
, pushed
);
1309 // draw the focus rectangle if we need it
1310 if ( (state
& ODS_FOCUS
) && !(state
& ODS_NOFOCUSRECT
) )
1312 DrawFocusRect(hdc
, &rectBtn
);
1315 if ( !wxUxThemeEngine::GetIfActive() )
1316 #endif // wxUSE_UXTHEME
1320 // the label is shifted by 1 pixel to create "pushed" effect
1321 OffsetRect(&rectBtn
, 1, 1);
1328 // draw the image, if any
1331 wxBitmap bmp
= m_imageData
->GetBitmap(GetButtonState(this, state
));
1333 bmp
= m_imageData
->GetBitmap(State_Normal
);
1335 const wxSize sizeBmp
= bmp
.GetSize();
1336 const wxSize margin
= m_imageData
->GetBitmapMargins();
1337 const wxSize
sizeBmpWithMargins(sizeBmp
+ 2*margin
);
1338 wxRect
rectButton(wxRectFromRECT(rectBtn
));
1340 // for simplicity, we start with centred rectangle and then move it to
1341 // the appropriate edge
1342 wxRect rectBitmap
= wxRect(sizeBmp
).CentreIn(rectButton
);
1344 // move bitmap only if we have a label, otherwise keep it centered
1347 switch ( m_imageData
->GetBitmapPosition() )
1350 wxFAIL_MSG( "invalid direction" );
1354 rectBitmap
.x
= rectButton
.x
+ margin
.x
;
1355 rectButton
.x
+= sizeBmpWithMargins
.x
;
1356 rectButton
.width
-= sizeBmpWithMargins
.x
;
1360 rectBitmap
.x
= rectButton
.GetRight() - sizeBmp
.x
- margin
.x
;
1361 rectButton
.width
-= sizeBmpWithMargins
.x
;
1365 rectBitmap
.y
= rectButton
.y
+ margin
.y
;
1366 rectButton
.y
+= sizeBmpWithMargins
.y
;
1367 rectButton
.height
-= sizeBmpWithMargins
.y
;
1371 rectBitmap
.y
= rectButton
.GetBottom() - sizeBmp
.y
- margin
.y
;
1372 rectButton
.height
-= sizeBmpWithMargins
.y
;
1377 wxDCTemp
dst((WXHDC
)hdc
);
1378 dst
.DrawBitmap(bmp
, rectBitmap
.GetPosition(), true);
1380 wxCopyRectToRECT(rectButton
, rectBtn
);
1384 // finally draw the label
1387 COLORREF colFg
= state
& ODS_DISABLED
1388 ? ::GetSysColor(COLOR_GRAYTEXT
)
1389 : wxColourToRGB(GetForegroundColour());
1391 // notice that DT_HIDEPREFIX doesn't work on old (pre-Windows 2000)
1392 // systems but by happy coincidence ODS_NOACCEL is not used under them
1393 // neither so DT_HIDEPREFIX should never be used there
1394 DrawButtonText(hdc
, &rectBtn
, GetLabel(), colFg
,
1395 state
& ODS_NOACCEL
? DT_HIDEPREFIX
: 0);
1401 #endif // wxUSE_BUTTON