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 IMPLEMENT_DYNAMIC_CLASS(wxGenericHyperlinkCtrl, wxControl)
  50
  51 // reserved for internal use only
  52 #define wxHYPERLINK_POPUP_COPY_ID           16384
  53
  54 // ----------------------------------------------------------------------------
  55 // wxGenericHyperlinkCtrl
  56 // ----------------------------------------------------------------------------
  57
  58 bool wxGenericHyperlinkCtrl::Create(wxWindow *parent, wxWindowID id,
  59     const wxString& label, const wxString& url, const wxPoint& pos,
  60     const wxSize& size, long style, const wxString& name)
  61 {
  62     // do validation checks:
  63     CheckParams(label, url, style);
  64
  65     if ((style & wxHL_ALIGN_LEFT) == 0)
  66         style |= wxFULL_REPAINT_ON_RESIZE;
  67
  68     if (!wxControl::Create(parent, id, pos, size, style, wxDefaultValidator, name))
  69         return false;
  70
  71     // set to non empty strings both the url and the label
  72     SetURL(url.empty() ? label : url);
  73     SetLabel(label.empty() ? url : label);
  74
  75     m_rollover = false;
  76     m_clicking = false;
  77     m_visited = false;
  78
  79     // colours
  80     m_normalColour = *wxBLUE;
  81     m_hoverColour = *wxRED;
  82     m_visitedColour = wxColour("#551a8b");
  83     SetForegroundColour(m_normalColour);
  84
  85     // by default the font of an hyperlink control is underlined
  86     wxFont f = GetFont();
  87     f.SetUnderlined(true);
  88     SetFont(f);
  89
  90     SetInitialSize(size);
  91
  92
  93     // connect our event handlers:
  94     // NOTE: since this class is the base class of the GTK+'s native implementation
  95     //       of wxHyperlinkCtrl, we cannot use the static macros in BEGIN/END_EVENT_TABLE
  96     //       blocks, otherwise the GTK+'s native impl of wxHyperlinkCtrl would not
  97     //       behave correctly (as we intercept events doing things which interfere
  98     //       with GTK+'s native handling):
  99
 100     Connect( wxEVT_PAINT, wxPaintEventHandler(wxGenericHyperlinkCtrl::OnPaint) );
 101     Connect( wxEVT_LEAVE_WINDOW, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnLeaveWindow) );
 102
 103     Connect( wxEVT_LEFT_DOWN, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnLeftDown) );
 104     Connect( wxEVT_LEFT_UP, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnLeftUp) );
 105     Connect( wxEVT_RIGHT_UP, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnRightUp) );
 106     Connect( wxEVT_MOTION, wxMouseEventHandler(wxGenericHyperlinkCtrl::OnMotion) );
 107
 108     Connect( wxHYPERLINK_POPUP_COPY_ID, wxEVT_COMMAND_MENU_SELECTED,
 109              wxCommandEventHandler(wxGenericHyperlinkCtrl::OnPopUpCopy) );
 110
 111     return true;
 112 }
 113
 114 wxSize wxGenericHyperlinkCtrl::DoGetBestSize() const
 115 {
 116     int w, h;
 117
 118     wxClientDC dc((wxWindow *)this);
 119     dc.SetFont(GetFont());
 120     dc.GetTextExtent(GetLabel(), &w, &h);
 121
 122     wxSize best(w, h);
 123     CacheBestSize(best);
 124     return best;
 125 }
 126
 127
 128 void wxGenericHyperlinkCtrl::SetNormalColour(const wxColour &colour)
 129 {
 130     m_normalColour = colour;
 131     if (!m_visited)
 132     {
 133         SetForegroundColour(m_normalColour);
 134         Refresh();
 135     }
 136 }
 137
 138 void wxGenericHyperlinkCtrl::SetVisitedColour(const wxColour &colour)
 139 {
 140     m_visitedColour = colour;
 141     if (m_visited)
 142     {
 143         SetForegroundColour(m_visitedColour);
 144         Refresh();
 145     }
 146 }
 147
 148 void wxGenericHyperlinkCtrl::DoContextMenu(const wxPoint &pos)
 149 {
 150     wxMenu *menuPopUp = new wxMenu(wxEmptyString, wxMENU_TEAROFF);
 151     menuPopUp->Append(wxHYPERLINK_POPUP_COPY_ID, _("&Copy URL"));
 152     PopupMenu( menuPopUp, pos );
 153     delete menuPopUp;
 154 }
 155
 156 wxRect wxGenericHyperlinkCtrl::GetLabelRect() const
 157 {
 158     // our best size is always the size of the label without borders
 159     wxSize c(GetClientSize()), b(GetBestSize());
 160     wxPoint offset;
 161
 162     // the label is always centered vertically
 163     offset.y = (c.GetHeight()-b.GetHeight())/2;
 164
 165     if (HasFlag(wxHL_ALIGN_CENTRE))
 166         offset.x = (c.GetWidth()-b.GetWidth())/2;
 167     else if (HasFlag(wxHL_ALIGN_RIGHT))
 168         offset.x = c.GetWidth()-b.GetWidth();
 169     else if (HasFlag(wxHL_ALIGN_LEFT))
 170         offset.x = 0;
 171     return wxRect(offset, b);
 172 }
 173
 174
 175
 176 // ----------------------------------------------------------------------------
 177 // wxGenericHyperlinkCtrl - event handlers
 178 // ----------------------------------------------------------------------------
 179
 180 void wxGenericHyperlinkCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
 181 {
 182     wxPaintDC dc(this);
 183     dc.SetFont(GetFont());
 184     dc.SetTextForeground(GetForegroundColour());
 185     dc.SetTextBackground(GetBackgroundColour());
 186
 187     dc.DrawText(GetLabel(), GetLabelRect().GetTopLeft());
 188 }
 189
 190 void wxGenericHyperlinkCtrl::OnLeftDown(wxMouseEvent& event)
 191 {
 192     // the left click must start from the hyperlink rect
 193     m_clicking = GetLabelRect().Contains(event.GetPosition());
 194 }
 195
 196 void wxGenericHyperlinkCtrl::OnLeftUp(wxMouseEvent& event)
 197 {
 198     // the click must be started and ended in the hyperlink rect
 199     if (!m_clicking || !GetLabelRect().Contains(event.GetPosition()))
 200         return;
 201
 202     SetForegroundColour(m_visitedColour);
 203     m_visited = true;
 204     m_clicking = false;
 205
 206     // send the event
 207     SendEvent();
 208 }
 209
 210 void wxGenericHyperlinkCtrl::OnRightUp(wxMouseEvent& event)
 211 {
 212     if( GetWindowStyle() & wxHL_CONTEXTMENU )
 213         if ( GetLabelRect().Contains(event.GetPosition()) )
 214             DoContextMenu(wxPoint(event.m_x, event.m_y));
 215 }
 216
 217 void wxGenericHyperlinkCtrl::OnMotion(wxMouseEvent& event)
 218 {
 219     wxRect textrc = GetLabelRect();
 220
 221     if (textrc.Contains(event.GetPosition()))
 222     {
 223         SetCursor(wxCursor(wxCURSOR_HAND));
 224         SetForegroundColour(m_hoverColour);
 225         m_rollover = true;
 226         Refresh();
 227     }
 228     else if (m_rollover)
 229     {
 230         SetCursor(*wxSTANDARD_CURSOR);
 231         SetForegroundColour(!m_visited ? m_normalColour : m_visitedColour);
 232         m_rollover = false;
 233         Refresh();
 234     }
 235 }
 236
 237 void wxGenericHyperlinkCtrl::OnLeaveWindow(wxMouseEvent& WXUNUSED(event) )
 238 {
 239     // NB: when the label rect and the client size rect have the same
 240     //     height this function is indispensable to remove the "rollover"
 241     //     effect as the OnMotion() event handler could not be called
 242     //     in that case moving the mouse out of the label vertically...
 243
 244     if (m_rollover)
 245     {
 246         SetCursor(*wxSTANDARD_CURSOR);
 247         SetForegroundColour(!m_visited ? m_normalColour : m_visitedColour);
 248         m_rollover = false;
 249         Refresh();
 250     }
 251 }
 252
 253 void wxGenericHyperlinkCtrl::OnPopUpCopy( wxCommandEvent& WXUNUSED(event) )
 254 {
 255 #if wxUSE_CLIPBOARD
 256     if (!wxTheClipboard->Open())
 257         return;
 258
 259     wxTextDataObject *data = new wxTextDataObject( m_url );
 260     wxTheClipboard->SetData( data );
 261     wxTheClipboard->Close();
 262 #endif // wxUSE_CLIPBOARD
 263 }
 264
 265 #endif // wxUSE_HYPERLINKCTRL