Fixed tab removal bug, and empty text element

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

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 84f9a38084fd887667e2472d759976de7e33edbd..f43fed3843e996d8ccc8339aa913b10169feb895 100644 (file)
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxToolTip class implementation for MSW
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxToolTip class implementation for MSW
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -23,17 +23,26 @@
     #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"
 

-// include <commctrl.h> "properly"
-#include "wx/msw/wrapcctl.h"
+#ifndef TTTOOLINFO_V1_SIZE
+    #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
 
 // VZ: normally, the trick with subclassing the tooltip control and processing
 //     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the


@@ -52,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


@@ -71,27 +83,50 @@ static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
 class wxToolInfo : public TOOLINFO
 {
 public:
 class wxToolInfo : public TOOLINFO
 {
 public:

-    wxToolInfo(HWND hwndOwner)
+    wxToolInfo(HWND hwndOwner, unsigned int id, const wxRect& rc)

     {
         // initialize all members
         ::ZeroMemory(this, sizeof(TOOLINFO));
 
         // the structure TOOLINFO has been extended with a 4 byte field in
     {
         // 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);
-#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;
 
         hwnd = hwndOwner;

-        uFlags = TTF_IDISHWND;
-        uId = (UINT)hwndOwner;
+
+        if (rc.IsEmpty())
+        {
+            uFlags = TTF_IDISHWND;
+            uId = (UINT_PTR)hwndOwner;
+        }
+        else
+        {
+            // this tooltip must be shown only if the mouse hovers a specific rect
+            // of the hwnd parameter!
+            rect.left = rc.GetLeft();
+            rect.right = rc.GetRight();
+            rect.top = rc.GetTop();
+            rect.bottom = rc.GetBottom();
+
+            // note that not setting TTF_IDISHWND from the uFlags member means that the
+            // ti.uId field should not contain the HWND but rather as MSDN says an
+            // "Application-defined identifier of the tool"; this is used internally by
+            // Windows to distinguish the different tooltips attached to the same window
+            uId = id;
+        }
+
+        // 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;
+        }

     }
 };
 
     }
 };
 


@@ -180,32 +215,67 @@ LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
 
 void wxToolTip::Enable(bool flag)
 {
 
 void wxToolTip::Enable(bool flag)
 {

+    // Make sure the tooltip has been created
+    (void) GetToolTipCtrl();
+

     SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
 }
 
 void wxToolTip::SetDelay(long milliseconds)
 {
     SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
 }
 
 void wxToolTip::SetDelay(long milliseconds)
 {

+    // Make sure the tooltip has been created
+    (void) GetToolTipCtrl();
+

     SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
                             TTDT_INITIAL, milliseconds);
 }
 
     SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
                             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, wxT("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;


@@ -222,6 +292,7 @@ WXHWND wxToolTip::GetToolTipCtrl()
     return ms_hwndTT;
 }
 
     return ms_hwndTT;
 }
 

+/* static */

 void wxToolTip::RelayEvent(WXMSG *msg)
 {
     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);
 void wxToolTip::RelayEvent(WXMSG *msg)
 {
     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);


@@ -237,22 +308,39 @@ wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {
     m_window = NULL;
          : m_text(tip)
 {
     m_window = NULL;

+
+    // make sure m_rect.IsEmpty() == true
+    m_rect.SetWidth(0);
+    m_rect.SetHeight(0);
+
+    // since m_rect is not valid, m_id is ignored by wxToolInfo ctor...
+    m_id = 0;
+}
+
+wxToolTip::wxToolTip(wxWindow* win, unsigned int id, const wxString &tip, const wxRect& rc)
+         : m_text(tip), m_rect(rc), m_id(id)
+{
+    m_window = NULL;
+
+    SetWindow(win);

 }
 
 wxToolTip::~wxToolTip()
 {
     // the tooltip has to be removed before deleting. Otherwise, if it is visible
 }
 
 wxToolTip::~wxToolTip()
 {
     // 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();
+    // while being deleted, there will be a delay before it goes away.
+    Remove();

 }
 
 // ----------------------------------------------------------------------------
 // others
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // others
 // ----------------------------------------------------------------------------
 

-void wxToolTip::Remove(WXHWND hWnd)
+/* static */
+void wxToolTip::Remove(WXHWND hWnd, unsigned int id, const wxRect& rc)

 {
 {

-    wxToolInfo ti((HWND)hWnd);
+    wxToolInfo ti((HWND)hWnd, id, rc);
+

     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti);
 }
 
     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti);
 }
 


@@ -261,7 +349,7 @@ void wxToolTip::Remove()
     // remove this tool from the tooltip control
     if ( m_window )
     {
     // remove this tool from the tooltip control
     if ( m_window )
     {

-        Remove(m_window->GetHWND());
+        Remove(m_window->GetHWND(), m_id, m_rect);

     }
 }
 
     }
 }
 


@@ -269,7 +357,7 @@ void wxToolTip::Add(WXHWND hWnd)
 {
     HWND hwnd = (HWND)hWnd;
 
 {
     HWND hwnd = (HWND)hWnd;
 

-    wxToolInfo ti(hwnd);
+    wxToolInfo ti(hwnd, m_id, m_rect);

 
     // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
     // store the tooltip text ourselves anyhow, and provide it in response to
 
     // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
     // store the tooltip text ourselves anyhow, and provide it in response to


@@ -278,69 +366,98 @@ 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 = const_cast<wxChar *>(m_text.wx_str());

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

-        wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
+        wxLogDebug(wxT("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)"));
-                }
-
-                SIZE sz;
-                if ( !::GetTextExtentPoint32(hdc, m_text, index, &sz) )
-                {
-                    wxLogLastError(wxT("GetTextExtentPoint32"));
-                }
-
-                SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
-                                        (void *)sz.cx);
+                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, wxT("\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.c_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(wxT("\n"), wxT(" "));
+        ti.lpszText = const_cast<wxChar *>(m_text.wx_str());
+
+        if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
+        {
+            wxLogDebug(wxT("Failed to create the tooltip '%s'"), m_text.c_str());

         }
     }
 }
         }
     }
 }


@@ -357,7 +474,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 )
     {


@@ -376,28 +493,23 @@ void wxToolTip::SetWindow(wxWindow *win)
             }
 
             // must have it by now!
             }
 
             // must have it by now!

-            wxASSERT_MSG( hwnd, _T("no hwnd for subcontrol?") );
+            wxASSERT_MSG( hwnd, wxT("no hwnd for subcontrol?") );

 
             Add((WXHWND)hwnd);
         }
     }
 
             Add((WXHWND)hwnd);
         }
     }

+#endif // !defined(__WXUNIVERSAL__)
+}

 
 

-    // 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 )
+void wxToolTip::SetRect(const wxRect& rc)
+{
+    m_rect = rc;
+
+    if ( m_window )

     {
     {

-        WXHWND hwndComboEdit = combo->GetWindowStyle() & wxCB_READONLY
-                                ? combo->GetHWND()
-                                : combo->GetEditHWND();
-        if ( hwndComboEdit )
-        {
-            Add(hwndComboEdit);
-        }
+        wxToolInfo ti(GetHwndOf(m_window), m_id, m_rect);
+        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_NEWTOOLRECT, &ti);

     }
     }

-#endif // !defined(__WXUNIVERSAL__)

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


@@ -407,9 +519,15 @@ void wxToolTip::SetTip(const wxString& tip)
     if ( m_window )
     {
         // update the tip text shown by the control
     if ( m_window )
     {
         // 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), m_id, m_rect);
+
+        // 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 *>(wxT(""));
+        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);

 
 

+        ti.lpszText = const_cast<wxChar *>(m_text.wx_str());

         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
     }
 }
         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
     }
 }