Disable some wxWebView tests that fail on the buildbot but not locally.

[wxWidgets.git] / src / msw / button.cpp

diff --git a/src/msw/button.cpp b/src/msw/button.cpp
index fce544bd25e3ef67f40f920a1d92f3d75be76053..3e9bfb5739e9358e37df4c1b06e6d2c0cd8deedf 100644 (file)
--- a/src/msw/button.cpp
+++ b/src/msw/button.cpp
@@ -1,201 +1,461 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        button.cpp
+// Name:        src/msw/button.cpp

 // Purpose:     wxButton
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "button.h"
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

-#ifndef WX_PRECOMP
+#if wxUSE_BUTTON
+

 #include "wx/button.h"
 #include "wx/button.h"

-#include "wx/brush.h"
+
+#ifndef WX_PRECOMP
+    #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
 
 #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 !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)
-#endif
+#if wxUSE_MARKUP
+    #include "wx/generic/private/markuptext.h"
+#endif // wxUSE_MARKUP

 
 

-#define BUTTON_HEIGHT_FROM_CHAR_HEIGHT(cy) (11*EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)/10)
+// 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

 
 

-// Buttons
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
+
+BEGIN_EVENT_TABLE(wxButton, wxButtonBase)
+    EVT_CHAR_HOOK(wxButton::OnCharHook)
+END_EVENT_TABLE()
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// creation/destruction
+// ----------------------------------------------------------------------------
+
+bool wxButton::Create(wxWindow *parent,
+                      wxWindowID id,
+                      const wxString& lbl,
+                      const wxPoint& pos,
+                      const wxSize& size,
+                      long style,
+                      const wxValidator& validator,
+                      const wxString& name)
+{
+    wxString label(lbl);
+    if (label.empty() && wxIsStockID(id))
+    {
+        // 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
+                );
+    }
+
+    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);
+}

 
 

-bool wxButton::MSWCommand(WXUINT param, WXWORD id)
+wxButton::~wxButton()

 {
 {

-  if (param == BN_CLICKED || (param == 1)) // 1 for accelerator
-  {
-    wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, id);
-    event.SetEventObject(this);
-    ProcessCommand(event);
-    return TRUE;
-  }
-  else return FALSE;
+    wxTopLevelWindow *tlw = wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow);
+    if ( tlw && tlw->GetTmpDefaultItem() == this )
+    {
+        UnsetTmpDefault();
+    }

 }
 
 }
 

-bool wxButton::Create(wxWindow *parent, wxWindowID id, const wxString& label,
-           const wxPoint& pos,
-           const wxSize& size, long style,
-           const wxValidator& validator,
-           const wxString& name)
+// ----------------------------------------------------------------------------
+// flags
+// ----------------------------------------------------------------------------
+
+WXDWORD wxButton::MSWGetStyle(long style, WXDWORD *exstyle) const

 {
 {

-  SetName(name);
-  SetValidator(validator);
+    // 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;
+}

 
 

-  parent->AddChild((wxButton *)this);
-  m_backgroundColour = parent->GetBackgroundColour() ;
-  m_foregroundColour = parent->GetForegroundColour() ;
+/* static */
+wxSize wxButtonBase::GetDefaultSize()
+{
+    static wxSize s_sizeBtn;
+
+    if ( s_sizeBtn.x == 0 )
+    {
+        wxScreenDC dc;
+        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;
+}

 
 

-  m_windowStyle = (long&)style;
+// ----------------------------------------------------------------------------
+// default button handling
+// ----------------------------------------------------------------------------

 
 

-  int x = pos.x;
-  int y = pos.y;
-  int width = size.x;
-  int height = size.y;
+/*
+   The comment below and all this code is probably due to not using WM_NEXTDLGCTL
+   message when changing focus (but just SetFocus() which is not enough), see
+   http://blogs.msdn.com/oldnewthing/archive/2004/08/02/205624.aspx for the
+   full explanation.
+
+   TODO: Do use WM_NEXTDLGCTL and get rid of all this code.
+
+
+   "Everything you ever wanted to know about the default buttons" or "Why do we
+   have to do all this?"
+
+   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.
+
+   NB: all this is quite complicated by now and the worst is that normally
+       it shouldn't be necessary at all as for the normal Windows programs
+       DefWindowProc() and IsDialogMessage() take care of all this
+       automatically -- however in wxWidgets programs this doesn't work for
+       nested hierarchies (i.e. a notebook inside a notebook) for unknown
+       reason and so we have to reproduce all this code ourselves. It would be
+       very nice if we could avoid doing it.
+ */
+
+// set this button as the (permanently) default one in its panel
+wxWindow *wxButton::SetDefault()
+{
+    // set this one as the default button both for wxWidgets ...
+    wxWindow *winOldDefault = wxButtonBase::SetDefault();

 
 

-  if (id == -1)
-    m_windowId = NewControlId();
-  else
-    m_windowId = id;
+    // ... and Windows
+    SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), false);
+    SetDefaultStyle(this, true);

 
 

-  DWORD exStyle = MakeExtendedStyle(m_windowStyle);
-  HWND wx_button =
-    CreateWindowEx(exStyle, "BUTTON", label, BS_PUSHBUTTON | WS_TABSTOP | WS_CHILD,
-                    0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId,
-                    wxGetInstance(), NULL);
+    return winOldDefault;
+}

 
 

-#if CTL3D
-//  if (!(GetParent()->GetWindowStyleFlag() & wxUSER_COLOURS))
-//    Ctl3dSubclassCtl(wx_button);
-#endif
+// return the top level parent window if it's not being deleted yet, otherwise
+// return NULL
+static wxTopLevelWindow *GetTLWParentIfNotBeingDeleted(wxWindow *win)
+{
+    for ( ;; )
+    {
+        // 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;

 
 

-  m_hWnd = (WXHWND)wx_button;
+            break;
+        }

 
 

-  // Subclass again for purposes of dialog editing mode
-  SubclassWin((WXHWND)wx_button);
+        win = parent;
+    }

 
 

-  SetFont(parent->GetFont());
+    wxASSERT_MSG( win, wxT("button without top level parent?") );

 
 

-  SetSize(x, y, width, height);
-  ShowWindow(wx_button, SW_SHOW);
+    wxTopLevelWindow * const tlw = wxDynamicCast(win, wxTopLevelWindow);
+    wxASSERT_MSG( tlw, wxT("logic error in GetTLWParentIfNotBeingDeleted()") );

 
 

-  return TRUE;
+    return tlw;

 }
 
 }
 

-void wxButton::SetSize(int x, int y, int width, int height, int sizeFlags)
+// set this button as being currently default
+void wxButton::SetTmpDefault()

 {
 {

-  int currentX, currentY;
-  GetPosition(&currentX, &currentY);
-  int x1 = x;
-  int y1 = y;
-  if (x == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
-    x1 = currentX;
-  if (y == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
-    y1 = currentY;
+    wxTopLevelWindow * const tlw = GetTLWParentIfNotBeingDeleted(GetParent());
+    if ( !tlw )
+        return;

 
 

-  AdjustForParentClientOrigin(x1, y1, sizeFlags);
+    wxWindow *winOldDefault = tlw->GetDefaultItem();
+    tlw->SetTmpDefaultItem(this);

 
 

-  int actualWidth = width;
-  int actualHeight = height;
-  int ww, hh;
-  GetSize(&ww, &hh);
+    SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), false);
+    SetDefaultStyle(this, true);
+}

 
 

-  int current_width;
-  int cyf;
-  char buf[300];
-  GetWindowText((HWND) GetHWND(), buf, 300);
-  GetTextExtent(buf, &current_width, &cyf,NULL,NULL,
-    & this->GetFont());
+// unset this button as currently default, it may still stay permanent default
+void wxButton::UnsetTmpDefault()
+{
+    wxTopLevelWindow * const tlw = GetTLWParentIfNotBeingDeleted(GetParent());
+    if ( !tlw )
+        return;

 
 

-  // If we're prepared to use the existing width, then...
-  if (width == -1 && ((sizeFlags & wxSIZE_AUTO_WIDTH) != wxSIZE_AUTO_WIDTH))
-    actualWidth = ww;
-  else if (width == -1)
-  {
-    int cx;
-    int cy;
-    wxGetCharSize(GetHWND(), &cx, &cy, & this->GetFont());
-    actualWidth = (int)(current_width + 3*cx) ;
-  }
-  
-  // If we're prepared to use the existing height, then...
-  if (height == -1 && ((sizeFlags & wxSIZE_AUTO_HEIGHT) != wxSIZE_AUTO_HEIGHT))
-    actualHeight = hh;
-  else if (height == -1)
-  {
-    actualHeight = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(cyf);
-  }
+    tlw->SetTmpDefaultItem(NULL);

 
 

-  MoveWindow((HWND) GetHWND(), x1, y1, actualWidth, actualHeight, TRUE);
+    wxWindow *winOldDefault = tlw->GetDefaultItem();
+
+    SetDefaultStyle(this, false);
+    SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), true);

 }
 
 }
 

-void wxButton::SetDefault(void)
+/* static */
+void
+wxButton::SetDefaultStyle(wxButton *btn, bool on)

 {
 {

-  wxWindow *parent = (wxWindow *)GetParent();
-  if (parent)
-    parent->SetDefaultItem(this);
+    // 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 )
+    {
+        // 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
+    }
+
+    // then also change the style as needed
+    long style = ::GetWindowLong(GetHwndOf(btn), GWL_STYLE);
+    if ( !(style & BS_DEFPUSHBUTTON) == on )
+    {
+        // 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();
+        }
+    }
+    //else: already has correct style
+}

 
 

-  if (parent)
-  {
-    SendMessage((HWND)parent->GetHWND(), DM_SETDEFID, m_windowId, 0L);
-  }
+// ----------------------------------------------------------------------------
+// helpers
+// ----------------------------------------------------------------------------

 
 

-  SendMessage((HWND)GetHWND(), BM_SETSTYLE, BS_DEFPUSHBUTTON, 1L);
+bool wxButton::SendClickEvent()
+{
+    wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetId());
+    event.SetEventObject(this);
+
+    return ProcessCommand(event);

 }
 
 }
 

-wxString wxButton::GetLabel(void) const
+void wxButton::Command(wxCommandEvent & event)

 {
 {

-    GetWindowText((HWND) GetHWND(), wxBuffer, 300);
-    return wxString(wxBuffer);
+    ProcessCommand(event);

 }
 
 }
 

-void wxButton::SetLabel(const wxString& label)
+// ----------------------------------------------------------------------------
+// event/message handlers
+// ----------------------------------------------------------------------------
+
+void wxButton::OnCharHook(wxKeyEvent& event)

 {
 {

-  SetWindowText((HWND) GetHWND(), (const char *) label);
+    // 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();
+    }

 }
 
 }
 

-WXHBRUSH wxButton::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-                       WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
+bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))

 {
 {

-/*
-    WXHBRUSH hBrush = (WXHBRUSH) MSWDefWindowProc(message, wParam, lParam);
-//    ::SetTextColor((HDC) pDC, GetSysColor(COLOR_BTNTEXT));
-    ::SetTextColor((HDC) pDC, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(),
-        GetForegroundColour().Blue()));
+    bool processed = false;
+    switch ( param )
+    {
+        // 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;
+}

 
 

-       return hBrush;
-*/
-  // This doesn't in fact seem to make any difference at all - buttons are always
-  // the same colour.
-  ::SetBkColor((HDC) pDC, RGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue()));
-  ::SetTextColor((HDC) pDC, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(), GetForegroundColour().Blue()));
+WXLRESULT wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+{
+    // 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();
+    }
+
+    // let the base class do all real processing
+    return wxAnyButton::MSWWindowProc(nMsg, wParam, lParam);
+}

 
 

-  wxBrush *backgroundBrush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
+// ----------------------------------------------------------------------------
+// authentication needed handling
+// ----------------------------------------------------------------------------

 
 

-  // Note that this will be cleaned up in wxApp::OnIdle, if backgroundBrush
-  // has a zero usage count.
-  // NOT NOW; CHANGED.
-//  backgroundBrush->RealizeResource();
-  return (WXHBRUSH) backgroundBrush->GetResourceHandle();
+bool wxButton::DoGetAuthNeeded() const
+{
+    return m_authNeeded;

 }
 
 }
 

-void wxButton::Command (wxCommandEvent & event)
+void wxButton::DoSetAuthNeeded(bool show)

 {
 {

-  ProcessCommand (event);
+    // show/hide UAC symbol on Windows Vista and later
+    if ( wxGetWinVersion() >= wxWinVersion_6 )
+    {
+        m_authNeeded = show;
+        ::SendMessage(GetHwnd(), BCM_SETSHIELD, 0, show);
+        InvalidateBestSize();
+    }

 }
 
 }
 

+#endif // wxUSE_BUTTON