src/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 licence
///////////////////////////////////////////////////////////////////////////////

// ============================================================================
// declarations
// ============================================================================

// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------

#include "wx/wxprec.h"

#ifdef __BORLANDC__
    #pragma hdrstop
#endif

#if wxUSE_TOOLTIPS

#include "wx/tooltip.h"

#ifndef WX_PRECOMP
    #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
    #include "wx/app.h"
    #include "wx/control.h"
    #include "wx/combobox.h"
#endif

#include "wx/tokenzr.h"
#include "wx/msw/private.h"

// 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;

#if wxUSE_TTM_WINDOWFROMPOINT

// the tooltip window proc
static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;

#endif // wxUSE_TTM_WINDOWFROMPOINT

// ----------------------------------------------------------------------------
// private classes
// ----------------------------------------------------------------------------

// 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(HWND hwndOwner)
    {
        // initialize all members
        ::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

        hwnd = hwndOwner;
        uFlags = TTF_IDISHWND;
        uId = (UINT)hwndOwner;
    }
};

#ifdef __VISUALC__
    #pragma warning( default : 4097 )
#endif

// ----------------------------------------------------------------------------
// private functions
// ----------------------------------------------------------------------------

// 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, 0, (LPARAM)lParam) : 0;
}

// send a message to all existing tooltip controls
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)
{
    if ( msg == TTM_WINDOWFROMPOINT )
    {
        LPPOINT ppt = (LPPOINT)lParam;

        // the window on which event occurred
        HWND hwnd = ::WindowFromPoint(*ppt);

        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 )
        {
            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
        {
            OutputDebugString("no window\r\n");
        }
    }

    return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip, hwndTT, msg, wParam, lParam);
}

#endif // wxUSE_TTM_WINDOWFROMPOINT

// ----------------------------------------------------------------------------
// static functions
// ----------------------------------------------------------------------------

void wxToolTip::Enable(bool flag)
{
    SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
}

void wxToolTip::SetDelay(long milliseconds)
{
    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);
}

// ---------------------------------------------------------------------------
// implementation helpers
// ---------------------------------------------------------------------------

// create the tooltip ctrl for our parent frame if it doesn't exist yet
/* static */
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)::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 ms_hwndTT;
}

/* static */
void wxToolTip::RelayEvent(WXMSG *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;
}

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();
}

// ----------------------------------------------------------------------------
// others
// ----------------------------------------------------------------------------

void wxToolTip::Remove(WXHWND hWnd)
{
    wxToolInfo ti((HWND)hWnd);
    (void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti);
}

void wxToolTip::Remove()
{
    // remove this tool from the tooltip control
    if ( m_window )
    {
        Remove(m_window->GetHWND());
    }
}

void wxToolTip::Add(WXHWND hWnd)
{
    HWND hwnd = (HWND)hWnd;

    wxToolInfo ti(hwnd);

    // 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 = (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());
    }
    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 ( !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);
            }
            else
#endif // comctl32.dll >= 4.70
            {
                // 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());
                }
            }
        }
    }
}

void wxToolTip::SetWindow(wxWindow *win)
{
    Remove();

    m_window = win;

    // add the window itself
    if ( m_window )
    {
        Add(m_window->GetHWND());
    }
#if !defined(__WXUNIVERSAL__)
    // and all of its subcontrols (e.g. radiobuttons 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++ )
        {
            int id = subcontrols[n];
            HWND hwnd = GetDlgItem(GetHwndOf(m_window), id);
            if ( !hwnd )
            {
                // may be 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, _T("no hwnd for subcontrol?") );

            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__)
}

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();

        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
    }
}

#endif // wxUSE_TOOLTIPS
Commit	Line	Data
	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: src/msw/tooltip.cpp
	3	// Purpose: wxToolTip class implementation for MSW
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 31.01.99
	7	// RCS-ID: $Id$
	8	// Copyright: (c) 1999 Vadim Zeitlin
	9	// Licence: wxWindows licence
	10	///////////////////////////////////////////////////////////////////////////////
	11
	12	// ============================================================================
	13	// declarations
	14	// ============================================================================
	15
	16	// ----------------------------------------------------------------------------
	17	// headers
	18	// ----------------------------------------------------------------------------
	19
	20	#include "wx/wxprec.h"
	21
	22	#ifdef __BORLANDC__
	23	#pragma hdrstop
	24	#endif
	25
	26	#if wxUSE_TOOLTIPS
	27
	28	#include "wx/tooltip.h"
	29
	30	#ifndef WX_PRECOMP
	31	#include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
	32	#include "wx/app.h"
	33	#include "wx/control.h"
	34	#include "wx/combobox.h"
	35	#endif
	36
	37	#include "wx/tokenzr.h"
	38	#include "wx/msw/private.h"
	39
	40	// VZ: normally, the trick with subclassing the tooltip control and processing
	41	// TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
	42	// code here for now (but it's not compiled) in case we need it later.
	43	//
	44	// For now I use an ugly workaround and process TTN_NEEDTEXT directly in
	45	// radio button wnd proc - fixing TTM_WINDOWFROMPOINT code would be nice
	46	// because it would then work for all controls, not only radioboxes but for
	47	// now I don't understand what's wrong with it...
	48	#define wxUSE_TTM_WINDOWFROMPOINT 0
	49
	50	// ----------------------------------------------------------------------------
	51	// global variables
	52	// ----------------------------------------------------------------------------
	53
	54	// the tooltip parent window
	55	WXHWND wxToolTip::ms_hwndTT = (WXHWND)NULL;
	56
	57	#if wxUSE_TTM_WINDOWFROMPOINT
	58
	59	// the tooltip window proc
	60	static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
	61
	62	#endif // wxUSE_TTM_WINDOWFROMPOINT
	63
	64	// ----------------------------------------------------------------------------
	65	// private classes
	66	// ----------------------------------------------------------------------------
	67
	68	// a wrapper around TOOLINFO Win32 structure
	69	#ifdef __VISUALC__
	70	#pragma warning( disable : 4097 ) // we inherit from a typedef - so what?
	71	#endif
	72
	73	class wxToolInfo : public TOOLINFO
	74	{
	75	public:
	76	wxToolInfo(HWND hwndOwner)
	77	{
	78	// initialize all members
	79	::ZeroMemory(this, sizeof(TOOLINFO));
	80
	81	// the structure TOOLINFO has been extended with a 4 byte field in
	82	// version 4.70 of comctl32.dll and if we compile on a newer machine
	83	// but run on one with the old version of comctl32, nothing will work
	84	// because the library will detect that we rely on a more recent
	85	// version of it. So we always use the old size - if we ever start
	86	// using our lParam member, we'd have to check for comctl32 version
	87	// during run-time
	88	#if _WIN32_IE >= 0x0300
	89	cbSize = sizeof(TOOLINFO) - sizeof(LPARAM);
	90	#else // old headers
	91	cbSize = sizeof(TOOLINFO);
	92	#endif // compile-time comctl32.dll version
	93
	94	hwnd = hwndOwner;
	95	uFlags = TTF_IDISHWND;
	96	uId = (UINT)hwndOwner;
	97	}
	98	};
	99
	100	#ifdef __VISUALC__
	101	#pragma warning( default : 4097 )
	102	#endif
	103
	104	// ----------------------------------------------------------------------------
	105	// private functions
	106	// ----------------------------------------------------------------------------
	107
	108	// send a message to the tooltip control if it exists
	109	//
	110	// NB: wParam is always 0 for the TTM_XXX messages we use
	111	static inline LRESULT SendTooltipMessage(WXHWND hwnd, UINT msg, void *lParam)
	112	{
	113	return hwnd ? ::SendMessage((HWND)hwnd, msg, 0, (LPARAM)lParam) : 0;
	114	}
	115
	116	// send a message to all existing tooltip controls
	117	static inline void
	118	SendTooltipMessageToAll(WXHWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
	119	{
	120	if ( hwnd )
	121	::SendMessage((HWND)hwnd, msg, wParam, lParam);
	122	}
	123
	124	// ============================================================================
	125	// implementation
	126	// ============================================================================
	127
	128	#if wxUSE_TTM_WINDOWFROMPOINT
	129
	130	// ----------------------------------------------------------------------------
	131	// window proc for our tooltip control
	132	// ----------------------------------------------------------------------------
	133
	134	LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
	135	UINT msg,
	136	WPARAM wParam,
	137	LPARAM lParam)
	138	{
	139	if ( msg == TTM_WINDOWFROMPOINT )
	140	{
	141	LPPOINT ppt = (LPPOINT)lParam;
	142
	143	// the window on which event occurred
	144	HWND hwnd = ::WindowFromPoint(*ppt);
	145
	146	OutputDebugString("TTM_WINDOWFROMPOINT: ");
	147	OutputDebugString(wxString::Format("0x%08x => ", hwnd));
	148
	149	// return a HWND corresponding to a wxWindow because only wxWidgets are
	150	// associated with tooltips using TTM_ADDTOOL
	151	wxWindow *win = wxGetWindowFromHWND((WXHWND)hwnd);
	152
	153	if ( win )
	154	{
	155	hwnd = GetHwndOf(win);
	156	OutputDebugString(wxString::Format("0x%08x\r\n", hwnd));
	157
	158	#if 0
	159	// modify the point too!
	160	RECT rect;
	161	GetWindowRect(hwnd, &rect);
	162
	163	ppt->x = (rect.right - rect.left) / 2;
	164	ppt->y = (rect.bottom - rect.top) / 2;
	165	#endif // 0
	166	return (LRESULT)hwnd;
	167	}
	168	else
	169	{
	170	OutputDebugString("no window\r\n");
	171	}
	172	}
	173
	174	return ::CallWindowProc(CASTWNDPROC gs_wndprocToolTip, hwndTT, msg, wParam, lParam);
	175	}
	176
	177	#endif // wxUSE_TTM_WINDOWFROMPOINT
	178
	179	// ----------------------------------------------------------------------------
	180	// static functions
	181	// ----------------------------------------------------------------------------
	182
	183	void wxToolTip::Enable(bool flag)
	184	{
	185	SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
	186	}
	187
	188	void wxToolTip::SetDelay(long milliseconds)
	189	{
	190	SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
	191	TTDT_INITIAL, milliseconds);
	192	}
	193
	194	void wxToolTip::SetAutoPop(long milliseconds)
	195	{
	196	SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
	197	TTDT_AUTOPOP, milliseconds);
	198	}
	199
	200	void wxToolTip::SetReshow(long milliseconds)
	201	{
	202	SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
	203	TTDT_RESHOW, milliseconds);
	204	}
	205
	206	// ---------------------------------------------------------------------------
	207	// implementation helpers
	208	// ---------------------------------------------------------------------------
	209
	210	// create the tooltip ctrl for our parent frame if it doesn't exist yet
	211	/* static */
	212	WXHWND wxToolTip::GetToolTipCtrl()
	213	{
	214	if ( !ms_hwndTT )
	215	{
	216	WXDWORD exflags = 0;
	217	if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
	218	{
	219	exflags \|= WS_EX_LAYOUTRTL;
	220	}
	221
	222	// we want to show the tooltips always (even when the window is not
	223	// active) and we don't want to strip "&"s from them
	224	ms_hwndTT = (WXHWND)::CreateWindowEx(exflags,
	225	TOOLTIPS_CLASS,
	226	(LPCTSTR)NULL,
	227	TTS_ALWAYSTIP \| TTS_NOPREFIX,
	228	CW_USEDEFAULT, CW_USEDEFAULT,
	229	CW_USEDEFAULT, CW_USEDEFAULT,
	230	NULL, (HMENU)NULL,
	231	wxGetInstance(),
	232	NULL);
	233	if ( ms_hwndTT )
	234	{
	235	HWND hwnd = (HWND)ms_hwndTT;
	236	SetWindowPos(hwnd, HWND_TOPMOST, 0, 0, 0, 0,
	237	SWP_NOMOVE \| SWP_NOSIZE \| SWP_NOACTIVATE);
	238
	239	#if wxUSE_TTM_WINDOWFROMPOINT
	240	// subclass the newly created control
	241	gs_wndprocToolTip = wxSetWindowProc(hwnd, wxToolTipWndProc);
	242	#endif // wxUSE_TTM_WINDOWFROMPOINT
	243	}
	244	}
	245
	246	return ms_hwndTT;
	247	}
	248
	249	/* static */
	250	void wxToolTip::RelayEvent(WXMSG *msg)
	251	{
	252	(void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);
	253	}
	254
	255	// ----------------------------------------------------------------------------
	256	// ctor & dtor
	257	// ----------------------------------------------------------------------------
	258
	259	IMPLEMENT_ABSTRACT_CLASS(wxToolTip, wxObject)
	260
	261	wxToolTip::wxToolTip(const wxString &tip)
	262	: m_text(tip)
	263	{
	264	m_window = NULL;
	265	}
	266
	267	wxToolTip::~wxToolTip()
	268	{
	269	// the tooltip has to be removed before deleting. Otherwise, if it is visible
	270	// while being deleted, there will be a delay before it goes away.
	271	Remove();
	272	}
	273
	274	// ----------------------------------------------------------------------------
	275	// others
	276	// ----------------------------------------------------------------------------
	277
	278	void wxToolTip::Remove(WXHWND hWnd)
	279	{
	280	wxToolInfo ti((HWND)hWnd);
	281	(void)SendTooltipMessage(GetToolTipCtrl(), TTM_DELTOOL, &ti);
	282	}
	283
	284	void wxToolTip::Remove()
	285	{
	286	// remove this tool from the tooltip control
	287	if ( m_window )
	288	{
	289	Remove(m_window->GetHWND());
	290	}
	291	}
	292
	293	void wxToolTip::Add(WXHWND hWnd)
	294	{
	295	HWND hwnd = (HWND)hWnd;
	296
	297	wxToolInfo ti(hwnd);
	298
	299	// another possibility would be to specify LPSTR_TEXTCALLBACK here as we
	300	// store the tooltip text ourselves anyhow, and provide it in response to
	301	// TTN_NEEDTEXT (sent via WM_NOTIFY), but then we would be limited to 79
	302	// character tooltips as this is the size of the szText buffer in
	303	// NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
	304	// of any length
	305	ti.hwnd = hwnd;
	306	ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast
	307
	308	if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
	309	{
	310	wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
	311	}
	312	else
	313	{
	314	// check for multiline toopltip
	315	int index = m_text.Find(_T('\n'));
	316
	317	if ( index != wxNOT_FOUND )
	318	{
	319	#ifdef TTM_SETMAXTIPWIDTH
	320	if ( wxApp::GetComCtl32Version() >= 470 )
	321	{
	322	// use TTM_SETMAXTIPWIDTH to make tooltip multiline using the
	323	// extent of its first line as max value
	324	HFONT hfont = (HFONT)
	325	SendTooltipMessage(GetToolTipCtrl(), WM_GETFONT, 0);
	326
	327	if ( !hfont )
	328	{
	329	hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
	330	if ( !hfont )
	331	{
	332	wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
	333	}
	334	}
	335
	336	MemoryHDC hdc;
	337	if ( !hdc )
	338	{
	339	wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
	340	}
	341
	342	if ( !SelectObject(hdc, hfont) )
	343	{
	344	wxLogLastError(wxT("SelectObject(hfont)"));
	345	}
	346
	347	// find the width of the widest line
	348	int max = 0;
	349	wxStringTokenizer tokenizer(m_text, _T("\n"));
	350	wxString token = tokenizer.GetNextToken();
	351	while (token.length())
	352	{
	353	SIZE sz;
	354	if ( !::GetTextExtentPoint32(hdc, token.wx_str(), token.length(), &sz) )
	355	{
	356	wxLogLastError(wxT("GetTextExtentPoint32"));
	357	}
	358	if ( sz.cx > max )
	359	max = sz.cx;
	360
	361	token = tokenizer.GetNextToken();
	362	}
	363
	364	// only set a new width if it is bigger than the current setting
	365	if (max > SendTooltipMessage(GetToolTipCtrl(), TTM_GETMAXTIPWIDTH, 0))
	366	SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
	367	(void *)max);
	368	}
	369	else
	370	#endif // comctl32.dll >= 4.70
	371	{
	372	// replace the '\n's with spaces because otherwise they appear as
	373	// unprintable characters in the tooltip string
	374	m_text.Replace(_T("\n"), _T(" "));
	375	ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast
	376
	377	if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
	378	{
	379	wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
	380	}
	381	}
	382	}
	383	}
	384	}
	385
	386	void wxToolTip::SetWindow(wxWindow *win)
	387	{
	388	Remove();
	389
	390	m_window = win;
	391
	392	// add the window itself
	393	if ( m_window )
	394	{
	395	Add(m_window->GetHWND());
	396	}
	397	#if !defined(__WXUNIVERSAL__)
	398	// and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
	399	wxControl *control = wxDynamicCast(m_window, wxControl);
	400	if ( control )
	401	{
	402	const wxArrayLong& subcontrols = control->GetSubcontrols();
	403	size_t count = subcontrols.GetCount();
	404	for ( size_t n = 0; n < count; n++ )
	405	{
	406	int id = subcontrols[n];
	407	HWND hwnd = GetDlgItem(GetHwndOf(m_window), id);
	408	if ( !hwnd )
	409	{
	410	// may be it's a child of parent of the control, in fact?
	411	// (radiobuttons are subcontrols, i.e. children of the radiobox
	412	// for wxWidgets but are its siblings at Windows level)
	413	hwnd = GetDlgItem(GetHwndOf(m_window->GetParent()), id);
	414	}
	415
	416	// must have it by now!
	417	wxASSERT_MSG( hwnd, _T("no hwnd for subcontrol?") );
	418
	419	Add((WXHWND)hwnd);
	420	}
	421	}
	422
	423	// VZ: it's ugly to do it here, but I don't want any major changes right
	424	// now, later we will probably want to have wxWindow::OnGotToolTip() or
	425	// something like this where the derived class can do such things
	426	// itself instead of wxToolTip "knowing" about them all
	427	wxComboBox *combo = wxDynamicCast(control, wxComboBox);
	428	if ( combo )
	429	{
	430	WXHWND hwndComboEdit = combo->GetWindowStyle() & wxCB_READONLY
	431	? combo->GetHWND()
	432	: combo->GetEditHWND();
	433	if ( hwndComboEdit )
	434	{
	435	Add(hwndComboEdit);
	436	}
	437	}
	438	#endif // !defined(__WXUNIVERSAL__)
	439	}
	440
	441	void wxToolTip::SetTip(const wxString& tip)
	442	{
	443	m_text = tip;
	444
	445	if ( m_window )
	446	{
	447	// update the tip text shown by the control
	448	wxToolInfo ti(GetHwndOf(m_window));
	449	ti.lpszText = (wxChar *)m_text.wx_str();
	450
	451	(void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
	452	}
	453	}
	454
	455	#endif // wxUSE_TOOLTIPS