1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: msw/tooltip.cpp
3 // Purpose: wxToolTip class implementation for MSW
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1999 Vadim Zeitlin
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/wxprec.h"
32 #include "wx/tooltip.h"
33 #include "wx/msw/private.h"
35 // include <commctrl.h> "properly"
36 #include "wx/msw/wrapcctl.h"
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.
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
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
52 // the tooltip parent window
53 WXHWND
wxToolTip::ms_hwndTT
= (WXHWND
)NULL
;
55 #if wxUSE_TTM_WINDOWFROMPOINT
57 // the tooltip window proc
58 static WNDPROC gs_wndprocToolTip
= (WNDPROC
)NULL
;
60 #endif // wxUSE_TTM_WINDOWFROMPOINT
62 // ----------------------------------------------------------------------------
64 // ----------------------------------------------------------------------------
66 // a wrapper around TOOLINFO Win32 structure
68 #pragma warning( disable : 4097 ) // we inherit from a typedef - so what?
71 class wxToolInfo
: public TOOLINFO
74 wxToolInfo(HWND hwndOwner
)
76 // initialize all members
77 ::ZeroMemory(this, sizeof(TOOLINFO
));
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
86 #if _WIN32_IE >= 0x0300
87 cbSize
= sizeof(TOOLINFO
) - sizeof(LPARAM
);
89 cbSize
= sizeof(TOOLINFO
);
90 #endif // compile-time comctl32.dll version
93 uFlags
= TTF_IDISHWND
;
94 uId
= (UINT
)hwndOwner
;
99 #pragma warning( default : 4097 )
102 // ----------------------------------------------------------------------------
104 // ----------------------------------------------------------------------------
106 // send a message to the tooltip control
107 inline LRESULT
SendTooltipMessage(WXHWND hwnd
,
112 return hwnd
? ::SendMessage((HWND
)hwnd
, msg
, wParam
, (LPARAM
)lParam
)
116 // send a message to all existing tooltip controls
117 static void SendTooltipMessageToAll(WXHWND hwnd
,
122 (void)SendTooltipMessage((WXHWND
)hwnd
, msg
, wParam
, (void *)lParam
);
125 // ============================================================================
127 // ============================================================================
129 #if wxUSE_TTM_WINDOWFROMPOINT
131 // ----------------------------------------------------------------------------
132 // window proc for our tooltip control
133 // ----------------------------------------------------------------------------
135 LRESULT APIENTRY
wxToolTipWndProc(HWND hwndTT
,
140 if ( msg
== TTM_WINDOWFROMPOINT
)
142 LPPOINT ppt
= (LPPOINT
)lParam
;
144 // the window on which event occurred
145 HWND hwnd
= ::WindowFromPoint(*ppt
);
147 OutputDebugString("TTM_WINDOWFROMPOINT: ");
148 OutputDebugString(wxString::Format("0x%08x => ", hwnd
));
150 // return a HWND corresponding to a wxWindow because only wxWidgets are
151 // associated with tooltips using TTM_ADDTOOL
152 wxWindow
*win
= wxGetWindowFromHWND((WXHWND
)hwnd
);
156 hwnd
= GetHwndOf(win
);
157 OutputDebugString(wxString::Format("0x%08x\r\n", hwnd
));
160 // modify the point too!
162 GetWindowRect(hwnd
, &rect
);
164 ppt
->x
= (rect
.right
- rect
.left
) / 2;
165 ppt
->y
= (rect
.bottom
- rect
.top
) / 2;
167 return (LRESULT
)hwnd
;
171 OutputDebugString("no window\r\n");
175 return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip
, hwndTT
, msg
, wParam
, lParam
);
178 #endif // wxUSE_TTM_WINDOWFROMPOINT
180 // ----------------------------------------------------------------------------
182 // ----------------------------------------------------------------------------
184 void wxToolTip::Enable(bool flag
)
186 SendTooltipMessageToAll(ms_hwndTT
, TTM_ACTIVATE
, flag
, 0);
189 void wxToolTip::SetDelay(long milliseconds
)
191 SendTooltipMessageToAll(ms_hwndTT
, TTM_SETDELAYTIME
,
192 TTDT_INITIAL
, milliseconds
);
195 // ---------------------------------------------------------------------------
196 // implementation helpers
197 // ---------------------------------------------------------------------------
199 // create the tooltip ctrl for our parent frame if it doesn't exist yet
200 WXHWND
wxToolTip::GetToolTipCtrl()
204 ms_hwndTT
= (WXHWND
)::CreateWindow(TOOLTIPS_CLASS
,
207 CW_USEDEFAULT
, CW_USEDEFAULT
,
208 CW_USEDEFAULT
, CW_USEDEFAULT
,
214 HWND hwnd
= (HWND
)ms_hwndTT
;
215 SetWindowPos(hwnd
, HWND_TOPMOST
, 0, 0, 0, 0,
216 SWP_NOMOVE
| SWP_NOSIZE
| SWP_NOACTIVATE
);
218 #if wxUSE_TTM_WINDOWFROMPOINT
219 // subclass the newly created control
220 gs_wndprocToolTip
= wxSetWindowProc(hwnd
, wxToolTipWndProc
);
221 #endif // wxUSE_TTM_WINDOWFROMPOINT
228 void wxToolTip::RelayEvent(WXMSG
*msg
)
230 (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT
, 0, msg
);
233 // ----------------------------------------------------------------------------
235 // ----------------------------------------------------------------------------
237 IMPLEMENT_ABSTRACT_CLASS(wxToolTip
, wxObject
)
239 wxToolTip::wxToolTip(const wxString
&tip
)
245 wxToolTip::~wxToolTip()
247 // there is no need to Remove() this tool - it will be done automatically
251 // ----------------------------------------------------------------------------
253 // ----------------------------------------------------------------------------
255 void wxToolTip::Remove()
257 // remove this tool from the tooltip control
260 wxToolInfo
ti(GetHwndOf(m_window
));
261 (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL
, 0, &ti
);
265 void wxToolTip::Add(WXHWND hWnd
)
267 HWND hwnd
= (HWND
)hWnd
;
271 // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
272 // store the tooltip text ourselves anyhow, and provide it in response to
273 // TTN_NEEDTEXT (sent via WM_NOTIFY), but then we would be limited to 79
274 // character tooltips as this is the size of the szText buffer in
275 // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
278 ti
.lpszText
= (wxChar
*)m_text
.c_str(); // const_cast
280 if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL
, 0, &ti
) )
282 wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text
.c_str());
286 // check for multiline toopltip
287 int index
= m_text
.Find(_T('\n'));
289 if ( index
!= wxNOT_FOUND
)
291 #ifdef TTM_SETMAXTIPWIDTH
292 if ( wxApp::GetComCtl32Version() >= 470 )
294 // use TTM_SETMAXTIPWIDTH to make tooltip multiline using the
295 // extent of its first line as max value
296 HFONT hfont
= (HFONT
)SendTooltipMessage(GetToolTipCtrl(),
301 hfont
= (HFONT
)GetStockObject(DEFAULT_GUI_FONT
);
304 wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
311 wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
314 if ( !SelectObject(hdc
, hfont
) )
316 wxLogLastError(wxT("SelectObject(hfont)"));
320 if ( !::GetTextExtentPoint32(hdc
, m_text
, index
, &sz
) )
322 wxLogLastError(wxT("GetTextExtentPoint32"));
325 SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH
,
328 #endif // comctl32.dll >= 4.70
330 // replace the '\n's with spaces because otherwise they appear as
331 // unprintable characters in the tooltip string
332 m_text
.Replace(_T("\n"), _T(" "));
337 void wxToolTip::SetWindow(wxWindow
*win
)
343 // add the window itself
346 Add(m_window
->GetHWND());
348 #if !defined(__WXUNIVERSAL__)
349 // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
350 wxControl
*control
= wxDynamicCast(m_window
, wxControl
);
353 const wxArrayLong
& subcontrols
= control
->GetSubcontrols();
354 size_t count
= subcontrols
.GetCount();
355 for ( size_t n
= 0; n
< count
; n
++ )
357 int id
= subcontrols
[n
];
358 HWND hwnd
= GetDlgItem(GetHwndOf(m_window
), id
);
361 // may be it's a child of parent of the control, in fact?
362 // (radiobuttons are subcontrols, i.e. children of the radiobox
363 // for wxWidgets but are its siblings at Windows level)
364 hwnd
= GetDlgItem(GetHwndOf(m_window
->GetParent()), id
);
367 // must have it by now!
368 wxASSERT_MSG( hwnd
, _T("no hwnd for subcontrol?") );
374 // VZ: it's ugly to do it here, but I don't want any major changes right
375 // now, later we will probably want to have wxWindow::OnGotToolTip() or
376 // something like this where the derived class can do such things
377 // itself instead of wxToolTip "knowing" about them all
378 wxComboBox
*combo
= wxDynamicCast(control
, wxComboBox
);
381 WXHWND hwndComboEdit
= combo
->GetWindowStyle() & wxCB_READONLY
383 : combo
->GetEditHWND();
389 #endif // !defined(__WXUNIVERSAL__)
392 void wxToolTip::SetTip(const wxString
& tip
)
398 // update the tip text shown by the control
399 wxToolInfo
ti(GetHwndOf(m_window
));
400 ti
.lpszText
= (wxChar
*)m_text
.c_str();
402 (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT
, 0, &ti
);
406 #endif // wxUSE_TOOLTIPS