]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/control.cpp
Docstring fixes
[wxWidgets.git] / src / msw / control.cpp
index b3f223c21001b4a00493442be8363b60d0d567c4..60d235e05f2c97829ff069b0bc14d884cb5ca05a 100644 (file)
@@ -5,11 +5,19 @@
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
+// Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma implementation "control.h"
 #endif
 
     #include "wx/app.h"
     #include "wx/dcclient.h"
     #include "wx/log.h"
+    #include "wx/settings.h"
 #endif
 
 #include "wx/control.h"
 
+#if wxUSE_NOTEBOOK
+    #include "wx/notebook.h"
+#endif // wxUSE_NOTEBOOK
+
 #include "wx/msw/private.h"
+#include "wx/msw/uxtheme.h"
 
-#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
+#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
     #include <commctrl.h>
 #endif
 
-IMPLEMENT_ABSTRACT_CLASS(wxControl, wxWindow)
+// ----------------------------------------------------------------------------
+// wxWin macros
+// ----------------------------------------------------------------------------
 
-BEGIN_EVENT_TABLE(wxControl, wxWindow)
-    EVT_ERASE_BACKGROUND(wxControl::OnEraseBackground)
-END_EVENT_TABLE()
+IMPLEMENT_ABSTRACT_CLASS(wxControl, wxWindow)
 
-// Item members
-wxControl::wxControl()
-{
-    m_backgroundColour = *wxWHITE;
-    m_foregroundColour = *wxBLACK;
+// ============================================================================
+// wxControl implementation
+// ============================================================================
 
-#if WXWIN_COMPATIBILITY
-    m_callback = 0;
-#endif // WXWIN_COMPATIBILITY
-}
+// ----------------------------------------------------------------------------
+// wxControl ctor/dtor
+// ----------------------------------------------------------------------------
 
 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,
                        const wxPoint& pos,
-                       const wxSize& size, long style,
-                       const wxValidator& validator,
+                       const wxSize& size,
+                       long style,
+                       const wxValidator& wxVALIDATOR_PARAM(validator),
                        const wxString& name)
 {
-    bool rval = wxWindow::Create(parent, id, pos, size, style, name);
-    if (rval) {
+    if ( !wxWindow::Create(parent, id, pos, size, style, name) )
+        return false;
+
 #if wxUSE_VALIDATORS
-        SetValidator(validator);
+    SetValidator(validator);
 #endif
-    }
-    return rval;
+
+    return true;
+}
+
+bool wxControl::MSWCreateControl(const wxChar *classname,
+                                 const wxString& label,
+                                 const wxPoint& pos,
+                                 const wxSize& size)
+{
+    WXDWORD exstyle;
+    WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), &exstyle);
+
+    return MSWCreateControl(classname, msStyle, pos, size, label, exstyle);
 }
 
 bool wxControl::MSWCreateControl(const wxChar *classname,
@@ -82,26 +110,34 @@ bool wxControl::MSWCreateControl(const wxChar *classname,
                                  const wxString& label,
                                  WXDWORD exstyle)
 {
-    // want3D tells us whether or not the style specified a 3D border.
-    // If so, under WIN16 we can use Ctl3D to give it an appropriate style.
-    // Sometimes want3D is used to indicate that the non-extended style should have
-    // WS_BORDER.
-    bool want3D = TRUE;
-
     // if no extended style given, determine it ourselves
     if ( exstyle == (WXDWORD)-1 )
     {
-        exstyle = GetExStyle(style, &want3D);
+        exstyle = 0;
+        (void) MSWGetStyle(GetWindowStyle(), &exstyle);
+    }
+
+    // all controls should have this style
+    style |= WS_CHILD;
+
+    // create the control visible if it's currently shown for wxWidgets
+    if ( m_isShown )
+    {
+        style |= WS_VISIBLE;
     }
 
-    // all controls have these styles (wxWindows creates all controls visible
-    // by default)
-    style |= WS_CHILD | WS_VISIBLE;
+    // 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;
 
-    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 a possible parent frames toolbar
+    AdjustForParentClientOrigin(x, y);
 
     m_hWnd = (WXHWND)::CreateWindowEx
                        (
@@ -118,33 +154,53 @@ bool wxControl::MSWCreateControl(const wxChar *classname,
 
     if ( !m_hWnd )
     {
-        wxLogDebug(wxT("Failed to create a control of class '%s'"), classname);
-        wxFAIL_MSG(_T("something is very wrong"));
-
-        return FALSE;
-    }
-
-#if wxUSE_CTL3D
-    if ( want3D )
-    {
-        Ctl3dSubclassCtl(GetHwnd());
-        m_useCtl3D = TRUE;
+#ifdef __WXDEBUG__
+        wxFAIL_MSG(wxString::Format
+                   (
+                    _T("CreateWindowEx(\"%s\", flags=%08x, ex=%08x) failed"),
+                    classname, (unsigned int)style, (unsigned int)exstyle
+                   ));
+#endif // __WXDEBUG__
+
+        return false;
     }
-#endif // wxUSE_CTL3D
 
-    // install wxWindows window proc for this window
+    // install wxWidgets window proc for this window
     SubclassWin(m_hWnd);
 
-    // controls use the same font and colours as their parent dialog by default
+    // set up fonts and colours
     InheritAttributes();
+    if (!m_hasFont)
+        SetFont(GetDefaultAttributes().font);
 
     // set the size now if no initial size specified
-    if ( w == 0 || h == 0 )
+    SetInitialBestSize(size);
+
+    return true;
+}
+
+// ----------------------------------------------------------------------------
+// various accessors
+// ----------------------------------------------------------------------------
+
+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;
+}
+
+WXDWORD wxControl::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+    long msStyle = wxWindow::MSWGetStyle(style, exstyle);
+
+    if ( AcceptsFocus() )
     {
-        SetBestSize(size);
+        msStyle |= WS_TABSTOP;
     }
 
-    return TRUE;
+    return msStyle;
 }
 
 wxSize wxControl::DoGetBestSize() const
@@ -152,18 +208,73 @@ wxSize wxControl::DoGetBestSize() const
     return wxSize(DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT);
 }
 
-bool wxControl::ProcessCommand(wxCommandEvent& event)
+// 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::GetBestSpinerSize(const bool is_vertical) const
 {
-#if WXWIN_COMPATIBILITY
-    if ( m_callback )
-    {
-        (void)(*m_callback)(*this, event);
+    // 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
+    );
 
-        return TRUE;
-    }
+    // 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
-#endif // WXWIN_COMPATIBILITY
+        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)
+{
     return GetEventHandler()->ProcessEvent(event);
 }
 
@@ -172,7 +283,7 @@ 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 )
@@ -217,80 +328,59 @@ bool wxControl::MSWOnNotify(int idCtrl,
 }
 #endif // Win95
 
-void wxControl::OnEraseBackground(wxEraseEvent& event)
+WXHBRUSH wxControl::DoMSWControlColor(WXHDC pDC, wxColour colBg)
 {
-    // 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
-
-    RECT rect;
-    ::GetClientRect(GetHwnd(), &rect);
-
-    HBRUSH hBrush = ::CreateSolidBrush(wxColourToRGB(GetBackgroundColour()));
-
-    HDC hdc = GetHdcOf((*event.GetDC()));
-    int mode = ::SetMapMode(hdc, MM_TEXT);
-
-    ::FillRect(hdc, &rect, hBrush);
-    ::DeleteObject(hBrush);
-    ::SetMapMode(hdc, mode);
-}
-
-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
-    )
-{
-#if wxUSE_CTL3D
-    if ( m_useCtl3D )
+    HDC hdc = (HDC)pDC;
+    if ( m_hasFgCol )
     {
-        HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
-        return (WXHBRUSH) hbrush;
+        ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
     }
-#endif // wxUSE_CTL3D
 
-    HDC hdc = (HDC)pDC;
-    if (GetParent()->GetTransparentBackground())
-        SetBkMode(hdc, TRANSPARENT);
-    else
-        SetBkMode(hdc, OPAQUE);
-
-    wxColour colBack = GetBackgroundColour();
+    // use the background colour override if a valid colour is given
+    WXHBRUSH hbr;
+    if ( colBg.Ok() )
+    {
+        ::SetBkColor(hdc, wxColourToRGB(colBg));
 
-    ::SetBkColor(hdc, wxColourToRGB(colBack));
-    ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
+        // draw children with the same colour as the parent
+        wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBg, wxSOLID);
 
-    wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
+        hbr = (WXHBRUSH)brush->GetResourceHandle();
+    }
+    else // use our own background colour and recurse upwards if necessary
+    {
+        hbr = MSWGetBgBrush(pDC);
+    }
 
-    return (WXHBRUSH)brush->GetResourceHandle();
+    return hbr;
 }
 
-WXDWORD wxControl::GetExStyle(WXDWORD& style, bool *want3D) const
+WXHBRUSH wxControl::MSWControlColor(WXHDC pDC)
 {
-    WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, want3D);
+    // by default consider that the controls text shouldn't erase the
+    // background under it (this is true for all static controls, check boxes,
+    // radio buttons, ...
+    ::SetBkMode((HDC)pDC, TRANSPARENT);
 
-    // Even with extended styles, need to combine with WS_BORDER for them to
-    // look right.
-    if ( *want3D || wxStyleHasBorder(m_windowStyle) )
-        style |= WS_BORDER;
+    return DoMSWControlColor(pDC, wxNullColour);
+}
 
-    return exStyle;
+WXHBRUSH wxControl::MSWControlColorDisabled(WXHDC pDC)
+{
+    return DoMSWControlColor(pDC,
+                             wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE));
 }
 
 // ---------------------------------------------------------------------------
 // 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 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)