Add comments explaining the workaround for mingw 3.2.3

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

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 0bac53472b783c6b28d0b93cedc896215f5b183a..71ef1f714e97674299f79425930464db6435f427 100644 (file)
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -6,7 +6,7 @@
 // Created:     31.01.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin
 // Created:     31.01.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin

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

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


@@ -32,17 +32,17 @@
 #include "wx/tooltip.h"
 #include "wx/msw/private.h"
 
 #include "wx/tooltip.h"
 #include "wx/msw/private.h"
 

-#if defined(__WIN95__) && !defined(__GNUWIN32_OLD__)
-    #include <commctrl.h>
-#endif
+// include <commctrl.h> "properly"
+#include "wx/msw/wrapcctl.h"

 
 // VZ: normally, the trick with subclassing the tooltip control and processing
 //     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
 //     code here for now (but it's not compiled) in case we need it later.
 //
 
 // VZ: normally, the trick with subclassing the tooltip control and processing
 //     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
 //     code here for now (but it's not compiled) in case we need it later.
 //

-//     For now, instead of this, we just add all radiobox buttons to the
-//     tooltip control as well (see SetWindow) - this is probably less
-//     efficient, but it works.
+//     For now I use an ugly workaround and process TTN_NEEDTEXT directly in
+//     radio button wnd proc - fixing TTM_WINDOWFROMPOINT code would be nice
+//     because it would then work for all controls, not only radioboxes but for
+//     now I don't understand what's wrong with it...

 #define wxUSE_TTM_WINDOWFROMPOINT   0
 
 // ----------------------------------------------------------------------------
 #define wxUSE_TTM_WINDOWFROMPOINT   0
 
 // ----------------------------------------------------------------------------


@@ -63,23 +63,38 @@ static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
 // private classes
 // ----------------------------------------------------------------------------
 
 // private classes
 // ----------------------------------------------------------------------------
 

-// a simple wrapper around TOOLINFO Win32 structure
+// a wrapper around TOOLINFO Win32 structure

 #ifdef __VISUALC__
     #pragma warning( disable : 4097 ) // we inherit from a typedef - so what?
 #endif
 #ifdef __VISUALC__
     #pragma warning( disable : 4097 ) // we inherit from a typedef - so what?
 #endif

+

 class wxToolInfo : public TOOLINFO
 {
 public:
 class wxToolInfo : public TOOLINFO
 {
 public:

-    wxToolInfo(HWND hwnd)
+    wxToolInfo(HWND hwndOwner)

     {
         // initialize all members
         ::ZeroMemory(this, sizeof(TOOLINFO));
 
     {
         // initialize all members
         ::ZeroMemory(this, sizeof(TOOLINFO));
 

+        // the structure TOOLINFO has been extended with a 4 byte field in
+        // version 4.70 of comctl32.dll and if we compile on a newer machine
+        // but run on one with the old version of comctl32, nothing will work
+        // because the library will detect that we rely on a more recent
+        // version of it. So we always use the old size - if we ever start
+        // using our lParam member, we'd have to check for comctl32 version
+        // during run-time
+#if _WIN32_IE >= 0x0300
+        cbSize = sizeof(TOOLINFO) - sizeof(LPARAM);
+#else // old headers

         cbSize = sizeof(TOOLINFO);
         cbSize = sizeof(TOOLINFO);

+#endif // compile-time comctl32.dll version
+
+        hwnd = hwndOwner;

         uFlags = TTF_IDISHWND;
         uFlags = TTF_IDISHWND;

-        uId = (UINT)hwnd;
+        uId = (UINT)hwndOwner;

     }
 };
     }
 };

+

 #ifdef __VISUALC__
     #pragma warning( default : 4097 )
 #endif
 #ifdef __VISUALC__
     #pragma warning( default : 4097 )
 #endif


@@ -125,30 +140,39 @@ LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
     if ( msg == TTM_WINDOWFROMPOINT )
     {
         LPPOINT ppt = (LPPOINT)lParam;
     if ( msg == TTM_WINDOWFROMPOINT )
     {
         LPPOINT ppt = (LPPOINT)lParam;

-        // is the window under control a wxWindow?
+
+        // the window on which event occured

         HWND hwnd = ::WindowFromPoint(*ppt);
 
         HWND hwnd = ::WindowFromPoint(*ppt);
 

-        // return a HWND correspondign to wxWindow because only wxWindows are
+        OutputDebugString("TTM_WINDOWFROMPOINT: ");
+        OutputDebugString(wxString::Format("0x%08x => ", hwnd));
+
+        // return a HWND corresponding to a wxWindow because only wxWidgets are

         // associated with tooltips using TTM_ADDTOOL
         // associated with tooltips using TTM_ADDTOOL

-        while ( hwnd && !wxFindWinFromHandle((WXHWND)hwnd) )
-        {
-            hwnd = ::GetParent(hwnd);
-        }
+        wxWindow *win = wxGetWindowFromHWND((WXHWND)hwnd);

 
 

-        if ( hwnd )
+        if ( win )

         {
         {

+            hwnd = GetHwndOf(win);
+            OutputDebugString(wxString::Format("0x%08x\r\n", hwnd));
+
+#if 0

             // modify the point too!
             RECT rect;
             GetWindowRect(hwnd, &rect);
 
             // modify the point too!
             RECT rect;
             GetWindowRect(hwnd, &rect);
 

-            ppt->x = rect.left;
-            ppt->y = rect.top;
-
+            ppt->x = (rect.right - rect.left) / 2;
+            ppt->y = (rect.bottom - rect.top) / 2;
+#endif // 0

             return (LRESULT)hwnd;
         }
             return (LRESULT)hwnd;
         }

+        else
+        {
+            OutputDebugString("no window\r\n");
+        }

     }
 
     }
 

-    return ::CallWindowProc(gs_wndprocToolTip, hwndTT, msg, wParam, lParam);
+    return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip, hwndTT, msg, wParam, lParam);

 }
 
 #endif // wxUSE_TTM_WINDOWFROMPOINT
 }
 
 #endif // wxUSE_TTM_WINDOWFROMPOINT


@@ -178,7 +202,7 @@ WXHWND wxToolTip::GetToolTipCtrl()
     if ( !ms_hwndTT )
     {
         ms_hwndTT = (WXHWND)::CreateWindow(TOOLTIPS_CLASS,
     if ( !ms_hwndTT )
     {
         ms_hwndTT = (WXHWND)::CreateWindow(TOOLTIPS_CLASS,

-                                           (LPSTR)NULL,
+                                           (LPCTSTR)NULL,

                                            TTS_ALWAYSTIP,
                                            CW_USEDEFAULT, CW_USEDEFAULT,
                                            CW_USEDEFAULT, CW_USEDEFAULT,
                                            TTS_ALWAYSTIP,
                                            CW_USEDEFAULT, CW_USEDEFAULT,
                                            CW_USEDEFAULT, CW_USEDEFAULT,


@@ -193,8 +217,7 @@ WXHWND wxToolTip::GetToolTipCtrl()
 
 #if wxUSE_TTM_WINDOWFROMPOINT
            // subclass the newly created control
 
 #if wxUSE_TTM_WINDOWFROMPOINT
            // subclass the newly created control

-           gs_wndprocToolTip = (WNDPROC)::GetWindowLong(hwnd, GWL_WNDPROC);
-           ::SetWindowLong(hwnd, GWL_WNDPROC, (long)wxToolTipWndProc);
+           gs_wndprocToolTip = wxSetWindowProc(hwnd, wxToolTipWndProc);

 #endif // wxUSE_TTM_WINDOWFROMPOINT
        }
     }
 #endif // wxUSE_TTM_WINDOWFROMPOINT
        }
     }


@@ -211,6 +234,8 @@ void wxToolTip::RelayEvent(WXMSG *msg)
 // ctor & dtor
 // ----------------------------------------------------------------------------
 
 // ctor & dtor
 // ----------------------------------------------------------------------------
 

+IMPLEMENT_ABSTRACT_CLASS(wxToolTip, wxObject)
+

 wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {
 wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {


@@ -243,17 +268,69 @@ void wxToolTip::Add(WXHWND hWnd)
 
     wxToolInfo ti(hwnd);
 
 
     wxToolInfo ti(hwnd);
 

-    // as we store our text anyhow, it seems useless to waste system memory
-    // by asking the tooltip ctrl to remember it too - instead it will send
-    // us TTN_NEEDTEXT (via WM_NOTIFY) when it is about to be shown
+    // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
+    // store the tooltip text ourselves anyhow, and provide it in response to
+    // TTN_NEEDTEXT (sent via WM_NOTIFY), but then we would be limited to 79
+    // character tooltips as this is the size of the szText buffer in
+    // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
+    // of any length

     ti.hwnd = hwnd;
     ti.hwnd = hwnd;

-    ti.lpszText = LPSTR_TEXTCALLBACK;
-    // instead of: ti.lpszText = (char *)m_text.c_str();
+    ti.lpszText = (wxChar *)m_text.c_str(); // const_cast

 
     if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, 0, &ti) )
     {
 
     if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, 0, &ti) )
     {

-        wxLogSysError(_("Failed to create the tooltip '%s'"),
-                      m_text.c_str());
+        wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
+    }
+    else
+    {
+        // check for multiline toopltip
+        int index = m_text.Find(_T('\n'));
+
+        if ( index != wxNOT_FOUND )
+        {
+#ifdef TTM_SETMAXTIPWIDTH
+            if ( wxApp::GetComCtl32Version() >= 470 )
+            {
+                // use TTM_SETMAXTIPWIDTH to make tooltip multiline using the
+                // extent of its first line as max value
+                HFONT hfont = (HFONT)SendTooltipMessage(GetToolTipCtrl(),
+                                                        WM_GETFONT,
+                                                        0, 0);
+                if ( !hfont )
+                {
+                    hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
+                    if ( !hfont )
+                    {
+                        wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
+                    }
+                }
+
+                MemoryHDC hdc;
+                if ( !hdc )
+                {
+                    wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
+                }
+
+                if ( !SelectObject(hdc, hfont) )
+                {
+                    wxLogLastError(wxT("SelectObject(hfont)"));
+                }
+
+                SIZE sz;
+                if ( !GetTextExtentPoint(hdc, m_text, index, &sz) )
+                {
+                    wxLogLastError(wxT("GetTextExtentPoint"));
+                }
+
+                SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
+                                   0, (void *)sz.cx);
+            }
+#endif // comctl32.dll >= 4.70
+
+            // replace the '\n's with spaces because otherwise they appear as
+            // unprintable characters in the tooltip string
+            m_text.Replace(_T("\n"), _T(" "));
+        }

     }
 }
 
     }
 }
 


@@ -268,23 +345,48 @@ void wxToolTip::SetWindow(wxWindow *win)
     {
         Add(m_window->GetHWND());
     }
     {
         Add(m_window->GetHWND());
     }

-
+#if !defined(__WXUNIVERSAL__)

     // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
     {
     // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
     {

-        size_t count = control->GetSubcontrols().GetCount();
+        const wxArrayLong& subcontrols = control->GetSubcontrols();
+        size_t count = subcontrols.GetCount();

         for ( size_t n = 0; n < count; n++ )
         {
         for ( size_t n = 0; n < count; n++ )
         {

-            wxWindowID id = control->GetSubcontrols()[n];
+            int id = subcontrols[n];

             HWND hwnd = GetDlgItem(GetHwndOf(m_window), id);
             HWND hwnd = GetDlgItem(GetHwndOf(m_window), id);

-
-            if ( hwnd )
+            if ( !hwnd )

             {
             {

-                Add((WXHWND)hwnd);
+                // may be it's a child of parent of the control, in fact?
+                // (radiobuttons are subcontrols, i.e. children of the radiobox
+                // for wxWidgets but are its siblings at Windows level)
+                hwnd = GetDlgItem(GetHwndOf(m_window->GetParent()), id);

             }
             }

+
+            // must have it by now!
+            wxASSERT_MSG( hwnd, _T("no hwnd for subcontrol?") );
+
+            Add((WXHWND)hwnd);
+        }
+    }
+
+    // VZ: it's ugly to do it here, but I don't want any major changes right
+    //     now, later we will probably want to have wxWindow::OnGotToolTip() or
+    //     something like this where the derived class can do such things
+    //     itself instead of wxToolTip "knowing" about them all
+    wxComboBox *combo = wxDynamicCast(control, wxComboBox);
+    if ( combo )
+    {
+        WXHWND hwndComboEdit = combo->GetWindowStyle() & wxCB_READONLY
+                                ? combo->GetHWND()
+                                : combo->GetEditHWND();
+        if ( hwndComboEdit )
+        {
+            Add(hwndComboEdit);

         }
     }
         }
     }

+#endif // !defined(__WXUNIVERSAL__)

 }
 
 void wxToolTip::SetTip(const wxString& tip)
 }
 
 void wxToolTip::SetTip(const wxString& tip)


@@ -293,7 +395,7 @@ void wxToolTip::SetTip(const wxString& tip)
 
     if ( m_window )
     {
 
     if ( m_window )
     {

-        // update it immediately
+        // update the tip text shown by the control

         wxToolInfo ti(GetHwndOf(m_window));
         ti.lpszText = (wxChar *)m_text.c_str();
 
         wxToolInfo ti(GetHwndOf(m_window));
         ti.lpszText = (wxChar *)m_text.c_str();