handle correctly never/always shown scrollbars in GetClientSize()

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

diff --git a/src/msw/control.cpp b/src/msw/control.cpp
index df2d8b11095b5a7d491ca688c8593dfa1922379d..745e9bd2a66cbd4aec8744dd4dfe17fd84690170 100644 (file)
--- a/src/msw/control.cpp
+++ b/src/msw/control.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxControl class
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxControl class
 // Author:      Julian Smart
 // Modified by:


@@ -9,9 +9,13 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "control.h"
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

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


@@ -22,37 +26,51 @@
 
 #if wxUSE_CONTROLS
 
 
 #if wxUSE_CONTROLS
 

+#include "wx/control.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

+    #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"

     #include "wx/event.h"
     #include "wx/app.h"
     #include "wx/dcclient.h"
     #include "wx/log.h"
     #include "wx/event.h"
     #include "wx/app.h"
     #include "wx/dcclient.h"
     #include "wx/log.h"

+    #include "wx/settings.h"
+    #include "wx/ctrlsub.h"

 #endif
 
 #endif
 

-#include "wx/control.h"
+#if wxUSE_LISTCTRL
+    #include "wx/listctrl.h"
+#endif // wxUSE_LISTCTRL
+
+#if wxUSE_TREECTRL
+    #include "wx/treectrl.h"
+#endif // wxUSE_TREECTRL

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

+#include "wx/msw/uxtheme.h"

 
 

-#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
-    #include <commctrl.h>
-#endif
+// ----------------------------------------------------------------------------
+// wxWin macros
+// ----------------------------------------------------------------------------

 
 IMPLEMENT_ABSTRACT_CLASS(wxControl, wxWindow)
 
 
 IMPLEMENT_ABSTRACT_CLASS(wxControl, wxWindow)
 

-BEGIN_EVENT_TABLE(wxControl, wxWindow)
-    EVT_ERASE_BACKGROUND(wxControl::OnEraseBackground)
-END_EVENT_TABLE()
+// ============================================================================
+// wxControl implementation
+// ============================================================================

 
 

-// Item members
-wxControl::wxControl()
-{
-}
+// ----------------------------------------------------------------------------
+// wxControl ctor/dtor
+// ----------------------------------------------------------------------------

 
 wxControl::~wxControl()
 {
 
 wxControl::~wxControl()
 {

-    m_isBeingDeleted = TRUE;
+    m_isBeingDeleted = true;

 }
 
 }
 

+// ----------------------------------------------------------------------------
+// control window creation
+// ----------------------------------------------------------------------------

 
 bool wxControl::Create(wxWindow *parent,
                        wxWindowID id,
 
 bool wxControl::Create(wxWindow *parent,
                        wxWindowID id,


@@ -63,13 +81,13 @@ bool wxControl::Create(wxWindow *parent,
                        const wxString& name)
 {
     if ( !wxWindow::Create(parent, id, pos, size, style, name) )
                        const wxString& name)
 {
     if ( !wxWindow::Create(parent, id, pos, size, style, name) )

-        return FALSE;
+        return false;

 
 #if wxUSE_VALIDATORS
     SetValidator(validator);
 #endif
 
 
 #if wxUSE_VALIDATORS
     SetValidator(validator);
 #endif
 

-    return TRUE;
+    return true;

 }
 
 bool wxControl::MSWCreateControl(const wxChar *classname,
 }
 
 bool wxControl::MSWCreateControl(const wxChar *classname,


@@ -100,89 +118,225 @@ bool wxControl::MSWCreateControl(const wxChar *classname,
     // all controls should have this style
     style |= WS_CHILD;
 
     // all controls should have this style
     style |= WS_CHILD;
 

-    // create the control visible if it's currently shown for wxWindows
+    // create the control visible if it's currently shown for wxWidgets

     if ( m_isShown )
     {
         style |= WS_VISIBLE;
     }
 
     if ( m_isShown )
     {
         style |= WS_VISIBLE;
     }
 

-    // choose the position for the control
-    int x = pos.x == -1 ? 0 : pos.x,
-        y = pos.y == -1 ? 0 : pos.y,
-        w = size.x == -1 ? 0 : size.x,
-        h = size.y == -1 ? 0 : size.y;
-
-    // ... and adjust it to account for ap ossible parent frames toolbar
+    // choose the position for the control: we have a problem with default size
+    // here as we can't calculate the best size before the control exists
+    // (DoGetBestSize() may need to use m_hWnd), so just choose the minimal
+    // possible but non 0 size because 0 window width/height result in problems
+    // elsewhere
+    int x = pos.x == wxDefaultCoord ? 0 : pos.x,
+        y = pos.y == wxDefaultCoord ? 0 : pos.y,
+        w = size.x == wxDefaultCoord ? 1 : size.x,
+        h = size.y == wxDefaultCoord ? 1 : size.y;
+
+    // ... and adjust it to account for a possible parent frames toolbar

     AdjustForParentClientOrigin(x, y);
 
     m_hWnd = (WXHWND)::CreateWindowEx
                        (
                         exstyle,            // extended style
                         classname,          // the kind of control to create
     AdjustForParentClientOrigin(x, y);
 
     m_hWnd = (WXHWND)::CreateWindowEx
                        (
                         exstyle,            // extended style
                         classname,          // the kind of control to create

-                        label,              // the window name
+                        label.wx_str(),     // the window name

                         style,              // the window style
                         x, y, w, h,         // the window position and size
                         style,              // the window style
                         x, y, w, h,         // the window position and size

-                        GetHwndOf(GetParent()),  // parent
-                        (HMENU)GetId(),     // child id
+                        GetHwndOf(GetParent()),         // parent
+                        (HMENU)wxUIntToPtr(GetId()),    // child id

                         wxGetInstance(),    // app instance
                         NULL                // creation parameters
                        );
 
     if ( !m_hWnd )
     {
                         wxGetInstance(),    // app instance
                         NULL                // creation parameters
                        );
 
     if ( !m_hWnd )
     {

-        wxLogDebug(wxT("Failed to create a control of class '%s'"), classname);
-        wxFAIL_MSG(_T("something is very wrong"));
+#ifdef __WXDEBUG__
+        wxLogLastError(wxString::Format
+                       (
+                        _T("CreateWindowEx(\"%s\", flags=%08lx, ex=%08lx)"),
+                        classname, style, exstyle
+                       ));
+#endif // __WXDEBUG__

 
 

-        return FALSE;
+        return false;

     }
 
     }
 

-#if wxUSE_CTL3D
-    if ( want3D )
-    {
-        Ctl3dSubclassCtl(GetHwnd());
-        m_useCtl3D = TRUE;
-    }
-#endif // wxUSE_CTL3D
-
-    // install wxWindows window proc for this window
+#if !wxUSE_UNICODE
+    // Text labels starting with the character 0xff (which is a valid character
+    // in many code pages) don't appear correctly as CreateWindowEx() has some
+    // special treatment for this case, apparently the strings starting with -1
+    // are not really strings but something called "ordinals". There is no
+    // documentation about it but the fact is that the label gets mangled or
+    // not displayed at all if we don't do this, see #9572.
+    //
+    // Notice that 0xffff is not a valid Unicode character so the problem
+    // doesn't arise in Unicode build.
+    if ( !label.empty() && label[0] == -1 )
+        ::SetWindowText(GetHwnd(), label.wx_str());
+#endif // !wxUSE_UNICODE
+
+    // saving the label in m_labelOrig to return it verbatim
+    // later in GetLabel()
+    m_labelOrig = label;
+
+    // install wxWidgets window proc for this window

     SubclassWin(m_hWnd);
 
     SubclassWin(m_hWnd);
 

-    // controls use the same font and colours as their parent dialog by default
+    // set up fonts and colours

     InheritAttributes();
     InheritAttributes();

+    if ( !m_hasFont )
+    {
+        bool setFont = true;
+
+        wxFont font = GetDefaultAttributes().font;
+
+        // if we set a font for {list,tree}ctrls and the font size is changed in
+        // the display properties then the font size for these controls doesn't
+        // automatically adjust when they receive WM_SETTINGCHANGE
+
+        // FIXME: replace the dynamic casts with virtual function calls!!
+#if wxUSE_LISTCTRL || wxUSE_TREECTRL
+        bool testFont = false;
+#if wxUSE_LISTCTRL
+        if ( wxDynamicCastThis(wxListCtrl) )
+            testFont = true;
+#endif // wxUSE_LISTCTRL
+#if wxUSE_TREECTRL
+        if ( wxDynamicCastThis(wxTreeCtrl) )
+            testFont = true;
+#endif // wxUSE_TREECTRL
+
+        if ( testFont )
+        {
+            // not sure if we need to explicitly set the font here for Win95/NT4
+            // but we definitely can't do it for any newer version
+            // see wxGetCCDefaultFont() in src/msw/settings.cpp for explanation
+            // of why this test works
+
+            // TODO: test Win95/NT4 to see if this is needed or breaks the
+            // font resizing as it does on newer versions
+            if ( font != wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT) )
+            {
+                setFont = false;
+            }
+        }
+#endif // wxUSE_LISTCTRL || wxUSE_TREECTRL
+
+        if ( setFont )
+        {
+            SetFont(GetDefaultAttributes().font);
+        }
+    }

 
     // set the size now if no initial size specified
 
     // set the size now if no initial size specified

-    if ( w <= 0 || h <= 0 )
+    SetInitialSize(size);
+
+    return true;
+}
+
+// ----------------------------------------------------------------------------
+// various accessors
+// ----------------------------------------------------------------------------
+
+WXDWORD wxControl::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+    long msStyle = wxWindow::MSWGetStyle(style, exstyle);
+
+    if ( AcceptsFocusFromKeyboard() )

     {
     {

-        SetBestSize(size);
+        msStyle |= WS_TABSTOP;

     }
 
     }
 

-    return TRUE;
+    return msStyle;
+}
+
+wxSize wxControl::DoGetBestSize() const
+{
+    return wxSize(DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT);

 }
 
 wxBorder wxControl::GetDefaultBorder() const
 {
 }
 
 wxBorder wxControl::GetDefaultBorder() const
 {

-    // we want to automatically give controls a sunken style (confusingly,
-    // it may not really mean sunken at all as we map it to WS_EX_CLIENTEDGE
-    // which is not sunken at all under Windows XP -- rather, just the default)
-    return wxBORDER_SUNKEN;
+    return wxControlBase::GetDefaultBorder();

 }
 
 }
 

-wxSize wxControl::DoGetBestSize() const
+// This is a helper for all wxControls made with UPDOWN native control.
+// In wxMSW it was only wxSpinCtrl derived from wxSpinButton but in
+// WinCE of Smartphones this happens also for native wxTextCtrl,
+// wxChoice and others.
+wxSize wxControl::GetBestSpinnerSize(const bool is_vertical) const

 {
 {

-    return wxSize(DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT);
+    // take size according to layout
+    wxSize bestSize(
+#if defined(__SMARTPHONE__) && defined(__WXWINCE__)
+                    0,GetCharHeight()
+#else
+                    ::GetSystemMetrics(is_vertical ? SM_CXVSCROLL : SM_CXHSCROLL),
+                    ::GetSystemMetrics(is_vertical ? SM_CYVSCROLL : SM_CYHSCROLL)
+#endif
+    );
+
+    // correct size as for undocumented MSW variants cases (WinCE and perhaps others)
+    if (bestSize.x==0)
+        bestSize.x = bestSize.y;
+    if (bestSize.y==0)
+        bestSize.y = bestSize.x;
+
+    // double size according to layout
+    if (is_vertical)
+        bestSize.y *= 2;
+    else
+        bestSize.x *= 2;
+
+    return bestSize;
+}
+
+/* static */ wxVisualAttributes
+wxControl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    wxVisualAttributes attrs;
+
+    // old school (i.e. not "common") controls use the standard dialog font
+    // by default
+    attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
+
+    // most, or at least many, of the controls use the same colours as the
+    // buttons -- others will have to override this (and possibly simply call
+    // GetCompositeControlsDefaultAttributes() from their versions)
+    attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNTEXT);
+    attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
+
+    return attrs;
+}
+
+// another version for the "composite", i.e. non simple controls
+/* static */ wxVisualAttributes
+wxControl::GetCompositeControlsDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    wxVisualAttributes attrs;
+    attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
+    attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
+    attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
+
+    return attrs;

 }
 
 }
 

+// ----------------------------------------------------------------------------
+// message handling
+// ----------------------------------------------------------------------------
+

 bool wxControl::ProcessCommand(wxCommandEvent& event)
 {
 bool wxControl::ProcessCommand(wxCommandEvent& event)
 {

-    return GetEventHandler()->ProcessEvent(event);
+    return HandleWindowEvent(event);

 }
 
 }
 

-#ifdef __WIN95__

 bool wxControl::MSWOnNotify(int idCtrl,
                             WXLPARAM lParam,
                             WXLPARAM* result)
 {
 bool wxControl::MSWOnNotify(int idCtrl,
                             WXLPARAM lParam,
                             WXLPARAM* result)
 {

-    wxEventType eventType = wxEVT_NULL;
+    wxEventType eventType wxDUMMY_INITIALIZE(wxEVT_NULL);

 
     NMHDR *hdr = (NMHDR*) lParam;
     switch ( hdr->code )
 
     NMHDR *hdr = (NMHDR*) lParam;
     switch ( hdr->code )


@@ -223,85 +377,115 @@ bool wxControl::MSWOnNotify(int idCtrl,
     event.SetEventType(eventType);
     event.SetEventObject(this);
 
     event.SetEventType(eventType);
     event.SetEventObject(this);
 

-    return GetEventHandler()->ProcessEvent(event);
+    return HandleWindowEvent(event);

 }
 }

-#endif // Win95

 
 

-void wxControl::OnEraseBackground(wxEraseEvent& event)
+WXHBRUSH wxControl::DoMSWControlColor(WXHDC pDC, wxColour colBg, WXHWND hWnd)

 {
 {

-    // notice that this 'dumb' implementation may cause flicker for some of the
-    // controls in which case they should intercept wxEraseEvent and process it
-    // themselves somehow
+    HDC hdc = (HDC)pDC;
+    if ( m_hasFgCol )
+    {
+        ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
+    }

 
 

-    RECT rect;
-    ::GetClientRect(GetHwnd(), &rect);
+    WXHBRUSH hbr = 0;
+    if ( !colBg.Ok() )
+    {
+        hbr = MSWGetBgBrush(pDC, hWnd);

 
 

-    HBRUSH hBrush = ::CreateSolidBrush(wxColourToRGB(GetBackgroundColour()));
+        // if the control doesn't have any bg colour, foreground colour will be
+        // ignored as the return value would be 0 -- so forcefully give it a
+        // non default background brush in this case
+        if ( !hbr && m_hasFgCol )
+            colBg = GetBackgroundColour();
+    }

 
 

-    HDC hdc = GetHdcOf((*event.GetDC()));
+    // use the background colour override if a valid colour is given
+    if ( colBg.Ok() )
+    {
+        ::SetBkColor(hdc, wxColourToRGB(colBg));

 
 

-#ifndef __WXWINCE__
-    int mode = ::SetMapMode(hdc, MM_TEXT);
-#endif
+        // draw children with the same colour as the parent
+        wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBg,
+                                                           wxBRUSHSTYLE_SOLID);
+        hbr = (WXHBRUSH)brush->GetResourceHandle();
+    }

 
 

-    ::FillRect(hdc, &rect, hBrush);
-    ::DeleteObject(hBrush);
+    // if we use custom background, we should set foreground ourselves too
+    if ( hbr && !m_hasFgCol )
+    {
+        ::SetTextColor(hdc, ::GetSysColor(COLOR_WINDOWTEXT));
+    }
+    //else: already set above

 
 

-#ifndef __WXWINCE__
-    ::SetMapMode(hdc, mode);
-#endif
+    return hbr;

 }
 
 }
 

-WXHBRUSH wxControl::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
-#if wxUSE_CTL3D
-                               WXUINT message,
-                               WXWPARAM wParam,
-                               WXLPARAM lParam
-#else
-                               WXUINT WXUNUSED(message),
-                               WXWPARAM WXUNUSED(wParam),
-                               WXLPARAM WXUNUSED(lParam)
-#endif
-    )
+WXHBRUSH wxControl::MSWControlColor(WXHDC pDC, WXHWND hWnd)

 {
 {

-#if wxUSE_CTL3D
-    if ( m_useCtl3D )
-    {
-        HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
-        return (WXHBRUSH) hbrush;
-    }
-#endif // wxUSE_CTL3D
-
-    HDC hdc = (HDC)pDC;
-    wxColour colBack = GetBackgroundColour();
+    wxColour colBg;

 
 

-    ::SetBkColor(hdc, wxColourToRGB(colBack));
-    ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
+    if ( HasTransparentBackground() )
+        ::SetBkMode((HDC)pDC, TRANSPARENT);
+    else // if the control is opaque it shouldn't use the parents background
+        colBg = GetBackgroundColour();

 
 

-    wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
+    return DoMSWControlColor(pDC, colBg, hWnd);
+}

 
 

-    return (WXHBRUSH)brush->GetResourceHandle();
+WXHBRUSH wxControl::MSWControlColorDisabled(WXHDC pDC)
+{
+    return DoMSWControlColor(pDC,
+                             wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE),
+                             GetHWND());

 }
 
 }
 

-WXDWORD wxControl::MSWGetStyle(long style, WXDWORD *exstyle) const
+// ----------------------------------------------------------------------------
+// wxControlWithItems
+// ----------------------------------------------------------------------------
+
+void wxControlWithItems::MSWAllocStorage(const wxArrayStringsAdapter& items,
+                                         unsigned wm)

 {
 {

-    long msStyle = wxWindow::MSWGetStyle(style, exstyle);
+    const unsigned numItems = items.GetCount();
+    unsigned long totalTextLength = numItems; // for trailing '\0' characters
+    for ( unsigned i = 0; i < numItems; ++i )
+    {
+        totalTextLength += items[i].length();
+    }

 
 

-    if ( AcceptsFocus() )
+    if ( SendMessage((HWND)MSWGetItemsHWND(), wm, numItems,
+                     (LPARAM)totalTextLength*sizeof(wxChar)) == LB_ERRSPACE )

     {
     {

-        msStyle |= WS_TABSTOP;
+        wxLogLastError(wxT("SendMessage(XX_INITSTORAGE)"));
+    }
+}
+
+int wxControlWithItems::MSWInsertOrAppendItem(unsigned pos,
+                                              const wxString& item,
+                                              unsigned wm)
+{
+    LRESULT n = SendMessage((HWND)MSWGetItemsHWND(), wm, pos,
+                            (LPARAM)item.wx_str());
+    if ( n == CB_ERR || n == CB_ERRSPACE )
+    {
+        wxLogLastError(wxT("SendMessage(XX_ADD/INSERTSTRING)"));
+        return wxNOT_FOUND;

     }
 
     }
 

-    return msStyle;
+    return n;

 }
 
 // ---------------------------------------------------------------------------
 // global functions
 // ---------------------------------------------------------------------------
 
 }
 
 // ---------------------------------------------------------------------------
 // global functions
 // ---------------------------------------------------------------------------
 

+// this is used in radiobox.cpp and slider95.cpp and should be removed as soon
+// as it is not needed there any more!
+//

 // Call this repeatedly for several wnds to find the overall size
 // of the widget.
 // Call this repeatedly for several wnds to find the overall size
 // of the widget.

-// Call it initially with -1 for all values in rect.
+// Call it initially with wxDefaultCoord for all values in rect.

 // Keep calling for other widgets, and rect will be modified
 // to calculate largest bounding rectangle.
 void wxFindMaxSize(WXHWND wnd, RECT *rect)
 // Keep calling for other widgets, and rect will be modified
 // to calculate largest bounding rectangle.
 void wxFindMaxSize(WXHWND wnd, RECT *rect)