1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/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"
28 #include "wx/tooltip.h"
31 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
33 #include "wx/control.h"
36 #include "wx/tokenzr.h"
37 #include "wx/msw/private.h"
39 #ifndef TTTOOLINFO_V1_SIZE
40 #define TTTOOLINFO_V1_SIZE 0x28
43 #ifndef TTF_TRANSPARENT
44 #define TTF_TRANSPARENT 0x0100
47 // VZ: normally, the trick with subclassing the tooltip control and processing
48 // TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
49 // code here for now (but it's not compiled) in case we need it later.
51 // For now I use an ugly workaround and process TTN_NEEDTEXT directly in
52 // radio button wnd proc - fixing TTM_WINDOWFROMPOINT code would be nice
53 // because it would then work for all controls, not only radioboxes but for
54 // now I don't understand what's wrong with it...
55 #define wxUSE_TTM_WINDOWFROMPOINT 0
57 // ----------------------------------------------------------------------------
59 // ----------------------------------------------------------------------------
61 // the tooltip parent window
62 WXHWND
wxToolTip::ms_hwndTT
= (WXHWND
)NULL
;
64 // new tooltip maximum width, default value is set on first call to wxToolTip::Add()
65 int wxToolTip::ms_maxWidth
= 0;
67 #if wxUSE_TTM_WINDOWFROMPOINT
69 // the tooltip window proc
70 static WNDPROC gs_wndprocToolTip
= (WNDPROC
)NULL
;
72 #endif // wxUSE_TTM_WINDOWFROMPOINT
74 // ----------------------------------------------------------------------------
76 // ----------------------------------------------------------------------------
78 // a wrapper around TOOLINFO Win32 structure
80 #pragma warning( disable : 4097 ) // we inherit from a typedef - so what?
83 class wxToolInfo
: public TOOLINFO
86 wxToolInfo(HWND hwndOwner
)
88 // initialize all members
89 ::ZeroMemory(this, sizeof(TOOLINFO
));
91 // the structure TOOLINFO has been extended with a 4 byte field in
92 // version 4.70 of comctl32.dll and another one in 5.01 but we don't
93 // use these extended fields so use the old struct size to ensure that
94 // the tooltips work on old (Windows 95) systems too
95 cbSize
= TTTOOLINFO_V1_SIZE
;
98 uFlags
= TTF_IDISHWND
;
100 // we use TTF_TRANSPARENT to fix a problem which arises at least with
101 // the text controls but may presumably happen with other controls
102 // which display the tooltip at mouse position: it can start flashing
103 // then as the control gets "focus lost" events and dismisses the
104 // tooltip which then reappears because mouse remains hovering over the
105 // control, see SF patch 1821229
106 if ( wxApp::GetComCtl32Version() >= 470 )
108 uFlags
|= TTF_TRANSPARENT
;
111 uId
= (UINT_PTR
)hwndOwner
;
116 #pragma warning( default : 4097 )
119 // ----------------------------------------------------------------------------
121 // ----------------------------------------------------------------------------
123 // send a message to the tooltip control if it exists
125 // NB: wParam is always 0 for the TTM_XXX messages we use
126 static inline LRESULT
SendTooltipMessage(WXHWND hwnd
, UINT msg
, void *lParam
)
128 return hwnd
? ::SendMessage((HWND
)hwnd
, msg
, 0, (LPARAM
)lParam
) : 0;
131 // send a message to all existing tooltip controls
133 SendTooltipMessageToAll(WXHWND hwnd
, UINT msg
, WPARAM wParam
, LPARAM lParam
)
136 ::SendMessage((HWND
)hwnd
, msg
, wParam
, lParam
);
139 // ============================================================================
141 // ============================================================================
143 #if wxUSE_TTM_WINDOWFROMPOINT
145 // ----------------------------------------------------------------------------
146 // window proc for our tooltip control
147 // ----------------------------------------------------------------------------
149 LRESULT APIENTRY
wxToolTipWndProc(HWND hwndTT
,
154 if ( msg
== TTM_WINDOWFROMPOINT
)
156 LPPOINT ppt
= (LPPOINT
)lParam
;
158 // the window on which event occurred
159 HWND hwnd
= ::WindowFromPoint(*ppt
);
161 OutputDebugString("TTM_WINDOWFROMPOINT: ");
162 OutputDebugString(wxString::Format("0x%08x => ", hwnd
));
164 // return a HWND corresponding to a wxWindow because only wxWidgets are
165 // associated with tooltips using TTM_ADDTOOL
166 wxWindow
*win
= wxGetWindowFromHWND((WXHWND
)hwnd
);
170 hwnd
= GetHwndOf(win
);
171 OutputDebugString(wxString::Format("0x%08x\r\n", hwnd
));
174 // modify the point too!
176 GetWindowRect(hwnd
, &rect
);
178 ppt
->x
= (rect
.right
- rect
.left
) / 2;
179 ppt
->y
= (rect
.bottom
- rect
.top
) / 2;
181 return (LRESULT
)hwnd
;
185 OutputDebugString("no window\r\n");
189 return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip
, hwndTT
, msg
, wParam
, lParam
);
192 #endif // wxUSE_TTM_WINDOWFROMPOINT
194 // ----------------------------------------------------------------------------
196 // ----------------------------------------------------------------------------
198 void wxToolTip::Enable(bool flag
)
200 SendTooltipMessageToAll(ms_hwndTT
, TTM_ACTIVATE
, flag
, 0);
203 void wxToolTip::SetDelay(long milliseconds
)
205 SendTooltipMessageToAll(ms_hwndTT
, TTM_SETDELAYTIME
,
206 TTDT_INITIAL
, milliseconds
);
209 void wxToolTip::SetAutoPop(long milliseconds
)
211 SendTooltipMessageToAll(ms_hwndTT
, TTM_SETDELAYTIME
,
212 TTDT_AUTOPOP
, milliseconds
);
215 void wxToolTip::SetReshow(long milliseconds
)
217 SendTooltipMessageToAll(ms_hwndTT
, TTM_SETDELAYTIME
,
218 TTDT_RESHOW
, milliseconds
);
221 void wxToolTip::SetMaxWidth(int width
)
223 wxASSERT_MSG( width
== -1 || width
>= 0, _T("invalid width value") );
228 // ---------------------------------------------------------------------------
229 // implementation helpers
230 // ---------------------------------------------------------------------------
232 // create the tooltip ctrl for our parent frame if it doesn't exist yet
234 WXHWND
wxToolTip::GetToolTipCtrl()
239 if ( wxTheApp
->GetLayoutDirection() == wxLayout_RightToLeft
)
241 exflags
|= WS_EX_LAYOUTRTL
;
244 // we want to show the tooltips always (even when the window is not
245 // active) and we don't want to strip "&"s from them
246 ms_hwndTT
= (WXHWND
)::CreateWindowEx(exflags
,
249 TTS_ALWAYSTIP
| TTS_NOPREFIX
,
250 CW_USEDEFAULT
, CW_USEDEFAULT
,
251 CW_USEDEFAULT
, CW_USEDEFAULT
,
257 HWND hwnd
= (HWND
)ms_hwndTT
;
258 SetWindowPos(hwnd
, HWND_TOPMOST
, 0, 0, 0, 0,
259 SWP_NOMOVE
| SWP_NOSIZE
| SWP_NOACTIVATE
);
261 #if wxUSE_TTM_WINDOWFROMPOINT
262 // subclass the newly created control
263 gs_wndprocToolTip
= wxSetWindowProc(hwnd
, wxToolTipWndProc
);
264 #endif // wxUSE_TTM_WINDOWFROMPOINT
272 void wxToolTip::RelayEvent(WXMSG
*msg
)
274 (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT
, msg
);
277 // ----------------------------------------------------------------------------
279 // ----------------------------------------------------------------------------
281 IMPLEMENT_ABSTRACT_CLASS(wxToolTip
, wxObject
)
283 wxToolTip::wxToolTip(const wxString
&tip
)
289 wxToolTip::~wxToolTip()
291 // the tooltip has to be removed before deleting. Otherwise, if it is visible
292 // while being deleted, there will be a delay before it goes away.
296 // ----------------------------------------------------------------------------
298 // ----------------------------------------------------------------------------
300 void wxToolTip::Remove(WXHWND hWnd
)
302 wxToolInfo
ti((HWND
)hWnd
);
303 (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL
, &ti
);
306 void wxToolTip::Remove()
308 // remove this tool from the tooltip control
311 Remove(m_window
->GetHWND());
315 void wxToolTip::Add(WXHWND hWnd
)
317 HWND hwnd
= (HWND
)hWnd
;
321 // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
322 // store the tooltip text ourselves anyhow, and provide it in response to
323 // TTN_NEEDTEXT (sent via WM_NOTIFY), but then we would be limited to 79
324 // character tooltips as this is the size of the szText buffer in
325 // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
328 ti
.lpszText
= (wxChar
*)m_text
.wx_str(); // const_cast
330 if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL
, &ti
) )
332 wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text
.c_str());
336 #ifdef TTM_SETMAXTIPWIDTH
337 if ( wxApp::GetComCtl32Version() >= 470 )
339 // use TTM_SETMAXTIPWIDTH to make tooltip multiline using the
340 // extent of its first line as max value
341 HFONT hfont
= (HFONT
)
342 SendTooltipMessage(GetToolTipCtrl(), WM_GETFONT
, 0);
346 hfont
= (HFONT
)GetStockObject(DEFAULT_GUI_FONT
);
349 wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
356 wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
359 if ( !SelectObject(hdc
, hfont
) )
361 wxLogLastError(wxT("SelectObject(hfont)"));
364 // find the width of the widest line
366 wxStringTokenizer
tokenizer(m_text
, _T("\n"));
367 while ( tokenizer
.HasMoreTokens() )
369 const wxString token
= tokenizer
.GetNextToken();
372 if ( !::GetTextExtentPoint32(hdc
, token
.wx_str(),
373 token
.length(), &sz
) )
375 wxLogLastError(wxT("GetTextExtentPoint32"));
378 if ( sz
.cx
> maxWidth
)
382 // limit size to ms_maxWidth, if set
383 if ( ms_maxWidth
== 0 )
385 // this is more or less arbitrary but seems to work well
386 static const int DEFAULT_MAX_WIDTH
= 400;
388 ms_maxWidth
= wxGetClientDisplayRect().width
/ 2;
390 if ( ms_maxWidth
> DEFAULT_MAX_WIDTH
)
391 ms_maxWidth
= DEFAULT_MAX_WIDTH
;
394 if ( ms_maxWidth
!= -1 && maxWidth
> ms_maxWidth
)
395 maxWidth
= ms_maxWidth
;
397 // only set a new width if it is bigger than the current setting
398 SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH
,
399 wxUIntToPtr(maxWidth
));
402 #endif // TTM_SETMAXTIPWIDTH
404 // replace the '\n's with spaces because otherwise they appear as
405 // unprintable characters in the tooltip string
406 m_text
.Replace(_T("\n"), _T(" "));
407 ti
.lpszText
= (wxChar
*)m_text
.wx_str(); // const_cast
409 if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL
, &ti
) )
411 wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text
.c_str());
417 void wxToolTip::SetWindow(wxWindow
*win
)
423 // add the window itself
426 Add(m_window
->GetHWND());
428 #if !defined(__WXUNIVERSAL__)
429 // and all of its subcontrols (e.g. radio buttons in a radiobox) as well
430 wxControl
*control
= wxDynamicCast(m_window
, wxControl
);
433 const wxArrayLong
& subcontrols
= control
->GetSubcontrols();
434 size_t count
= subcontrols
.GetCount();
435 for ( size_t n
= 0; n
< count
; n
++ )
437 int id
= subcontrols
[n
];
438 HWND hwnd
= GetDlgItem(GetHwndOf(m_window
), id
);
441 // may be it's a child of parent of the control, in fact?
442 // (radiobuttons are subcontrols, i.e. children of the radiobox
443 // for wxWidgets but are its siblings at Windows level)
444 hwnd
= GetDlgItem(GetHwndOf(m_window
->GetParent()), id
);
447 // must have it by now!
448 wxASSERT_MSG( hwnd
, _T("no hwnd for subcontrol?") );
453 #endif // !defined(__WXUNIVERSAL__)
456 void wxToolTip::SetTip(const wxString
& tip
)
462 // update the tip text shown by the control
463 wxToolInfo
ti(GetHwndOf(m_window
));
465 // for some reason, changing the tooltip text directly results in
466 // repaint of the controls under it, see #10520 -- but this doesn't
467 // happen if we reset it first
468 ti
.lpszText
= const_cast<wxChar
*>(_T(""));
469 (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT
, &ti
);
471 ti
.lpszText
= const_cast<wxChar
*>(m_text
.wx_str());
472 (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT
, &ti
);
476 #endif // wxUSE_TOOLTIPS