X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ada88e3efe9048f4d660eb657b0e44bd463b0fba..f5590243955d800aaeee4e2c3b8c4aec14919181:/src/msw/tooltip.cpp

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index cec5c0f8ed..8fde93e577 100644
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -103,23 +103,20 @@ public:
 // private functions
 // ----------------------------------------------------------------------------
 
-// send a message to the tooltip control
-inline LRESULT SendTooltipMessage(WXHWND hwnd,
-                                  UINT msg,
-                                  WPARAM wParam,
-                                  void *lParam)
+// send a message to the tooltip control if it exists
+//
+// NB: wParam is always 0 for the TTM_XXX messages we use
+static inline LRESULT SendTooltipMessage(WXHWND hwnd, UINT msg, void *lParam)
 {
-    return hwnd ? ::SendMessage((HWND)hwnd, msg, wParam, (LPARAM)lParam)
-                : 0;
+    return hwnd ? ::SendMessage((HWND)hwnd, msg, 0, (LPARAM)lParam) : 0;
 }
 
 // send a message to all existing tooltip controls
-static void SendTooltipMessageToAll(WXHWND hwnd,
-                                    UINT msg,
-                                    WPARAM wParam,
-                                    LPARAM lParam)
+static inline void
+SendTooltipMessageToAll(WXHWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
 {
-    (void)SendTooltipMessage((WXHWND)hwnd, msg, wParam, (void *)lParam);
+    if ( hwnd )
+        ::SendMessage((HWND)hwnd, msg, wParam, lParam);
 }
 
 // ============================================================================
@@ -141,13 +138,13 @@ LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
     {
         LPPOINT ppt = (LPPOINT)lParam;
 
-        // the window on which event occured
+        // the window on which event occurred
         HWND hwnd = ::WindowFromPoint(*ppt);
 
         OutputDebugString("TTM_WINDOWFROMPOINT: ");
         OutputDebugString(wxString::Format("0x%08x => ", hwnd));
 
-        // return a HWND corresponding to a wxWindow because only wxWindows are
+        // return a HWND corresponding to a wxWindow because only wxWidgets are
         // associated with tooltips using TTM_ADDTOOL
         wxWindow *win = wxGetWindowFromHWND((WXHWND)hwnd);
 
@@ -197,6 +194,7 @@ void wxToolTip::SetDelay(long milliseconds)
 // ---------------------------------------------------------------------------
 
 // create the tooltip ctrl for our parent frame if it doesn't exist yet
+/* static */
 WXHWND wxToolTip::GetToolTipCtrl()
 {
     if ( !ms_hwndTT )
@@ -225,9 +223,10 @@ WXHWND wxToolTip::GetToolTipCtrl()
     return ms_hwndTT;
 }
 
+/* static */
 void wxToolTip::RelayEvent(WXMSG *msg)
 {
-    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, 0, msg);
+    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);
 }
 
 // ----------------------------------------------------------------------------
@@ -244,21 +243,27 @@ wxToolTip::wxToolTip(const wxString &tip)
 
 wxToolTip::~wxToolTip()
 {
-    // there is no need to Remove() this tool - it will be done automatically
-    // anyhow
+    // the tooltip has to be removed before deleting. Otherwise, if it is visible
+	// while being deleted, there will be a delay before it goes away.
+	Remove();
 }
 
 // ----------------------------------------------------------------------------
 // others
 // ----------------------------------------------------------------------------
 
+void wxToolTip::Remove(WXHWND hWnd)
+{
+    wxToolInfo ti((HWND)hWnd);
+    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti);
+}
+
 void wxToolTip::Remove()
 {
     // remove this tool from the tooltip control
     if ( m_window )
     {
-        wxToolInfo ti(GetHwndOf(m_window));
-        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, 0, &ti);
+        Remove(m_window->GetHWND());
     }
 }
 
@@ -277,7 +282,7 @@ void wxToolTip::Add(WXHWND hWnd)
     ti.hwnd = hwnd;
     ti.lpszText = (wxChar *)m_text.c_str(); // const_cast
 
-    if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, 0, &ti) )
+    if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
     {
         wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
     }
@@ -289,13 +294,13 @@ void wxToolTip::Add(WXHWND hWnd)
         if ( index != wxNOT_FOUND )
         {
 #ifdef TTM_SETMAXTIPWIDTH
-            if ( wxTheApp->GetComCtl32Version() >= 470 )
+            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);
+                HFONT hfont = (HFONT)
+                    SendTooltipMessage(GetToolTipCtrl(), WM_GETFONT, 0);
+
                 if ( !hfont )
                 {
                     hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
@@ -317,19 +322,27 @@ void wxToolTip::Add(WXHWND hWnd)
                 }
 
                 SIZE sz;
-                if ( !GetTextExtentPoint(hdc, m_text, index, &sz) )
+                if ( !::GetTextExtentPoint32(hdc, m_text, index, &sz) )
                 {
-                    wxLogLastError(wxT("GetTextExtentPoint"));
+                    wxLogLastError(wxT("GetTextExtentPoint32"));
                 }
 
                 SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
-                                   0, (void *)sz.cx);
+                                        (void *)sz.cx);
             }
+            else
 #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(" "));
+                ti.lpszText = (wxChar *)m_text.c_str(); // const_cast
 
-            // replace the '\n's with spaces because otherwise they appear as
-            // unprintable characters in the tooltip string
-            m_text.Replace(_T("\n"), _T(" "));
+                if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
+                {
+                    wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
+                }
+            }
         }
     }
 }
@@ -350,7 +363,7 @@ void wxToolTip::SetWindow(wxWindow *win)
     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
     {
-        const wxArrayLong subcontrols = control->GetSubcontrols();
+        const wxArrayLong& subcontrols = control->GetSubcontrols();
         size_t count = subcontrols.GetCount();
         for ( size_t n = 0; n < count; n++ )
         {
@@ -360,7 +373,7 @@ void wxToolTip::SetWindow(wxWindow *win)
             {
                 // may be it's a child of parent of the control, in fact?
                 // (radiobuttons are subcontrols, i.e. children of the radiobox
-                // for wxWindows but are its siblings at Windows level)
+                // for wxWidgets but are its siblings at Windows level)
                 hwnd = GetDlgItem(GetHwndOf(m_window->GetParent()), id);
             }
 
@@ -399,7 +412,7 @@ void wxToolTip::SetTip(const wxString& tip)
         wxToolInfo ti(GetHwndOf(m_window));
         ti.lpszText = (wxChar *)m_text.c_str();
 
-        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, 0, &ti);
+        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
     }
 }