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           = NULL;                                 // 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         DWORD dwStyle = GetStyle();
  66         ::SetWindowLong(GetSafeHwnd(), GWL_STYLE, dwStyle | SS_NOTIFY);
  67
  68         // By default use the label text as the URL
  69         if (m_strURL.IsEmpty())
  70                 GetWindowText(m_strURL);
  71
  72         CString strWndText;
  73         GetWindowText(strWndText);
  74         if (strWndText.IsEmpty())
  75         {
  76                 SetWindowText(m_strURL);
  77         }
  78
  79         CFont* pFont = GetFont();
  80         if (!pFont)
  81         {
  82                 HFONT hFont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
  83                 if (hFont == NULL)
  84                         hFont = (HFONT) GetStockObject(ANSI_VAR_FONT);
  85                 if (hFont)
  86                         pFont = CFont::FromHandle(hFont);
  87         }
  88         ASSERT(pFont && pFont->GetSafeHandle());
  89
  90         LOGFONT lf;
  91         pFont->GetLogFont(&lf);
  92         m_StdFont.CreateFontIndirect(&lf);
  93         lf.lfUnderline = (BYTE) TRUE;
  94         m_UnderlineFont.CreateFontIndirect(&lf);
  95
  96         SetDefaultCursor(); // try loading a "hand" cursor
  97         SetUnderline();
  98
  99         CRect rect;
 100         GetClientRect(rect);
 101         m_ToolTip.Create(this);
 102         m_ToolTip.AddTool(this, m_strURL, rect, TOOLTIP_ID);
 103
 104         CStatic::PreSubclassWindow();
 105 }
 106
 107 BEGIN_MESSAGE_MAP(CHyperLink, CStatic)
 108         ON_WM_CTLCOLOR_REFLECT()
 109         ON_WM_SETCURSOR()
 110         ON_WM_MOUSEMOVE()
 111         ON_WM_TIMER()
 112         ON_WM_ERASEBKGND()
 113         ON_CONTROL_REFLECT(STN_CLICKED, OnClicked)
 114 END_MESSAGE_MAP()
 115
 116
 117 void CHyperLink::OnClicked()
 118 {
 119         if(!m_strURL.IsEmpty())
 120         {
 121                 GotoURL(m_strURL);
 122         }
 123         else
 124         {
 125                 ::SendMessage(this->GetParent()->m_hWnd,WM_COMMAND,this->GetDlgCtrlID(),0);
 126         }
 127 }
 128
 129 HBRUSH CHyperLink::CtlColor(CDC* pDC, UINT /*nCtlColor*/)
 130 {
 131         if (m_bOverControl)
 132                 pDC->SetTextColor(m_crHoverColor);
 133         else
 134                 pDC->SetTextColor(m_crLinkColor);
 135
 136         // draw transparent
 137         pDC->SetBkMode(TRANSPARENT);
 138         return (HBRUSH)GetStockObject(NULL_BRUSH);
 139 }
 140
 141 void CHyperLink::OnMouseMove(UINT nFlags, CPoint point)
 142 {
 143         if (!m_bOverControl)
 144         {
 145                 m_bOverControl = TRUE;
 146
 147                 if (m_nUnderline == ulHover)
 148                         SetFont(&m_UnderlineFont);
 149                 Invalidate();
 150
 151                 SetTimer(m_nTimerID, 100, NULL);
 152         }
 153         CStatic::OnMouseMove(nFlags, point);
 154 }
 155
 156 void CHyperLink::OnTimer(UINT_PTR nIDEvent)
 157 {
 158         CPoint p(GetMessagePos());
 159         ScreenToClient(&p);
 160
 161         CRect rect;
 162         GetClientRect(rect);
 163         if (!rect.PtInRect(p))
 164         {
 165                 m_bOverControl = FALSE;
 166                 KillTimer(m_nTimerID);
 167
 168                 if (m_nUnderline != ulAlways)
 169                         SetFont(&m_StdFont);
 170                 rect.bottom+=10;
 171                 InvalidateRect(rect);
 172         }
 173
 174         CStatic::OnTimer(nIDEvent);
 175 }
 176
 177 BOOL CHyperLink::OnSetCursor(CWnd* /*pWnd*/, UINT /*nHitTest*/, UINT /*message*/)
 178 {
 179         if (m_hLinkCursor)
 180         {
 181                 ::SetCursor(m_hLinkCursor);
 182                 return TRUE;
 183         }
 184         return FALSE;
 185 }
 186
 187 BOOL CHyperLink::OnEraseBkgnd(CDC* pDC)
 188 {
 189         CRect rect;
 190         GetClientRect(rect);
 191         pDC->FillSolidRect(rect, ::GetSysColor(COLOR_3DFACE));
 192
 193         return TRUE;
 194 }
 195
 196 void CHyperLink::SetURL(CString strURL)
 197 {
 198         m_strURL = strURL;
 199
 200         if (::IsWindow(GetSafeHwnd()))
 201         {
 202                 m_ToolTip.UpdateTipText(strURL, this, TOOLTIP_ID);
 203         }
 204 }
 205
 206 CString CHyperLink::GetURL() const
 207 {
 208         return m_strURL;
 209 }
 210
 211 void CHyperLink::SetColors(COLORREF crLinkColor, COLORREF crHoverColor)
 212 {
 213         m_crLinkColor = crLinkColor;
 214
 215         if (crHoverColor == -1)
 216                 m_crHoverColor = ::GetSysColor(COLOR_HIGHLIGHT);
 217         else
 218                 m_crHoverColor = crHoverColor;
 219
 220         if (::IsWindow(m_hWnd))
 221                 Invalidate();
 222 }
 223
 224 COLORREF CHyperLink::GetLinkColor() const
 225 {
 226         return m_crLinkColor;
 227 }
 228
 229 COLORREF CHyperLink::GetHoverColor() const
 230 {
 231         return m_crHoverColor;
 232 }
 233
 234 void CHyperLink::SetUnderline(int nUnderline /*=ulHover*/)
 235 {
 236         if (m_nUnderline == nUnderline)
 237                 return;
 238
 239         if (::IsWindow(GetSafeHwnd()))
 240         {
 241                 if (nUnderline == ulAlways)
 242                         SetFont(&m_UnderlineFont);
 243                 else
 244                         SetFont(&m_StdFont);
 245
 246                 Invalidate();
 247         }
 248
 249         m_nUnderline = nUnderline;
 250 }
 251
 252 int CHyperLink::GetUnderline() const
 253 {
 254         return m_nUnderline;
 255 }
 256
 257 // The following appeared in Paul DiLascia's Jan 1998 MSJ articles.
 258 // It loads a "hand" cursor from the winhlp32.exe module
 259 void CHyperLink::SetDefaultCursor()
 260 {
 261         if (m_hLinkCursor == NULL)
 262         {
 263                 // first try the windows hand cursor (not available on NT4)
 264 #ifndef OCR_HAND
 265 #       define OCR_HAND 32649
 266 #endif
 267                 HCURSOR hHandCursor = (HCURSOR)::LoadImage(NULL, MAKEINTRESOURCE(OCR_HAND), IMAGE_CURSOR, 0, 0, LR_DEFAULTSIZE | LR_SHARED);
 268                 if (hHandCursor)
 269                 {
 270                         m_hLinkCursor = hHandCursor;
 271                         return;
 272                 }
 273                 // windows cursor not available, so try to load it from winhlp32.exe
 274                 CString strWndDir;
 275                 GetWindowsDirectory(strWndDir.GetBuffer(MAX_PATH), MAX_PATH);   // Explorer can't handle paths longer than MAX_PATH.
 276                 strWndDir.ReleaseBuffer();
 277
 278                 strWndDir += _T("\\winhlp32.exe");
 279                 // This retrieves cursor #106 from winhlp32.exe, which is a hand pointer
 280                 CAutoLibrary hModule = LoadLibrary(strWndDir);
 281                 if (hModule) {
 282                         HCURSOR hHandCursor2 = (HCURSOR)::LoadImage(hModule, MAKEINTRESOURCE(106), IMAGE_CURSOR, 0, 0, LR_DEFAULTSIZE);
 283                         if (hHandCursor2)
 284                                 m_hLinkCursor = CopyCursor(hHandCursor2);
 285                 }
 286         }
 287 }
 288
 289 HINSTANCE CHyperLink::GotoURL(LPCTSTR url)
 290 {
 291         return ShellExecute(NULL, _T("open"), url, NULL,NULL, SW_SHOW);
 292 }