Further fixes to references

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

diff --git a/src/msw/button.cpp b/src/msw/button.cpp
index 380af241267b2314f62fa918717f69f383329f9a..5cb83273d77c78e44c53b521f4dd2967a1751951 100644 (file)
--- a/src/msw/button.cpp
+++ b/src/msw/button.cpp
@@ -1,197 +1,506 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxButton
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Purpose:     wxButton
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows license
+// Licence:     wxWindows license

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

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 #ifdef __GNUG__
 #ifdef __GNUG__

-#pragma implementation "button.h"
+    #pragma implementation "button.h"

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

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_BUTTON
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-#include "wx/button.h"
+    #include "wx/button.h"
+    #include "wx/brush.h"
+    #include "wx/panel.h"
+    #include "wx/bmpbuttn.h"
+    #include "wx/settings.h"
+    #include "wx/dcscreen.h"

 #endif
 
 #include "wx/msw/private.h"
 
 #endif
 
 #include "wx/msw/private.h"
 

-#if !USE_SHARED_LIBRARY
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
+

 IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)
 IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)

-#endif

 
 

-#define BUTTON_HEIGHT_FACTOR (EDIT_CONTROL_FACTOR * 1.1)
+// 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)
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// creation/destruction
+// ----------------------------------------------------------------------------
+
+bool wxButton::Create(wxWindow *parent,
+                      wxWindowID id,
+                      const wxString& label,
+                      const wxPoint& pos,
+                      const wxSize& size,
+                      long style,
+                      const wxValidator& validator,
+                      const wxString& name)
+{
+    if ( !CreateControl(parent, id, pos, size, style, validator, name) )
+        return FALSE;

 
 

-// Buttons
+    return MSWCreateControl(_T("BUTTON"), label, pos, size, style);
+}

 
 

-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;

 }
 
 }
 

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

 
 

-  parent->AddChild((wxButton *)this);
-  m_backgroundColour = parent->GetDefaultBackgroundColour() ;
-  m_foregroundColour = parent->GetDefaultForegroundColour() ;
+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;
+}

 
 

-  m_windowStyle = (long&)style;
+// ----------------------------------------------------------------------------
+// size management including autosizing
+// ----------------------------------------------------------------------------

 
 

-  int x = pos.x;
-  int y = pos.y;
-  int width = size.x;
-  int height = size.y;
+wxSize wxButton::DoGetBestSize() const
+{
+    wxString label = wxGetWindowText(GetHWND());
+    int wBtn;
+    GetTextExtent(label, &wBtn, NULL);

 
 

-  if (id == -1)
-    m_windowId = NewControlId();
-  else
-    m_windowId = id;
+    int wChar, hChar;
+    wxGetCharSize(GetHWND(), &wChar, &hChar, &GetFont());

 
 

-  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);
+    // add a margin - the button is wider than just its label
+    wBtn += 3*wChar;

 
 

-#if CTL3D
-//  if (!(GetParent()->GetWindowStyleFlag() & wxUSER_COLOURS))
-//    Ctl3dSubclassCtl(wx_button);
-#endif
+    // the button height is proportional to the height of the font used
+    int hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar);

 
 

-  m_hWnd = (WXHWND)wx_button;
+    wxSize sz = GetDefaultSize();
+    if (wBtn > sz.x) sz.x = wBtn;
+    if (hBtn > sz.y) sz.y = hBtn;

 
 

-  // Subclass again for purposes of dialog editing mode
-  SubclassWin((WXHWND)wx_button);
+    return sz;
+}

 
 

-  SetFont(* parent->GetFont());
+/* 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
+        // 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;
+    }
+
+    return s_sizeBtn;
+}

 
 

-  SetSize(x, y, width, height);
-  ShowWindow(wx_button, SW_SHOW);
+// ----------------------------------------------------------------------------
+// set this button as the default one in its panel
+// ----------------------------------------------------------------------------

 
 

-  return TRUE;
+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?
+    {
+        btnOldDefault = NULL;
+    }
+
+    if ( btnOldDefault && btnOldDefault != this )
+    {
+        // 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)!
+        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);
+    if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
+    {
+        style |= BS_DEFPUSHBUTTON;
+        SendMessage(GetHwnd(), BM_SETSTYLE, style, 1L);
+    }

 }
 
 }
 

-void wxButton::SetSize(int x, int y, int width, int height, int sizeFlags)
+// ----------------------------------------------------------------------------
+// helpers
+// ----------------------------------------------------------------------------
+
+bool wxButton::SendClickEvent()

 {
 {

-  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;
+    wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetId());
+    event.SetEventObject(this);

 
 

-  AdjustForParentClientOrigin(x1, y1, sizeFlags);
+    return ProcessCommand(event);
+}

 
 

-  int actualWidth = width;
-  int actualHeight = height;
-  int ww, hh;
-  GetSize(&ww, &hh);
+void wxButton::Command(wxCommandEvent & event)
+{
+    ProcessCommand(event);
+}

 
 

-  int current_width;
-  int cyf;
-  char buf[300];
-  GetWindowText((HWND) GetHWND(), buf, 300);
-  GetTextExtent(buf, &current_width, &cyf,NULL,NULL,GetFont());
+// ----------------------------------------------------------------------------
+// event/message handlers
+// ----------------------------------------------------------------------------

 
 

-  // 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,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 = (int)(cyf*BUTTON_HEIGHT_FACTOR) ;
-  }
+bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
+{
+    bool processed = FALSE;
+    switch ( param )
+    {
+        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;
+    }
+
+    return processed;
+}

 
 

-  MoveWindow((HWND) GetHWND(), x1, y1, actualWidth, actualHeight, TRUE);
+long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+{
+    // when we receive focus, we want to become the default button in our
+    // parent panel
+    if ( nMsg == WM_SETFOCUS )
+    {
+        SetDefault();
+
+        // let the default processign take place too
+    }
+    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 conitnue with processing the message normally as well
+    }
+
+    // let the base class do all real processing
+    return wxControl::MSWWindowProc(nMsg, wParam, lParam);

 }
 
 }
 

-void wxButton::SetDefault(void)
+// ----------------------------------------------------------------------------
+// owner-drawn buttons support
+// ----------------------------------------------------------------------------
+
+#ifdef __WIN32__
+
+// drawing helpers
+
+static void DrawButtonText(HDC hdc,
+                           RECT *pRect,
+                           const wxString& text,
+                           COLORREF col)

 {
 {

-  wxWindow *parent = (wxWindow *)GetParent();
-  if (parent)
-    parent->SetDefaultItem(this);
+    COLORREF colOld = SetTextColor(hdc, col);
+    int modeOld = SetBkMode(hdc, TRANSPARENT);
+
+    DrawText(hdc, text, text.length(), pRect,
+             DT_CENTER | DT_VCENTER | DT_SINGLELINE);

 
 

-  if (parent)
-  {
-    SendMessage((HWND) parent->GetHWND(), DM_SETDEFID, m_windowId, 0L);
-  }
+    SetBkMode(hdc, modeOld);
+    SetTextColor(hdc, colOld);

 }
 
 }
 

-wxString wxButton::GetLabel(void) const
+static void DrawRect(HDC hdc, const RECT& r)

 {
 {

-    GetWindowText((HWND) GetHWND(), wxBuffer, 300);
-    return wxString(wxBuffer);
+    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::SetLabel(const wxString& label)
+void wxButton::MakeOwnerDrawn()

 {
 {

-  SetWindowText((HWND) GetHWND(), (const char *) label);
+    long style = GetWindowLong(GetHwnd(), GWL_STYLE);
+    if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
+    {
+        // make it so
+        style |= BS_OWNERDRAW;
+        SetWindowLong(GetHwnd(), GWL_STYLE, style);
+    }

 }
 
 }
 

-WXHBRUSH wxButton::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-                       WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
+bool wxButton::SetBackgroundColour(const wxColour &colour)

 {
 {

-/*
-    WXHBRUSH hBrush = (WXHBRUSH) MSWDefWindowProc(message, wParam, lParam);
-//    ::SetTextColor((HDC) pDC, GetSysColor(COLOR_BTNTEXT));
-    ::SetTextColor((HDC) pDC, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(),
-        GetForegroundColour().Blue()));
+    if ( !wxControl::SetBackgroundColour(colour) )
+    {
+        // nothing to do
+        return FALSE;
+    }

 
 

-       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()));
+    MakeOwnerDrawn();
+
+    Refresh();
+
+    return TRUE;
+}
+
+bool wxButton::SetForegroundColour(const wxColour &colour)
+{
+    if ( !wxControl::SetForegroundColour(colour) )
+    {
+        // nothing to do
+        return FALSE;
+    }

 
 

-  wxBrush *backgroundBrush = wxTheBrushList->FindOrCreateBrush(GetBackgroundColour(), wxSOLID);
+    MakeOwnerDrawn();

 
 

-  // 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();
+    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);
+
+        (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);

 }
 
 }
 

-void wxButton::Command (wxCommandEvent & event)
+bool wxButton::MSWOnDraw(WXDRAWITEMSTRUCT *wxdis)

 {
 {

-  ProcessCommand (event);
+    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