More style fixes

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

diff --git a/src/msw/button.cpp b/src/msw/button.cpp
index 29464dda75a52ba3ac0ee20345a9ccf530018001..7fcfa743d405fbc1f71d96ef249efe51339a25f6 100644 (file)
--- a/src/msw/button.cpp
+++ b/src/msw/button.cpp
@@ -5,8 +5,8 @@
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -31,6 +31,7 @@
 #if wxUSE_BUTTON
 
 #ifndef WX_PRECOMP
 #if wxUSE_BUTTON
 
 #ifndef WX_PRECOMP

+    #include "wx/app.h"

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


@@ -71,7 +72,24 @@ bool wxButton::Create(wxWindow *parent,
     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
         return FALSE;
 
     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
         return FALSE;
 

-    return MSWCreateControl(_T("BUTTON"), label, pos, size, style);
+    WXDWORD exstyle;
+    WXDWORD msStyle = MSWGetStyle(style, &exstyle);
+
+#ifdef __WIN32__
+    // 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 m_label is not set yet when MSWGetStyle() is called;
+    //     besides changing BS_MULTILINE during run-time is pointless anyhow
+    if ( label.find(_T('\n')) != wxString::npos )
+    {
+        msStyle |= BS_MULTILINE;
+    }
+#endif // __WIN32__
+
+    return MSWCreateControl(_T("BUTTON"), msStyle, pos, size, label, exstyle);

 }
 
 wxButton::~wxButton()
 }
 
 wxButton::~wxButton()


@@ -117,24 +135,33 @@ WXDWORD wxButton::MSWGetStyle(long style, WXDWORD *exstyle) const
 
 wxSize wxButton::DoGetBestSize() const
 {
 
 wxSize wxButton::DoGetBestSize() const
 {

-    wxString label = wxGetWindowText(GetHWND());

     int wBtn;
     int wBtn;

-    GetTextExtent(label, &wBtn, NULL);
+    GetTextExtent(wxGetWindowText(GetHWND()), &wBtn, NULL);

 
     int wChar, hChar;
     wxGetCharSize(GetHWND(), &wChar, &hChar, &GetFont());
 
 
     int wChar, hChar;
     wxGetCharSize(GetHWND(), &wChar, &hChar, &GetFont());
 

-    // add a margin - the button is wider than just its label
+    // 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);
 
     wBtn += 3*wChar;
 
     // the button height is proportional to the height of the font used
     int hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar);
 

-    wxSize sz = GetDefaultSize();
-    if (wBtn > sz.x) sz.x = wBtn;
-    if (hBtn > sz.y) sz.y = hBtn;
+    // all buttons have at least the standard size unless the user explicitly
+    // wants them to be of smaller size and used wxBU_EXACTFIT style when
+    // creating the button
+    if ( !HasFlag(wxBU_EXACTFIT) )
+    {
+        wxSize sz = GetDefaultSize();
+        if (wBtn > sz.x)
+            sz.x = wBtn;
+        if (hBtn > sz.y)
+            sz.y = hBtn;

 
 

-    return sz;
+        return sz;
+    }
+
+    return wxSize(wBtn, hBtn);

 }
 
 /* static */
 }
 
 /* static */


@@ -163,52 +190,140 @@ wxSize wxButtonBase::GetDefaultSize()
 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// set this button as the default one in its panel
+// default button handling

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

+/*
+   "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 wxWindows 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

 void wxButton::SetDefault()
 {
     wxWindow *parent = GetParent();
 void wxButton::SetDefault()
 {
     wxWindow *parent = GetParent();

-    wxButton *btnOldDefault;
-    if ( parent )
-    {
-        wxWindow *winOldDefault = parent->SetDefaultItem(this);
-        btnOldDefault = wxDynamicCast(winOldDefault, wxButton);

 
 

-        ::SendMessage(GetWinHwnd(parent), DM_SETDEFID, m_windowId, 0L);
-    }
-    else // is a button without parent really normal?
+    wxCHECK_RET( parent, _T("button without parent?") );
+
+    // set this one as the default button both for wxWindows ...
+    wxWindow *winOldDefault = parent->SetDefaultItem(this);
+
+    // ... and Windows
+    SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), FALSE);
+    SetDefaultStyle(this, TRUE);
+}
+
+// set this button as being currently default
+void wxButton::SetTmpDefault()
+{
+    wxWindow *parent = GetParent();
+
+    wxCHECK_RET( parent, _T("button without parent?") );
+
+    wxWindow *winOldDefault = parent->GetDefaultItem();
+    parent->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()
+{
+    wxWindow *parent = GetParent();
+
+    wxCHECK_RET( parent, _T("button without parent?") );
+
+    parent->SetTmpDefaultItem(NULL);
+
+    wxWindow *winOldDefault = parent->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 )

     {
     {

-        btnOldDefault = NULL;
+        // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
+        // focus at all any more
+        if ( !wxTheApp->IsActive() )
+            return;
+
+        // look for a panel-like window
+        wxWindow *win = btn->GetParent();
+        while ( win && !win->HasFlag(wxTAB_TRAVERSAL) )
+            win = win->GetParent();
+
+        if ( win )
+        {
+            ::SendMessage(GetHwndOf(win), DM_SETDEFID, btn->GetId(), 0L);
+
+            // sending DM_SETDEFID also changes the button style to
+            // BS_DEFPUSHBUTTON so there is nothing more to do
+        }

     }
 
     }
 

-    if ( btnOldDefault && btnOldDefault != this )
+    // 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);
-
-        // don't do it with the owner drawn buttons because it will reset
-        // BS_OWNERDRAW style bit too (BS_OWNERDRAW & BS_DEFPUSHBUTTON != 0)!
+        // 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 )
         {
         if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
         {

-            style &= ~BS_DEFPUSHBUTTON;
-            SendMessage(GetHwndOf(btnOldDefault), BM_SETSTYLE, style, 1L);
+            ::SendMessage(GetHwndOf(btn), BM_SETSTYLE,
+                          on ? style | BS_DEFPUSHBUTTON
+                             : style & ~BS_DEFPUSHBUTTON,
+                          1L /* redraw */);

         }
         }

-        else
+        else // owner drawn

         {
         {

-            // redraw the button - it will notice itself that it's not the
-            // default one any longer
-            btnOldDefault->Refresh();
+            // 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);
-    if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
-    {
-        style |= BS_DEFPUSHBUTTON;
-        SendMessage(GetHwnd(), BM_SETSTYLE, style, 1L);
-    }
+    //else: already has correct style

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -237,9 +352,18 @@ bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
     bool processed = FALSE;
     switch ( param )
     {
     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 EVET_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
         case 1:                     // message came from an accelerator
         case BN_CLICKED:            // normal buttons send this

-        case BN_DOUBLECLICKED:      // owner-drawn ones also send this

             processed = SendClickEvent();
             break;
     }
             processed = SendClickEvent();
             break;
     }


@@ -249,13 +373,18 @@ bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 
 long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {
 
 long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {

-    // when we receive focus, we want to become the default button in our
-    // parent panel
+    // when we receive focus, we want to temporary 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 )
     {
     if ( nMsg == WM_SETFOCUS )
     {

-        SetDefault();
+        SetTmpDefault();

 
 

-        // let the default processign take place too
+        // let the default processing take place too
+    }
+    else if ( nMsg == WM_KILLFOCUS )
+    {
+        UnsetTmpDefault();

     }
     else if ( nMsg == WM_LBUTTONDBLCLK )
     {
     }
     else if ( nMsg == WM_LBUTTONDBLCLK )
     {


@@ -263,14 +392,8 @@ long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
         // appearance - without this, it won't do it
         (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN, wParam, lParam);
 
         // appearance - without this, it won't do it
         (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN, wParam, lParam);
 

-        // and conitnue with processing the message normally as well
+        // and continue with processing the message normally as well

     }
     }

-#if 0
-    else if ( nMsg == WM_MOVE )
-    {
-        Refresh();
-    }
-#endif

 
     // let the base class do all real processing
     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 
     // let the base class do all real processing
     return wxControl::MSWWindowProc(nMsg, wParam, lParam);


@@ -292,8 +415,7 @@ static void DrawButtonText(HDC hdc,
     COLORREF colOld = SetTextColor(hdc, col);
     int modeOld = SetBkMode(hdc, TRANSPARENT);
 
     COLORREF colOld = SetTextColor(hdc, col);
     int modeOld = SetBkMode(hdc, TRANSPARENT);
 

-    DrawText(hdc, text, text.length(), pRect,
-             DT_CENTER | DT_VCENTER | DT_SINGLELINE);
+    ::DrawText(hdc, text, text.length(), pRect, DT_CENTER | DT_VCENTER);

 
     SetBkMode(hdc, modeOld);
     SetTextColor(hdc, colOld);
 
     SetBkMode(hdc, modeOld);
     SetTextColor(hdc, colOld);