]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/tooltip.cpp
[ 1509599 ] 'Split pickers page in widgets sample' with more icons and rebaking.
[wxWidgets.git] / src / msw / tooltip.cpp
index e8b34e7da0410736529b542dad0b65bd1c8f0c14..8ca70b9ff363b3dc9f4cc3bf9b45d110a8d856bd 100644 (file)
@@ -6,7 +6,7 @@
 // Created:     31.01.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 #include "wx/tooltip.h"
 #include "wx/msw/private.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
+// include <commctrl.h> "properly"
+#include "wx/msw/wrapcctl.h"
 
 // VZ: normally, the trick with subclassing the tooltip control and processing
 //     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
@@ -77,7 +71,7 @@ static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
 class wxToolInfo : public TOOLINFO
 {
 public:
-    wxToolInfo(HWND hwnd)
+    wxToolInfo(HWND hwndOwner)
     {
         // initialize all members
         ::ZeroMemory(this, sizeof(TOOLINFO));
@@ -95,8 +89,9 @@ public:
         cbSize = sizeof(TOOLINFO);
 #endif // compile-time comctl32.dll version
 
+        hwnd = hwndOwner;
         uFlags = TTF_IDISHWND;
-        uId = (UINT)hwnd;
+        uId = (UINT)hwndOwner;
     }
 };
 
@@ -108,23 +103,20 @@ public:
 // 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
-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 +138,13 @@ LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
     {
         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));
 
-        // 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);
 
@@ -202,13 +194,16 @@ void wxToolTip::SetDelay(long milliseconds)
 // ---------------------------------------------------------------------------
 
 // create the tooltip ctrl for our parent frame if it doesn't exist yet
+/* static */
 WXHWND wxToolTip::GetToolTipCtrl()
 {
     if ( !ms_hwndTT )
     {
+        // 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)::CreateWindow(TOOLTIPS_CLASS,
                                            (LPCTSTR)NULL,
-                                           TTS_ALWAYSTIP,
+                                           TTS_ALWAYSTIP | TTS_NOPREFIX,
                                            CW_USEDEFAULT, CW_USEDEFAULT,
                                            CW_USEDEFAULT, CW_USEDEFAULT,
                                            NULL, (HMENU)NULL,
@@ -222,8 +217,7 @@ WXHWND wxToolTip::GetToolTipCtrl()
 
 #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
        }
     }
@@ -231,15 +225,18 @@ WXHWND wxToolTip::GetToolTipCtrl()
     return ms_hwndTT;
 }
 
+/* static */
 void wxToolTip::RelayEvent(WXMSG *msg)
 {
-    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, 0, msg);
+    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);
 }
 
 // ----------------------------------------------------------------------------
 // ctor & dtor
 // ----------------------------------------------------------------------------
 
+IMPLEMENT_ABSTRACT_CLASS(wxToolTip, wxObject)
+
 wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {
@@ -248,21 +245,27 @@ wxToolTip::wxToolTip(const wxString &tip)
 
 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
 // ----------------------------------------------------------------------------
 
+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 )
     {
-        wxToolInfo ti(GetHwndOf(m_window));
-        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, 0, &ti);
+        Remove(m_window->GetHWND());
     }
 }
 
@@ -272,14 +275,16 @@ void wxToolTip::Add(WXHWND 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.lpszText = LPSTR_TEXTCALLBACK;
-    // instead of: ti.lpszText = (char *)m_text.c_str();
+    ti.lpszText = (wxChar *)m_text.c_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());
     }
@@ -290,14 +295,14 @@ void wxToolTip::Add(WXHWND hWnd)
 
         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
-                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);
@@ -307,7 +312,7 @@ void wxToolTip::Add(WXHWND hWnd)
                     }
                 }
 
-                HDC hdc = CreateCompatibleDC(NULL);
+                MemoryHDC hdc;
                 if ( !hdc )
                 {
                     wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
@@ -319,21 +324,27 @@ void wxToolTip::Add(WXHWND hWnd)
                 }
 
                 SIZE sz;
-                if ( !GetTextExtentPoint(hdc, m_text, index, &sz) )
+                if ( !::GetTextExtentPoint32(hdc, m_text, index, &sz) )
                 {
-                    wxLogLastError(wxT("GetTextExtentPoint"));
+                    wxLogLastError(wxT("GetTextExtentPoint32"));
                 }
 
-                DeleteDC(hdc);
-
                 SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
-                                   0, (void *)sz.cx);
+                                        (void *)sz.cx);
             }
+            else
 #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.c_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,7 +360,7 @@ void wxToolTip::SetWindow(wxWindow *win)
     {
         Add(m_window->GetHWND());
     }
-
+#if !defined(__WXUNIVERSAL__)
     // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
@@ -364,7 +375,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
-                // 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);
             }
 
@@ -390,6 +401,7 @@ void wxToolTip::SetWindow(wxWindow *win)
             Add(hwndComboEdit);
         }
     }
+#endif // !defined(__WXUNIVERSAL__)
 }
 
 void wxToolTip::SetTip(const wxString& tip)
@@ -398,11 +410,11 @@ void wxToolTip::SetTip(const wxString& tip)
 
     if ( m_window )
     {
-        // update it immediately
+        // update the tip text shown by the control
         wxToolInfo ti(GetHwndOf(m_window));
         ti.lpszText = (wxChar *)m_text.c_str();
 
-        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, 0, &ti);
+        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
     }
 }