notify the timers outside of loop over m_timers to avoid crashes if a timer event...

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

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 78b93e424cee918f3030f20ace63f968b7b8ecd0..31ef19fac0d68cf21d9e6fda7e00c936256e7cbd 100644 (file)
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        msw/tooltip.cpp
+// Name:        src/msw/tooltip.cpp

 // Purpose:     wxToolTip class implementation for MSW
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     31.01.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin
 // Purpose:     wxToolTip class implementation for MSW
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     31.01.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin

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

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


@@ -23,22 +23,25 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#ifndef WX_PRECOMP
-    #include "wx/wx.h"
-#endif
-

 #if wxUSE_TOOLTIPS
 
 #include "wx/tooltip.h"
 #if wxUSE_TOOLTIPS
 
 #include "wx/tooltip.h"

+
+#ifndef WX_PRECOMP
+    #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
+    #include "wx/app.h"
+    #include "wx/control.h"
+#endif
+
+#include "wx/tokenzr.h"

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

-#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
-    #include <commctrl.h>
+#ifndef TTTOOLINFO_V1_SIZE
+    #define TTTOOLINFO_V1_SIZE 0x28

 #endif
 
 #endif
 

-#ifndef _WIN32_IE
-    // minimal set of features by default
-    #define _WIN32_IE 0x0200
+#ifndef TTF_TRANSPARENT
+    #define TTF_TRANSPARENT 0x0100

 #endif
 
 // VZ: normally, the trick with subclassing the tooltip control and processing
 #endif
 
 // VZ: normally, the trick with subclassing the tooltip control and processing


@@ -58,6 +61,9 @@
 // the tooltip parent window
 WXHWND wxToolTip::ms_hwndTT = (WXHWND)NULL;
 
 // 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
 #if wxUSE_TTM_WINDOWFROMPOINT
 
 // the tooltip window proc


@@ -83,21 +89,26 @@ public:
         ::ZeroMemory(this, sizeof(TOOLINFO));
 
         // the structure TOOLINFO has been extended with a 4 byte field in
         ::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);
-#endif // compile-time comctl32.dll version
+        // version 4.70 of comctl32.dll and another one in 5.01 but we don't
+        // use these extended fields so use the old struct size to ensure that
+        // the tooltips work on old (Windows 95) systems too
+        cbSize = TTTOOLINFO_V1_SIZE;

 
         hwnd = hwndOwner;
         uFlags = TTF_IDISHWND;
 
         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;

     }
 };
 
     }
 };
 


@@ -109,23 +120,20 @@ public:
 // private functions
 // ----------------------------------------------------------------------------
 
 // 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
 }
 
 // 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);

 }
 
 // ============================================================================
 }
 
 // ============================================================================


@@ -147,13 +155,13 @@ LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
     {
         LPPOINT ppt = (LPPOINT)lParam;
 
     {
         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));
 
         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);
 
         // associated with tooltips using TTM_ADDTOOL
         wxWindow *win = wxGetWindowFromHWND((WXHWND)hwnd);
 


@@ -198,23 +206,52 @@ void wxToolTip::SetDelay(long milliseconds)
                             TTDT_INITIAL, milliseconds);
 }
 
                             TTDT_INITIAL, milliseconds);
 }
 

+void wxToolTip::SetAutoPop(long milliseconds)
+{
+    SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
+                            TTDT_AUTOPOP, milliseconds);
+}
+
+void wxToolTip::SetReshow(long milliseconds)
+{
+    SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
+                            TTDT_RESHOW, milliseconds);
+}
+
+void wxToolTip::SetMaxWidth(int width)
+{
+    wxASSERT_MSG( width == -1 || width >= 0, _T("invalid width value") );
+
+    ms_maxWidth = width;
+}
+

 // ---------------------------------------------------------------------------
 // implementation helpers
 // ---------------------------------------------------------------------------
 
 // create the tooltip ctrl for our parent frame if it doesn't exist yet
 // ---------------------------------------------------------------------------
 // implementation helpers
 // ---------------------------------------------------------------------------
 
 // create the tooltip ctrl for our parent frame if it doesn't exist yet

+/* static */

 WXHWND wxToolTip::GetToolTipCtrl()
 {
     if ( !ms_hwndTT )
     {
 WXHWND wxToolTip::GetToolTipCtrl()
 {
     if ( !ms_hwndTT )
     {

-        ms_hwndTT = (WXHWND)::CreateWindow(TOOLTIPS_CLASS,
-                                           (LPCTSTR)NULL,
-                                           TTS_ALWAYSTIP,
-                                           CW_USEDEFAULT, CW_USEDEFAULT,
-                                           CW_USEDEFAULT, CW_USEDEFAULT,
-                                           NULL, (HMENU)NULL,
-                                           wxGetInstance(),
-                                           NULL);
+        WXDWORD exflags = 0;
+        if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
+        {
+            exflags |= WS_EX_LAYOUTRTL;
+        }
+
+        // we want to show the tooltips always (even when the window is not
+        // active) and we don't want to strip "&"s from them
+        ms_hwndTT = (WXHWND)::CreateWindowEx(exflags,
+                                             TOOLTIPS_CLASS,
+                                             (LPCTSTR)NULL,
+                                             TTS_ALWAYSTIP | TTS_NOPREFIX,
+                                             CW_USEDEFAULT, CW_USEDEFAULT,
+                                             CW_USEDEFAULT, CW_USEDEFAULT,
+                                             NULL, (HMENU)NULL,
+                                             wxGetInstance(),
+                                             NULL);

        if ( ms_hwndTT )
        {
            HWND hwnd = (HWND)ms_hwndTT;
        if ( ms_hwndTT )
        {
            HWND hwnd = (HWND)ms_hwndTT;


@@ -223,8 +260,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
        }
     }


@@ -232,9 +268,10 @@ WXHWND wxToolTip::GetToolTipCtrl()
     return ms_hwndTT;
 }
 
     return ms_hwndTT;
 }
 

+/* static */

 void wxToolTip::RelayEvent(WXMSG *msg)
 {
 void wxToolTip::RelayEvent(WXMSG *msg)
 {

-    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, 0, msg);
+    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -251,21 +288,27 @@ wxToolTip::wxToolTip(const wxString &tip)
 
 wxToolTip::~wxToolTip()
 {
 
 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
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // 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 )
     {
 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());

     }
 }
 
     }
 }
 


@@ -282,61 +325,91 @@ void wxToolTip::Add(WXHWND hWnd)
     // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
     // of any length
     ti.hwnd = hwnd;
     // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
     // of any length
     ti.hwnd = hwnd;

-    ti.lpszText = (wxChar *)m_text.c_str(); // const_cast
+    ti.lpszText = (wxChar *)m_text.wx_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());
     }
     else
     {
     {
         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 )

         {
         {

-#if _WIN32_IE >= 0x0300
-            if ( wxTheApp->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 )

             {
             {

-                // use TTM_SETMAXWIDTH 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)GetStockObject(DEFAULT_GUI_FONT);

                 if ( !hfont )
                 {
                 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 maxWidth = 0;
+            wxStringTokenizer tokenizer(m_text, _T("\n"));
+            while ( tokenizer.HasMoreTokens() )
+            {
+                const wxString token = tokenizer.GetNextToken();

 
                 SIZE sz;
 
                 SIZE sz;

-                if ( !GetTextExtentPoint(hdc, m_text, index, &sz) )
+                if ( !::GetTextExtentPoint32(hdc, token.wx_str(),
+                                             token.length(), &sz) )

                 {
                 {

-                    wxLogLastError(wxT("GetTextExtentPoint"));
+                    wxLogLastError(wxT("GetTextExtentPoint32"));

                 }
 
                 }
 

-                SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
-                                   0, (void *)sz.cx);
+                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;

             }
             }

-#endif // comctl32.dll >= 4.70

 
 

+            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(" "));
             // 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());
+            }

         }
     }
 }
         }
     }
 }


@@ -353,7 +426,7 @@ void wxToolTip::SetWindow(wxWindow *win)
         Add(m_window->GetHWND());
     }
 #if !defined(__WXUNIVERSAL__)
         Add(m_window->GetHWND());
     }
 #if !defined(__WXUNIVERSAL__)

-    // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
+    // and all of its subcontrols (e.g. radio buttons in a radiobox) as well

     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
     {
     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
     {


@@ -367,7 +440,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
             {
                 // 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);
             }
 
                 hwnd = GetDlgItem(GetHwndOf(m_window->GetParent()), id);
             }
 


@@ -377,22 +450,6 @@ void wxToolTip::SetWindow(wxWindow *win)
             Add((WXHWND)hwnd);
         }
     }
             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__)
 }
 
 #endif // !defined(__WXUNIVERSAL__)
 }
 


@@ -404,9 +461,9 @@ void wxToolTip::SetTip(const wxString& tip)
     {
         // update the tip text shown by the control
         wxToolInfo ti(GetHwndOf(m_window));
     {
         // update the tip text shown by the control
         wxToolInfo ti(GetHwndOf(m_window));

-        ti.lpszText = (wxChar *)m_text.c_str();
+        ti.lpszText = (wxChar *)m_text.wx_str();

 
 

-        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, 0, &ti);
+        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);

     }
 }
 
     }
 }