src/Utils/MiscUI/HyperLink.cpp

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2012-2016 - TortoiseGit
   4 // Copyright (C) 2003-2006,2008, 2011, 2018 - 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 #include "stdafx.h"
  21 #include "HyperLink.h"
  22 #include "SmartHandle.h"
  23
  24 #ifdef _DEBUG
  25 #define new DEBUG_NEW
  26 #undef THIS_FILE
  27 static char THIS_FILE[] = __FILE__;
  28 #endif
  29
  30 #define TOOLTIP_ID 1
  31
  32
  33 CHyperLink::CHyperLink()
  34         : m_hLinkCursor(nullptr)
  35         , m_crLinkColor(GetSysColor(COLOR_HOTLIGHT))
  36         , m_crHoverColor(RGB(255, 0, 0)) // Red
  37         , m_bOverControl(FALSE)
  38         , m_nUnderline(ulHover)
  39         , m_nTimerID(100)
  40 {
  41 }
  42
  43 CHyperLink::~CHyperLink()
  44 {
  45         m_UnderlineFont.DeleteObject();
  46 }
  47
  48 BOOL CHyperLink::DestroyWindow()
  49 {
  50         KillTimer(m_nTimerID);
  51
  52         return CStatic::DestroyWindow();
  53 }
  54
  55 BOOL CHyperLink::PreTranslateMessage(MSG* pMsg)
  56 {
  57         m_ToolTip.RelayEvent(pMsg);
  58         return CStatic::PreTranslateMessage(pMsg);
  59 }
  60
  61
  62 void CHyperLink::PreSubclassWindow()
  63 {
  64         // Enable notifications - CStatic has this disabled by default
  65         ModifyStyle(0, SS_NOTIFY);
  66
  67         // By default use the label text as the URL
  68         if (m_strURL.IsEmpty())
  69                 GetWindowText(m_strURL);
  70
  71         CString strWndText;
  72         GetWindowText(strWndText);
  73         if (strWndText.IsEmpty())
  74         {
  75                 SetWindowText(m_strURL);
  76         }
  77
  78         LOGFONT lf;
  79         CFont* pFont = GetFont();
  80         if (pFont)
  81                 pFont->GetObject(sizeof(lf), &lf);
  82         else
  83         {
  84                 NONCLIENTMETRICS metrics = { 0 };
  85                 metrics.cbSize = sizeof(NONCLIENTMETRICS);
  86                 SystemParametersInfo(SPI_GETNONCLIENTMETRICS, 0, &metrics, FALSE);
  87                 memcpy_s(&lf, sizeof(LOGFONT), &metrics.lfMessageFont, sizeof(LOGFONT));
  88         }
  89         m_StdFont.CreateFontIndirect(&lf);
  90         lf.lfUnderline = (BYTE) TRUE;
  91         m_UnderlineFont.CreateFontIndirect(&lf);
  92
  93         SetDefaultCursor(); // try loading a "hand" cursor
  94         SetUnderline();
  95
  96         CRect rect;
  97         GetClientRect(rect);
  98         m_ToolTip.Create(this);
  99         m_ToolTip.AddTool(this, m_strURL, rect, TOOLTIP_ID);
 100
 101         CStatic::PreSubclassWindow();
 102 }
 103
 104 BEGIN_MESSAGE_MAP(CHyperLink, CStatic)
 105         ON_WM_CTLCOLOR_REFLECT()
 106         ON_WM_SETCURSOR()
 107         ON_WM_MOUSEMOVE()
 108         ON_WM_TIMER()
 109         ON_WM_ERASEBKGND()
 110         ON_CONTROL_REFLECT(STN_CLICKED, OnClicked)
 111         ON_WM_SYSCOLORCHANGE()
 112 END_MESSAGE_MAP()
 113
 114
 115 void CHyperLink::OnClicked()
 116 {
 117         if(!m_strURL.IsEmpty())
 118         {
 119                 GotoURL(m_strURL);
 120         }
 121         else
 122         {
 123                 ::SendMessage(this->GetParent()->m_hWnd,WM_COMMAND,this->GetDlgCtrlID(),0);
 124         }
 125 }
 126
 127 HBRUSH CHyperLink::CtlColor(CDC* pDC, UINT /*nCtlColor*/)
 128 {
 129         if (m_bOverControl)
 130                 pDC->SetTextColor(m_crHoverColor);
 131         else
 132                 pDC->SetTextColor(m_crLinkColor);
 133
 134         // draw transparent
 135         pDC->SetBkMode(TRANSPARENT);
 136         return (HBRUSH)GetStockObject(NULL_BRUSH);
 137 }
 138
 139 void CHyperLink::OnMouseMove(UINT nFlags, CPoint point)
 140 {
 141         if (!m_bOverControl)
 142         {
 143                 m_bOverControl = TRUE;
 144
 145                 if (m_nUnderline == ulHover)
 146                         SetFont(&m_UnderlineFont);
 147                 Invalidate();
 148
 149                 SetTimer(m_nTimerID, 100, nullptr);
 150         }
 151         CStatic::OnMouseMove(nFlags, point);
 152 }
 153
 154 void CHyperLink::OnTimer(UINT_PTR nIDEvent)
 155 {
 156         CPoint p(GetMessagePos());
 157         ScreenToClient(&p);
 158
 159         CRect rect;
 160         GetClientRect(rect);
 161         if (!rect.PtInRect(p))
 162         {
 163                 m_bOverControl = FALSE;
 164                 KillTimer(m_nTimerID);
 165
 166                 if (m_nUnderline != ulAlways)
 167                         SetFont(&m_StdFont);
 168                 rect.bottom+=10;
 169                 InvalidateRect(rect);
 170         }
 171
 172         CStatic::OnTimer(nIDEvent);
 173 }
 174
 175 BOOL CHyperLink::OnSetCursor(CWnd* /*pWnd*/, UINT /*nHitTest*/, UINT /*message*/)
 176 {
 177         if (m_hLinkCursor)
 178         {
 179                 ::SetCursor(m_hLinkCursor);
 180                 return TRUE;
 181         }
 182         return FALSE;
 183 }
 184
 185 BOOL CHyperLink::OnEraseBkgnd(CDC* pDC)
 186 {
 187         CRect rect;
 188         GetClientRect(rect);
 189         pDC->FillSolidRect(rect, ::GetSysColor(COLOR_3DFACE));
 190
 191         return TRUE;
 192 }
 193
 194 void CHyperLink::SetURL(CString strURL)
 195 {
 196         m_strURL = strURL;
 197
 198         if (::IsWindow(GetSafeHwnd()))
 199         {
 200                 m_ToolTip.UpdateTipText(strURL, this, TOOLTIP_ID);
 201         }
 202 }
 203
 204 CString CHyperLink::GetURL() const
 205 {
 206         return m_strURL;
 207 }
 208
 209 void CHyperLink::SetColors(COLORREF crLinkColor, COLORREF crHoverColor)
 210 {
 211         m_crLinkColor = crLinkColor;
 212
 213         if (crHoverColor == -1)
 214                 m_crHoverColor = ::GetSysColor(COLOR_HIGHLIGHT);
 215         else
 216                 m_crHoverColor = crHoverColor;
 217
 218         if (::IsWindow(m_hWnd))
 219                 Invalidate();
 220 }
 221
 222 COLORREF CHyperLink::GetLinkColor() const
 223 {
 224         return m_crLinkColor;
 225 }
 226
 227 COLORREF CHyperLink::GetHoverColor() const
 228 {
 229         return m_crHoverColor;
 230 }
 231
 232 void CHyperLink::SetUnderline(int nUnderline /*=ulHover*/)
 233 {
 234         if (m_nUnderline == nUnderline)
 235                 return;
 236
 237         if (::IsWindow(GetSafeHwnd()))
 238         {
 239                 if (nUnderline == ulAlways)
 240                         SetFont(&m_UnderlineFont);
 241                 else
 242                         SetFont(&m_StdFont);
 243
 244                 Invalidate();
 245         }
 246
 247         m_nUnderline = nUnderline;
 248 }
 249
 250 int CHyperLink::GetUnderline() const
 251 {
 252         return m_nUnderline;
 253 }
 254
 255 // The following appeared in Paul DiLascia's Jan 1998 MSJ articles.
 256 // It loads a "hand" cursor from the winhlp32.exe module
 257 void CHyperLink::SetDefaultCursor()
 258 {
 259         if (!m_hLinkCursor)
 260         {
 261                 // first try the windows hand cursor (not available on NT4)
 262 #ifndef OCR_HAND
 263 #       define OCR_HAND 32649
 264 #endif
 265                 HCURSOR hHandCursor = (HCURSOR)::LoadImage(nullptr, MAKEINTRESOURCE(OCR_HAND), IMAGE_CURSOR, 0, 0, LR_DEFAULTSIZE | LR_SHARED);
 266                 if (hHandCursor)
 267                 {
 268                         m_hLinkCursor = hHandCursor;
 269                         return;
 270                 }
 271                 // windows cursor not available, so try to load it from winhlp32.exe
 272                 CString strWndDir;
 273                 GetWindowsDirectory(CStrBuf(strWndDir, MAX_PATH), MAX_PATH);    // Explorer can't handle paths longer than MAX_PATH.
 274                 strWndDir += L"\\winhlp32.exe";
 275                 // This retrieves cursor #106 from winhlp32.exe, which is a hand pointer
 276                 CAutoLibrary hModule = LoadLibrary(strWndDir);
 277                 if (hModule) {
 278                         HCURSOR hHandCursor2 = (HCURSOR)::LoadImage(hModule, MAKEINTRESOURCE(106), IMAGE_CURSOR, 0, 0, LR_DEFAULTSIZE);
 279                         if (hHandCursor2)
 280                                 m_hLinkCursor = CopyCursor(hHandCursor2);
 281                 }
 282         }
 283 }
 284
 285 HINSTANCE CHyperLink::GotoURL(LPCTSTR url)
 286 {
 287         return ShellExecute(nullptr, L"open", url, nullptr, nullptr, SW_SHOW);
 288 }
 289
 290 void CHyperLink::OnSysColorChange()
 291 {
 292         __super::OnSysColorChange();
 293         m_crLinkColor = GetSysColor(COLOR_HOTLIGHT);
 294         Invalidate();
 295 }