X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bd9d76cbe57fdebdcf9a362e6f92f0a5ad0584a0..09fbcf2a62dcbafaf5b7fc9af39c560480833733:/src/msw/tooltip.cpp diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp index f17e964b68..d18525e22b 100644 --- a/src/msw/tooltip.cpp +++ b/src/msw/tooltip.cpp @@ -1,12 +1,12 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: msw/tooltip.cpp +// Name: src/msw/tooltip.cpp // Purpose: wxToolTip class implementation for MSW // Author: Vadim Zeitlin // Modified by: // Created: 31.01.99 // RCS-ID: $Id$ // Copyright: (c) 1999 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -23,108 +23,198 @@ #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/vector.h" #include "wx/msw/private.h" -#if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__) -#include +#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 +// code here for now (but it's not compiled) in case we need it later. +// +// For now I use an ugly workaround and process TTN_NEEDTEXT directly in +// radio button wnd proc - fixing TTM_WINDOWFROMPOINT code would be nice +// because it would then work for all controls, not only radioboxes but for +// now I don't understand what's wrong with it... +#define wxUSE_TTM_WINDOWFROMPOINT 0 + +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +// 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 +static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL; + +#endif // wxUSE_TTM_WINDOWFROMPOINT + // ---------------------------------------------------------------------------- // private classes // ---------------------------------------------------------------------------- -// a simple wrapper around TOOLINFO Win32 structure +// This is simply a wrapper for vector but defined as a class to hide the +// details from the public header. +class wxToolTipOtherWindows : public wxVector +{ +}; + +// a wrapper around TOOLINFO Win32 structure +#ifdef __VISUALC__ + #pragma warning( disable : 4097 ) // we inherit from a typedef - so what? +#endif + class wxToolInfo : public TOOLINFO { public: - wxToolInfo(wxWindow *win) + wxToolInfo(HWND hwndOwner, unsigned int id, const wxRect& rc) { // initialize all members -#ifdef __GNUWIN32__ - memset(this, 0, sizeof(TOOLINFO)); -#else ::ZeroMemory(this, sizeof(TOOLINFO)); -#endif - cbSize = sizeof(TOOLINFO); - uFlags = TTF_IDISHWND; - uId = (UINT)win->GetHWND(); + // the structure TOOLINFO has been extended with a 4 byte field in + // 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; + + 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 + // 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; + } } }; +#ifdef __VISUALC__ + #pragma warning( default : 4097 ) +#endif + // ---------------------------------------------------------------------------- // private functions // ---------------------------------------------------------------------------- -// send a message to the tooltip control -inline LRESULT SendTooltipMessage(WXHWND hwnd, - UINT msg, - WPARAM wParam, - void *lParam) +// send a message to the tooltip control if it exists +// +// NB: wParam is always 0 for the TTM_XXX messages we use +static inline LRESULT SendTooltipMessage(WXHWND hwnd, UINT msg, void *lParam) { - return hwnd ? ::SendMessage((HWND)hwnd, msg, wParam, (LPARAM)lParam) - : 0; + return hwnd ? ::SendMessage((HWND)hwnd, msg, 0, (LPARAM)lParam) : 0; } // send a message to all existing tooltip controls -static void SendTooltipMessageToAll(UINT msg, WPARAM wParam, LPARAM lParam) +static inline void +SendTooltipMessageToAll(WXHWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam) +{ + if ( hwnd ) + ::SendMessage((HWND)hwnd, msg, wParam, lParam); +} + +// ============================================================================ +// implementation +// ============================================================================ + +#if wxUSE_TTM_WINDOWFROMPOINT + +// ---------------------------------------------------------------------------- +// window proc for our tooltip control +// ---------------------------------------------------------------------------- + +LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT, + UINT msg, + WPARAM wParam, + LPARAM lParam) { - // NB: it might be somewhat easier to maintain a list of all existing - // wxToolTip controls (put them there in ctor, delete from the list - // in dtor) - may be it's worth doing it this way? OTOH, typical - // application won't have many top level windows, so iterating over all - // of them shouldnt' take much time neither... - - // iterate over all top level windows and send message to the tooltip - // control of each and every of them (or more precisely to all dialogs and - // frames) - wxDialog *dialog = NULL; - wxFrame *frame = NULL; - - wxNode *node = wxTopLevelWindows.First(); - while ( node ) + if ( msg == TTM_WINDOWFROMPOINT ) { - wxWindow *win = (wxWindow *)node->Data(); + LPPOINT ppt = (LPPOINT)lParam; - node = node->Next(); + // the window on which event occurred + HWND hwnd = ::WindowFromPoint(*ppt); - if ( win->IsKindOf(CLASSINFO(wxFrame)) ) - { - frame = (wxFrame *)win; - dialog = NULL; - } - else if ( win->IsKindOf(CLASSINFO(wxDialog)) ) + OutputDebugString("TTM_WINDOWFROMPOINT: "); + OutputDebugString(wxString::Format("0x%08x => ", hwnd)); + + // return a HWND corresponding to a wxWindow because only wxWidgets are + // associated with tooltips using TTM_ADDTOOL + wxWindow *win = wxGetWindowFromHWND((WXHWND)hwnd); + + if ( win ) { - dialog = (wxDialog *)win; - frame = NULL; + hwnd = GetHwndOf(win); + OutputDebugString(wxString::Format("0x%08x\r\n", hwnd)); + +#if 0 + // modify the point too! + RECT rect; + GetWindowRect(hwnd, &rect); + + ppt->x = (rect.right - rect.left) / 2; + ppt->y = (rect.bottom - rect.top) / 2; +#endif // 0 + return (LRESULT)hwnd; } else { - // skip this strange top level window - continue; - } - - wxASSERT_MSG( dialog || frame, "logic error" ); - - WXHWND hwndTT = frame ? frame->GetToolTipCtrl() - : dialog->GetToolTipCtrl(); - if ( hwndTT ) - { - (void)SendTooltipMessage(hwndTT, msg, wParam, (void *)lParam); + OutputDebugString("no window\r\n"); } } + + return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip, hwndTT, msg, wParam, lParam); } -// ============================================================================ -// implementation -// ============================================================================ +#endif // wxUSE_TTM_WINDOWFROMPOINT // ---------------------------------------------------------------------------- // static functions @@ -132,12 +222,38 @@ static void SendTooltipMessageToAll(UINT msg, WPARAM wParam, LPARAM lParam) void wxToolTip::Enable(bool flag) { - SendTooltipMessageToAll(TTM_ACTIVATE, flag, 0); + // Make sure the tooltip has been created + (void) GetToolTipCtrl(); + + SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0); } void wxToolTip::SetDelay(long milliseconds) { - SendTooltipMessageToAll(TTM_SETDELAYTIME, TTDT_INITIAL, milliseconds); + // Make sure the tooltip has been created + (void) GetToolTipCtrl(); + + SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME, + 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, wxT("invalid width value") ); + + ms_maxWidth = width; } // --------------------------------------------------------------------------- @@ -145,96 +261,235 @@ void wxToolTip::SetDelay(long milliseconds) // --------------------------------------------------------------------------- // create the tooltip ctrl for our parent frame if it doesn't exist yet +/* static */ WXHWND wxToolTip::GetToolTipCtrl() { - // find either parent dialog or parent frame - tooltip controls are managed - // by these 2 classes only (it doesn't make sense to create one tooltip per - // each and every wxWindow) - wxFrame *frame = NULL; - wxDialog *dialog = NULL; - - wxWindow *parent = m_window; - while ( parent ) + if ( !ms_hwndTT ) { - if ( parent->IsKindOf(CLASSINFO(wxFrame)) ) - { - frame = (wxFrame *)parent; - - break; - } - else if ( parent->IsKindOf(CLASSINFO(wxDialog)) ) + WXDWORD exflags = 0; + if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft ) { - dialog = (wxDialog *)parent; - - break; + exflags |= WS_EX_LAYOUTRTL; } - parent = parent->GetParent(); - } - - wxCHECK_MSG( frame || dialog, 0, - "can't create tooltip control outside a frame or a dialog" ); - - HWND hwndTT = (HWND)(frame ? frame->GetToolTipCtrl() - : dialog->GetToolTipCtrl()); - if ( !hwndTT ) - { - hwndTT = ::CreateWindow(TOOLTIPS_CLASS, - (LPSTR)NULL, - TTS_ALWAYSTIP, - CW_USEDEFAULT, CW_USEDEFAULT, - CW_USEDEFAULT, CW_USEDEFAULT, - (HWND)parent->GetHWND(), (HMENU)NULL, - wxGetInstance(), NULL); - - if ( hwndTT ) - { - if ( frame ) - frame->SetToolTipCtrl((WXHWND)hwndTT); - else - dialog->SetToolTipCtrl((WXHWND)hwndTT); - } - else - { - wxLogSysError(_("Can not create tooltip control")); - } + // 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)::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; + SetWindowPos(hwnd, HWND_TOPMOST, 0, 0, 0, 0, + SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE); + +#if wxUSE_TTM_WINDOWFROMPOINT + // subclass the newly created control + gs_wndprocToolTip = wxSetWindowProc(hwnd, wxToolTipWndProc); +#endif // wxUSE_TTM_WINDOWFROMPOINT + } } - return (WXHWND)hwndTT; + return ms_hwndTT; } +/* static */ void wxToolTip::RelayEvent(WXMSG *msg) { - (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, 0, msg); + (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg); } // ---------------------------------------------------------------------------- // ctor & dtor // ---------------------------------------------------------------------------- +IMPLEMENT_ABSTRACT_CLASS(wxToolTip, wxObject) + wxToolTip::wxToolTip(const wxString &tip) : m_text(tip) { m_window = NULL; + m_others = 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; + m_others = NULL; + + SetWindow(win); } wxToolTip::~wxToolTip() { - // there is no need to Remove() this tool - it will be done automatically - // anyhow + // 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(); + + delete m_others; } // ---------------------------------------------------------------------------- // others // ---------------------------------------------------------------------------- +/* static */ +void wxToolTip::Remove(WXHWND hWnd, unsigned int id, const wxRect& rc) +{ + wxToolInfo ti((HWND)hWnd, id, rc); + + (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti); +} + +void wxToolTip::DoRemove(WXHWND hWnd) +{ + if ( m_window && hWnd == m_window->GetHWND() ) + { + // Remove the tooltip from the main window. + Remove(hWnd, m_id, m_rect); + } + else + { + // Not really sure what to pass to remove in this case... + Remove(hWnd, 0, wxRect()); + } +} + void wxToolTip::Remove() { - // remove this tool from the tooltip control - if ( m_window ) + DoForAllWindows(&wxToolTip::DoRemove); +} + +void wxToolTip::Add(WXHWND hWnd) +{ + if ( !m_others ) + m_others = new wxToolTipOtherWindows; + + m_others->push_back(hWnd); + + DoAddOtherWindow(hWnd); +} + +void wxToolTip::DoAddOtherWindow(WXHWND hWnd) +{ + HWND hwnd = (HWND)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 + // TTN_NEEDTEXT (sent via WM_NOTIFY), but then we would be limited to 79 + // character tooltips as this is the size of the szText buffer in + // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips + // of any length + ti.hwnd = hwnd; + ti.lpszText = const_cast(m_text.wx_str()); + + if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) ) + { + wxLogDebug(wxT("Failed to create the tooltip '%s'"), m_text.c_str()); + + return; + } + +#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 ( !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 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) ) + { + 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 { - wxToolInfo ti(m_window); - (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, 0, &ti); + // 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(m_text.wx_str()); + + if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) ) + { + wxLogDebug(wxT("Failed to create the tooltip '%s'"), m_text.c_str()); + } } } @@ -244,36 +499,87 @@ void wxToolTip::SetWindow(wxWindow *win) m_window = win; + // add the window itself if ( m_window ) { - wxToolInfo ti(m_window); - - // as we store our text anyhow, it seems useless to waste system memory - // by asking the tooltip ctrl to remember it too - instead it will send - // us TTN_NEEDTEXT (via WM_NOTIFY) when it is about to be shown - ti.hwnd = (HWND)m_window->GetHWND(); - ti.lpszText = LPSTR_TEXTCALLBACK; - // instead of: ti.lpszText = (char *)m_text.c_str(); - - if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, 0, &ti) ) + Add(m_window->GetHWND()); + } +#if !defined(__WXUNIVERSAL__) + // and all of its subcontrols (e.g. radio buttons in a radiobox) as well + wxControl *control = wxDynamicCast(m_window, wxControl); + if ( control ) + { + const wxArrayLong& subcontrols = control->GetSubcontrols(); + size_t count = subcontrols.GetCount(); + for ( size_t n = 0; n < count; n++ ) { - wxLogSysError(_("Failed to create the tooltip '%s'"), - m_text.c_str()); + int id = subcontrols[n]; + HWND hwnd = GetDlgItem(GetHwndOf(m_window), id); + if ( !hwnd ) + { + // maybe it's a child of parent of the control, in fact? + // (radiobuttons are subcontrols, i.e. children of the radiobox + // for wxWidgets but are its siblings at Windows level) + hwnd = GetDlgItem(GetHwndOf(m_window->GetParent()), id); + } + + // must have it by now! + 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; + DoForAllWindows(&wxToolTip::DoSetTip); +} + +void wxToolTip::DoSetTip(WXHWND hWnd) +{ + // update the tip text shown by the control + wxToolInfo ti((HWND)hWnd, 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(wxT("")); + (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti); + + ti.lpszText = const_cast(m_text.wx_str()); + (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti); +} + +void wxToolTip::DoForAllWindows(void (wxToolTip::*func)(WXHWND)) +{ if ( m_window ) { - // update it immediately - wxToolInfo ti(m_window); - ti.lpszText = (char *)m_text.c_str(); + (this->*func)(m_window->GetHWND()); + } - (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, 0, &ti); + if ( m_others ) + { + for ( wxToolTipOtherWindows::const_iterator it = m_others->begin(); + it != m_others->end(); + ++it ) + { + (this->*func)(*it); + } } }