src/generic/hyperlinkg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/hyperlinkg.cpp
   3 // Purpose:     Hyperlink control
   4 // Author:      David Norris <danorris@gmail.com>, Otto Wyss
   5 // Modified by: Ryan Norton, Francesco Montorsi
   6 // Created:     04/02/2005
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2005 David Norris
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 //---------------------------------------------------------------------------
  17 // Pre-compiled header stuff
  18 //---------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_HYPERLINKCTRL
  28
  29 //---------------------------------------------------------------------------
  30 // Includes
  31 //---------------------------------------------------------------------------
  32
  33 #include "wx/hyperlink.h"
  34
  35 #ifndef WX_PRECOMP
  36     #include "wx/utils.h" // for wxLaunchDefaultBrowser
  37     #include "wx/dcclient.h"
  38     #include "wx/menu.h"
  39     #include "wx/log.h"
  40     #include "wx/dataobj.h"
  41 #endif
  42
  43 #include "wx/clipbrd.h"
  44
  45 // ============================================================================
  46 // implementation
  47 // ============================================================================
  48
  49 // reserved for internal use only
  50 #define wxHYPERLINK_POPUP_COPY_ID           16384
  51
  52 // ----------------------------------------------------------------------------
  53 // wxGenericHyperlinkCtrl
  54 // ----------------------------------------------------------------------------
  55
  56 bool wxGenericHyperlinkCtrl::Create(wxWindow *parent, wxWindowID id,
  57     const wxString& label, const wxString& url, const wxPoint& pos,
  58     const wxSize& size, long style, const wxString& name)
  59 {
  60     // do validation checks:
  61     CheckParams(label, url, style);
  62
  63     if ((style & wxHL_ALIGN_LEFT) == 0)
  64         style |= wxFULL_REPAINT_ON_RESIZE;
  65
  66     if (!wxControl::Create(parent, id, pos, size, style, wxDefaultValidator, name))
  67         return false;
  68
  69     // set to non empty strings both the url and the label
  70     SetURL(url.empty() ? label : url);
  71     SetLabel(label.empty() ? url : label);
  72
  73     Init();
  74     SetForegroundColour(m_normalColour);
  75
  76     // by default the font of an hyperlink control is underlined
  77     wxFont f = GetFont();
  78     f.SetUnderlined(true);
  79     SetFont(f);
  80
  81     SetInitialSize(size);
  82
  83
  84     // connect our event handlers:
  85     // NOTE: since this class is the base class of the GTK+'s native implementation
  86     //       of wxHyperlinkCtrl, we cannot use the static macros in BEGIN/END_EVENT_TABLE
  87     //       blocks, otherwise the GTK+'s native impl of wxHyperlinkCtrl would not
  88     //       behave correctly (as we intercept events doing things which interfere
  89     //       with GTK+'s native handling):
  90
  91     Connect( wxEVT_PAINT, wxPaintEventHandler(wxGenericHyperlinkCtrl::OnPaint) );
  92     Connect( wxEVT_LEAVE_WINDOW, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnLeaveWindow) );
  93
  94     Connect( wxEVT_LEFT_DOWN, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnLeftDown) );
  95     Connect( wxEVT_LEFT_UP, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnLeftUp) );
  96     Connect( wxEVT_MOTION, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnMotion) );
  97
  98     ConnectMenuHandlers();
  99
 100     return true;
 101 }
 102
 103 void wxGenericHyperlinkCtrl::Init()
 104 {
 105     m_rollover = false;
 106     m_clicking = false;
 107     m_visited = false;
 108
 109     // colours
 110     m_normalColour = *wxBLUE;
 111     m_hoverColour = *wxRED;
 112     m_visitedColour = wxColour("#551a8b");
 113 }
 114
 115 void wxGenericHyperlinkCtrl::ConnectMenuHandlers()
 116 {
 117     // Connect the event handlers for the context menu.
 118     Connect( wxEVT_RIGHT_UP, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnRightUp) );
 119     Connect( wxHYPERLINK_POPUP_COPY_ID, wxEVT_COMMAND_MENU_SELECTED,
 120              wxCommandEventHandler(wxGenericHyperlinkCtrl::OnPopUpCopy) );
 121 }
 122
 123 wxSize wxGenericHyperlinkCtrl::DoGetBestClientSize() const
 124 {
 125     wxClientDC dc((wxWindow *)this);
 126     return dc.GetTextExtent(GetLabel());
 127 }
 128
 129
 130 void wxGenericHyperlinkCtrl::SetNormalColour(const wxColour &colour)
 131 {
 132     m_normalColour = colour;
 133     if (!m_visited)
 134     {
 135         SetForegroundColour(m_normalColour);
 136         Refresh();
 137     }
 138 }
 139
 140 void wxGenericHyperlinkCtrl::SetVisitedColour(const wxColour &colour)
 141 {
 142     m_visitedColour = colour;
 143     if (m_visited)
 144     {
 145         SetForegroundColour(m_visitedColour);
 146         Refresh();
 147     }
 148 }
 149
 150 void wxGenericHyperlinkCtrl::DoContextMenu(const wxPoint &pos)
 151 {
 152     wxMenu *menuPopUp = new wxMenu(wxEmptyString, wxMENU_TEAROFF);
 153     menuPopUp->Append(wxHYPERLINK_POPUP_COPY_ID, _("&Copy URL"));
 154     PopupMenu( menuPopUp, pos );
 155     delete menuPopUp;
 156 }
 157
 158 wxRect wxGenericHyperlinkCtrl::GetLabelRect() const
 159 {
 160     // our best size is always the size of the label without borders
 161     wxSize c(GetClientSize()), b(GetBestSize());
 162     wxPoint offset;
 163
 164     // the label is always centered vertically
 165     offset.y = (c.GetHeight()-b.GetHeight())/2;
 166
 167     if (HasFlag(wxHL_ALIGN_CENTRE))
 168         offset.x = (c.GetWidth()-b.GetWidth())/2;
 169     else if (HasFlag(wxHL_ALIGN_RIGHT))
 170         offset.x = c.GetWidth()-b.GetWidth();
 171     else if (HasFlag(wxHL_ALIGN_LEFT))
 172         offset.x = 0;
 173     return wxRect(offset, b);
 174 }
 175
 176
 177
 178 // ----------------------------------------------------------------------------
 179 // wxGenericHyperlinkCtrl - event handlers
 180 // ----------------------------------------------------------------------------
 181
 182 void wxGenericHyperlinkCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
 183 {
 184     wxPaintDC dc(this);
 185     dc.SetFont(GetFont());
 186     dc.SetTextForeground(GetForegroundColour());
 187     dc.SetTextBackground(GetBackgroundColour());
 188
 189     dc.DrawText(GetLabel(), GetLabelRect().GetTopLeft());
 190 }
 191
 192 void wxGenericHyperlinkCtrl::OnLeftDown(wxMouseEvent& event)
 193 {
 194     // the left click must start from the hyperlink rect
 195     m_clicking = GetLabelRect().Contains(event.GetPosition());
 196 }
 197
 198 void wxGenericHyperlinkCtrl::OnLeftUp(wxMouseEvent& event)
 199 {
 200     // the click must be started and ended in the hyperlink rect
 201     if (!m_clicking || !GetLabelRect().Contains(event.GetPosition()))
 202         return;
 203
 204     SetForegroundColour(m_visitedColour);
 205     m_visited = true;
 206     m_clicking = false;
 207
 208     // send the event
 209     SendEvent();
 210 }
 211
 212 void wxGenericHyperlinkCtrl::OnRightUp(wxMouseEvent& event)
 213 {
 214     if( GetWindowStyle() & wxHL_CONTEXTMENU )
 215         if ( GetLabelRect().Contains(event.GetPosition()) )
 216             DoContextMenu(wxPoint(event.m_x, event.m_y));
 217 }
 218
 219 void wxGenericHyperlinkCtrl::OnMotion(wxMouseEvent& event)
 220 {
 221     wxRect textrc = GetLabelRect();
 222
 223     if (textrc.Contains(event.GetPosition()))
 224     {
 225         SetCursor(wxCursor(wxCURSOR_HAND));
 226         SetForegroundColour(m_hoverColour);
 227         m_rollover = true;
 228         Refresh();
 229     }
 230     else if (m_rollover)
 231     {
 232         SetCursor(*wxSTANDARD_CURSOR);
 233         SetForegroundColour(!m_visited ? m_normalColour : m_visitedColour);
 234         m_rollover = false;
 235         Refresh();
 236     }
 237 }
 238
 239 void wxGenericHyperlinkCtrl::OnLeaveWindow(wxMouseEvent& WXUNUSED(event) )
 240 {
 241     // NB: when the label rect and the client size rect have the same
 242     //     height this function is indispensable to remove the "rollover"
 243     //     effect as the OnMotion() event handler could not be called
 244     //     in that case moving the mouse out of the label vertically...
 245
 246     if (m_rollover)
 247     {
 248         SetCursor(*wxSTANDARD_CURSOR);
 249         SetForegroundColour(!m_visited ? m_normalColour : m_visitedColour);
 250         m_rollover = false;
 251         Refresh();
 252     }
 253 }
 254
 255 void wxGenericHyperlinkCtrl::OnPopUpCopy( wxCommandEvent& WXUNUSED(event) )
 256 {
 257 #if wxUSE_CLIPBOARD
 258     if (!wxTheClipboard->Open())
 259         return;
 260
 261     wxTextDataObject *data = new wxTextDataObject( m_url );
 262     wxTheClipboard->SetData( data );
 263     wxTheClipboard->Close();
 264 #endif // wxUSE_CLIPBOARD
 265 }
 266
 267 #endif // wxUSE_HYPERLINKCTRL