#define TTTOOLINFO_V1_SIZE 0x28
#endif
+#ifndef TTF_TRANSPARENT
+ #define TTF_TRANSPARENT 0x0100
+#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.
// the tooltip parent window
WXHWND wxToolTip::ms_hwndTT = (WXHWND)NULL;
+// new tooltip maximum width, default value is set on first call to wxToolTip::Add()
+int wxToolTip::ms_maxWidth = 0;
+
#if wxUSE_TTM_WINDOWFROMPOINT
// the tooltip window proc
class wxToolInfo : public TOOLINFO
{
public:
- wxToolInfo(HWND hwndOwner)
+ wxToolInfo(HWND hwndOwner, unsigned int id, const wxRect& rc)
{
// initialize all members
::ZeroMemory(this, sizeof(TOOLINFO));
cbSize = TTTOOLINFO_V1_SIZE;
hwnd = hwndOwner;
- uFlags = TTF_IDISHWND;
+
+ if (rc.IsEmpty())
+ {
+ uFlags = TTF_IDISHWND;
+ uId = (UINT_PTR)hwndOwner;
+ }
+ else
+ {
+ // this tooltip must be shown only if the mouse hovers a specific rect
+ // of the hwnd parameter!
+ rect.left = rc.GetLeft();
+ rect.right = rc.GetRight();
+ rect.top = rc.GetTop();
+ rect.bottom = rc.GetBottom();
+
+ // note that not setting TTF_IDISHWND from the uFlags member means that the
+ // ti.uId field should not contain the HWND but rather as MSDN says an
+ // "Application-defined identifier of the tool"; this is used internally by
+ // Windows to distinguish the different tooltips attached to the same window
+ uId = id;
+ }
// we use TTF_TRANSPARENT to fix a problem which arises at least with
// the text controls but may presumably happen with other controls
{
uFlags |= TTF_TRANSPARENT;
}
-
- uId = (UINT)hwndOwner;
}
};
void wxToolTip::Enable(bool flag)
{
+ // Make sure the tooltip has been created
+ (void) GetToolTipCtrl();
+
SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
}
void wxToolTip::SetDelay(long milliseconds)
{
+ // Make sure the tooltip has been created
+ (void) GetToolTipCtrl();
+
SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
TTDT_INITIAL, milliseconds);
}
TTDT_RESHOW, milliseconds);
}
+void wxToolTip::SetMaxWidth(int width)
+{
+ wxASSERT_MSG( width == -1 || width >= 0, wxT("invalid width value") );
+
+ ms_maxWidth = width;
+}
+
// ---------------------------------------------------------------------------
// implementation helpers
// ---------------------------------------------------------------------------
: m_text(tip)
{
m_window = NULL;
+
+ // make sure m_rect.IsEmpty() == true
+ m_rect.SetWidth(0);
+ m_rect.SetHeight(0);
+
+ // since m_rect is not valid, m_id is ignored by wxToolInfo ctor...
+ m_id = 0;
+}
+
+wxToolTip::wxToolTip(wxWindow* win, unsigned int id, const wxString &tip, const wxRect& rc)
+ : m_text(tip), m_rect(rc), m_id(id)
+{
+ m_window = NULL;
+
+ SetWindow(win);
}
wxToolTip::~wxToolTip()
// others
// ----------------------------------------------------------------------------
-void wxToolTip::Remove(WXHWND hWnd)
+/* static */
+void wxToolTip::Remove(WXHWND hWnd, unsigned int id, const wxRect& rc)
{
- wxToolInfo ti((HWND)hWnd);
+ wxToolInfo ti((HWND)hWnd, id, rc);
+
(void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti);
}
// remove this tool from the tooltip control
if ( m_window )
{
- Remove(m_window->GetHWND());
+ Remove(m_window->GetHWND(), m_id, m_rect);
}
}
{
HWND hwnd = (HWND)hWnd;
- wxToolInfo ti(hwnd);
+ wxToolInfo ti(hwnd, m_id, m_rect);
// another possibility would be to specify LPSTR_TEXTCALLBACK here as we
// store the tooltip text ourselves anyhow, and provide it in response to
// NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
// of any length
ti.hwnd = hwnd;
- ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast
+ ti.lpszText = const_cast<wxChar *>(m_text.wx_str());
if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
{
- wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
+ wxLogDebug(wxT("Failed to create the tooltip '%s'"), m_text.c_str());
+
+ return;
}
- else
+
+#ifdef TTM_SETMAXTIPWIDTH
+ if ( wxApp::GetComCtl32Version() >= 470 )
{
- // check for multiline toopltip
- int index = m_text.Find(_T('\n'));
+ // 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);
- if ( index != wxNOT_FOUND )
+ if ( !hfont )
{
-#ifdef TTM_SETMAXTIPWIDTH
- if ( wxApp::GetComCtl32Version() >= 470 )
+ hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
+ if ( !hfont )
{
- // 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);
-
- if ( !hfont )
- {
- hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
- if ( !hfont )
- {
- wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
- }
- }
-
- MemoryHDC hdc;
- if ( !hdc )
- {
- wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
- }
-
- if ( !SelectObject(hdc, hfont) )
- {
- wxLogLastError(wxT("SelectObject(hfont)"));
- }
-
- // find the width of the widest line
- int max = 0;
- wxStringTokenizer tokenizer(m_text, _T("\n"));
- wxString token = tokenizer.GetNextToken();
- while (token.length())
- {
- SIZE sz;
- if ( !::GetTextExtentPoint32(hdc, token.wx_str(), token.length(), &sz) )
- {
- wxLogLastError(wxT("GetTextExtentPoint32"));
- }
- if ( sz.cx > max )
- max = sz.cx;
-
- token = tokenizer.GetNextToken();
- }
-
- // only set a new width if it is bigger than the current setting
- if (max > SendTooltipMessage(GetToolTipCtrl(), TTM_GETMAXTIPWIDTH, 0))
- SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
- (void *)max);
+ wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
}
- else
-#endif // comctl32.dll >= 4.70
+ }
+
+ MemoryHDC hdc;
+ if ( !hdc )
+ {
+ wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
+ }
+
+ if ( !SelectObject(hdc, hfont) )
+ {
+ wxLogLastError(wxT("SelectObject(hfont)"));
+ }
+
+ // find the width of the widest line
+ int maxWidth = 0;
+ wxStringTokenizer tokenizer(m_text, wxT("\n"));
+ while ( tokenizer.HasMoreTokens() )
+ {
+ const wxString token = tokenizer.GetNextToken();
+
+ SIZE sz;
+ if ( !::GetTextExtentPoint32(hdc, token.wx_str(),
+ token.length(), &sz) )
{
- // 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.wx_str(); // const_cast
-
- if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
- {
- wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
- }
+ wxLogLastError(wxT("GetTextExtentPoint32"));
}
+
+ if ( sz.cx > maxWidth )
+ maxWidth = sz.cx;
+ }
+
+ // limit size to ms_maxWidth, if set
+ if ( ms_maxWidth == 0 )
+ {
+ // this is more or less arbitrary but seems to work well
+ static const int DEFAULT_MAX_WIDTH = 400;
+
+ ms_maxWidth = wxGetClientDisplayRect().width / 2;
+
+ if ( ms_maxWidth > DEFAULT_MAX_WIDTH )
+ ms_maxWidth = DEFAULT_MAX_WIDTH;
+ }
+
+ if ( ms_maxWidth != -1 && maxWidth > ms_maxWidth )
+ maxWidth = ms_maxWidth;
+
+ // only set a new width if it is bigger than the current setting:
+ // otherwise adding a tooltip with shorter line(s) than a previous
+ // one would result in breaking the longer lines unnecessarily as
+ // all our tooltips share the same maximal width
+ if ( maxWidth > SendTooltipMessage(GetToolTipCtrl(),
+ TTM_GETMAXTIPWIDTH, 0) )
+ {
+ SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
+ wxUIntToPtr(maxWidth));
+ }
+ }
+ else
+#endif // TTM_SETMAXTIPWIDTH
+ {
+ // replace the '\n's with spaces because otherwise they appear as
+ // unprintable characters in the tooltip string
+ m_text.Replace(wxT("\n"), wxT(" "));
+ ti.lpszText = const_cast<wxChar *>(m_text.wx_str());
+
+ if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
+ {
+ wxLogDebug(wxT("Failed to create the tooltip '%s'"), m_text.c_str());
}
}
}
}
// must have it by now!
- wxASSERT_MSG( hwnd, _T("no hwnd for subcontrol?") );
+ wxASSERT_MSG( hwnd, wxT("no hwnd for subcontrol?") );
Add((WXHWND)hwnd);
}
#endif // !defined(__WXUNIVERSAL__)
}
+void wxToolTip::SetRect(const wxRect& rc)
+{
+ m_rect = rc;
+
+ if ( m_window )
+ {
+ wxToolInfo ti(GetHwndOf(m_window), m_id, m_rect);
+ (void)SendTooltipMessage(GetToolTipCtrl(), TTM_NEWTOOLRECT, &ti);
+ }
+}
+
void wxToolTip::SetTip(const wxString& tip)
{
m_text = tip;
if ( m_window )
{
// update the tip text shown by the control
- wxToolInfo ti(GetHwndOf(m_window));
- ti.lpszText = (wxChar *)m_text.wx_str();
+ wxToolInfo ti(GetHwndOf(m_window), m_id, m_rect);
+
+ // for some reason, changing the tooltip text directly results in
+ // repaint of the controls under it, see #10520 -- but this doesn't
+ // happen if we reset it first
+ ti.lpszText = const_cast<wxChar *>(wxT(""));
+ (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
+ ti.lpszText = const_cast<wxChar *>(m_text.wx_str());
(void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
}
}
projects / wxWidgets.git / blobdiff