Disable wxUSE_ENH_METAFILE for wxGTK builds.

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

diff --git a/src/msw/checkbox.cpp b/src/msw/checkbox.cpp
index 15347befaa1b2e2cd17eeb1601b03fa66c514e73..6b8963443ab2f9eabbbf25f339c6696272a8df35 100644 (file)
--- a/src/msw/checkbox.cpp
+++ b/src/msw/checkbox.cpp
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

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

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


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "checkbox.h"
-#endif
-

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


@@ -30,37 +26,68 @@
 
 #if wxUSE_CHECKBOX
 
 
 #if wxUSE_CHECKBOX
 

+#include "wx/checkbox.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/checkbox.h"

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

+    #include "wx/dcclient.h"

     #include "wx/dcscreen.h"
     #include "wx/settings.h"
 #endif
 
     #include "wx/dcscreen.h"
     #include "wx/settings.h"
 #endif
 

-#include "wx/msw/private.h"
+#include "wx/msw/dc.h"          // for wxDCTemp
+#include "wx/renderer.h"
+#include "wx/msw/uxtheme.h"
+#include "wx/msw/private/button.h"
+#include "wx/msw/missing.h"

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

-// macros
+// constants

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

-IMPLEMENT_DYNAMIC_CLASS(wxCheckBox, wxControl)
-IMPLEMENT_DYNAMIC_CLASS(wxBitmapCheckBox, wxCheckBox)
+#ifndef BP_CHECKBOX
+    #define BP_CHECKBOX 3
+#endif
+
+// these values are defined in tmschema.h (except the first one)
+enum
+{
+    CBS_INVALID,
+    CBS_UNCHECKEDNORMAL,
+    CBS_UNCHECKEDHOT,
+    CBS_UNCHECKEDPRESSED,
+    CBS_UNCHECKEDDISABLED,
+    CBS_CHECKEDNORMAL,
+    CBS_CHECKEDHOT,
+    CBS_CHECKEDPRESSED,
+    CBS_CHECKEDDISABLED,
+    CBS_MIXEDNORMAL,
+    CBS_MIXEDHOT,
+    CBS_MIXEDPRESSED,
+    CBS_MIXEDDISABLED
+};
+
+// these are our own
+enum
+{
+    CBS_HOT_OFFSET = 1,
+    CBS_PRESSED_OFFSET = 2,
+    CBS_DISABLED_OFFSET = 3
+};

 
 // ============================================================================
 // implementation
 // ============================================================================
 
 // ----------------------------------------------------------------------------
 
 // ============================================================================
 // implementation
 // ============================================================================
 
 // ----------------------------------------------------------------------------

-// wxCheckBox
+// wxCheckBox creation

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

-bool wxCheckBox::MSWCommand(WXUINT WXUNUSED(param), WXWORD WXUNUSED(id))
+void wxCheckBox::Init()

 {
 {

-    wxCommandEvent event(wxEVT_COMMAND_CHECKBOX_CLICKED, m_windowId);
-    event.SetInt(GetValue());
-    event.SetEventObject(this);
-    ProcessCommand(event);
-    return TRUE;
+    m_state = wxCHK_UNCHECKED;
+    m_isPressed =
+    m_isHot = false;

 }
 
 bool wxCheckBox::Create(wxWindow *parent,
 }
 
 bool wxCheckBox::Create(wxWindow *parent,


@@ -71,22 +98,43 @@ bool wxCheckBox::Create(wxWindow *parent,
                         const wxValidator& validator,
                         const wxString& name)
 {
                         const wxValidator& validator,
                         const wxString& name)
 {

-    if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
-        return FALSE;
+    Init();

 
 

-    long msStyle = BS_AUTOCHECKBOX | WS_TABSTOP;
-    if ( style & wxALIGN_RIGHT )
-        msStyle |= BS_LEFTTEXT;
+    WXValidateStyle(&style);
+    if ( !CreateControl(parent, id, pos, size, style, validator, name) )
+        return false;
+
+    WXDWORD exstyle;
+    WXDWORD msStyle = MSWGetStyle(style, &exstyle);
+
+    msStyle |= wxMSWButton::GetMultilineStyle(label);

 
 

-    return MSWCreateControl(wxT("BUTTON"), msStyle, pos, size, label, 0);
+    return MSWCreateControl(wxT("BUTTON"), msStyle, pos, size, label, exstyle);

 }
 
 }
 

-void wxCheckBox::SetLabel(const wxString& label)
+WXDWORD wxCheckBox::MSWGetStyle(long style, WXDWORD *exstyle) const

 {
 {

-    SetWindowText(GetHwnd(), label);
+    // buttons never have an external border, they draw their own one
+    WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
+
+    if ( style & wxCHK_3STATE )
+        msStyle |= BS_3STATE;
+    else
+        msStyle |= BS_CHECKBOX;
+
+    if ( style & wxALIGN_RIGHT )
+    {
+        msStyle |= BS_LEFTTEXT | BS_RIGHT;
+    }
+
+    return msStyle;

 }
 
 }
 

-wxSize wxCheckBox::DoGetBestSize() const
+// ----------------------------------------------------------------------------
+// wxCheckBox geometry
+// ----------------------------------------------------------------------------
+
+wxSize wxCheckBox::DoGetBestClientSize() const

 {
     static int s_checkSize = 0;
 
 {
     static int s_checkSize = 0;
 


@@ -101,11 +149,26 @@ wxSize wxCheckBox::DoGetBestSize() const
     wxString str = wxGetWindowText(GetHWND());
 
     int wCheckbox, hCheckbox;
     wxString str = wxGetWindowText(GetHWND());
 
     int wCheckbox, hCheckbox;

-    if ( !str.IsEmpty() )
+    if ( !str.empty() )

     {
     {

-        GetTextExtent(str, &wCheckbox, &hCheckbox);
+        wxClientDC dc(const_cast<wxCheckBox *>(this));
+        dc.SetFont(GetFont());
+        dc.GetMultiLineTextExtent(GetLabelText(str), &wCheckbox, &hCheckbox);

         wCheckbox += s_checkSize + GetCharWidth();
 
         wCheckbox += s_checkSize + GetCharWidth();
 

+        if ( ::GetWindowLong(GetHwnd(), GWL_STYLE) & BS_MULTILINE )
+        {
+            // We need to make the checkbox even wider in this case because
+            // otherwise it wraps lines automatically and not only on "\n"s as
+            // we need and this makes the size computed here wrong resulting in
+            // checkbox contents being truncated when it's actually displayed.
+            // Without this hack simple checkbox with "Some thing\n and more"
+            // label appears on 3 lines, not 2, under Windows 2003 using
+            // classic look and feel (although it works fine under Windows 7,
+            // with or without themes).
+            wCheckbox += s_checkSize;
+        }
+

         if ( hCheckbox < s_checkSize )
             hCheckbox = s_checkSize;
     }
         if ( hCheckbox < s_checkSize )
             hCheckbox = s_checkSize;
     }


@@ -114,96 +177,327 @@ wxSize wxCheckBox::DoGetBestSize() const
         wCheckbox = s_checkSize;
         hCheckbox = s_checkSize;
     }
         wCheckbox = s_checkSize;
         hCheckbox = s_checkSize;
     }

+#ifdef __WXWINCE__
+    hCheckbox += 1;
+#endif

 
 

-    return wxSize(wCheckbox, hCheckbox);
+    wxSize best(wCheckbox, hCheckbox);
+    CacheBestSize(best);
+    return best;

 }
 
 }
 

-void wxCheckBox::SetValue(bool val)
+// ----------------------------------------------------------------------------
+// wxCheckBox operations
+// ----------------------------------------------------------------------------
+
+void wxCheckBox::SetLabel(const wxString& label)

 {
 {

-    SendMessage(GetHwnd(), BM_SETCHECK, val, 0);
+    wxMSWButton::UpdateMultilineStyle(GetHwnd(), label);
+
+    wxCheckBoxBase::SetLabel(label);

 }
 
 }
 

-#ifndef BST_CHECKED
-#define BST_CHECKED 0x0001
-#endif
+void wxCheckBox::SetValue(bool val)
+{
+    Set3StateValue(val ? wxCHK_CHECKED : wxCHK_UNCHECKED);
+}

 
 bool wxCheckBox::GetValue() const
 {
 
 bool wxCheckBox::GetValue() const
 {

-#ifdef __WIN32__
-  return (SendMessage(GetHwnd(), BM_GETCHECK, 0, 0) == BST_CHECKED);
-#else
-  return ((0x001 & SendMessage(GetHwnd(), BM_GETCHECK, 0, 0)) == 0x001);
-#endif
+    return Get3StateValue() != wxCHK_UNCHECKED;
+}
+
+void wxCheckBox::Command(wxCommandEvent& event)
+{
+    int state = event.GetInt();
+    wxCHECK_RET( (state == wxCHK_UNCHECKED) || (state == wxCHK_CHECKED)
+        || (state == wxCHK_UNDETERMINED),
+        wxT("event.GetInt() returned an invalid checkbox state") );
+
+    Set3StateValue((wxCheckBoxState) state);
+    ProcessCommand(event);
+}
+
+wxCOMPILE_TIME_ASSERT(wxCHK_UNCHECKED == BST_UNCHECKED
+    && wxCHK_CHECKED == BST_CHECKED
+    && wxCHK_UNDETERMINED == BST_INDETERMINATE, EnumValuesIncorrect);
+
+void wxCheckBox::DoSet3StateValue(wxCheckBoxState state)
+{
+    m_state = state;
+    if ( !IsOwnerDrawn() )
+        ::SendMessage(GetHwnd(), BM_SETCHECK, (WPARAM) state, 0);
+    else // owner drawn buttons don't react to this message
+        Refresh();
+}
+
+wxCheckBoxState wxCheckBox::DoGet3StateValue() const
+{
+    return m_state;

 }
 
 }
 

-void wxCheckBox::Command (wxCommandEvent & event)
+bool wxCheckBox::MSWCommand(WXUINT cmd, WXWORD WXUNUSED(id))

 {
 {

-  SetValue ((event.GetInt() != 0));
-  ProcessCommand (event);
+    if ( cmd != BN_CLICKED && cmd != BN_DBLCLK )
+        return false;
+
+    // first update the value so that user event handler gets the new checkbox
+    // value
+
+    // ownerdrawn buttons don't manage their state themselves unlike usual
+    // auto checkboxes so do it ourselves in any case
+    wxCheckBoxState state;
+    if ( Is3rdStateAllowedForUser() )
+    {
+        state = (wxCheckBoxState)((m_state + 1) % 3);
+    }
+    else // 2 state checkbox (at least from users point of view)
+    {
+        // note that wxCHK_UNDETERMINED also becomes unchecked when clicked
+        state = m_state == wxCHK_UNCHECKED ? wxCHK_CHECKED : wxCHK_UNCHECKED;
+    }
+
+    DoSet3StateValue(state);
+
+
+    // generate the event
+    wxCommandEvent event(wxEVT_CHECKBOX, m_windowId);
+
+    event.SetInt(state);
+    event.SetEventObject(this);
+    ProcessCommand(event);
+
+    return true;

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

-// wxBitmapCheckBox
+// owner drawn checkboxes stuff

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

-bool wxBitmapCheckBox::Create(wxWindow *parent, wxWindowID id, const wxBitmap *WXUNUSED(label),
-           const wxPoint& pos,
-           const wxSize& size, long style,
-           const wxValidator& validator,
-           const wxString& name)
-{
-  SetName(name);
-#if wxUSE_VALIDATORS
-  SetValidator(validator);
-#endif // wxUSE_VALIDATORS
-  if (parent) parent->AddChild(this);
-
-  SetBackgroundColour(parent->GetBackgroundColour()) ;
-  SetForegroundColour(parent->GetForegroundColour()) ;
-  m_windowStyle = style;
-
-  if ( id == -1 )
-      m_windowId = NewControlId();
-  else
-      m_windowId = id;
-
-  int x = pos.x;
-  int y = pos.y;
-  int width = size.x;
-  int height = size.y;
-
-  checkWidth = -1 ;
-  checkHeight = -1 ;
-  long msStyle = CHECK_FLAGS;
-
-  HWND wx_button = CreateWindowEx(MakeExtendedStyle(m_windowStyle), CHECK_CLASS, wxT("toggle"),
-                    msStyle,
-                    0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId,
-                    wxGetInstance(), NULL);
-
-#if wxUSE_CTL3D
-  if (!(GetParent()->GetWindowStyleFlag() & wxUSER_COLOURS))
-  {
-    Ctl3dSubclassCtl(wx_button);
-    m_useCtl3D = TRUE;
-  }
-#endif
+bool wxCheckBox::SetForegroundColour(const wxColour& colour)
+{
+    if ( !wxCheckBoxBase::SetForegroundColour(colour) )
+        return false;
+
+    // the only way to change the checkbox foreground colour under Windows XP
+    // is to owner draw it
+    if ( wxUxThemeEngine::GetIfActive() )
+        MSWMakeOwnerDrawn(colour.IsOk());
+
+    return true;
+}
+
+bool wxCheckBox::IsOwnerDrawn() const
+{
+    return
+        (::GetWindowLong(GetHwnd(), GWL_STYLE) & BS_OWNERDRAW) == BS_OWNERDRAW;
+}
+
+void wxCheckBox::MSWMakeOwnerDrawn(bool ownerDrawn)
+{
+    long style = ::GetWindowLong(GetHwnd(), GWL_STYLE);
+
+    // note that BS_CHECKBOX & BS_OWNERDRAW != 0 so we can't operate on
+    // them as on independent style bits
+    if ( ownerDrawn )
+    {
+        style &= ~(BS_CHECKBOX | BS_3STATE);
+        style |= BS_OWNERDRAW;
+
+        Connect(wxEVT_ENTER_WINDOW,
+                wxMouseEventHandler(wxCheckBox::OnMouseEnterOrLeave));
+        Connect(wxEVT_LEAVE_WINDOW,
+                wxMouseEventHandler(wxCheckBox::OnMouseEnterOrLeave));
+        Connect(wxEVT_LEFT_DOWN, wxMouseEventHandler(wxCheckBox::OnMouseLeft));
+        Connect(wxEVT_LEFT_UP, wxMouseEventHandler(wxCheckBox::OnMouseLeft));
+        Connect(wxEVT_SET_FOCUS, wxFocusEventHandler(wxCheckBox::OnFocus));
+        Connect(wxEVT_KILL_FOCUS, wxFocusEventHandler(wxCheckBox::OnFocus));
+    }
+    else // reset to default colour
+    {
+        style &= ~BS_OWNERDRAW;
+        style |= HasFlag(wxCHK_3STATE) ? BS_3STATE : BS_CHECKBOX;
+
+        Disconnect(wxEVT_ENTER_WINDOW,
+                   wxMouseEventHandler(wxCheckBox::OnMouseEnterOrLeave));
+        Disconnect(wxEVT_LEAVE_WINDOW,
+                   wxMouseEventHandler(wxCheckBox::OnMouseEnterOrLeave));
+        Disconnect(wxEVT_LEFT_DOWN, wxMouseEventHandler(wxCheckBox::OnMouseLeft));
+        Disconnect(wxEVT_LEFT_UP, wxMouseEventHandler(wxCheckBox::OnMouseLeft));
+        Disconnect(wxEVT_SET_FOCUS, wxFocusEventHandler(wxCheckBox::OnFocus));
+        Disconnect(wxEVT_KILL_FOCUS, wxFocusEventHandler(wxCheckBox::OnFocus));
+    }

 
 

-  m_hWnd = (WXHWND)wx_button;
+    ::SetWindowLong(GetHwnd(), GWL_STYLE, style);

 
 

-  // Subclass again for purposes of dialog editing mode
-  SubclassWin((WXHWND)wx_button);
+    if ( !ownerDrawn )
+    {
+        // ensure that controls state is consistent with internal state
+        DoSet3StateValue(m_state);
+    }
+}
+
+void wxCheckBox::OnMouseEnterOrLeave(wxMouseEvent& event)
+{
+    m_isHot = event.GetEventType() == wxEVT_ENTER_WINDOW;
+    if ( !m_isHot )
+        m_isPressed = false;
+
+    Refresh();

 
 

-  SetSize(x, y, width, height);
+    event.Skip();
+}

 
 

-  ShowWindow(wx_button, SW_SHOW);
+void wxCheckBox::OnMouseLeft(wxMouseEvent& event)
+{
+    // TODO: we should capture the mouse here to be notified about left up
+    //       event but this interferes with BN_CLICKED generation so if we
+    //       want to do this we'd need to generate them ourselves
+    m_isPressed = event.GetEventType() == wxEVT_LEFT_DOWN;
+    Refresh();

 
 

-  return TRUE;
+    event.Skip();

 }
 
 }
 

-void wxBitmapCheckBox::SetLabel(const wxBitmap& WXUNUSED(bitmap))
+void wxCheckBox::OnFocus(wxFocusEvent& event)

 {
 {

-    wxFAIL_MSG(wxT("not implemented"));
+    Refresh();
+
+    event.Skip();
+}
+
+bool wxCheckBox::MSWOnDraw(WXDRAWITEMSTRUCT *item)
+{
+    DRAWITEMSTRUCT *dis = (DRAWITEMSTRUCT *)item;
+
+    if ( !IsOwnerDrawn() || dis->CtlType != ODT_BUTTON )
+        return wxCheckBoxBase::MSWOnDraw(item);
+
+    // calculate the rectangles for the check mark itself and the label
+    HDC hdc = dis->hDC;
+    RECT& rect = dis->rcItem;
+    RECT rectCheck,
+         rectLabel;
+    rectLabel.top = rect.top + (rect.bottom - rect.top - GetBestSize().y) / 2;
+    rectLabel.bottom = rectLabel.top + GetBestSize().y;
+    const int MARGIN = 3;
+    const int CXMENUCHECK = ::GetSystemMetrics(SM_CXMENUCHECK);
+    // the space between the checkbox and the label is included in the
+    // check-mark bitmap
+    const int checkSize = wxMin(CXMENUCHECK - MARGIN, GetSize().y);
+    rectCheck.top = rect.top + (rect.bottom - rect.top - checkSize) / 2;
+    rectCheck.bottom = rectCheck.top + checkSize;
+
+    const bool isRightAligned = HasFlag(wxALIGN_RIGHT);
+    if ( isRightAligned )
+    {
+        rectLabel.right = rect.right - CXMENUCHECK;
+        rectLabel.left = rect.left;
+
+        rectCheck.left = rectLabel.right + ( CXMENUCHECK + MARGIN - checkSize ) / 2;
+        rectCheck.right = rectCheck.left + checkSize;
+    }
+    else // normal, left-aligned checkbox
+    {
+        rectCheck.left = rect.left + ( CXMENUCHECK - MARGIN - checkSize ) / 2;
+        rectCheck.right = rectCheck.left + checkSize;
+
+        rectLabel.left = rect.left + CXMENUCHECK;
+        rectLabel.right = rect.right;
+    }
+
+    // shall we draw a focus rect?
+    const bool isFocused = m_isPressed || FindFocus() == this;
+
+
+    // draw the checkbox itself
+    wxDCTemp dc(hdc);
+
+    int flags = 0;
+    if ( !IsEnabled() )
+        flags |= wxCONTROL_DISABLED;
+    switch ( Get3StateValue() )
+    {
+        case wxCHK_CHECKED:
+            flags |= wxCONTROL_CHECKED;
+            break;
+
+        case wxCHK_UNDETERMINED:
+            flags |= wxCONTROL_PRESSED;
+            break;
+
+        default:
+            wxFAIL_MSG( wxT("unexpected Get3StateValue() return value") );
+            // fall through
+
+        case wxCHK_UNCHECKED:
+            // no extra styles needed
+            break;
+    }
+
+    if ( wxFindWindowAtPoint(wxGetMousePosition()) == this )
+        flags |= wxCONTROL_CURRENT;
+
+    wxRendererNative::Get().
+        DrawCheckBox(this, dc, wxRectFromRECT(rectCheck), flags);
+
+    // draw the text
+    const wxString& label = GetLabel();
+
+    // first we need to measure it
+    UINT fmt = DT_NOCLIP;
+
+    // drawing underlying doesn't look well with focus rect (and the native
+    // control doesn't do it)
+    if ( isFocused )
+        fmt |= DT_HIDEPREFIX;
+    if ( isRightAligned )
+        fmt |= DT_RIGHT;
+    // TODO: also use DT_HIDEPREFIX if the system is configured so
+
+    // we need to get the label real size first if we have to draw a focus rect
+    // around it
+    if ( isFocused )
+    {
+        RECT oldLabelRect = rectLabel; // needed if right aligned
+
+        if ( !::DrawText(hdc, label.t_str(), label.length(), &rectLabel,
+                         fmt | DT_CALCRECT) )
+        {
+            wxLogLastError(wxT("DrawText(DT_CALCRECT)"));
+        }
+
+        if ( isRightAligned )
+        {
+            // move the label rect to the right
+            const int labelWidth = rectLabel.right - rectLabel.left;
+            rectLabel.right = oldLabelRect.right;
+            rectLabel.left = rectLabel.right - labelWidth;
+        }
+    }
+
+    if ( !IsEnabled() )
+    {
+        ::SetTextColor(hdc, ::GetSysColor(COLOR_GRAYTEXT));
+    }
+
+    if ( !::DrawText(hdc, label.t_str(), label.length(), &rectLabel, fmt) )
+    {
+        wxLogLastError(wxT("DrawText()"));
+    }
+
+    // finally draw the focus
+    if ( isFocused )
+    {
+        rectLabel.left--;
+        rectLabel.right++;
+        if ( !::DrawFocusRect(hdc, &rectLabel) )
+        {
+            wxLogLastError(wxT("DrawFocusRect()"));
+        }
+    }
+
+    return true;

 }
 
 #endif // wxUSE_CHECKBOX
 }
 
 #endif // wxUSE_CHECKBOX