]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/tooltip.cpp
added SetStatusText method (avoiding dc.Clear)
[wxWidgets.git] / src / msw / tooltip.cpp
index c119026190fc3039312275d01d5aea67554f4a58..930748cdbf1cf5b33ac47d6beaf93417fbf405fa 100644 (file)
 #include "wx/tooltip.h"
 #include "wx/msw/private.h"
 
-#if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__)
-#include <commctrl.h>
+#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
+    #include <commctrl.h>
 #endif
 
+#ifndef _WIN32_IE
+    // minimal set of features by default
+    #define _WIN32_IE 0x0200
+#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 I use an ugly workaround and process TTN_NEEDTEXT directly in
+//     radio button wnd proc - fixing TTM_WINDOWFROMPOINT code would be nice
+//     because it would then work for all controls, not only radioboxes but for
+//     now I don't understand what's wrong with it...
+#define wxUSE_TTM_WINDOWFROMPOINT   0
+
+// ----------------------------------------------------------------------------
+// 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
 // ----------------------------------------------------------------------------
 
-// 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:
-    wxToolInfo(wxWindow *win)
+    wxToolInfo(HWND hwnd)
     {
         // initialize all members
-#ifdef __GNUWIN32__
-        memset(this, 0, sizeof(TOOLINFO));
-#else
         ::ZeroMemory(this, sizeof(TOOLINFO));
-#endif
 
+        // 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
+
         uFlags = TTF_IDISHWND;
-        uId = (UINT)win->GetHWND();
+        uId = (UINT)hwnd;
     }
 };
 
+#ifdef __VISUALC__
+    #pragma warning( default : 4097 )
+#endif
+
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
@@ -74,57 +119,68 @@ inline LRESULT SendTooltipMessage(WXHWND hwnd,
 }
 
 // send a message to all existing tooltip controls
-static void SendTooltipMessageToAll(UINT msg, WPARAM wParam, LPARAM lParam)
+static void SendTooltipMessageToAll(WXHWND hwnd,
+                                    UINT msg,
+                                    WPARAM wParam,
+                                    LPARAM lParam)
 {
-    // NB: it might be somewhat easier to maintain a list of all existing
-    //     wxToolTip controls (put them there in ctor, delete from the list
-    //     in dtor) - may be it's worth doing it this way? OTOH, typical
-    //     application won't have many top level windows, so iterating over all
-    //     of them shouldnt' take much time neither...
-
-    // iterate over all top level windows and send message to the tooltip
-    // control of each and every of them (or more precisely to all dialogs and
-    // frames)
-    wxDialog *dialog = NULL;
-    wxFrame *frame = NULL;
-
-    wxNode *node = wxTopLevelWindows.First();
-    while ( node )
+    (void)SendTooltipMessage((WXHWND)hwnd, msg, wParam, (void *)lParam);
+}
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+#if wxUSE_TTM_WINDOWFROMPOINT
+
+// ----------------------------------------------------------------------------
+// window proc for our tooltip control
+// ----------------------------------------------------------------------------
+
+LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
+                                  UINT msg,
+                                  WPARAM wParam,
+                                  LPARAM lParam)
+{
+    if ( msg == TTM_WINDOWFROMPOINT )
     {
-        wxWindow *win = (wxWindow *)node->Data();
+        LPPOINT ppt = (LPPOINT)lParam;
 
-        node = node->Next();
+        // the window on which event occured
+        HWND hwnd = ::WindowFromPoint(*ppt);
 
-        if ( win->IsKindOf(CLASSINFO(wxFrame)) )
-        {
-            frame = (wxFrame *)win;
-            dialog = NULL;
-        }
-        else if ( win->IsKindOf(CLASSINFO(wxDialog)) )
+        OutputDebugString("TTM_WINDOWFROMPOINT: ");
+        OutputDebugString(wxString::Format("0x%08x => ", hwnd));
+
+        // return a HWND corresponding to a wxWindow because only wxWindows are
+        // associated with tooltips using TTM_ADDTOOL
+        wxWindow *win = wxGetWindowFromHWND((WXHWND)hwnd);
+
+        if ( win )
         {
-            dialog = (wxDialog *)win;
-            frame = NULL;
+            hwnd = GetHwndOf(win);
+            OutputDebugString(wxString::Format("0x%08x\r\n", hwnd));
+
+#if 0
+            // modify the point too!
+            RECT rect;
+            GetWindowRect(hwnd, &rect);
+
+            ppt->x = (rect.right - rect.left) / 2;
+            ppt->y = (rect.bottom - rect.top) / 2;
+#endif // 0
+            return (LRESULT)hwnd;
         }
         else
         {
-            // skip this strange top level window
-            continue;
-        }
-
-        wxASSERT_MSG( dialog || frame, _T("logic error") );
-
-        WXHWND hwndTT = frame ? frame->GetToolTipCtrl()
-                              : dialog->GetToolTipCtrl();
-        if ( hwndTT )
-        {
-            (void)SendTooltipMessage(hwndTT, msg, wParam, (void *)lParam);
+            OutputDebugString("no window\r\n");
         }
     }
+
+    return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip, hwndTT, msg, wParam, lParam);
 }
 
-// ============================================================================
-// implementation
-// ============================================================================
+#endif // wxUSE_TTM_WINDOWFROMPOINT
 
 // ----------------------------------------------------------------------------
 // static functions
@@ -132,12 +188,13 @@ static void SendTooltipMessageToAll(UINT msg, WPARAM wParam, LPARAM lParam)
 
 void wxToolTip::Enable(bool flag)
 {
-    SendTooltipMessageToAll(TTM_ACTIVATE, flag, 0);
+    SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
 }
 
 void wxToolTip::SetDelay(long milliseconds)
 {
-    SendTooltipMessageToAll(TTM_SETDELAYTIME, TTDT_INITIAL, milliseconds);
+    SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
+                            TTDT_INITIAL, milliseconds);
 }
 
 // ---------------------------------------------------------------------------
@@ -147,60 +204,31 @@ void wxToolTip::SetDelay(long milliseconds)
 // create the tooltip ctrl for our parent frame if it doesn't exist yet
 WXHWND wxToolTip::GetToolTipCtrl()
 {
-    // find either parent dialog or parent frame - tooltip controls are managed
-    // by these 2 classes only (it doesn't make sense to create one tooltip per
-    // each and every wxWindow)
-    wxFrame *frame = NULL;
-    wxDialog *dialog = NULL;
-
-    wxWindow *parent = m_window;
-    while ( parent )
+    if ( !ms_hwndTT )
     {
-        if ( parent->IsKindOf(CLASSINFO(wxFrame)) )
-        {
-            frame = (wxFrame *)parent;
-
-            break;
-        }
-        else if ( parent->IsKindOf(CLASSINFO(wxDialog)) )
-        {
-            dialog = (wxDialog *)parent;
-
-            break;
-        }
-
-        parent = parent->GetParent();
+        ms_hwndTT = (WXHWND)::CreateWindow(TOOLTIPS_CLASS,
+                                           (LPCTSTR)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
+       }
     }
 
-    wxCHECK_MSG( frame || dialog, 0,
-                 _T("can't create tooltip control outside a frame or a dialog") );
-
-    HWND hwndTT = (HWND)(frame ? frame->GetToolTipCtrl()
-                               : dialog->GetToolTipCtrl());
-    if ( !hwndTT )
-    {
-        hwndTT = ::CreateWindow(TOOLTIPS_CLASS,
-                                (LPSTR)NULL,
-                                TTS_ALWAYSTIP,
-                                CW_USEDEFAULT, CW_USEDEFAULT,
-                                CW_USEDEFAULT, CW_USEDEFAULT,
-                                (HWND)parent->GetHWND(), (HMENU)NULL,
-                                wxGetInstance(), NULL);
-
-        if ( hwndTT )
-        {
-            if ( frame )
-                frame->SetToolTipCtrl((WXHWND)hwndTT);
-            else
-                dialog->SetToolTipCtrl((WXHWND)hwndTT);
-        }
-        else
-        {
-            wxLogSysError(_("Can not create tooltip control"));
-        }
-    }
-
-    return (WXHWND)hwndTT;
+    return ms_hwndTT;
 }
 
 void wxToolTip::RelayEvent(WXMSG *msg)
@@ -212,6 +240,8 @@ void wxToolTip::RelayEvent(WXMSG *msg)
 // ctor & dtor
 // ----------------------------------------------------------------------------
 
+IMPLEMENT_ABSTRACT_CLASS(wxToolTip, wxObject)
+
 wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {
@@ -233,32 +263,133 @@ void wxToolTip::Remove()
     // 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 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());
+    }
+    else
+    {
+        // check for multiline toopltip
+        int index = m_text.Find(_T('\n'));
+
+        if ( index != wxNOT_FOUND )
+        {
+#if _WIN32_IE >= 0x0300
+            if ( wxTheApp->GetComCtl32Version() >= 470 )
+            {
+                // 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);
+                if ( !hfont )
+                {
+                    hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
+                    if ( !hfont )
+                    {
+                        wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
+                    }
+                }
+
+                HDC hdc = CreateCompatibleDC(NULL);
+                if ( !hdc )
+                {
+                    wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
+                }
+
+                if ( !SelectObject(hdc, hfont) )
+                {
+                    wxLogLastError(wxT("SelectObject(hfont)"));
+                }
+
+                SIZE sz;
+                if ( !GetTextExtentPoint(hdc, m_text, index, &sz) )
+                {
+                    wxLogLastError(wxT("GetTextExtentPoint"));
+                }
+
+                DeleteDC(hdc);
+
+                SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
+                                   0, (void *)sz.cx);
+            }
+#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(" "));
+        }
+    }
+}
+
 void wxToolTip::SetWindow(wxWindow *win)
 {
     Remove();
 
     m_window = win;
 
+    // add the window itself
     if ( m_window )
     {
-        wxToolInfo ti(m_window);
+        Add(m_window->GetHWND());
+    }
 
-        // 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();
+    // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
+    wxControl *control = wxDynamicCast(m_window, wxControl);
+    if ( control )
+    {
+        const wxArrayLong& subcontrols = control->GetSubcontrols();
+        size_t count = subcontrols.GetCount();
+        for ( size_t n = 0; n < count; n++ )
+        {
+            int id = subcontrols[n];
+            HWND hwnd = GetDlgItem(GetHwndOf(m_window), id);
+            if ( !hwnd )
+            {
+                // 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)
+                hwnd = GetDlgItem(GetHwndOf(m_window->GetParent()), id);
+            }
+
+            // must have it by now!
+            wxASSERT_MSG( hwnd, _T("no hwnd for subcontrol?") );
+
+            Add((WXHWND)hwnd);
+        }
+    }
 
-        if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, 0, &ti) )
+    // 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 )
         {
-            wxLogSysError(_("Failed to create the tooltip '%s'"),
-                          m_text.c_str());
+            Add(hwndComboEdit);
         }
     }
 }
@@ -270,7 +401,7 @@ void wxToolTip::SetTip(const wxString& tip)
     if ( m_window )
     {
         // update it immediately
-        wxToolInfo ti(m_window);
+        wxToolInfo ti(GetHwndOf(m_window));
         ti.lpszText = (wxChar *)m_text.c_str();
 
         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, 0, &ti);