Moved include for Windows compilation; minor doc tweaks

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

diff --git a/src/msw/control.cpp b/src/msw/control.cpp
index 408813f4f695b08d3f38fb18be838bf132142376..5454e029f9e633219be6bbfe51221104fdbb93c5 100644 (file)
--- a/src/msw/control.cpp
+++ b/src/msw/control.cpp
@@ -1,319 +1,318 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxControl class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Purpose:     wxControl class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__

-#pragma implementation "control.h"
+    #pragma implementation "control.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_CONTROLS
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

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

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

-#if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__)
-#include <commctrl.h>
-#endif
-
-#ifdef GetCharWidth
-#undef GetCharWidth
-#undef GetWindowProc
+#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
+    #include <commctrl.h>

 #endif
 
 #endif
 

-#if !USE_SHARED_LIBRARY

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

-       EVT_ERASE_BACKGROUND(wxControl::OnEraseBackground)
+    EVT_ERASE_BACKGROUND(wxControl::OnEraseBackground)

 END_EVENT_TABLE()
 END_EVENT_TABLE()

-#endif

 
 // Item members
 
 // Item members

-wxControl::wxControl(void)
+wxControl::wxControl()

 {
 {

-  m_backgroundColour = *wxWHITE;
-  m_foregroundColour = *wxBLACK;
-  m_callback = 0;
-//  m_windowCursor = wxNullCursor; // To avoid the standard cursor being used
+#if WXWIN_COMPATIBILITY
+    m_callback = 0;
+#endif // WXWIN_COMPATIBILITY

 }
 
 }
 

-wxControl::~wxControl(void)
+wxControl::~wxControl()

 {
 {

-  m_isBeingDeleted = TRUE;
-
-  // If we delete an item, we should initialize the parent panel,
-  // because it could now be invalid.
-  wxWindow *parent = (wxWindow *)GetParent();
-  if (parent)
-  {
-    if (parent->GetDefaultItem() == (wxButton*) this)
-        parent->SetDefaultItem(NULL);
-  }
+    m_isBeingDeleted = TRUE;

 }
 
 }
 

-void wxControl::SetLabel(const wxString& label)
-{
-  if (GetHWND())
-    SetWindowText((HWND) GetHWND(), (const char *)label);
-}

 
 

-wxString wxControl::GetLabel(void) const
+bool wxControl::Create(wxWindow *parent, wxWindowID id,
+                       const wxPoint& pos,
+                       const wxSize& size, long style,
+                       const wxValidator& validator,
+                       const wxString& name)

 {
 {

-    wxBuffer[0] = 0;
-    if (GetHWND())
-    {
-        int len = GetWindowText((HWND)GetHWND(), wxBuffer, 256);
-        wxBuffer[len] = 0;
+    bool rval = wxWindow::Create(parent, id, pos, size, style, name);
+    if (rval) {
+#if wxUSE_VALIDATORS
+        SetValidator(validator);
+#endif

     }
     }

-
-  return wxString(wxBuffer);
+    return rval;

 }
 
 }
 

-// Call this repeatedly for several wnds to find the overall size
-// of the widget.
-// Call it initially with -1 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)
+bool wxControl::MSWCreateControl(const wxChar *classname,
+                                 WXDWORD style,
+                                 const wxPoint& pos,
+                                 const wxSize& size,
+                                 const wxString& label,
+                                 WXDWORD exstyle)

 {
 {

-  int left = rect->left;
-  int right = rect->right;
-  int top = rect->top;
-  int bottom = rect->bottom;
+    // 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);
+    }

 
 

-  GetWindowRect((HWND) wnd, rect);
+    // all controls have these styles (wxWindows creates all controls visible
+    // by default)
+    style |= WS_CHILD | WS_VISIBLE;
+
+    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;
+
+    m_hWnd = (WXHWND)::CreateWindowEx
+                       (
+                        exstyle,            // extended style
+                        classname,          // the kind of control to create
+                        label,              // the window name
+                        style,              // the window style
+                        x, y, w, h,         // the window position and size
+                        GetHwndOf(GetParent()),  // parent
+                        (HMENU)GetId(),     // child id
+                        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"));

 
 

-  if (left < 0)
-    return;
+        return FALSE;
+    }

 
 

-  if (left < rect->left)
-    rect->left = left;
+#if wxUSE_CTL3D
+    if ( want3D )
+    {
+        Ctl3dSubclassCtl(GetHwnd());
+        m_useCtl3D = TRUE;
+    }
+#endif // wxUSE_CTL3D

 
 

-  if (right > rect->right)
-    rect->right = right;
+    // install wxWindows window proc for this window
+    SubclassWin(m_hWnd);

 
 

-  if (top < rect->top)
-    rect->top = top;
+    // controls use the same font and colours as their parent dialog by default
+    InheritAttributes();

 
 

-  if (bottom > rect->bottom)
-    rect->bottom = bottom;
+    // set the size now if no initial size specified
+    if ( w == 0 || h == 0 )
+    {
+        SetBestSize(size);
+    }

 
 

+    return TRUE;

 }
 
 }
 

-/*
-// Not currently used
-void wxConvertDialogToPixels(wxWindow *control, int *x, int *y)
+wxSize wxControl::DoGetBestSize() const

 {
 {

-  if (control->m_windowParent && control->m_windowParent->is_dialog)
-  {
-    DWORD word = GetDialogBaseUnits();
-    int xs = LOWORD(word);
-    int ys = HIWORD(word);
-    *x = (int)(*x * xs/4);
-    *y = (int)(*y * ys/8);
-  }
-  else
-  {
-    *x = *x;
-    *y = *y;
-  }
+    return wxSize(DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT);

 }
 }

-*/

 
 

-void wxControl::MSWOnMouseMove(int x, int y, WXUINT flags)
+bool wxControl::ProcessCommand(wxCommandEvent& event)

 {
 {

-/*
-  // Trouble with this is that it sets the cursor for controls too :-(
-  if (m_windowCursor.Ok() && !wxIsBusy())
-    ::SetCursor(m_windowCursor.GetHCURSOR());
-*/
-
-  if (!m_mouseInWindow)
-  {
-    // Generate an ENTER event
-    m_mouseInWindow = TRUE;
-    MSWOnMouseEnter(x, y, flags);
-  }
-
-  wxMouseEvent event(wxEVT_MOTION);
-
-  event.m_x = x; event.m_y = y;
-  event.m_shiftDown = ((flags & MK_SHIFT) != 0);
-  event.m_controlDown = ((flags & MK_CONTROL) != 0);
-  event.m_leftDown = ((flags & MK_LBUTTON) != 0);
-  event.m_middleDown = ((flags & MK_MBUTTON) != 0);
-  event.m_rightDown = ((flags & MK_RBUTTON) != 0);
-  event.SetTimestamp(wxApp::sm_lastMessageTime);
-  event.SetEventObject( this );
-
-  // Window gets a click down message followed by a mouse move
-  // message even if position isn't changed!  We want to discard
-  // the trailing move event if x and y are the same.
-  if ((m_lastMouseEvent == wxEVT_RIGHT_DOWN || m_lastMouseEvent == wxEVT_LEFT_DOWN ||
-       m_lastMouseEvent == wxEVT_MIDDLE_DOWN) &&
-      (m_lastMouseX == event.GetX() && m_lastMouseY == event.GetY()))
-  {
-    m_lastMouseX = event.GetX(); m_lastMouseY = event.GetY();
-    m_lastMouseEvent = wxEVT_MOTION;
-    return;
-  }
-
-  m_lastMouseEvent = wxEVT_MOTION;
-  m_lastMouseX = event.GetX(); m_lastMouseY = event.GetY();
-
-  if (!GetEventHandler()->ProcessEvent(event))
-    Default();
+#if WXWIN_COMPATIBILITY
+    if ( m_callback )
+    {
+        (void)(*m_callback)(*this, event);
+
+        return TRUE;
+    }
+    else
+#endif // WXWIN_COMPATIBILITY
+
+    return GetEventHandler()->ProcessEvent(event);

 }
 
 }
 

-bool wxControl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam,
-                          WXLPARAM* result)
+#ifdef __WIN95__
+bool wxControl::MSWOnNotify(int idCtrl,
+                            WXLPARAM lParam,
+                            WXLPARAM* result)

 {
 {

-#if defined(__WIN95__)
-       wxCommandEvent event(wxEVT_NULL, m_windowId);
-       wxEventType eventType = wxEVT_NULL;
-       NMHDR *hdr1 = (NMHDR*) lParam;
-       switch ( hdr1->code )
-       {
-               case NM_CLICK:
-               {
-                       eventType = wxEVT_COMMAND_LEFT_CLICK;
-                       break;
-               }
-               case NM_DBLCLK:
-               {
-                       eventType = wxEVT_COMMAND_LEFT_DCLICK;
-                       break;
-               }
-               case NM_RCLICK:
-               {
-                       eventType = wxEVT_COMMAND_RIGHT_CLICK;
-                       break;
-               }
-               case NM_RDBLCLK:
-               {
-                       eventType = wxEVT_COMMAND_RIGHT_DCLICK;
-                       break;
-               }
-               case NM_SETFOCUS:
-               {
-                       eventType = wxEVT_COMMAND_SET_FOCUS;
-                       break;
-               }
-               case NM_KILLFOCUS:
-               {
-                       eventType = wxEVT_COMMAND_KILL_FOCUS;
-                       break;
-               }
-               case NM_RETURN:
-               {
-                       eventType = wxEVT_COMMAND_ENTER;
-                       break;
-               }
-/* Not implemented
-               case NM_OUTOFMEMORY:
-               {
-                       eventType = wxEVT_COMMAND_OUT_OF_MEMORY;
-                       break;
-               }
-*/
-               default:
-            return wxWindow::MSWNotify(wParam, lParam, result);
-       }
+    wxEventType eventType = wxEVT_NULL;
+
+    NMHDR *hdr = (NMHDR*) lParam;
+    switch ( hdr->code )
+    {
+        case NM_CLICK:
+            eventType = wxEVT_COMMAND_LEFT_CLICK;
+            break;
+
+        case NM_DBLCLK:
+            eventType = wxEVT_COMMAND_LEFT_DCLICK;
+            break;
+
+        case NM_RCLICK:
+            eventType = wxEVT_COMMAND_RIGHT_CLICK;
+            break;

 
 

+        case NM_RDBLCLK:
+            eventType = wxEVT_COMMAND_RIGHT_DCLICK;
+            break;
+
+        case NM_SETFOCUS:
+            eventType = wxEVT_COMMAND_SET_FOCUS;
+            break;
+
+        case NM_KILLFOCUS:
+            eventType = wxEVT_COMMAND_KILL_FOCUS;
+            break;
+
+        case NM_RETURN:
+            eventType = wxEVT_COMMAND_ENTER;
+            break;
+
+        default:
+            return wxWindow::MSWOnNotify(idCtrl, lParam, result);
+    }
+
+    wxCommandEvent event(wxEVT_NULL, m_windowId);

     event.SetEventType(eventType);
     event.SetEventType(eventType);

-       event.SetEventObject(this);
+    event.SetEventObject(this);

 
 

-       if ( !GetEventHandler()->ProcessEvent(event) )
-               return FALSE;
-       return TRUE;
-#else   // !Win95
-    return FALSE;
-#endif
+    return GetEventHandler()->ProcessEvent(event);
+}
+#endif // Win95
+
+void wxControl::OnEraseBackground(wxEraseEvent& event)
+{
+    // 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);

 }
 
 }
 

-void wxControl::ProcessCommand (wxCommandEvent & event)
+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
+    )

 {
 {

-  // Tries:
-  // 1) A callback function (to become obsolete)
-  // 2) OnCommand, starting at this window and working up parent hierarchy
-  // 3) OnCommand then calls ProcessEvent to search the event tables.
-  if (m_callback)
+#if wxUSE_CTL3D
+    if ( m_useCtl3D )

     {
     {

-      (void) (*(m_callback)) (*this, event);
+        HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
+        return (WXHBRUSH) hbrush;

     }
     }

+#endif // wxUSE_CTL3D
+
+    HDC hdc = (HDC)pDC;
+    if (GetParent()->GetTransparentBackground())
+        SetBkMode(hdc, TRANSPARENT);

     else
     else

-    {
-      GetEventHandler()->OnCommand(*this, event);
-    }
-}
+        SetBkMode(hdc, OPAQUE);

 
 

-void wxControl::OnEraseBackground(wxEraseEvent& event)
-{
-  // In general, you don't want to erase the background of a control,
-  // or you'll get a flicker.
-  // TODO: move this 'null' function into each control that
-  // might flicker.
+    wxColour colBack = GetBackgroundColour();

 
 

-  RECT rect;
-  ::GetClientRect((HWND) GetHWND(), &rect);
+    ::SetBkColor(hdc, wxColourToRGB(colBack));
+    ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));

 
 

-  HBRUSH hBrush = ::CreateSolidBrush(PALETTERGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue()));
-  int mode = ::SetMapMode((HDC) event.GetDC()->GetHDC(), MM_TEXT);
+    wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);

 
 

-  ::FillRect ((HDC) event.GetDC()->GetHDC(), &rect, hBrush);
-  ::DeleteObject(hBrush);
-  ::SetMapMode((HDC) event.GetDC()->GetHDC(), mode);
+    return (WXHBRUSH)brush->GetResourceHandle();

 }
 
 }
 

-void wxControl::SetClientSize (int width, int height)
+WXDWORD wxControl::GetExStyle(WXDWORD& style, bool *want3D) const

 {
 {

-  SetSize (-1, -1, width, height);
+    WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, want3D);
+
+    // Even with extended styles, need to combine with WS_BORDER for them to
+    // look right.
+    if ( *want3D || wxStyleHasBorder(m_windowStyle) )
+        style |= WS_BORDER;
+
+    return exStyle;

 }
 
 }
 

-void wxControl::Centre (int direction)
+// ---------------------------------------------------------------------------
+// global functions
+// ---------------------------------------------------------------------------
+
+// Call this repeatedly for several wnds to find the overall size
+// of the widget.
+// Call it initially with -1 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)

 {
 {

-  int x, y, width, height, panel_width, panel_height, new_x, new_y;
+    int left = rect->left;
+    int right = rect->right;
+    int top = rect->top;
+    int bottom = rect->bottom;

 
 

-  wxWindow *parent = (wxWindow *) GetParent ();
-  if (!parent)
-    return;
+    GetWindowRect((HWND) wnd, rect);

 
 

-  parent->GetClientSize (&panel_width, &panel_height);
-  GetSize (&width, &height);
-  GetPosition (&x, &y);
+    if (left < 0)
+        return;

 
 

-  new_x = x;
-  new_y = y;
+    if (left < rect->left)
+        rect->left = left;

 
 

-  if (direction & wxHORIZONTAL)
-    new_x = (int) ((panel_width - width) / 2);
+    if (right > rect->right)
+        rect->right = right;

 
 

-  if (direction & wxVERTICAL)
-    new_y = (int) ((panel_height - height) / 2);
+    if (top < rect->top)
+        rect->top = top;

 
 

-  SetSize (new_x, new_y, width, height);
-  int temp_x, temp_y;
-  GetPosition (&temp_x, &temp_y);
-  GetPosition (&temp_x, &temp_y);
+    if (bottom > rect->bottom)
+        rect->bottom = bottom;

 }
 
 }
 

-
+#endif // wxUSE_CONTROLS