make sure we are removing ourselves from the focus of the toplevel frame when deletin...

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

diff --git a/src/msw/button.cpp b/src/msw/button.cpp
index f9a84f98d20be8f68dd943edd020baf32fa9cad1..cb5cce446f0bd5aa0747f64bbec70536426c8efc 100644 (file)
--- a/src/msw/button.cpp
+++ b/src/msw/button.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxButton
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxButton
 // Author:      Julian Smart
 // Modified by:


@@ -16,6 +16,7 @@
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------

+

 #ifdef __GNUG__
     #pragma implementation "button.h"
 #endif
 #ifdef __GNUG__
     #pragma implementation "button.h"
 #endif


@@ -27,6 +28,8 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_BUTTON
+

 #ifndef WX_PRECOMP
     #include "wx/button.h"
     #include "wx/brush.h"
 #ifndef WX_PRECOMP
     #include "wx/button.h"
     #include "wx/brush.h"


@@ -42,9 +45,7 @@
 // macros
 // ----------------------------------------------------------------------------
 
 // macros
 // ----------------------------------------------------------------------------
 

-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)
-#endif
+IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)

 
 // this macro tries to adjust the default button height to a reasonable value
 // using the char height as the base
 
 // this macro tries to adjust the default button height to a reasonable value
 // using the char height as the base


@@ -67,68 +68,71 @@ bool wxButton::Create(wxWindow *parent,
                       const wxValidator& validator,
                       const wxString& name)
 {
                       const wxValidator& validator,
                       const wxString& name)
 {

-    if ( !CreateBase(parent, id, pos, size, style, validator, name) )
+    if ( !CreateControl(parent, id, pos, size, style, validator, name) )

         return FALSE;
 
         return FALSE;
 

-    SetValidator(validator);
-
-    parent->AddChild((wxButton *)this);
-
-    m_backgroundColour = parent->GetBackgroundColour() ;
-    m_foregroundColour = parent->GetForegroundColour() ;
-
-    m_hWnd = (WXHWND)CreateWindowEx
-                     (
-                      MakeExtendedStyle(m_windowStyle),
-                      _T("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))
+    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 )

     {
     {

-        if ((size.x == -1) && (nsize.x < 80)) nsize.x = 80;
-       if ((size.y == -1) && (nsize.y < 23)) nsize.y = 23;
-        SetSize( nsize );
+        msStyle |= BS_MULTILINE;

     }
     }

+#endif // __WIN32__

 
 

-    return TRUE;
+    return MSWCreateControl(_T("BUTTON"), msStyle, pos, size, label, exstyle);

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

-    wxPanel *panel = wxDynamicCast(GetParent(), wxPanel);
-    if ( panel )
-    {
-        if ( panel->GetDefaultItem() == this )
-        {
-            // don't leave the panel with invalid default item
-            panel->SetDefaultItem(NULL);
-        }
-    }
+}
+
+// ----------------------------------------------------------------------------
+// flags
+// ----------------------------------------------------------------------------
+
+WXDWORD wxButton::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+    // 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 resizeable dialog which has more than one button in
+    // the bottom
+    msStyle |= WS_CLIPSIBLINGS;
+
+#ifdef __WIN32__
+    // 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;
+#endif // __WIN32__
+
+    return msStyle;

 }
 
 // ----------------------------------------------------------------------------
 // size management including autosizing
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // size management including autosizing
 // ----------------------------------------------------------------------------
 

-wxSize wxButton::DoGetBestSize()
+wxSize wxButton::DoGetBestSize() const

 {
     wxString label = wxGetWindowText(GetHWND());
     int wBtn;
 {
     wxString label = wxGetWindowText(GetHWND());
     int wBtn;


@@ -143,18 +147,22 @@ wxSize wxButton::DoGetBestSize()
     // the button height is proportional to the height of the font used
     int hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar);
 
     // the button height is proportional to the height of the font used
     int hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar);
 

-    return wxSize(wBtn, hBtn);
+    wxSize sz = GetDefaultSize();
+    if (wBtn > sz.x) sz.x = wBtn;
+    if (hBtn > sz.y) sz.y = hBtn;
+
+    return sz;

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

-wxSize wxButton::GetDefaultSize()
+wxSize wxButtonBase::GetDefaultSize()

 {
     static wxSize s_sizeBtn;
 
     if ( s_sizeBtn.x == 0 )
     {
         wxScreenDC dc;
 {
     static wxSize s_sizeBtn;
 
     if ( s_sizeBtn.x == 0 )
     {
         wxScreenDC dc;

-        dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
+        dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));

 
         // the size of a standard button in the dialog units is 50x14,
         // translate this to pixels
 
         // the size of a standard button in the dialog units is 50x14,
         // translate this to pixels


@@ -172,39 +180,123 @@ wxSize wxButton::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 (!).
+
+   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.
+
+   Remark that we probably don't need to send DM_SETDEFID as we don't use
+   ::IsDialogMessage() (which relies on it) any longer but OTOH it probably
+   doesn't hurt neither.
+ */
+
+// 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 = NULL;
-    wxPanel *panel = wxDynamicCast(parent, wxPanel);
-    if ( panel )
+
+    wxCHECK_RET( parent, _T("button without parent?") );
+
+    // set this one as the default button both for wxWindows and Windows
+    wxWindow *winOldDefault = parent->SetDefaultItem(this);
+    ::SendMessage(GetWinHwnd(parent), DM_SETDEFID, m_windowId, 0L);
+
+    UpdateDefaultStyle(this, winOldDefault);
+}
+
+void wxButton::SetTmpDefault()
+{
+    wxWindow *parent = GetParent();
+
+    wxCHECK_RET( parent, _T("button without parent?") );
+
+    wxWindow *winOldDefault = parent->GetDefaultItem();
+    parent->SetTmpDefaultItem(this);
+    if ( winOldDefault != this )

     {
     {

-        btnOldDefault = panel->GetDefaultItem();
-        panel->SetDefaultItem(this);
+        UpdateDefaultStyle(this, winOldDefault);

     }
     }

+    //else: no styles to update
+}
+
+void wxButton::UnsetTmpDefault()
+{
+    wxWindow *parent = GetParent();
+
+    wxCHECK_RET( parent, _T("button without parent?") );
+
+    parent->SetTmpDefaultItem(NULL);

 
 

-    if ( parent )
+    wxWindow *winOldDefault = parent->GetDefaultItem();
+    if ( winOldDefault != this )

     {
     {

-        SendMessage(GetWinHwnd(parent), DM_SETDEFID, m_windowId, 0L);
+        UpdateDefaultStyle(winOldDefault, this);

     }
     }

+    //else: we had been default before anyhow
+}

 
 

-    // this doesn't work with bitmap buttons because it also removes the
-    // "ownerdrawn" style...
-    if ( btnOldDefault && !wxDynamicCast(btnOldDefault, wxBitmapButton) )
+/* static */
+void
+wxButton::UpdateDefaultStyle(wxWindow *winDefault, wxWindow *winOldDefault)
+{
+    // clear the BS_DEFPUSHBUTTON for the old default button
+    wxButton *btnOldDefault = wxDynamicCast(winOldDefault, wxButton);
+    if ( btnOldDefault && btnOldDefault != winDefault )

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

     }
 
     }
 

-    // set this button as the default
-    long style = GetWindowLong(GetHwnd(), GWL_STYLE);
-    style |= BS_DEFPUSHBUTTON;
-    SendMessage(GetHwnd(), BM_SETSTYLE, style, 1L);
+    // and set BS_DEFPUSHBUTTON for this button
+    wxButton *btnDefault = wxDynamicCast(winDefault, wxButton);
+    if ( btnDefault )
+    {
+        long style = ::GetWindowLong(GetHwndOf(btnDefault), GWL_STYLE);
+        if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
+        {
+            style |= BS_DEFPUSHBUTTON;
+            ::SendMessage(GetHwndOf(btnDefault), BM_SETSTYLE, style, 1L);
+        }
+        else
+        {
+            btnDefault->Refresh();
+        }
+    }

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


@@ -228,13 +320,14 @@ void wxButton::Command(wxCommandEvent & event)
 // event/message handlers
 // ----------------------------------------------------------------------------
 
 // event/message handlers
 // ----------------------------------------------------------------------------
 

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

 {
     bool processed = FALSE;
     switch ( param )
     {
 {
     bool processed = FALSE;
     switch ( param )
     {

-        case 1:                                             // 1 for accelerator
-        case BN_CLICKED:
+        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;
     }


@@ -242,15 +335,265 @@ bool wxButton::MSWCommand(WXUINT param, WXWORD id)
     return processed;
 }
 
     return processed;
 }
 

-WXHBRUSH wxButton::OnCtlColor(WXHDC pDC,
-                              WXHWND pWnd,
-                              WXUINT nCtlColor,
-                              WXUINT message,
-                              WXWPARAM wParam,
-                              WXLPARAM lParam)
+long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+{
+    // 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 )
+    {
+        SetTmpDefault();
+
+        // let the default processing take place too
+    }
+    else if ( nMsg == WM_KILLFOCUS )
+    {
+        UnsetTmpDefault();
+    }
+    else if ( nMsg == WM_LBUTTONDBLCLK )
+    {
+        // emulate a click event to force an owner-drawn button to change its
+        // appearance - without this, it won't do it
+        (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN, wParam, lParam);
+
+        // and continue with processing the message normally as well
+    }
+
+    // let the base class do all real processing
+    return wxControl::MSWWindowProc(nMsg, wParam, lParam);
+}
+
+// ----------------------------------------------------------------------------
+// owner-drawn buttons support
+// ----------------------------------------------------------------------------
+
+#ifdef __WIN32__
+
+// drawing helpers
+
+static void DrawButtonText(HDC hdc,
+                           RECT *pRect,
+                           const wxString& text,
+                           COLORREF col)
+{
+    COLORREF colOld = SetTextColor(hdc, col);
+    int modeOld = SetBkMode(hdc, TRANSPARENT);
+
+    DrawText(hdc, text, text.length(), pRect,
+             DT_CENTER | DT_VCENTER | DT_SINGLELINE);
+
+    SetBkMode(hdc, modeOld);
+    SetTextColor(hdc, colOld);
+}
+
+static void DrawRect(HDC hdc, const RECT& r)

 {
 {

-  wxBrush *backgroundBrush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
+    MoveToEx(hdc, r.left, r.top, NULL);
+    LineTo(hdc, r.right, r.top);
+    LineTo(hdc, r.right, r.bottom);
+    LineTo(hdc, r.left, r.bottom);
+    LineTo(hdc, r.left, r.top);
+}
+
+void wxButton::MakeOwnerDrawn()
+{
+    long style = GetWindowLong(GetHwnd(), GWL_STYLE);
+    if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
+    {
+        // make it so
+        style |= BS_OWNERDRAW;
+        SetWindowLong(GetHwnd(), GWL_STYLE, style);
+    }
+}
+
+bool wxButton::SetBackgroundColour(const wxColour &colour)
+{
+    if ( !wxControl::SetBackgroundColour(colour) )
+    {
+        // nothing to do
+        return FALSE;
+    }
+
+    MakeOwnerDrawn();
+
+    Refresh();
+
+    return TRUE;
+}
+
+bool wxButton::SetForegroundColour(const wxColour &colour)
+{
+    if ( !wxControl::SetForegroundColour(colour) )
+    {
+        // nothing to do
+        return FALSE;
+    }
+
+    MakeOwnerDrawn();
+
+    Refresh();
+
+    return TRUE;
+}
+
+/*
+   The button frame looks like this normally:
+
+   WWWWWWWWWWWWWWWWWWB
+   WHHHHHHHHHHHHHHHHGB  W = white       (HILIGHT)
+   WH               GB  H = light grey  (LIGHT)
+   WH               GB  G = dark grey   (SHADOW)
+   WH               GB  B = black       (DKSHADOW)
+   WH               GB
+   WGGGGGGGGGGGGGGGGGB
+   BBBBBBBBBBBBBBBBBBB
+
+   When the button is selected, the button becomes like this (the total button
+   size doesn't change):
+
+   BBBBBBBBBBBBBBBBBBB
+   BWWWWWWWWWWWWWWWWBB
+   BWHHHHHHHHHHHHHHGBB
+   BWH             GBB
+   BWH             GBB
+   BWGGGGGGGGGGGGGGGBB
+   BBBBBBBBBBBBBBBBBBB
+   BBBBBBBBBBBBBBBBBBB
+
+   When the button is pushed (while selected) it is like:
+
+   BBBBBBBBBBBBBBBBBBB
+   BGGGGGGGGGGGGGGGGGB
+   BG               GB
+   BG               GB
+   BG               GB
+   BG               GB
+   BGGGGGGGGGGGGGGGGGB
+   BBBBBBBBBBBBBBBBBBB
+*/
+
+static void DrawButtonFrame(HDC hdc, const RECT& rectBtn,
+                            bool selected, bool pushed)
+{
+    RECT r;
+    CopyRect(&r, &rectBtn);
+
+    HPEN hpenBlack   = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DDKSHADOW)),
+         hpenGrey    = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DSHADOW)),
+         hpenLightGr = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DLIGHT)),
+         hpenWhite   = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DHILIGHT));
+
+    HPEN hpenOld = (HPEN)SelectObject(hdc, hpenBlack);
+
+    r.right--;
+    r.bottom--;
+
+    if ( pushed )
+    {
+        DrawRect(hdc, r);
+
+        (void)SelectObject(hdc, hpenGrey);
+        InflateRect(&r, -1, -1);
+
+        DrawRect(hdc, r);
+    }
+    else // !pushed
+    {
+        if ( selected )
+        {
+            DrawRect(hdc, r);
+
+            InflateRect(&r, -1, -1);
+        }
+
+        MoveToEx(hdc, r.left, r.bottom, NULL);
+        LineTo(hdc, r.right, r.bottom);
+        LineTo(hdc, r.right, r.top - 1);

 
 

-  return (WXHBRUSH) backgroundBrush->GetResourceHandle();
+        (void)SelectObject(hdc, hpenWhite);
+        MoveToEx(hdc, r.left, r.bottom - 1, NULL);
+        LineTo(hdc, r.left, r.top);
+        LineTo(hdc, r.right, r.top);
+
+        (void)SelectObject(hdc, hpenLightGr);
+        MoveToEx(hdc, r.left + 1, r.bottom - 2, NULL);
+        LineTo(hdc, r.left + 1, r.top + 1);
+        LineTo(hdc, r.right - 1, r.top + 1);
+
+        (void)SelectObject(hdc, hpenGrey);
+        MoveToEx(hdc, r.left + 1, r.bottom - 1, NULL);
+        LineTo(hdc, r.right - 1, r.bottom - 1);
+        LineTo(hdc, r.right - 1, r.top);
+    }
+
+    (void)SelectObject(hdc, hpenOld);
+    DeleteObject(hpenWhite);
+    DeleteObject(hpenLightGr);
+    DeleteObject(hpenGrey);
+    DeleteObject(hpenBlack);

 }
 
 }
 

+bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT *wxdis)
+{
+    LPDRAWITEMSTRUCT lpDIS = (LPDRAWITEMSTRUCT)wxdis;
+
+    RECT rectBtn;
+    CopyRect(&rectBtn, &lpDIS->rcItem);
+
+    COLORREF colBg = wxColourToRGB(GetBackgroundColour()),
+             colFg = wxColourToRGB(GetForegroundColour());
+
+    HDC hdc = lpDIS->hDC;
+    UINT state = lpDIS->itemState;
+
+    // first, draw the background
+    HBRUSH hbrushBackground = ::CreateSolidBrush(colBg);
+
+    FillRect(hdc, &rectBtn, hbrushBackground);
+
+    // draw the border for the current state
+    bool selected = (state & ODS_SELECTED) != 0;
+    if ( !selected )
+    {
+        wxPanel *panel = wxDynamicCast(GetParent(), wxPanel);
+        if ( panel )
+        {
+            selected = panel->GetDefaultItem() == this;
+        }
+    }
+    bool pushed = (SendMessage(GetHwnd(), BM_GETSTATE, 0, 0) & BST_PUSHED) != 0;
+
+    DrawButtonFrame(hdc, rectBtn, selected, pushed);
+
+    // draw the focus rect if needed
+    if ( state & ODS_FOCUS )
+    {
+        RECT rectFocus;
+        CopyRect(&rectFocus, &rectBtn);
+
+        // I don't know where does this constant come from, but this is how
+        // Windows draws them
+        InflateRect(&rectFocus, -4, -4);
+
+        DrawFocusRect(hdc, &rectFocus);
+    }
+
+    if ( pushed )
+    {
+        // the label is shifted by 1 pixel to create "pushed" effect
+        OffsetRect(&rectBtn, 1, 1);
+    }
+
+    DrawButtonText(hdc, &rectBtn, GetLabel(),
+                   state & ODS_DISABLED ? GetSysColor(COLOR_GRAYTEXT)
+                                        : colFg);
+
+    ::DeleteObject(hbrushBackground);
+
+    return TRUE;
+}
+
+#endif // __WIN32__
+
+#endif // wxUSE_BUTTON
+