src/Utils/MiscUI/Tooltip.cpp

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2011 - Sven Strickroth <email@cs-ware.de>
   4 // Copyright (C) 2008-2012 - TortoiseSVN
   5
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software Foundation,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20
  21 #include "stdafx.h"
  22 #include "Tooltip.h"
  23
  24
  25 BEGIN_MESSAGE_MAP(CToolTips, CToolTipCtrl)
  26         ON_NOTIFY_REFLECT_EX( TTN_NEEDTEXT, &CToolTips::OnTtnNeedText )
  27 END_MESSAGE_MAP()
  28
  29
  30
  31 BOOL CToolTips::OnTtnNeedText(NMHDR *pNMHDR, LRESULT *pResult)
  32 {
  33         if (pNMHDR->code == TTN_NEEDTEXTW)
  34         {
  35                 LPNMTTDISPINFO lpnmtdi = (LPNMTTDISPINFO)pNMHDR;
  36                 UINT_PTR nID = pNMHDR->idFrom;
  37
  38                 if (lpnmtdi->uFlags & TTF_IDISHWND)
  39                 {
  40                         // idFrom is actually the HWND of the tool
  41                         nID = ::GetDlgCtrlID((HWND)nID);
  42                 }
  43
  44                 auto iterFind = toolTextMap.find((unsigned int)nID);
  45                 if (iterFind != toolTextMap.end())
  46                 {
  47                         lpnmtdi->lpszText = (LPTSTR)(LPCTSTR)iterFind->second;
  48                         lpnmtdi->hinst = AfxGetResourceHandle();
  49                         *pResult = 0;
  50                         return TRUE;
  51                 }
  52         }
  53         return FALSE;
  54 }
  55
  56 BOOL CToolTips::AddTool(CWnd* pWnd, UINT nIDText, LPCRECT lpRectTool /* = NULL */, UINT_PTR nIDTool /* = 0 */)
  57 {
  58         CString sTemp = LoadTooltip(nIDText);
  59         toolTextMap[::GetDlgCtrlID(pWnd->GetSafeHwnd())] = sTemp;
  60         return CToolTipCtrl::AddTool(pWnd, LPSTR_TEXTCALLBACK, lpRectTool, nIDTool);
  61 }
  62
  63 BOOL CToolTips::AddTool(CWnd* pWnd, LPCTSTR lpszText /* = LPSTR_TEXTCALLBACK */, LPCRECT lpRectTool /* = NULL */, UINT_PTR nIDTool /* = 0 */)
  64 {
  65         if (lpszText != LPSTR_TEXTCALLBACK)
  66                 toolTextMap[::GetDlgCtrlID(pWnd->GetSafeHwnd())] = CString(lpszText);
  67         return CToolTipCtrl::AddTool(pWnd, lpszText, lpRectTool, nIDTool);
  68 }
  69
  70 void CToolTips::AddTool(int nIdWnd, UINT nIdText, LPCRECT lpRectTool /* = NULL */, UINT_PTR nIDTool /* = 0 */)
  71 {
  72         AddTool(((CDialog*)m_pParentWnd)->GetDlgItem(nIdWnd), nIdText, lpRectTool, nIDTool);
  73 }
  74
  75 void CToolTips::AddTool(int nIdWnd, CString sBalloonTipText, LPCRECT lpRectTool /* = NULL */, UINT_PTR nIDTool /* = 0 */)
  76 {
  77         AddTool(((CDialog*)m_pParentWnd)->GetDlgItem(nIdWnd), sBalloonTipText, lpRectTool, nIDTool);
  78 }
  79
  80 void CToolTips::DelTool( CWnd* pWnd, UINT_PTR nIDTool /* = 0 */)
  81 {
  82         toolTextMap.erase(::GetDlgCtrlID(pWnd->GetSafeHwnd()));
  83         return CToolTipCtrl::DelTool(pWnd, nIDTool);
  84 }
  85
  86 void CToolTips::DelTool( int nIdWnd, UINT_PTR nIDTool /* = 0 */)
  87 {
  88         return DelTool(((CDialog*)m_pParentWnd)->GetDlgItem(nIdWnd), nIDTool);
  89 }
  90
  91 BOOL CToolTips::ShowBalloon(CWnd *pWnd, UINT nIDText, UINT nIDTitle, UINT icon /* = 0 */)
  92 {
  93         CString sTemp = LoadTooltip(nIDText);
  94
  95         const HWND hwndTT = CreateWindow
  96                 (
  97                 TOOLTIPS_CLASS,
  98                 _T(""),
  99                 TTS_NOPREFIX|TTS_BALLOON|TTS_ALWAYSTIP|TTS_CLOSE,
 100                 CW_USEDEFAULT, CW_USEDEFAULT,
 101                 CW_USEDEFAULT, CW_USEDEFAULT,
 102                 pWnd->GetSafeHwnd(),
 103                 NULL,
 104                 NULL,
 105                 NULL
 106                 );
 107         if (hwndTT == NULL)
 108                 return FALSE;
 109
 110         TOOLINFO ti = { 0 };
 111         ti.cbSize = sizeof(ti);
 112         ti.uFlags = TTF_TRACK | TTF_IDISHWND | TTF_PARSELINKS;
 113         ti.hwnd = pWnd->GetSafeHwnd();
 114         ti.lpszText = sTemp.GetBuffer();
 115         ::SendMessage(hwndTT, TTM_ADDTOOL, 0, (LPARAM)&ti);
 116         ::SendMessage(hwndTT, TTM_SETTITLE, icon, (LPARAM)(LPCTSTR)CString(MAKEINTRESOURCE(nIDTitle)));
 117         ::SendMessage(hwndTT, TTM_SETMAXTIPWIDTH, 0, 800);
 118
 119         // Position the tooltip below the control
 120         RECT rc;
 121         ::GetWindowRect(pWnd->GetSafeHwnd(), &rc);
 122         ::SendMessage(hwndTT, TTM_TRACKPOSITION, 0, MAKELONG(rc.left + 10, rc.bottom));
 123
 124         // Show the tooltip
 125         ::SendMessage(hwndTT, TTM_TRACKACTIVATE, TRUE, (LPARAM)&ti);
 126
 127         return TRUE;
 128 }
 129
 130 void CToolTips::ShowBalloon(int nIdWnd, UINT nIdText, UINT nIDTitle, UINT icon /* = 0 */)
 131 {
 132         ShowBalloon(((CDialog*)m_pParentWnd)->GetDlgItem(nIdWnd), nIdText, nIDTitle, icon);
 133 }
 134
 135 CString CToolTips::LoadTooltip( UINT nIDText )
 136 {
 137         CString sTemp;
 138         sTemp.LoadString(nIDText);
 139         // tooltips can't handle \t and single \n, only spaces and \r\n
 140         sTemp.Replace('\t', ' ');
 141         sTemp.Replace(_T("\r\n"), _T("\n"));
 142         sTemp.Replace(_T("\n"), _T("\r\n"));
 143         return sTemp;
 144 }
 145
 146 void CToolTips::RelayEvent(LPMSG lpMsg, CWnd * dlgWnd)
 147 {
 148         if (lpMsg->message == WM_NULL)
 149                 return;
 150
 151         if(dlgWnd && ((lpMsg->message == WM_MOUSEMOVE) || (lpMsg->message == WM_NCMOUSEMOVE)) && (lpMsg->hwnd == dlgWnd->m_hWnd))
 152         {
 153                 // allow tooltips for disabled controls
 154                 CRect  rect;
 155                 POINT  pt;
 156
 157                 pt.x = LOWORD(lpMsg->lParam);
 158                 pt.y = HIWORD(lpMsg->lParam);
 159
 160                 for (auto it = toolTextMap.cbegin(); it != toolTextMap.cend(); ++it)
 161                 {
 162                         CWnd * pWndCtrl = dlgWnd->GetDlgItem(it->first);
 163                         pWndCtrl->GetWindowRect(&rect);
 164                         if (lpMsg->message == WM_MOUSEMOVE)
 165                                 dlgWnd->ScreenToClient(&rect);
 166
 167                         if(rect.PtInRect(pt) )
 168                         {
 169                                 // save the original parameters
 170                                 HWND origHwnd = lpMsg->hwnd;
 171                                 LPARAM origLParam = lpMsg->lParam;
 172
 173                                 // translate and relay the mouse move message to
 174                                 // the tooltip control as if they were sent
 175                                 // by the disabled control
 176                                 lpMsg->hwnd = pWndCtrl->m_hWnd;
 177
 178                                 if (lpMsg->message == WM_MOUSEMOVE)
 179                                         dlgWnd->ClientToScreen(&pt);
 180                                 pWndCtrl->ScreenToClient(&pt);
 181                                 lpMsg->lParam = MAKELPARAM(pt.x, pt.y);
 182
 183                                 __super::RelayEvent(lpMsg);
 184
 185                                 // restore the original parameters
 186                                 lpMsg->hwnd = origHwnd;
 187                                 lpMsg->lParam = origLParam;
 188                                 return;
 189                         }
 190                 }
 191         }
 192
 193         // Let the ToolTip process this message.
 194         __super::RelayEvent(lpMsg);
 195 }