src/msw/tooltip.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/tooltip.cpp
   3 // Purpose:     wxToolTip class implementation for MSW
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     31.01.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1999 Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #ifndef WX_PRECOMP
  27     #include "wx/wx.h"
  28 #endif
  29
  30 #if wxUSE_TOOLTIPS
  31
  32 #include "wx/tooltip.h"
  33 #include "wx/msw/private.h"
  34
  35 // include <commctrl.h> "properly"
  36 #include "wx/msw/wrapcctl.h"
  37
  38 // VZ: normally, the trick with subclassing the tooltip control and processing
  39 //     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
  40 //     code here for now (but it's not compiled) in case we need it later.
  41 //
  42 //     For now I use an ugly workaround and process TTN_NEEDTEXT directly in
  43 //     radio button wnd proc - fixing TTM_WINDOWFROMPOINT code would be nice
  44 //     because it would then work for all controls, not only radioboxes but for
  45 //     now I don't understand what's wrong with it...
  46 #define wxUSE_TTM_WINDOWFROMPOINT   0
  47
  48 // ----------------------------------------------------------------------------
  49 // global variables
  50 // ----------------------------------------------------------------------------
  51
  52 // the tooltip parent window
  53 WXHWND wxToolTip::ms_hwndTT = (WXHWND)NULL;
  54
  55 #if wxUSE_TTM_WINDOWFROMPOINT
  56
  57 // the tooltip window proc
  58 static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
  59
  60 #endif // wxUSE_TTM_WINDOWFROMPOINT
  61
  62 // ----------------------------------------------------------------------------
  63 // private classes
  64 // ----------------------------------------------------------------------------
  65
  66 // a wrapper around TOOLINFO Win32 structure
  67 #ifdef __VISUALC__
  68     #pragma warning( disable : 4097 ) // we inherit from a typedef - so what?
  69 #endif
  70
  71 class wxToolInfo : public TOOLINFO
  72 {
  73 public:
  74     wxToolInfo(HWND hwndOwner)
  75     {
  76         // initialize all members
  77         ::ZeroMemory(this, sizeof(TOOLINFO));
  78
  79         // the structure TOOLINFO has been extended with a 4 byte field in
  80         // version 4.70 of comctl32.dll and if we compile on a newer machine
  81         // but run on one with the old version of comctl32, nothing will work
  82         // because the library will detect that we rely on a more recent
  83         // version of it. So we always use the old size - if we ever start
  84         // using our lParam member, we'd have to check for comctl32 version
  85         // during run-time
  86 #if _WIN32_IE >= 0x0300
  87         cbSize = sizeof(TOOLINFO) - sizeof(LPARAM);
  88 #else // old headers
  89         cbSize = sizeof(TOOLINFO);
  90 #endif // compile-time comctl32.dll version
  91
  92         hwnd = hwndOwner;
  93         uFlags = TTF_IDISHWND;
  94         uId = (UINT)hwndOwner;
  95     }
  96 };
  97
  98 #ifdef __VISUALC__
  99     #pragma warning( default : 4097 )
 100 #endif
 101
 102 // ----------------------------------------------------------------------------
 103 // private functions
 104 // ----------------------------------------------------------------------------
 105
 106 // send a message to the tooltip control if it exists
 107 //
 108 // NB: wParam is always 0 for the TTM_XXX messages we use
 109 static inline LRESULT SendTooltipMessage(WXHWND hwnd, UINT msg, void *lParam)
 110 {
 111     return hwnd ? ::SendMessage((HWND)hwnd, msg, 0, (LPARAM)lParam) : 0;
 112 }
 113
 114 // send a message to all existing tooltip controls
 115 static inline void
 116 SendTooltipMessageToAll(WXHWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
 117 {
 118     if ( hwnd )
 119         ::SendMessage((HWND)hwnd, msg, wParam, lParam);
 120 }
 121
 122 // ============================================================================
 123 // implementation
 124 // ============================================================================
 125
 126 #if wxUSE_TTM_WINDOWFROMPOINT
 127
 128 // ----------------------------------------------------------------------------
 129 // window proc for our tooltip control
 130 // ----------------------------------------------------------------------------
 131
 132 LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
 133                                   UINT msg,
 134                                   WPARAM wParam,
 135                                   LPARAM lParam)
 136 {
 137     if ( msg == TTM_WINDOWFROMPOINT )
 138     {
 139         LPPOINT ppt = (LPPOINT)lParam;
 140
 141         // the window on which event occurred
 142         HWND hwnd = ::WindowFromPoint(*ppt);
 143
 144         OutputDebugString("TTM_WINDOWFROMPOINT: ");
 145         OutputDebugString(wxString::Format("0x%08x => ", hwnd));
 146
 147         // return a HWND corresponding to a wxWindow because only wxWidgets are
 148         // associated with tooltips using TTM_ADDTOOL
 149         wxWindow *win = wxGetWindowFromHWND((WXHWND)hwnd);
 150
 151         if ( win )
 152         {
 153             hwnd = GetHwndOf(win);
 154             OutputDebugString(wxString::Format("0x%08x\r\n", hwnd));
 155
 156 #if 0
 157             // modify the point too!
 158             RECT rect;
 159             GetWindowRect(hwnd, &rect);
 160
 161             ppt->x = (rect.right - rect.left) / 2;
 162             ppt->y = (rect.bottom - rect.top) / 2;
 163 #endif // 0
 164             return (LRESULT)hwnd;
 165         }
 166         else
 167         {
 168             OutputDebugString("no window\r\n");
 169         }
 170     }
 171
 172     return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip, hwndTT, msg, wParam, lParam);
 173 }
 174
 175 #endif // wxUSE_TTM_WINDOWFROMPOINT
 176
 177 // ----------------------------------------------------------------------------
 178 // static functions
 179 // ----------------------------------------------------------------------------
 180
 181 void wxToolTip::Enable(bool flag)
 182 {
 183     SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
 184 }
 185
 186 void wxToolTip::SetDelay(long milliseconds)
 187 {
 188     SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
 189                             TTDT_INITIAL, milliseconds);
 190 }
 191
 192 // ---------------------------------------------------------------------------
 193 // implementation helpers
 194 // ---------------------------------------------------------------------------
 195
 196 // create the tooltip ctrl for our parent frame if it doesn't exist yet
 197 /* static */
 198 WXHWND wxToolTip::GetToolTipCtrl()
 199 {
 200     if ( !ms_hwndTT )
 201     {
 202         // we want to show the tooltips always (even when the window is not
 203         // active) and we don't want to strip "&"s from them
 204         ms_hwndTT = (WXHWND)::CreateWindow(TOOLTIPS_CLASS,
 205                                            (LPCTSTR)NULL,
 206                                            TTS_ALWAYSTIP | TTS_NOPREFIX,
 207                                            CW_USEDEFAULT, CW_USEDEFAULT,
 208                                            CW_USEDEFAULT, CW_USEDEFAULT,
 209                                            NULL, (HMENU)NULL,
 210                                            wxGetInstance(),
 211                                            NULL);
 212        if ( ms_hwndTT )
 213        {
 214            HWND hwnd = (HWND)ms_hwndTT;
 215            SetWindowPos(hwnd, HWND_TOPMOST, 0, 0, 0, 0,
 216                         SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
 217
 218 #if wxUSE_TTM_WINDOWFROMPOINT
 219            // subclass the newly created control
 220            gs_wndprocToolTip = wxSetWindowProc(hwnd, wxToolTipWndProc);
 221 #endif // wxUSE_TTM_WINDOWFROMPOINT
 222        }
 223     }
 224
 225     return ms_hwndTT;
 226 }
 227
 228 /* static */
 229 void wxToolTip::RelayEvent(WXMSG *msg)
 230 {
 231     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);
 232 }
 233
 234 // ----------------------------------------------------------------------------
 235 // ctor & dtor
 236 // ----------------------------------------------------------------------------
 237
 238 IMPLEMENT_ABSTRACT_CLASS(wxToolTip, wxObject)
 239
 240 wxToolTip::wxToolTip(const wxString &tip)
 241          : m_text(tip)
 242 {
 243     m_window = NULL;
 244 }
 245
 246 wxToolTip::~wxToolTip()
 247 {
 248     // the tooltip has to be removed before deleting. Otherwise, if it is visible
 249         // while being deleted, there will be a delay before it goes away.
 250         Remove();
 251 }
 252
 253 // ----------------------------------------------------------------------------
 254 // others
 255 // ----------------------------------------------------------------------------
 256
 257 void wxToolTip::Remove(WXHWND hWnd)
 258 {
 259     wxToolInfo ti((HWND)hWnd);
 260     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti);
 261 }
 262
 263 void wxToolTip::Remove()
 264 {
 265     // remove this tool from the tooltip control
 266     if ( m_window )
 267     {
 268         Remove(m_window->GetHWND());
 269     }
 270 }
 271
 272 void wxToolTip::Add(WXHWND hWnd)
 273 {
 274     HWND hwnd = (HWND)hWnd;
 275
 276     wxToolInfo ti(hwnd);
 277
 278     // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
 279     // store the tooltip text ourselves anyhow, and provide it in response to
 280     // TTN_NEEDTEXT (sent via WM_NOTIFY), but then we would be limited to 79
 281     // character tooltips as this is the size of the szText buffer in
 282     // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
 283     // of any length
 284     ti.hwnd = hwnd;
 285     ti.lpszText = (wxChar *)m_text.c_str(); // const_cast
 286
 287     if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
 288     {
 289         wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
 290     }
 291     else
 292     {
 293         // check for multiline toopltip
 294         int index = m_text.Find(_T('\n'));
 295
 296         if ( index != wxNOT_FOUND )
 297         {
 298 #ifdef TTM_SETMAXTIPWIDTH
 299             if ( wxApp::GetComCtl32Version() >= 470 )
 300             {
 301                 // use TTM_SETMAXTIPWIDTH to make tooltip multiline using the
 302                 // extent of its first line as max value
 303                 HFONT hfont = (HFONT)
 304                     SendTooltipMessage(GetToolTipCtrl(), WM_GETFONT, 0);
 305
 306                 if ( !hfont )
 307                 {
 308                     hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
 309                     if ( !hfont )
 310                     {
 311                         wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
 312                     }
 313                 }
 314
 315                 MemoryHDC hdc;
 316                 if ( !hdc )
 317                 {
 318                     wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
 319                 }
 320
 321                 if ( !SelectObject(hdc, hfont) )
 322                 {
 323                     wxLogLastError(wxT("SelectObject(hfont)"));
 324                 }
 325
 326                 SIZE sz;
 327                 if ( !::GetTextExtentPoint32(hdc, m_text, index, &sz) )
 328                 {
 329                     wxLogLastError(wxT("GetTextExtentPoint32"));
 330                 }
 331
 332                 SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
 333                                         (void *)sz.cx);
 334             }
 335             else
 336 #endif // comctl32.dll >= 4.70
 337             {
 338                 // replace the '\n's with spaces because otherwise they appear as
 339                 // unprintable characters in the tooltip string
 340                 m_text.Replace(_T("\n"), _T(" "));
 341                 ti.lpszText = (wxChar *)m_text.c_str(); // const_cast
 342
 343                 if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
 344                 {
 345                     wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
 346                 }
 347             }
 348         }
 349     }
 350 }
 351
 352 void wxToolTip::SetWindow(wxWindow *win)
 353 {
 354     Remove();
 355
 356     m_window = win;
 357
 358     // add the window itself
 359     if ( m_window )
 360     {
 361         Add(m_window->GetHWND());
 362     }
 363 #if !defined(__WXUNIVERSAL__)
 364     // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
 365     wxControl *control = wxDynamicCast(m_window, wxControl);
 366     if ( control )
 367     {
 368         const wxArrayLong& subcontrols = control->GetSubcontrols();
 369         size_t count = subcontrols.GetCount();
 370         for ( size_t n = 0; n < count; n++ )
 371         {
 372             int id = subcontrols[n];
 373             HWND hwnd = GetDlgItem(GetHwndOf(m_window), id);
 374             if ( !hwnd )
 375             {
 376                 // may be it's a child of parent of the control, in fact?
 377                 // (radiobuttons are subcontrols, i.e. children of the radiobox
 378                 // for wxWidgets but are its siblings at Windows level)
 379                 hwnd = GetDlgItem(GetHwndOf(m_window->GetParent()), id);
 380             }
 381
 382             // must have it by now!
 383             wxASSERT_MSG( hwnd, _T("no hwnd for subcontrol?") );
 384
 385             Add((WXHWND)hwnd);
 386         }
 387     }
 388
 389     // VZ: it's ugly to do it here, but I don't want any major changes right
 390     //     now, later we will probably want to have wxWindow::OnGotToolTip() or
 391     //     something like this where the derived class can do such things
 392     //     itself instead of wxToolTip "knowing" about them all
 393     wxComboBox *combo = wxDynamicCast(control, wxComboBox);
 394     if ( combo )
 395     {
 396         WXHWND hwndComboEdit = combo->GetWindowStyle() & wxCB_READONLY
 397                                 ? combo->GetHWND()
 398                                 : combo->GetEditHWND();
 399         if ( hwndComboEdit )
 400         {
 401             Add(hwndComboEdit);
 402         }
 403     }
 404 #endif // !defined(__WXUNIVERSAL__)
 405 }
 406
 407 void wxToolTip::SetTip(const wxString& tip)
 408 {
 409     m_text = tip;
 410
 411     if ( m_window )
 412     {
 413         // update the tip text shown by the control
 414         wxToolInfo ti(GetHwndOf(m_window));
 415         ti.lpszText = (wxChar *)m_text.c_str();
 416
 417         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
 418     }
 419 }
 420
 421 #endif // wxUSE_TOOLTIPS