flags moved to chkconf

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

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 128c77e852b8ed075b717a5841d64e412d67e49d..909352209d6e350e7abb96eb6e8a06c4b1363011 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__) || defined(__MINGW32__))
-    #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


@@ -77,26 +80,32 @@ static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
 class wxToolInfo : public TOOLINFO
 {
 public:
 class wxToolInfo : public TOOLINFO
 {
 public:

-    wxToolInfo(HWND hwnd)
+    wxToolInfo(HWND hwndOwner)

     {
         // 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;

         uFlags = TTF_IDISHWND;
         uFlags = TTF_IDISHWND;

-        uId = (UINT)hwnd;
+
+        // 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)hwndOwner;

     }
 };
 
     }
 };
 


@@ -108,23 +117,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);

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


@@ -146,13 +152,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);
 


@@ -197,23 +203,45 @@ 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);
+}
+

 // ---------------------------------------------------------------------------
 // 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,
-                                           (LPSTR)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,8 +250,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
        }
     }


@@ -231,15 +258,18 @@ 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);

 }
 
 // ----------------------------------------------------------------------------
 // ctor & dtor
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // ctor & dtor
 // ----------------------------------------------------------------------------
 

+IMPLEMENT_ABSTRACT_CLASS(wxToolTip, wxObject)
+

 wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {
 wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {


@@ -248,21 +278,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());

     }
 }
 
     }
 }
 


@@ -272,14 +308,16 @@ void wxToolTip::Add(WXHWND hWnd)
 
     wxToolInfo ti(hwnd);
 
 
     wxToolInfo ti(hwnd);
 

-    // as we store our text anyhow, it seems useless to waste system memory
-    // by asking the tooltip ctrl to remember it too - instead it will send
-    // us TTN_NEEDTEXT (via WM_NOTIFY) when it is about to be shown
+    // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
+    // store the tooltip text ourselves anyhow, and provide it in response to
+    // TTN_NEEDTEXT (sent via WM_NOTIFY), but then we would be limited to 79
+    // character tooltips as this is the size of the szText buffer in
+    // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
+    // of any length

     ti.hwnd = hwnd;
     ti.hwnd = hwnd;

-    ti.lpszText = LPSTR_TEXTCALLBACK;
-    // instead of: ti.lpszText = (char *)m_text.c_str();
+    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());
     }
     {
         wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
     }


@@ -290,50 +328,69 @@ void wxToolTip::Add(WXHWND hWnd)
 
         if ( index != wxNOT_FOUND )
         {
 
         if ( index != wxNOT_FOUND )
         {

-#if _WIN32_IE >= 0x0300
-            if ( wxTheApp->GetComCtl32Version() >= 470 )
+#ifdef TTM_SETMAXTIPWIDTH
+            if ( wxApp::GetComCtl32Version() >= 470 )

             {
             {

-                // use TTM_SETMAXWIDTH to make tooltip multiline using the
+                // use TTM_SETMAXTIPWIDTH to make tooltip multiline using the

                 // extent of its first line as max value
                 // 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);
                     if ( !hfont )
                     {
                 if ( !hfont )
                 {
                     hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
                     if ( !hfont )
                     {

-                        wxLogLastError("GetStockObject(DEFAULT_GUI_FONT)");
+                        wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));

                     }
                 }
 
                     }
                 }
 

-                HDC hdc = CreateCompatibleDC(NULL);
+                MemoryHDC hdc;

                 if ( !hdc )
                 {
                 if ( !hdc )
                 {

-                    wxLogLastError("CreateCompatibleDC(NULL)");
+                    wxLogLastError(wxT("CreateCompatibleDC(NULL)"));

                 }
 
                 if ( !SelectObject(hdc, hfont) )
                 {
                 }
 
                 if ( !SelectObject(hdc, hfont) )
                 {

-                    wxLogLastError("SelectObject(hfont)");
+                    wxLogLastError(wxT("SelectObject(hfont)"));

                 }
 
                 }
 

-                SIZE sz;
-                if ( !GetTextExtentPoint(hdc, m_text, index, &sz) )
+                // find the width of the widest line
+                int max = 0;
+                wxStringTokenizer tokenizer(m_text, _T("\n"));
+                wxString token = tokenizer.GetNextToken();
+                while (token.length())

                 {
                 {

-                    wxLogLastError("GetTextExtentPoint");
-                }
+                    SIZE sz;
+                    if ( !::GetTextExtentPoint32(hdc, token.wx_str(), token.length(), &sz) )
+                    {
+                        wxLogLastError(wxT("GetTextExtentPoint32"));
+                    }
+                    if ( sz.cx > max )
+                        max = sz.cx;

 
 

-                DeleteDC(hdc);
+                    token = tokenizer.GetNextToken();
+                }

 
 

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

             }
             }

+            else

 #endif // comctl32.dll >= 4.70
 #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.wx_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());
+                }
+            }

         }
     }
 }
         }
     }
 }


@@ -349,8 +406,8 @@ void wxToolTip::SetWindow(wxWindow *win)
     {
         Add(m_window->GetHWND());
     }
     {
         Add(m_window->GetHWND());
     }

-
-    // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
+#if !defined(__WXUNIVERSAL__)
+    // 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 )
     {


@@ -364,7 +421,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);
             }
 


@@ -374,6 +431,7 @@ void wxToolTip::SetWindow(wxWindow *win)
             Add((WXHWND)hwnd);
         }
     }
             Add((WXHWND)hwnd);
         }
     }

+#endif // !defined(__WXUNIVERSAL__)

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


@@ -382,11 +440,11 @@ void wxToolTip::SetTip(const wxString& tip)
 
     if ( m_window )
     {
 
     if ( m_window )
     {

-        // update it immediately
+        // update the tip text shown by the control

         wxToolInfo ti(GetHwndOf(m_window));
         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);

     }
 }
 
     }
 }