/////////////////////////////////////////////////////////////////////////////
-// Name: button.cpp
+// Name: src/msw/button.cpp
// Purpose: wxButton
// Author: Julian Smart
// Modified by:
// Created: 04/01/98
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "button.h"
-#endif
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
+#if wxUSE_BUTTON
+
+#include "wx/button.h"
+
#ifndef WX_PRECOMP
- #include "wx/button.h"
+ #include "wx/app.h"
#include "wx/brush.h"
#include "wx/panel.h"
#include "wx/bmpbuttn.h"
#include "wx/settings.h"
#include "wx/dcscreen.h"
+ #include "wx/dcclient.h"
+ #include "wx/toplevel.h"
+ #include "wx/msw/wrapcctl.h"
+ #include "wx/msw/private.h"
+ #include "wx/msw/missing.h"
#endif
-#include "wx/msw/private.h"
+#include "wx/imaglist.h"
+#include "wx/stockitem.h"
+#include "wx/msw/private/button.h"
+#include "wx/msw/private/dc.h"
+#include "wx/private/window.h"
+
+#if wxUSE_MARKUP
+ #include "wx/generic/private/markuptext.h"
+#endif // wxUSE_MARKUP
+
+// set the value for BCM_SETSHIELD (for the UAC shield) if it's not defined in
+// the header
+#ifndef BCM_SETSHIELD
+ #define BCM_SETSHIELD 0x160c
+#endif
// ----------------------------------------------------------------------------
// macros
// ----------------------------------------------------------------------------
-#if !USE_SHARED_LIBRARY
- IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)
-#endif
-
-// this macro tries to adjust the default button height to a reasonable value
-// using the char height as the base
-#define BUTTON_HEIGHT_FROM_CHAR_HEIGHT(cy) (11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)/10)
+BEGIN_EVENT_TABLE(wxButton, wxButtonBase)
+ EVT_CHAR_HOOK(wxButton::OnCharHook)
+END_EVENT_TABLE()
// ============================================================================
// implementation
bool wxButton::Create(wxWindow *parent,
wxWindowID id,
- const wxString& label,
+ const wxString& lbl,
const wxPoint& pos,
const wxSize& size,
long style,
const wxValidator& validator,
const wxString& name)
{
- if ( !CreateBase(parent, id, pos, size, style, validator, name) )
- return FALSE;
-
- parent->AddChild((wxButton *)this);
-
- m_backgroundColour = parent->GetBackgroundColour() ;
- m_foregroundColour = parent->GetForegroundColour() ;
-
- m_hWnd = (WXHWND)CreateWindowEx
- (
- MakeExtendedStyle(m_windowStyle),
- wxT("BUTTON"),
- label,
- WS_VISIBLE | WS_TABSTOP | WS_CHILD,
- 0, 0, 0, 0,
- GetWinHwnd(parent),
- (HMENU)m_windowId,
- wxGetInstance(),
- NULL
- );
-
- // Subclass again for purposes of dialog editing mode
- SubclassWin(m_hWnd);
-
- SetFont(parent->GetFont());
-
- SetSize(pos.x, pos.y, size.x, size.y);
-
- // bad hack added by Robert to make buttons at least
- // 80 pixels wide. There are probably better ways...
- // TODO. FIXME.
- wxSize nsize( GetSize() );
- if ((nsize.x < 80) || (nsize.y < 23))
+ wxString label(lbl);
+ if (label.empty() && wxIsStockID(id))
{
- if ((size.x == -1) && (nsize.x < 80))
- nsize.x = 80;
- if ((size.y == -1) && (nsize.y < 23))
- nsize.y = 23;
- SetSize( nsize );
+ // On Windows, some buttons aren't supposed to have mnemonics
+ label = wxGetStockLabel
+ (
+ id,
+ id == wxID_OK || id == wxID_CANCEL || id == wxID_CLOSE
+ ? wxSTOCK_NOFLAGS
+ : wxSTOCK_WITH_MNEMONIC
+ );
}
- return TRUE;
+ if ( !CreateControl(parent, id, pos, size, style, validator, name) )
+ return false;
+
+ WXDWORD exstyle;
+ WXDWORD msStyle = MSWGetStyle(style, &exstyle);
+
+ // if the label contains several lines we must explicitly tell the button
+ // about it or it wouldn't draw it correctly ("\n"s would just appear as
+ // black boxes)
+ //
+ // NB: we do it here and not in MSWGetStyle() because we need the label
+ // value and the label is not set yet when MSWGetStyle() is called
+ msStyle |= wxMSWButton::GetMultilineStyle(label);
+
+ return MSWCreateControl(wxT("BUTTON"), msStyle, pos, size, label, exstyle);
}
wxButton::~wxButton()
{
- wxPanel *panel = wxDynamicCast(GetParent(), wxPanel);
- if ( panel )
+ wxTopLevelWindow *tlw = wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow);
+ if ( tlw && tlw->GetTmpDefaultItem() == this )
{
- if ( panel->GetDefaultItem() == this )
- {
- // don't leave the panel with invalid default item
- panel->SetDefaultItem(NULL);
- }
+ UnsetTmpDefault();
}
}
// ----------------------------------------------------------------------------
-// size management including autosizing
+// flags
// ----------------------------------------------------------------------------
-wxSize wxButton::DoGetBestSize()
+WXDWORD wxButton::MSWGetStyle(long style, WXDWORD *exstyle) const
{
- wxString label = wxGetWindowText(GetHWND());
- int wBtn;
- GetTextExtent(label, &wBtn, NULL);
-
- int wChar, hChar;
- wxGetCharSize(GetHWND(), &wChar, &hChar, &GetFont());
-
- // add a margin - the button is wider than just its label
- wBtn += 3*wChar;
-
- // the button height is proportional to the height of the font used
- int hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar);
-
- return wxSize(wBtn, hBtn);
+ // buttons never have an external border, they draw their own one
+ WXDWORD msStyle = wxControl::MSWGetStyle
+ (
+ (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
+ );
+
+ // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
+ // each other in any resizable dialog which has more than one button in
+ // the bottom
+ msStyle |= WS_CLIPSIBLINGS;
+
+ // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
+ // and wxBU_RIGHT to get BS_CENTER!
+ if ( style & wxBU_LEFT )
+ msStyle |= BS_LEFT;
+ if ( style & wxBU_RIGHT )
+ msStyle |= BS_RIGHT;
+ if ( style & wxBU_TOP )
+ msStyle |= BS_TOP;
+ if ( style & wxBU_BOTTOM )
+ msStyle |= BS_BOTTOM;
+#ifndef __WXWINCE__
+ // flat 2d buttons
+ if ( style & wxNO_BORDER )
+ msStyle |= BS_FLAT;
+#endif // __WXWINCE__
+
+ return msStyle;
}
/* static */
-wxSize wxButton::GetDefaultSize()
+wxSize wxButtonBase::GetDefaultSize()
{
static wxSize s_sizeBtn;
if ( s_sizeBtn.x == 0 )
{
wxScreenDC dc;
- dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
-
- // the size of a standard button in the dialog units is 50x14,
- // translate this to pixels
- // NB1: the multipliers come from the Windows convention
- // NB2: the extra +1/+2 were needed to get the size be the same as the
- // size of the buttons in the standard dialog - I don't know how
- // this happens, but on my system this size is 75x23 in pixels and
- // 23*8 isn't even divisible by 14... Would be nice to understand
- // why these constants are needed though!
- s_sizeBtn.x = (50 * (dc.GetCharWidth() + 1))/4;
- s_sizeBtn.y = ((14 * dc.GetCharHeight()) + 2)/8;
+ dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
+
+ // The size of a standard button in the dialog units is 50x14,
+ // translate this to pixels.
+ //
+ // Windows' computes dialog units using average character width over
+ // upper- and lower-case ASCII alphabet and not using the average
+ // character width metadata stored in the font; see
+ // http://support.microsoft.com/default.aspx/kb/145994 for detailed
+ // discussion.
+ //
+ // NB: wxMulDivInt32() is used, because it correctly rounds the result
+
+ const wxSize base = wxPrivate::GetAverageASCIILetterSize(dc);
+ s_sizeBtn.x = wxMulDivInt32(50, base.x, 4);
+ s_sizeBtn.y = wxMulDivInt32(14, base.y, 8);
}
return s_sizeBtn;
}
// ----------------------------------------------------------------------------
-// set this button as the default one in its panel
+// default button handling
// ----------------------------------------------------------------------------
-void wxButton::SetDefault()
+/*
+ In normal Windows programs there is no need to handle default button
+ manually because this is taken care by the system provided you use
+ WM_NEXTDLGCTL and not just SetFocus() to switch focus betweeh the controls
+ (see http://blogs.msdn.com/oldnewthing/archive/2004/08/02/205624.aspx for
+ the full explanation why just calling SetFocus() is not enough).
+
+ However this only works if the window is a dialog, i.e. uses DefDlgProc(),
+ but not with plain windows using DefWindowProc() and we do want to have
+ default buttons inside frames as well, so we're forced to reimplement all
+ this logic ourselves. It would be great to avoid having to do this but using
+ DefDlgProc() for all the windows would almost certainly result in more
+ problems, we'd need to carefully filter messages and pass some of them to
+ DefWindowProc() and some of them to DefDlgProc() which looks dangerous (what
+ if the handling of some message changes in some Windows version?), so doing
+ this ourselves is probably a lesser evil.
+
+ Read the rest to learn everything you ever wanted to know about the default
+ buttons but were afraid to ask.
+
+
+ In MSW the default button should be activated when the user presses Enter
+ and the current control doesn't process Enter itself somehow. This is
+ handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
+ Another aspect of "defaultness" is that the default button has different
+ appearance: this is due to BS_DEFPUSHBUTTON style which is completely
+ separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
+ be unset if our parent window is not active so it should be unset whenever
+ we lose activation and set back when we regain it.
+
+ Final complication is that when a button is active, it should be the default
+ one, i.e. pressing Enter on a button always activates it and not another
+ one.
+
+ We handle this by maintaining a permanent and a temporary default items in
+ wxControlContainer (both may be NULL). When a button becomes the current
+ control (i.e. gets focus) it sets itself as the temporary default which
+ ensures that it has the right appearance and that Enter will be redirected
+ to it. When the button loses focus, it unsets the temporary default and so
+ the default item will be the permanent default -- that is the default button
+ if any had been set or none otherwise, which is just what we want.
+ */
+
+// set this button as the (permanently) default one in its panel
+wxWindow *wxButton::SetDefault()
{
- wxWindow *parent = GetParent();
- wxButton *btnOldDefault = NULL;
- wxPanel *panel = wxDynamicCast(parent, wxPanel);
- if ( panel )
+ // set this one as the default button both for wxWidgets ...
+ wxWindow *winOldDefault = wxButtonBase::SetDefault();
+
+ // ... and Windows
+ SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), false);
+ SetDefaultStyle(this, true);
+
+ return winOldDefault;
+}
+
+// return the top level parent window if it's not being deleted yet, otherwise
+// return NULL
+static wxTopLevelWindow *GetTLWParentIfNotBeingDeleted(wxWindow *win)
+{
+ for ( ;; )
{
- btnOldDefault = panel->GetDefaultItem();
- panel->SetDefaultItem(this);
+ // IsTopLevel() will return false for a wxTLW being deleted, so we also
+ // need the parent test for this case
+ wxWindow * const parent = win->GetParent();
+ if ( !parent || win->IsTopLevel() )
+ {
+ if ( win->IsBeingDeleted() )
+ return NULL;
+
+ break;
+ }
+
+ win = parent;
}
- if ( parent )
+ wxASSERT_MSG( win, wxT("button without top level parent?") );
+
+ wxTopLevelWindow * const tlw = wxDynamicCast(win, wxTopLevelWindow);
+ wxASSERT_MSG( tlw, wxT("logic error in GetTLWParentIfNotBeingDeleted()") );
+
+ return tlw;
+}
+
+// set this button as being currently default
+void wxButton::SetTmpDefault()
+{
+ wxTopLevelWindow * const tlw = GetTLWParentIfNotBeingDeleted(this);
+ if ( !tlw )
+ return;
+
+ wxWindow *winOldDefault = tlw->GetDefaultItem();
+ tlw->SetTmpDefaultItem(this);
+
+ SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), false);
+ SetDefaultStyle(this, true);
+}
+
+// unset this button as currently default, it may still stay permanent default
+void wxButton::UnsetTmpDefault()
+{
+ wxTopLevelWindow * const tlw = GetTLWParentIfNotBeingDeleted(this);
+ if ( !tlw )
+ return;
+
+ tlw->SetTmpDefaultItem(NULL);
+
+ wxWindow *winOldDefault = tlw->GetDefaultItem();
+
+ SetDefaultStyle(this, false);
+ SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), true);
+}
+
+/* static */
+void
+wxButton::SetDefaultStyle(wxButton *btn, bool on)
+{
+ // we may be called with NULL pointer -- simpler to do the check here than
+ // in the caller which does wxDynamicCast()
+ if ( !btn )
+ return;
+
+ // first, let DefDlgProc() know about the new default button
+ if ( on )
{
- SendMessage(GetWinHwnd(parent), DM_SETDEFID, m_windowId, 0L);
+ // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
+ // focus at all any more
+ if ( !wxTheApp->IsActive() )
+ return;
+
+ wxWindow * const tlw = wxGetTopLevelParent(btn);
+ wxCHECK_RET( tlw, wxT("button without top level window?") );
+
+ ::SendMessage(GetHwndOf(tlw), DM_SETDEFID, btn->GetId(), 0L);
+
+ // sending DM_SETDEFID also changes the button style to
+ // BS_DEFPUSHBUTTON so there is nothing more to do
}
- // this doesn't work with bitmap buttons because it also removes the
- // "ownerdrawn" style...
- if ( btnOldDefault && !wxDynamicCast(btnOldDefault, wxBitmapButton) )
+ // then also change the style as needed
+ long style = ::GetWindowLong(GetHwndOf(btn), GWL_STYLE);
+ if ( !(style & BS_DEFPUSHBUTTON) == on )
{
- // remove the BS_DEFPUSHBUTTON style from the other button
- long style = GetWindowLong(GetHwndOf(btnOldDefault), GWL_STYLE);
- style &= ~BS_DEFPUSHBUTTON;
- SendMessage(GetHwndOf(btnOldDefault), BM_SETSTYLE, style, 1L);
+ // don't do it with the owner drawn buttons because it will
+ // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
+ // BS_DEFPUSHBUTTON != 0)!
+ if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
+ {
+ ::SendMessage(GetHwndOf(btn), BM_SETSTYLE,
+ on ? style | BS_DEFPUSHBUTTON
+ : style & ~BS_DEFPUSHBUTTON,
+ 1L /* redraw */);
+ }
+ else // owner drawn
+ {
+ // redraw the button - it will notice itself that it's
+ // [not] the default one [any longer]
+ btn->Refresh();
+ }
}
-
- // set this button as the default
- long style = GetWindowLong(GetHwnd(), GWL_STYLE);
- style |= BS_DEFPUSHBUTTON;
- SendMessage(GetHwnd(), BM_SETSTYLE, style, 1L);
+ //else: already has correct style
}
// ----------------------------------------------------------------------------
// event/message handlers
// ----------------------------------------------------------------------------
-bool wxButton::MSWCommand(WXUINT param, WXWORD id)
+void wxButton::OnCharHook(wxKeyEvent& event)
{
- bool processed = FALSE;
+ // We want to ensure that the button always processes Enter key events
+ // itself, even if it's inside some control that normally takes over them
+ // (this happens when the button is part of an in-place editor control for
+ // example).
+ if ( event.GetKeyCode() == WXK_RETURN )
+ {
+ // We should ensure that subsequent key events are still generated even
+ // if we did handle EVT_CHAR_HOOK (normally this would suppress their
+ // generation).
+ event.DoAllowNextEvent();
+ }
+ else
+ {
+ event.Skip();
+ }
+}
+
+bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
+{
+ bool processed = false;
switch ( param )
{
- case 1: // means that the message came from an accelerator
- case BN_CLICKED:
+ // NOTE: Apparently older versions (NT 4?) of the common controls send
+ // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
+ // buttons, so in order to send two EVT_BUTTON events we should
+ // catch both types. Currently (Feb 2003) up-to-date versions of
+ // win98, win2k and winXP all send two BN_CLICKED messages for
+ // all button types, so we don't catch BN_DOUBLECLICKED anymore
+ // in order to not get 3 EVT_BUTTON events. If this is a problem
+ // then we need to figure out which version of the comctl32 changed
+ // this behaviour and test for it.
+
+ case 1: // message came from an accelerator
+ case BN_CLICKED: // normal buttons send this
processed = SendClickEvent();
break;
}
return processed;
}
-WXHBRUSH wxButton::OnCtlColor(WXHDC pDC,
- WXHWND pWnd,
- WXUINT nCtlColor,
- WXUINT message,
- WXWPARAM wParam,
- WXLPARAM lParam)
+WXLRESULT wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
- wxBrush *backgroundBrush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
+ // when we receive focus, we want to temporarily become the default button in
+ // our parent panel so that pressing "Enter" would activate us -- and when
+ // losing it we should restore the previous default button as well
+ if ( nMsg == WM_SETFOCUS )
+ {
+ SetTmpDefault();
+
+ // let the default processing take place too
+ }
+ else if ( nMsg == WM_KILLFOCUS )
+ {
+ UnsetTmpDefault();
+ }
- return (WXHBRUSH) backgroundBrush->GetResourceHandle();
+ // let the base class do all real processing
+ return wxAnyButton::MSWWindowProc(nMsg, wParam, lParam);
}
-long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+// ----------------------------------------------------------------------------
+// authentication needed handling
+// ----------------------------------------------------------------------------
+
+bool wxButton::DoGetAuthNeeded() const
{
- // make sure that we won't have BS_DEFPUSHBUTTON style any more if the
- // focus is being transfered to another button with the same parent -
- // otherwise, we could finish with 2 default buttons inside one panel
- if ( (nMsg == WM_KILLFOCUS) &&
- (GetWindowLong(GetHwnd(), GWL_STYLE) & BS_DEFPUSHBUTTON) )
+ return m_authNeeded;
+}
+
+void wxButton::DoSetAuthNeeded(bool show)
+{
+ // show/hide UAC symbol on Windows Vista and later
+ if ( wxGetWinVersion() >= wxWinVersion_6 )
{
- wxWindow *parent = GetParent();
- wxWindow *win = wxFindWinFromHandle((WXHWND)wParam);
- if ( win && win->GetParent() == parent )
- {
- wxPanel *panel = wxDynamicCast(parent, wxPanel);
- if ( panel )
- {
- panel->SetDefaultItem(this);
- }
- // else: I don't know what to do - we'll still have the problem
- // with multiple default buttons in a dialog...
- }
+ m_authNeeded = show;
+ ::SendMessage(GetHwnd(), BCM_SETSHIELD, 0, show);
+ InvalidateBestSize();
}
-
- // let the base class do all real processing
- return wxControl::MSWWindowProc(nMsg, wParam, lParam);
}
+
+#endif // wxUSE_BUTTON
+
projects / wxWidgets.git / blobdiff