Initial revision

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

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 7fe905694920f7e90e22ce6daa2953b84b04b5f4..2b6f2f55756607d655f11939db0c1919b69bc59d 100644 (file)
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -27,32 +27,77 @@
     #include "wx/wx.h"
 #endif
 
     #include "wx/wx.h"
 #endif
 

+#if wxUSE_TOOLTIPS
+

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

-#if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__)
-#include <commctrl.h>
+#if defined(__WIN95__) && (!defined(__GNUWIN32__) || defined(__MINGW32__))
+    #include <commctrl.h>

 #endif
 
 #endif
 

+// VZ: normally, the trick with subclassing the tooltip control and processing
+//     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
+//     code here for now (but it's not compiled) in case we need it later.
+//
+//     For now, instead of this, we just add all radiobox buttons to the
+//     tooltip control as well (see SetWindow) - this is probably less
+//     efficient, but it works.
+#define wxUSE_TTM_WINDOWFROMPOINT   1
+
+// ----------------------------------------------------------------------------
+// global variables
+// ----------------------------------------------------------------------------
+
+// the tooltip parent window
+WXHWND wxToolTip::ms_hwndTT = (WXHWND)NULL;
+
+#if wxUSE_TTM_WINDOWFROMPOINT
+
+// the tooltip window proc
+static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
+
+#endif // wxUSE_TTM_WINDOWFROMPOINT
+

 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------
 

-// a simple wrapper around TOOLINFO Win32 structure
+// a wrapper around TOOLINFO Win32 structure
+#ifdef __VISUALC__
+    #pragma warning( disable : 4097 ) // we inherit from a typedef - so what?
+#endif
+

 class wxToolInfo : public TOOLINFO
 {
 public:
 class wxToolInfo : public TOOLINFO
 {
 public:

-    wxToolInfo(wxWindow *win)
+    wxToolInfo(HWND hwnd)

     {
         // initialize all members
         ::ZeroMemory(this, sizeof(TOOLINFO));
 
     {
         // 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 defined(_WIN32_IE) && (_WIN32_IE >= 0x0300)
+        cbSize = sizeof(TOOLINFO) - sizeof(LPARAM);
+#else // old headers

         cbSize = sizeof(TOOLINFO);
         cbSize = sizeof(TOOLINFO);

+#endif // compile-time comctl32.dll version
+

         uFlags = TTF_IDISHWND;
         uFlags = TTF_IDISHWND;

-        uId = (UINT)win->GetHWND();
+        uId = (UINT)hwnd;

     }
 };
 
     }
 };
 

+#ifdef __VISUALC__
+    #pragma warning( default : 4097 )
+#endif
+

 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------


@@ -67,65 +112,113 @@ inline LRESULT SendTooltipMessage(WXHWND hwnd,
                 : 0;
 }
 
                 : 0;
 }
 

+// send a message to all existing tooltip controls
+static void SendTooltipMessageToAll(WXHWND hwnd,
+                                    UINT msg,
+                                    WPARAM wParam,
+                                    LPARAM lParam)
+{
+    (void)SendTooltipMessage((WXHWND)hwnd, msg, wParam, (void *)lParam);
+}
+

 // ============================================================================
 // implementation
 // ============================================================================
 
 // ============================================================================
 // implementation
 // ============================================================================
 

+#if wxUSE_TTM_WINDOWFROMPOINT
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// "semiglobal" functions - these methods work with the tooltip control which
-// is shared among all the wxToolTips of the same frame
+// window proc for our tooltip control

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// create the tooltip ctrl for our parent frame if it doesn't exist yet
-WXHWND wxToolTip::GetToolTipCtrl()
+LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
+                                  UINT msg,
+                                  WPARAM wParam,
+                                  LPARAM lParam)

 {
 {

-    wxWindow *parent = m_window;
-    while ( parent && !parent->IsKindOf(CLASSINFO(wxFrame)) )
+    if ( msg == TTM_WINDOWFROMPOINT )

     {
     {

-        parent = parent->GetParent();
-    }
+        LPPOINT ppt = (LPPOINT)lParam;
+        // is the window under control a wxWindow?
+        HWND hwnd = ::WindowFromPoint(*ppt);

 
 

-    wxCHECK_MSG( parent, 0, "can't create tooltip control outside a frame" );
-
-    wxFrame *frame = (wxFrame *)parent;
-    HWND hwndTT = (HWND)frame->GetToolTipCtrl();
-    if ( !hwndTT )
-    {
-        hwndTT = ::CreateWindow(TOOLTIPS_CLASS,
-                                (LPSTR)NULL,
-                                TTS_ALWAYSTIP,
-                                CW_USEDEFAULT, CW_USEDEFAULT,
-                                CW_USEDEFAULT, CW_USEDEFAULT,
-                                (HWND)frame->GetHWND(), (HMENU)NULL,
-                                wxGetInstance(), NULL);
-
-        if ( hwndTT )
+        // return a HWND correspondign to wxWindow because only wxWindows are
+        // associated with tooltips using TTM_ADDTOOL
+        while ( hwnd && !wxFindWinFromHandle((WXHWND)hwnd) )

         {
         {

-            frame->SetToolTipCtrl((WXHWND)hwndTT);
+            hwnd = ::GetParent(hwnd);

         }
         }

-        else
+
+        if ( hwnd )

         {
         {

-            wxLogSysError(_("Can not create tooltip control"));
+            // modify the point too!
+            RECT rect;
+            GetWindowRect(hwnd, &rect);
+
+            ppt->x = rect.left;
+            ppt->y = rect.top;
+
+            return (LRESULT)hwnd;

         }
     }
 
         }
     }
 

-    return (WXHWND)hwndTT;
+    return ::CallWindowProc(gs_wndprocToolTip, hwndTT, msg, wParam, lParam);

 }
 
 }
 

+#endif // wxUSE_TTM_WINDOWFROMPOINT
+
+// ----------------------------------------------------------------------------
+// static functions
+// ----------------------------------------------------------------------------
+

 void wxToolTip::Enable(bool flag)
 {
 void wxToolTip::Enable(bool flag)
 {

-    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_ACTIVATE, flag, 0);
+    SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);

 }
 
 }
 

-void wxToolTip::RelayEvent(WXMSG *msg)
+void wxToolTip::SetDelay(long milliseconds)

 {
 {

-    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, 0, msg);
+    SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
+                            TTDT_INITIAL, milliseconds);

 }
 
 }
 

-void wxToolTip::SetDelay(long milliseconds)
+// ---------------------------------------------------------------------------
+// implementation helpers
+// ---------------------------------------------------------------------------
+
+// create the tooltip ctrl for our parent frame if it doesn't exist yet
+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);
+       if ( ms_hwndTT )
+       {
+           HWND hwnd = (HWND)ms_hwndTT;
+           SetWindowPos(hwnd, HWND_TOPMOST, 0, 0, 0, 0,
+                        SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
+
+#if wxUSE_TTM_WINDOWFROMPOINT
+           // subclass the newly created control
+           gs_wndprocToolTip = (WNDPROC)::GetWindowLong(hwnd, GWL_WNDPROC);
+           ::SetWindowLong(hwnd, GWL_WNDPROC, (long)wxToolTipWndProc);
+#endif // wxUSE_TTM_WINDOWFROMPOINT
+       }
+    }
+
+    return ms_hwndTT;
+}
+
+void wxToolTip::RelayEvent(WXMSG *msg)

 {
 {

-    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_SETDELAYTIME,
-                             TTDT_INITIAL, (void *)milliseconds);
+    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, 0, msg);

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


@@ -153,34 +246,60 @@ void wxToolTip::Remove()
     // remove this tool from the tooltip control
     if ( m_window )
     {
     // remove this tool from the tooltip control
     if ( m_window )
     {

-        wxToolInfo ti(m_window);
+        wxToolInfo ti(GetHwndOf(m_window));

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

+void wxToolTip::Add(WXHWND hWnd)
+{
+    HWND hwnd = (HWND)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
+    ti.hwnd = hwnd;
+    ti.lpszText = LPSTR_TEXTCALLBACK;
+    // instead of: ti.lpszText = (char *)m_text.c_str();
+
+    if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, 0, &ti) )
+    {
+        wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
+    }
+}
+

 void wxToolTip::SetWindow(wxWindow *win)
 {
     Remove();
 
     m_window = win;
 
 void wxToolTip::SetWindow(wxWindow *win)
 {
     Remove();
 
     m_window = win;
 

+    // add the window itself

     if ( m_window )
     {
     if ( m_window )
     {

-        wxToolInfo ti(m_window);
-
-        // 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
-        ti.hwnd = (HWND)m_window->GetHWND();
-        ti.lpszText = LPSTR_TEXTCALLBACK;
-        // instead of: ti.lpszText = (char *)m_text.c_str();
+        Add(m_window->GetHWND());
+    }

 
 

-        if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, 0, &ti) )
+#if 1 //!wxUSE_TTM_WINDOWFROMPOINT
+    // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
+    wxControl *control = wxDynamicCast(m_window, wxControl);
+    if ( control )
+    {
+        size_t count = control->GetSubcontrols().GetCount();
+        for ( size_t n = 0; n < count; n++ )

         {
         {

-            wxLogSysError(_("Failed to create the tooltip '%s'"),
-                          m_text.c_str());
+            wxWindowID id = control->GetSubcontrols()[n];
+            HWND hwnd = GetDlgItem(GetHwndOf(m_window), id);
+
+            if ( hwnd )
+            {
+                Add((WXHWND)hwnd);
+            }

         }
     }
         }
     }

+#endif // !wxUSE_TTM_WINDOWFROMPOINT

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


@@ -190,9 +309,11 @@ void wxToolTip::SetTip(const wxString& tip)
     if ( m_window )
     {
         // update it immediately
     if ( m_window )
     {
         // update it immediately

-        wxToolInfo ti(m_window);
-        ti.lpszText = (char *)m_text.c_str();
+        wxToolInfo ti(GetHwndOf(m_window));
+        ti.lpszText = (wxChar *)m_text.c_str();

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

+
+#endif // wxUSE_TOOLTIPS