include/wx/hyperlink.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/hyperlink.h
   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 #ifndef _WX_HYPERLINK_H_
  13 #define _WX_HYPERLINK_H_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_HYPERLINKCTRL
  18
  19 #include "wx/control.h"
  20
  21 // ----------------------------------------------------------------------------
  22 // constants
  23 // ----------------------------------------------------------------------------
  24
  25 #define wxHL_CONTEXTMENU        0x0001
  26 #define wxHL_ALIGN_LEFT         0x0002
  27 #define wxHL_ALIGN_RIGHT        0x0004
  28 #define wxHL_ALIGN_CENTRE       0x0008
  29 #define wxHL_DEFAULT_STYLE      (wxHL_CONTEXTMENU|wxNO_BORDER|wxHL_ALIGN_CENTRE)
  30
  31 extern WXDLLIMPEXP_DATA_ADV(const char) wxHyperlinkCtrlNameStr[];
  32
  33
  34 // ----------------------------------------------------------------------------
  35 // wxHyperlinkCtrl
  36 // ----------------------------------------------------------------------------
  37
  38 // A static text control that emulates a hyperlink. The link is displayed
  39 // in an appropriate text style, derived from the control's normal font.
  40 // When the mouse rolls over the link, the cursor changes to a hand and the
  41 // link's color changes to the active color.
  42 //
  43 // Clicking on the link does not launch a web browser; instead, a
  44 // HyperlinkEvent is fired. The event propagates upward until it is caught,
  45 // just like a wxCommandEvent.
  46 //
  47 // Use the EVT_HYPERLINK() to catch link events.
  48 class WXDLLIMPEXP_ADV wxHyperlinkCtrlBase : public wxControl
  49 {
  50 public:
  51
  52     // get/set
  53     virtual wxColour GetHoverColour() const = 0;
  54     virtual void SetHoverColour(const wxColour &colour) = 0;
  55
  56     virtual wxColour GetNormalColour() const = 0;
  57     virtual void SetNormalColour(const wxColour &colour) = 0;
  58
  59     virtual wxColour GetVisitedColour() const = 0;
  60     virtual void SetVisitedColour(const wxColour &colour) = 0;
  61
  62     virtual wxString GetURL() const = 0;
  63     virtual void SetURL (const wxString &url) = 0;
  64
  65     virtual void SetVisited(bool visited = true) = 0;
  66     virtual bool GetVisited() const = 0;
  67
  68     // NOTE: also wxWindow::Set/GetLabel, wxWindow::Set/GetBackgroundColour,
  69     //       wxWindow::Get/SetFont, wxWindow::Get/SetCursor are important !
  70
  71 protected:
  72     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
  73
  74     // checks for validity some of the ctor/Create() function parameters
  75     void CheckParams(const wxString& label, const wxString& url, long style);
  76
  77 public:
  78     // not part of the public API but needs to be public as used by
  79     // GTK+ callbacks:
  80     void SendEvent();
  81 };
  82
  83 #ifndef __WXDEBUG__
  84 inline void wxHyperlinkCtrlBase::CheckParams(const wxString&, const wxString&, long) { }
  85 #endif
  86
  87 // ----------------------------------------------------------------------------
  88 // wxHyperlinkEvent
  89 // ----------------------------------------------------------------------------
  90
  91 class WXDLLIMPEXP_FWD_ADV wxHyperlinkEvent;
  92
  93 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_HYPERLINK, wxHyperlinkEvent );
  94
  95 //
  96 // An event fired when the user clicks on the label in a hyperlink control.
  97 // See HyperlinkControl for details.
  98 //
  99 class WXDLLIMPEXP_ADV wxHyperlinkEvent : public wxCommandEvent
 100 {
 101 public:
 102     wxHyperlinkEvent() {}
 103     wxHyperlinkEvent(wxObject *generator, wxWindowID id, const wxString& url)
 104         : wxCommandEvent(wxEVT_COMMAND_HYPERLINK, id),
 105           m_url(url)
 106     {
 107         SetEventObject(generator);
 108     }
 109
 110     // Returns the URL associated with the hyperlink control
 111     // that the user clicked on.
 112     wxString GetURL() const { return m_url; }
 113     void SetURL(const wxString &url) { m_url=url; }
 114
 115     // default copy ctor, assignment operator and dtor are ok
 116     virtual wxEvent *Clone() const { return new wxHyperlinkEvent(*this); }
 117
 118 private:
 119
 120     // URL associated with the hyperlink control that the used clicked on.
 121     wxString m_url;
 122
 123     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHyperlinkEvent)
 124 };
 125
 126
 127 // ----------------------------------------------------------------------------
 128 // event types and macros
 129 // ----------------------------------------------------------------------------
 130
 131 typedef void (wxEvtHandler::*wxHyperlinkEventFunction)(wxHyperlinkEvent&);
 132
 133 #define wxHyperlinkEventHandler(func) \
 134     wxEVENT_HANDLER_CAST(wxHyperlinkEventFunction, func)
 135
 136 #define EVT_HYPERLINK(id, fn) \
 137     wx__DECLARE_EVT1(wxEVT_COMMAND_HYPERLINK, id, wxHyperlinkEventHandler(fn))
 138
 139
 140 #if defined(__WXGTK210__) && !defined(__WXUNIVERSAL__)
 141     #include "wx/gtk/hyperlink.h"
 142 #else
 143     #include "wx/generic/hyperlink.h"
 144     #define wxHyperlinkCtrl     wxGenericHyperlinkCtrl
 145 #endif
 146
 147
 148 #endif // wxUSE_HYPERLINKCTRL
 149
 150 #endif // _WX_HYPERLINK_H_