src/Utils/MiscUI/HyperLink.cpp

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2006,2008, 2011 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #include "stdafx.h"
  20 #include "HyperLink.h"
  21 #include "SmartHandle.h"
  22
  23 #ifdef _DEBUG
  24 #define new DEBUG_NEW
  25 #undef THIS_FILE
  26 static char THIS_FILE[] = __FILE__;
  27 #endif
  28
  29 #define TOOLTIP_ID 1
  30
  31
  32 CHyperLink::CHyperLink()
  33 {
  34         m_hLinkCursor           = nullptr;                              // No cursor as yet
  35         m_crLinkColor           = RGB(  0,       0,     238);   // Blue
  36         m_crHoverColor          = RGB(255,       0,       0);   // Red
  37         m_bOverControl          = FALSE;                                // Cursor not yet over control
  38         m_nUnderline            = ulHover;                              // Underline the link?
  39         m_strURL.Empty();
  40         m_nTimerID                      = 100;
  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         CFont* pFont = GetFont();
  79         if (!pFont)
  80         {
  81                 HFONT hFont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
  82                 if (!hFont)
  83                         hFont = (HFONT) GetStockObject(ANSI_VAR_FONT);
  84                 if (hFont)
  85                         pFont = CFont::FromHandle(hFont);
  86         }
  87         ASSERT(pFont && pFont->GetSafeHandle());
  88
  89         LOGFONT lf;
  90         pFont->GetLogFont(&lf);
  91         m_StdFont.CreateFontIndirect(&lf);
  92         lf.lfUnderline = (BYTE) TRUE;
  93         m_UnderlineFont.CreateFontIndirect(&lf);
  94
  95         SetDefaultCursor(); // try loading a "hand" cursor
  96         SetUnderline();
  97
  98         CRect rect;
  99         GetClientRect(rect);
 100         m_ToolTip.Create(this);
 101         m_ToolTip.AddTool(this, m_strURL, rect, TOOLTIP_ID);
 102
 103         CStatic::PreSubclassWindow();
 104 }
 105
 106 BEGIN_MESSAGE_MAP(CHyperLink, CStatic)
 107         ON_WM_CTLCOLOR_REFLECT()
 108         ON_WM_SETCURSOR()
 109         ON_WM_MOUSEMOVE()
 110         ON_WM_TIMER()
 111         ON_WM_ERASEBKGND()
 112         ON_CONTROL_REFLECT(STN_CLICKED, OnClicked)
 113 END_MESSAGE_MAP()
 114
 115
 116 void CHyperLink::OnClicked()
 117 {
 118         if(!m_strURL.IsEmpty())
 119         {
 120                 GotoURL(m_strURL);
 121         }
 122         else
 123         {
 124                 ::SendMessage(this->GetParent()->m_hWnd,WM_COMMAND,this->GetDlgCtrlID(),0);
 125         }
 126 }
 127
 128 HBRUSH CHyperLink::CtlColor(CDC* pDC, UINT /*nCtlColor*/)
 129 {
 130         if (m_bOverControl)
 131                 pDC->SetTextColor(m_crHoverColor);
 132         else
 133                 pDC->SetTextColor(m_crLinkColor);
 134
 135         // draw transparent
 136         pDC->SetBkMode(TRANSPARENT);
 137         return (HBRUSH)GetStockObject(NULL_BRUSH);
 138 }
 139
 140 void CHyperLink::OnMouseMove(UINT nFlags, CPoint point)
 141 {
 142         if (!m_bOverControl)
 143         {
 144                 m_bOverControl = TRUE;
 145
 146                 if (m_nUnderline == ulHover)
 147                         SetFont(&m_UnderlineFont);
 148                 Invalidate();
 149
 150                 SetTimer(m_nTimerID, 100, nullptr);
 151         }
 152         CStatic::OnMouseMove(nFlags, point);
 153 }
 154
 155 void CHyperLink::OnTimer(UINT_PTR nIDEvent)
 156 {
 157         CPoint p(GetMessagePos());
 158         ScreenToClient(&p);
 159
 160         CRect rect;
 161         GetClientRect(rect);
 162         if (!rect.PtInRect(p))
 163         {
 164                 m_bOverControl = FALSE;
 165                 KillTimer(m_nTimerID);
 166
 167                 if (m_nUnderline != ulAlways)
 168                         SetFont(&m_StdFont);
 169                 rect.bottom+=10;
 170                 InvalidateRect(rect);
 171         }
 172
 173         CStatic::OnTimer(nIDEvent);
 174 }
 175
 176 BOOL CHyperLink::OnSetCursor(CWnd* /*pWnd*/, UINT /*nHitTest*/, UINT /*message*/)
 177 {
 178         if (m_hLinkCursor)
 179         {
 180                 ::SetCursor(m_hLinkCursor);
 181                 return TRUE;
 182         }
 183         return FALSE;
 184 }
 185
 186 BOOL CHyperLink::OnEraseBkgnd(CDC* pDC)
 187 {
 188         CRect rect;
 189         GetClientRect(rect);
 190         pDC->FillSolidRect(rect, ::GetSysColor(COLOR_3DFACE));
 191
 192         return TRUE;
 193 }
 194
 195 void CHyperLink::SetURL(CString strURL)
 196 {
 197         m_strURL = strURL;
 198
 199         if (::IsWindow(GetSafeHwnd()))
 200         {
 201                 m_ToolTip.UpdateTipText(strURL, this, TOOLTIP_ID);
 202         }
 203 }
 204
 205 CString CHyperLink::GetURL() const
 206 {
 207         return m_strURL;
 208 }
 209
 210 void CHyperLink::SetColors(COLORREF crLinkColor, COLORREF crHoverColor)
 211 {
 212         m_crLinkColor = crLinkColor;
 213
 214         if (crHoverColor == -1)
 215                 m_crHoverColor = ::GetSysColor(COLOR_HIGHLIGHT);
 216         else
 217                 m_crHoverColor = crHoverColor;
 218
 219         if (::IsWindow(m_hWnd))
 220                 Invalidate();
 221 }
 222
 223 COLORREF CHyperLink::GetLinkColor() const
 224 {
 225         return m_crLinkColor;
 226 }
 227
 228 COLORREF CHyperLink::GetHoverColor() const
 229 {
 230         return m_crHoverColor;
 231 }
 232
 233 void CHyperLink::SetUnderline(int nUnderline /*=ulHover*/)
 234 {
 235         if (m_nUnderline == nUnderline)
 236                 return;
 237
 238         if (::IsWindow(GetSafeHwnd()))
 239         {
 240                 if (nUnderline == ulAlways)
 241                         SetFont(&m_UnderlineFont);
 242                 else
 243                         SetFont(&m_StdFont);
 244
 245                 Invalidate();
 246         }
 247
 248         m_nUnderline = nUnderline;
 249 }
 250
 251 int CHyperLink::GetUnderline() const
 252 {
 253         return m_nUnderline;
 254 }
 255
 256 // The following appeared in Paul DiLascia's Jan 1998 MSJ articles.
 257 // It loads a "hand" cursor from the winhlp32.exe module
 258 void CHyperLink::SetDefaultCursor()
 259 {
 260         if (!m_hLinkCursor)
 261         {
 262                 // first try the windows hand cursor (not available on NT4)
 263 #ifndef OCR_HAND
 264 #       define OCR_HAND 32649
 265 #endif
 266                 HCURSOR hHandCursor = (HCURSOR)::LoadImage(nullptr, MAKEINTRESOURCE(OCR_HAND), IMAGE_CURSOR, 0, 0, LR_DEFAULTSIZE | LR_SHARED);
 267                 if (hHandCursor)
 268                 {
 269                         m_hLinkCursor = hHandCursor;
 270                         return;
 271                 }
 272                 // windows cursor not available, so try to load it from winhlp32.exe
 273                 CString strWndDir;
 274                 GetWindowsDirectory(strWndDir.GetBuffer(MAX_PATH), MAX_PATH);   // Explorer can't handle paths longer than MAX_PATH.
 275                 strWndDir.ReleaseBuffer();
 276
 277                 strWndDir += _T("\\winhlp32.exe");
 278                 // This retrieves cursor #106 from winhlp32.exe, which is a hand pointer
 279                 CAutoLibrary hModule = LoadLibrary(strWndDir);
 280                 if (hModule) {
 281                         HCURSOR hHandCursor2 = (HCURSOR)::LoadImage(hModule, MAKEINTRESOURCE(106), IMAGE_CURSOR, 0, 0, LR_DEFAULTSIZE);
 282                         if (hHandCursor2)
 283                                 m_hLinkCursor = CopyCursor(hHandCursor2);
 284                 }
 285         }
 286 }
 287
 288 HINSTANCE CHyperLink::GotoURL(LPCTSTR url)
 289 {
 290         return ShellExecute(nullptr, _T("open"), url, nullptr, nullptr, SW_SHOW);
 291 }