]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/button.cpp
extended wxWindow::MSWGetBgBrush() and wxControl::MSWControlColor() to work for arbit...
[wxWidgets.git] / src / msw / button.cpp
index 172cf7de5b5e0e0249db6a8abffeeabbe3d8606e..b50d0c6bd88b9339ea7215f6be9a2c7cd99422bd 100644 (file)
@@ -5,8 +5,8 @@
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma implementation "button.h"
 #endif
 
@@ -31,6 +31,7 @@
 #if wxUSE_BUTTON
 
 #ifndef WX_PRECOMP
+    #include "wx/app.h"
     #include "wx/button.h"
     #include "wx/brush.h"
     #include "wx/panel.h"
     #include "wx/dcscreen.h"
 #endif
 
+#include "wx/stockitem.h"
+#include "wx/tokenzr.h"
 #include "wx/msw/private.h"
 
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 
+#if wxUSE_EXTENDED_RTTI
+
+WX_DEFINE_FLAGS( wxButtonStyle )
+
+wxBEGIN_FLAGS( wxButtonStyle )
+    // new style border flags, we put them first to
+    // use them for streaming out
+    wxFLAGS_MEMBER(wxBORDER_SIMPLE)
+    wxFLAGS_MEMBER(wxBORDER_SUNKEN)
+    wxFLAGS_MEMBER(wxBORDER_DOUBLE)
+    wxFLAGS_MEMBER(wxBORDER_RAISED)
+    wxFLAGS_MEMBER(wxBORDER_STATIC)
+    wxFLAGS_MEMBER(wxBORDER_NONE)
+
+    // old style border flags
+    wxFLAGS_MEMBER(wxSIMPLE_BORDER)
+    wxFLAGS_MEMBER(wxSUNKEN_BORDER)
+    wxFLAGS_MEMBER(wxDOUBLE_BORDER)
+    wxFLAGS_MEMBER(wxRAISED_BORDER)
+    wxFLAGS_MEMBER(wxSTATIC_BORDER)
+    wxFLAGS_MEMBER(wxBORDER)
+
+    // standard window styles
+    wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
+    wxFLAGS_MEMBER(wxCLIP_CHILDREN)
+    wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
+    wxFLAGS_MEMBER(wxWANTS_CHARS)
+    wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
+    wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
+    wxFLAGS_MEMBER(wxVSCROLL)
+    wxFLAGS_MEMBER(wxHSCROLL)
+
+    wxFLAGS_MEMBER(wxBU_LEFT)
+    wxFLAGS_MEMBER(wxBU_RIGHT)
+    wxFLAGS_MEMBER(wxBU_TOP)
+    wxFLAGS_MEMBER(wxBU_BOTTOM)
+    wxFLAGS_MEMBER(wxBU_EXACTFIT)
+wxEND_FLAGS( wxButtonStyle )
+
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxButton, wxControl,"wx/button.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxButton)
+    wxEVENT_PROPERTY( Click , wxEVT_COMMAND_BUTTON_CLICKED , wxCommandEvent)
+
+    wxPROPERTY( Font , wxFont , SetFont , GetFont  , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+    wxPROPERTY( Label, wxString , SetLabel, GetLabel, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+
+    wxPROPERTY_FLAGS( WindowStyle , wxButtonStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxButton)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_6( wxButton , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle  )
+
+
+#else
 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
@@ -61,15 +123,30 @@ IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)
 
 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)
 {
+    wxString label(lbl);
+    if (label.empty() && wxIsStockID(id))
+    {
+        // On Windows, some buttons aren't supposed to have
+        // mnemonics, so strip them out.
+        
+        label = wxGetStockLabel(id 
+#if defined(__WXMSW__) || defined(__WXWINCE__)
+                                        , ( id != wxID_OK &&
+                                            id != wxID_CANCEL &&
+                                            id != wxID_CLOSE )
+#endif
+                                );
+     }
+    
     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
-        return FALSE;
+        return false;
 
     WXDWORD exstyle;
     WXDWORD msStyle = MSWGetStyle(style, &exstyle);
@@ -123,6 +200,11 @@ WXDWORD wxButton::MSWGetStyle(long style, WXDWORD *exstyle) const
         msStyle |= BS_TOP;
     if ( style & wxBU_BOTTOM )
         msStyle |= BS_BOTTOM;
+#ifndef __WXWINCE__
+    // flat 2d buttons
+    if ( style & wxNO_BORDER )
+        msStyle |= BS_FLAT;
+#endif // __WXWINCE__
 #endif // __WIN32__
 
     return msStyle;
@@ -134,29 +216,32 @@ WXDWORD wxButton::MSWGetStyle(long style, WXDWORD *exstyle) const
 
 wxSize wxButton::DoGetBestSize() const
 {
-    wxString label = wxGetWindowText(GetHWND());
-    int wBtn;
-    GetTextExtent(label, &wBtn, NULL);
-
-    int wChar, hChar;
-    wxGetCharSize(GetHWND(), &wChar, &hChar, &GetFont());
+    wxClientDC dc(wx_const_cast(wxButton *, this));
+    dc.SetFont(GetFont());
 
-    // add a margin - the button is wider than just its label
-    wBtn += 3*wChar;
+    wxCoord wBtn,
+            hBtn;
+    dc.GetMultiLineTextExtent(GetLabel(), &wBtn, &hBtn);
 
-    // the button height is proportional to the height of the font used
-    int hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar);
+    // add a margin -- the button is wider than just its label
+    wBtn += 3*GetCharWidth();
+    hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hBtn);
 
-    if (!HasFlag(wxBU_EXACTFIT))
+    // 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;
+        if (wBtn > sz.x)
+            sz.x = wBtn;
+        if (hBtn > sz.y)
+            sz.y = hBtn;
+
         return sz;
     }
-    else
-        return wxSize(wBtn, hBtn);
 
+    return wxSize(wBtn, hBtn);
 }
 
 /* static */
@@ -197,7 +282,9 @@ wxSize wxButtonBase::GetDefaultSize()
    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 (!).
+   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
@@ -211,9 +298,13 @@ wxSize wxButtonBase::GetDefaultSize()
    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.
+   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
@@ -223,13 +314,15 @@ void wxButton::SetDefault()
 
     wxCHECK_RET( parent, _T("button without parent?") );
 
-    // set this one as the default button both for wxWindows and Windows
+    // set this one as the default button both for wxWidgets ...
     wxWindow *winOldDefault = parent->SetDefaultItem(this);
-    ::SendMessage(GetWinHwnd(parent), DM_SETDEFID, m_windowId, 0L);
 
-    UpdateDefaultStyle(this, winOldDefault);
+    // ... and Windows
+    SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), false);
+    SetDefaultStyle(this, true);
 }
 
+// set this button as being currently default
 void wxButton::SetTmpDefault()
 {
     wxWindow *parent = GetParent();
@@ -238,13 +331,12 @@ void wxButton::SetTmpDefault()
 
     wxWindow *winOldDefault = parent->GetDefaultItem();
     parent->SetTmpDefaultItem(this);
-    if ( winOldDefault != this )
-    {
-        UpdateDefaultStyle(this, winOldDefault);
-    }
-    //else: no styles to update
+
+    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();
@@ -254,54 +346,64 @@ void wxButton::UnsetTmpDefault()
     parent->SetTmpDefaultItem(NULL);
 
     wxWindow *winOldDefault = parent->GetDefaultItem();
-    if ( winOldDefault != this )
-    {
-        UpdateDefaultStyle(winOldDefault, this);
-    }
-    //else: we had been default before anyhow
+
+    SetDefaultStyle(this, false);
+    SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), true);
 }
 
 /* static */
 void
-wxButton::UpdateDefaultStyle(wxWindow *winDefault, wxWindow *winOldDefault)
+wxButton::SetDefaultStyle(wxButton *btn, bool on)
 {
-    // clear the BS_DEFPUSHBUTTON for the old default button
-    wxButton *btnOldDefault = wxDynamicCast(winOldDefault, wxButton);
-    if ( btnOldDefault && btnOldDefault != winDefault )
+    // 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 )
     {
-        // remove the BS_DEFPUSHBUTTON style from the other button
-        long style = ::GetWindowLong(GetHwndOf(btnOldDefault), GWL_STYLE);
+        // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
+        // focus at all any more
+        if ( !wxTheApp->IsActive() )
+            return;
 
-        // 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
+        // look for a panel-like window
+        wxWindow *win = btn->GetParent();
+        while ( win && !win->HasFlag(wxTAB_TRAVERSAL) )
+            win = win->GetParent();
+
+        if ( win )
         {
-            // redraw the button - it will notice itself that it's not the
-            // default one any longer
-            btnOldDefault->Refresh();
+            ::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
         }
     }
 
-    // and set BS_DEFPUSHBUTTON for this button
-    wxButton *btnDefault = wxDynamicCast(winDefault, wxButton);
-    if ( btnDefault )
+    // then also change the style as needed
+    long style = ::GetWindowLong(GetHwndOf(btn), GWL_STYLE);
+    if ( !(style & BS_DEFPUSHBUTTON) == on )
     {
-        long style = ::GetWindowLong(GetHwndOf(btnDefault), GWL_STYLE);
+        // 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 )
         {
-            style |= BS_DEFPUSHBUTTON;
-            ::SendMessage(GetHwndOf(btnDefault), BM_SETSTYLE, style, 1L);
+            ::SendMessage(GetHwndOf(btn), BM_SETSTYLE,
+                          on ? style | BS_DEFPUSHBUTTON
+                             : style & ~BS_DEFPUSHBUTTON,
+                          1L /* redraw */);
         }
-        else
+        else // owner drawn
         {
-            btnDefault->Refresh();
+            // redraw the button - it will notice itself that it's
+            // [not] the default one [any longer]
+            btn->Refresh();
         }
     }
+    //else: already has correct style
 }
 
 // ----------------------------------------------------------------------------
@@ -327,12 +429,21 @@ void wxButton::Command(wxCommandEvent & event)
 
 bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 {
-    bool processed = FALSE;
+    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
-        case BN_DOUBLECLICKED:      // owner-drawn ones also send this
             processed = SendClickEvent();
             break;
     }
@@ -340,9 +451,9 @@ bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
     return processed;
 }
 
-long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+WXLRESULT wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {
-    // when we receive focus, we want to temporary become the default button in
+    // 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 )
@@ -384,8 +495,8 @@ static void DrawButtonText(HDC hdc,
     COLORREF colOld = SetTextColor(hdc, col);
     int modeOld = SetBkMode(hdc, TRANSPARENT);
 
-    DrawText(hdc, text, text.length(), pRect,
-             DT_CENTER | DT_VCENTER | DT_SINGLELINE);
+    // Note: we must have DT_SINGLELINE for DT_VCENTER to work.
+    ::DrawText(hdc, text, text.length(), pRect, DT_SINGLELINE | DT_CENTER | DT_VCENTER);
 
     SetBkMode(hdc, modeOld);
     SetTextColor(hdc, colOld);
@@ -393,11 +504,10 @@ static void DrawButtonText(HDC hdc,
 
 static void DrawRect(HDC hdc, const RECT& r)
 {
-    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);
+    wxDrawLine(hdc, r.left, r.top, r.right, r.top);
+    wxDrawLine(hdc, r.right, r.top, r.right, r.bottom);
+    wxDrawLine(hdc, r.right, r.bottom, r.left, r.bottom);
+    wxDrawLine(hdc, r.left, r.bottom, r.left, r.top);
 }
 
 void wxButton::MakeOwnerDrawn()
@@ -416,14 +526,14 @@ bool wxButton::SetBackgroundColour(const wxColour &colour)
     if ( !wxControl::SetBackgroundColour(colour) )
     {
         // nothing to do
-        return FALSE;
+        return false;
     }
 
     MakeOwnerDrawn();
 
     Refresh();
 
-    return TRUE;
+    return true;
 }
 
 bool wxButton::SetForegroundColour(const wxColour &colour)
@@ -431,14 +541,14 @@ bool wxButton::SetForegroundColour(const wxColour &colour)
     if ( !wxControl::SetForegroundColour(colour) )
     {
         // nothing to do
-        return FALSE;
+        return false;
     }
 
     MakeOwnerDrawn();
 
     Refresh();
 
-    return TRUE;
+    return true;
 }
 
 /*
@@ -498,7 +608,7 @@ static void DrawButtonFrame(HDC hdc, const RECT& rectBtn,
         DrawRect(hdc, r);
 
         (void)SelectObject(hdc, hpenGrey);
-        InflateRect(&r, -1, -1);
+        ::InflateRect(&r, -1, -1);
 
         DrawRect(hdc, r);
     }
@@ -508,27 +618,23 @@ static void DrawButtonFrame(HDC hdc, const RECT& rectBtn,
         {
             DrawRect(hdc, r);
 
-            InflateRect(&r, -1, -1);
+            ::InflateRect(&r, -1, -1);
         }
 
-        MoveToEx(hdc, r.left, r.bottom, NULL);
-        LineTo(hdc, r.right, r.bottom);
-        LineTo(hdc, r.right, r.top - 1);
+        wxDrawLine(hdc, r.left, r.bottom, r.right, r.bottom);
+        wxDrawLine(hdc, r.right, r.bottom, r.right, r.top - 1);
 
         (void)SelectObject(hdc, hpenWhite);
-        MoveToEx(hdc, r.left, r.bottom - 1, NULL);
-        LineTo(hdc, r.left, r.top);
-        LineTo(hdc, r.right, r.top);
+        wxDrawLine(hdc, r.left, r.bottom - 1, r.left, r.top);
+        wxDrawLine(hdc, r.left, r.top, 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);
+        wxDrawLine(hdc, r.left + 1, r.bottom - 2, r.left + 1, r.top + 1);
+        wxDrawLine(hdc, r.left + 1, r.top + 1, 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);
+        wxDrawLine(hdc, r.left + 1, r.bottom - 1, r.right - 1, r.bottom - 1);
+        wxDrawLine(hdc, r.right - 1, r.bottom - 1, r.right - 1, r.top);
     }
 
     (void)SelectObject(hdc, hpenOld);
@@ -595,7 +701,7 @@ bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT *wxdis)
 
     ::DeleteObject(hbrushBackground);
 
-    return TRUE;
+    return true;
 }
 
 #endif // __WIN32__