applying patch, fixes #10523

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

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 98ef64a1b81f6180fc7c9db8cdb881d04e6c729b..31ef19fac0d68cf21d9e6fda7e00c936256e7cbd 100644 (file)
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -40,6 +40,10 @@
     #define TTTOOLINFO_V1_SIZE 0x28
 #endif
 
+#ifndef TTF_TRANSPARENT
+    #define TTF_TRANSPARENT 0x0100
+#endif
+
 // 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.
@@ -57,6 +61,9 @@
 // the tooltip parent window
 WXHWND wxToolTip::ms_hwndTT = (WXHWND)NULL;
 
+// new tooltip maximum width, default value is set on first call to wxToolTip::Add()
+int wxToolTip::ms_maxWidth = 0;
+
 #if wxUSE_TTM_WINDOWFROMPOINT
 
 // the tooltip window proc
@@ -90,7 +97,18 @@ public:
         hwnd = hwndOwner;
         uFlags = TTF_IDISHWND;
 
-        uId = (UINT)hwndOwner;
+        // we use TTF_TRANSPARENT to fix a problem which arises at least with
+        // the text controls but may presumably happen with other controls
+        // which display the tooltip at mouse position: it can start flashing
+        // then as the control gets "focus lost" events and dismisses the
+        // tooltip which then reappears because mouse remains hovering over the
+        // control, see SF patch 1821229
+        if ( wxApp::GetComCtl32Version() >= 470 )
+        {
+            uFlags |= TTF_TRANSPARENT;
+        }
+
+        uId = (UINT_PTR)hwndOwner;
     }
 };
 
@@ -200,6 +218,13 @@ void wxToolTip::SetReshow(long milliseconds)
                             TTDT_RESHOW, milliseconds);
 }
 
+void wxToolTip::SetMaxWidth(int width)
+{
+    wxASSERT_MSG( width == -1 || width >= 0, _T("invalid width value") );
+
+    ms_maxWidth = width;
+}
+
 // ---------------------------------------------------------------------------
 // implementation helpers
 // ---------------------------------------------------------------------------
@@ -308,73 +333,82 @@ void wxToolTip::Add(WXHWND hWnd)
     }
     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);
+        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);
 
+            if ( !hfont )
+            {
+                hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
                 if ( !hfont )
                 {
-                    hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
-                    if ( !hfont )
-                    {
-                        wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
-                    }
+                    wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
                 }
+            }
 
-                MemoryHDC hdc;
-                if ( !hdc )
-                {
-                    wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
-                }
+            MemoryHDC hdc;
+            if ( !hdc )
+            {
+                wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
+            }
 
-                if ( !SelectObject(hdc, hfont) )
-                {
-                    wxLogLastError(wxT("SelectObject(hfont)"));
-                }
+            if ( !SelectObject(hdc, hfont) )
+            {
+                wxLogLastError(wxT("SelectObject(hfont)"));
+            }
 
-                // find the width of the widest line
-                int max = 0;
-                wxStringTokenizer tokenizer(m_text, _T("\n"));
-                wxString token = tokenizer.GetNextToken();
-                while (token.length())
+            // find the width of the widest line
+            int maxWidth = 0;
+            wxStringTokenizer tokenizer(m_text, _T("\n"));
+            while ( tokenizer.HasMoreTokens() )
+            {
+                const wxString token = tokenizer.GetNextToken();
+
+                SIZE sz;
+                if ( !::GetTextExtentPoint32(hdc, token.wx_str(),
+                                             token.length(), &sz) )
                 {
-                    SIZE sz;
-                    if ( !::GetTextExtentPoint32(hdc, token.wx_str(), token.length(), &sz) )
-                    {
-                        wxLogLastError(wxT("GetTextExtentPoint32"));
-                    }
-                    if ( sz.cx > max )
-                        max = sz.cx;
-
-                    token = tokenizer.GetNextToken();
+                    wxLogLastError(wxT("GetTextExtentPoint32"));
                 }
 
-                // only set a new width if it is bigger than the current setting
-                if (max > SendTooltipMessage(GetToolTipCtrl(), TTM_GETMAXTIPWIDTH, 0))
-                    SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
-                                       (void *)max);
+                if ( sz.cx > maxWidth )
+                    maxWidth = sz.cx;
             }
-            else
-#endif // comctl32.dll >= 4.70
+
+            // limit size to ms_maxWidth, if set
+            if ( ms_maxWidth == 0 )
             {
-                // replace the '\n's with spaces because otherwise they appear as
-                // unprintable characters in the tooltip string
-                m_text.Replace(_T("\n"), _T(" "));
-                ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast
+                // this is more or less arbitrary but seems to work well
+                static const int DEFAULT_MAX_WIDTH = 400;
 
-                if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
-                {
-                    wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
-                }
+                ms_maxWidth = wxGetClientDisplayRect().width / 2;
+
+                if ( ms_maxWidth > DEFAULT_MAX_WIDTH )
+                    ms_maxWidth = DEFAULT_MAX_WIDTH;
+            }
+
+            if ( ms_maxWidth != -1 && maxWidth > ms_maxWidth )
+                maxWidth = ms_maxWidth;
+
+            // only set a new width if it is bigger than the current setting
+            SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
+                               wxUIntToPtr(maxWidth));
+        }
+        else
+#endif // TTM_SETMAXTIPWIDTH
+        {
+            // replace the '\n's with spaces because otherwise they appear as
+            // unprintable characters in the tooltip string
+            m_text.Replace(_T("\n"), _T(" "));
+            ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast
+
+            if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
+            {
+                wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
             }
         }
     }