X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c5d7205ca284d90d3f68d4b8a67ecca2b07f71ef..c12822fec7f87e7734cabbfcf23b99685fc371ce:/src/msw/tooltip.cpp diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp index 8ca70b9ff3..31ef19fac0 100644 --- a/src/msw/tooltip.cpp +++ b/src/msw/tooltip.cpp @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: msw/tooltip.cpp +// Name: src/msw/tooltip.cpp // Purpose: wxToolTip class implementation for MSW // Author: Vadim Zeitlin // Modified by: @@ -23,17 +23,26 @@ #pragma hdrstop #endif -#ifndef WX_PRECOMP - #include "wx/wx.h" -#endif - #if wxUSE_TOOLTIPS #include "wx/tooltip.h" + +#ifndef WX_PRECOMP + #include "wx/msw/wrapcctl.h" // include "properly" + #include "wx/app.h" + #include "wx/control.h" +#endif + +#include "wx/tokenzr.h" #include "wx/msw/private.h" -// include "properly" -#include "wx/msw/wrapcctl.h" +#ifndef TTTOOLINFO_V1_SIZE + #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 @@ -52,6 +61,9 @@ // 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 @@ -77,21 +89,26 @@ public: ::ZeroMemory(this, sizeof(TOOLINFO)); // the structure TOOLINFO has been extended with a 4 byte field in - // version 4.70 of comctl32.dll and if we compile on a newer machine - // but run on one with the old version of comctl32, nothing will work - // because the library will detect that we rely on a more recent - // version of it. So we always use the old size - if we ever start - // using our lParam member, we'd have to check for comctl32 version - // during run-time -#if _WIN32_IE >= 0x0300 - cbSize = sizeof(TOOLINFO) - sizeof(LPARAM); -#else // old headers - cbSize = sizeof(TOOLINFO); -#endif // compile-time comctl32.dll version + // version 4.70 of comctl32.dll and another one in 5.01 but we don't + // use these extended fields so use the old struct size to ensure that + // the tooltips work on old (Windows 95) systems too + cbSize = TTTOOLINFO_V1_SIZE; hwnd = hwndOwner; uFlags = TTF_IDISHWND; - uId = (UINT)hwndOwner; + + // we use TTF_TRANSPARENT to fix a problem which arises at least with + // the text controls but may presumably happen with other controls + // which display the tooltip at mouse position: it can start flashing + // then as the control gets "focus lost" events and dismisses the + // tooltip which then reappears because mouse remains hovering over the + // control, see SF patch 1821229 + if ( wxApp::GetComCtl32Version() >= 470 ) + { + uFlags |= TTF_TRANSPARENT; + } + + uId = (UINT_PTR)hwndOwner; } }; @@ -189,6 +206,25 @@ void wxToolTip::SetDelay(long milliseconds) TTDT_INITIAL, milliseconds); } +void wxToolTip::SetAutoPop(long milliseconds) +{ + SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME, + TTDT_AUTOPOP, milliseconds); +} + +void wxToolTip::SetReshow(long milliseconds) +{ + SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME, + TTDT_RESHOW, milliseconds); +} + +void wxToolTip::SetMaxWidth(int width) +{ + wxASSERT_MSG( width == -1 || width >= 0, _T("invalid width value") ); + + ms_maxWidth = width; +} + // --------------------------------------------------------------------------- // implementation helpers // --------------------------------------------------------------------------- @@ -199,16 +235,23 @@ WXHWND wxToolTip::GetToolTipCtrl() { if ( !ms_hwndTT ) { + WXDWORD exflags = 0; + if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft ) + { + exflags |= WS_EX_LAYOUTRTL; + } + // 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_NOPREFIX, - CW_USEDEFAULT, CW_USEDEFAULT, - CW_USEDEFAULT, CW_USEDEFAULT, - NULL, (HMENU)NULL, - wxGetInstance(), - NULL); + ms_hwndTT = (WXHWND)::CreateWindowEx(exflags, + TOOLTIPS_CLASS, + (LPCTSTR)NULL, + TTS_ALWAYSTIP | TTS_NOPREFIX, + CW_USEDEFAULT, CW_USEDEFAULT, + CW_USEDEFAULT, CW_USEDEFAULT, + NULL, (HMENU)NULL, + wxGetInstance(), + NULL); if ( ms_hwndTT ) { HWND hwnd = (HWND)ms_hwndTT; @@ -246,8 +289,8 @@ wxToolTip::wxToolTip(const wxString &tip) wxToolTip::~wxToolTip() { // 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(); + // while being deleted, there will be a delay before it goes away. + Remove(); } // ---------------------------------------------------------------------------- @@ -282,7 +325,7 @@ void wxToolTip::Add(WXHWND hWnd) // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips // of any length ti.hwnd = hwnd; - ti.lpszText = (wxChar *)m_text.c_str(); // const_cast + ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) ) { @@ -290,60 +333,82 @@ void wxToolTip::Add(WXHWND hWnd) } else { - // check for multiline toopltip - int index = m_text.Find(_T('\n')); - - if ( index != wxNOT_FOUND ) - { #ifdef TTM_SETMAXTIPWIDTH - if ( wxApp::GetComCtl32Version() >= 470 ) - { - // 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 ( wxApp::GetComCtl32Version() >= 470 ) + { + // 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 ) { - hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT); - if ( !hfont ) - { - wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)")); - } + wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)")); } + } - MemoryHDC hdc; - if ( !hdc ) - { - wxLogLastError(wxT("CreateCompatibleDC(NULL)")); - } + MemoryHDC hdc; + if ( !hdc ) + { + wxLogLastError(wxT("CreateCompatibleDC(NULL)")); + } - if ( !SelectObject(hdc, hfont) ) - { - wxLogLastError(wxT("SelectObject(hfont)")); - } + if ( !SelectObject(hdc, hfont) ) + { + wxLogLastError(wxT("SelectObject(hfont)")); + } + + // find the width of the widest line + int maxWidth = 0; + wxStringTokenizer tokenizer(m_text, _T("\n")); + while ( tokenizer.HasMoreTokens() ) + { + const wxString token = tokenizer.GetNextToken(); SIZE sz; - if ( !::GetTextExtentPoint32(hdc, m_text, index, &sz) ) + if ( !::GetTextExtentPoint32(hdc, token.wx_str(), + token.length(), &sz) ) { wxLogLastError(wxT("GetTextExtentPoint32")); } - SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH, - (void *)sz.cx); + if ( sz.cx > maxWidth ) + maxWidth = sz.cx; } - else -#endif // comctl32.dll >= 4.70 + + // limit size to ms_maxWidth, if set + if ( ms_maxWidth == 0 ) { - // 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 + // this is more or less arbitrary but seems to work well + static const int DEFAULT_MAX_WIDTH = 400; - if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) ) - { - wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str()); - } + 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 + 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(_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()); } } } @@ -361,7 +426,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 + // and all of its subcontrols (e.g. radio buttons in a radiobox) as well wxControl *control = wxDynamicCast(m_window, wxControl); if ( control ) { @@ -385,22 +450,6 @@ void wxToolTip::SetWindow(wxWindow *win) Add((WXHWND)hwnd); } } - - // VZ: it's ugly to do it here, but I don't want any major changes right - // now, later we will probably want to have wxWindow::OnGotToolTip() or - // something like this where the derived class can do such things - // itself instead of wxToolTip "knowing" about them all - wxComboBox *combo = wxDynamicCast(control, wxComboBox); - if ( combo ) - { - WXHWND hwndComboEdit = combo->GetWindowStyle() & wxCB_READONLY - ? combo->GetHWND() - : combo->GetEditHWND(); - if ( hwndComboEdit ) - { - Add(hwndComboEdit); - } - } #endif // !defined(__WXUNIVERSAL__) } @@ -412,7 +461,7 @@ void wxToolTip::SetTip(const wxString& tip) { // update the tip text shown by the control wxToolInfo ti(GetHwndOf(m_window)); - ti.lpszText = (wxChar *)m_text.c_str(); + ti.lpszText = (wxChar *)m_text.wx_str(); (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti); }