X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dca0f651782d5c2659203c97b3243f613966998d..7185918d695b5a3bb662ac4c71dd943dca9a2afc:/src/msw/tooltip.cpp

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index dd3fdd076b..351f44ff6f 100644
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -61,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
@@ -215,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
 // ---------------------------------------------------------------------------
@@ -315,85 +325,98 @@ void wxToolTip::Add(WXHWND hWnd)
     // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
     // of any length
     ti.hwnd = hwnd;
-    ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast
+    ti.lpszText = const_cast<wxChar *>(m_text.wx_str());
 
     if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
     {
         wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
+
+        return;
     }
-    else
+
+#ifdef TTM_SETMAXTIPWIDTH
+    if ( wxApp::GetComCtl32Version() >= 470 )
     {
-        // check for multiline toopltip
-        int index = m_text.Find(_T('\n'));
+        // 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 ( index != wxNOT_FOUND )
+        if ( !hfont )
         {
-#ifdef TTM_SETMAXTIPWIDTH
-            if ( wxApp::GetComCtl32Version() >= 470 )
+            hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
+            if ( !hfont )
             {
-                // 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 )
-                    {
-                        wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
-                    }
-                }
-
-                MemoryHDC hdc;
-                if ( !hdc )
-                {
-                    wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
-                }
-
-                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())
-                {
-                    SIZE sz;
-                    if ( !::GetTextExtentPoint32(hdc, token.wx_str(), token.length(), &sz) )
-                    {
-                        wxLogLastError(wxT("GetTextExtentPoint32"));
-                    }
-                    if ( sz.cx > max )
-                        max = sz.cx;
-
-                    token = tokenizer.GetNextToken();
-                }
-
-                // only set a new width if it is bigger than the current setting
-                if ( max > SendTooltipMessage(GetToolTipCtrl(),
-                                              TTM_GETMAXTIPWIDTH, 0) )
-                {
-                    SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
-                                       wxUIntToPtr(max));
-                }
+                wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
             }
-            else
-#endif // comctl32.dll >= 4.70
+        }
+
+        MemoryHDC hdc;
+        if ( !hdc )
+        {
+            wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
+        }
+
+        if ( !SelectObject(hdc, hfont) )
+        {
+            wxLogLastError(wxT("SelectObject(hfont)"));
+        }
+
+        // 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) )
             {
-                // 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());
-                }
+                wxLogLastError(wxT("GetTextExtentPoint32"));
             }
+
+            if ( sz.cx > maxWidth )
+                maxWidth = sz.cx;
+        }
+
+        // limit size to ms_maxWidth, if set
+        if ( ms_maxWidth == 0 )
+        {
+            // this is more or less arbitrary but seems to work well
+            static const int DEFAULT_MAX_WIDTH = 400;
+
+            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:
+        // otherwise adding a tooltip with shorter line(s) than a previous
+        // one would result in breaking the longer lines unnecessarily as
+        // all our tooltips share the same maximal width
+        if ( maxWidth > SendTooltipMessage(GetToolTipCtrl(),
+                                           TTM_GETMAXTIPWIDTH, 0) )
+        {
+            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 = const_cast<wxChar *>(m_text.wx_str());
+
+        if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
+        {
+            wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
         }
     }
 }
@@ -445,8 +468,14 @@ void wxToolTip::SetTip(const wxString& tip)
     {
         // update the tip text shown by the control
         wxToolInfo ti(GetHwndOf(m_window));
-        ti.lpszText = (wxChar *)m_text.wx_str();
 
+        // for some reason, changing the tooltip text directly results in
+        // repaint of the controls under it, see #10520 -- but this doesn't
+        // happen if we reset it first
+        ti.lpszText = const_cast<wxChar *>(_T(""));
+        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
+
+        ti.lpszText = const_cast<wxChar *>(m_text.wx_str());
         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
     }
 }