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
8 // Copyright: (c) 2005 David Norris
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_HYPERLINK_H__
13 #define _WX_HYPERLINK_H__
17 #if wxUSE_HYPERLINKCTRL
19 #include "wx/control.h"
21 // ----------------------------------------------------------------------------
23 // ----------------------------------------------------------------------------
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)
31 extern WXDLLIMPEXP_DATA_ADV(const wxChar
) wxHyperlinkCtrlNameStr
[];
34 // ----------------------------------------------------------------------------
36 // ----------------------------------------------------------------------------
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.
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.
47 // Use the EVT_HYPERLINK() to catch link events.
48 class WXDLLIMPEXP_ADV wxHyperlinkCtrlBase
: public wxControl
53 virtual wxColour
GetHoverColour() const = 0;
54 virtual void SetHoverColour(const wxColour
&colour
) = 0;
56 virtual wxColour
GetNormalColour() const = 0;
57 virtual void SetNormalColour(const wxColour
&colour
) = 0;
59 virtual wxColour
GetVisitedColour() const = 0;
60 virtual void SetVisitedColour(const wxColour
&colour
) = 0;
62 virtual wxString
GetURL() const = 0;
63 virtual void SetURL (const wxString
&url
) = 0;
65 virtual void SetVisited(bool visited
= true) = 0;
66 virtual bool GetVisited() const = 0;
68 // NOTE: also wxWindow::Set/GetLabel, wxWindow::Set/GetBackgroundColour,
69 // wxWindow::Get/SetFont, wxWindow::Get/SetCursor are important !
72 // checks for validity some of the ctor/Create() function parameters
73 void CheckParams(const wxString
& label
, const wxString
& url
, long style
);
76 // not part of the public API but needs to be public as used by
82 inline void wxHyperlinkCtrlBase::CheckParams(const wxString
&, const wxString
&, long) { }
85 // ----------------------------------------------------------------------------
87 // ----------------------------------------------------------------------------
89 // Declare an event identifier.
90 BEGIN_DECLARE_EVENT_TYPES()
91 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_HYPERLINK
, 3700)
92 END_DECLARE_EVENT_TYPES()
95 // An event fired when the user clicks on the label in a hyperlink control.
96 // See HyperlinkControl for details.
98 class WXDLLIMPEXP_ADV wxHyperlinkEvent
: public wxCommandEvent
101 wxHyperlinkEvent() {}
102 wxHyperlinkEvent(wxObject
*generator
, wxWindowID id
, const wxString
& url
)
103 : wxCommandEvent(wxEVT_COMMAND_HYPERLINK
, id
),
106 SetEventObject(generator
);
109 // Returns the URL associated with the hyperlink control
110 // that the user clicked on.
111 wxString
GetURL() const { return m_url
; }
112 void SetURL(const wxString
&url
) { m_url
=url
; }
114 // default copy ctor, assignment operator and dtor are ok
115 virtual wxEvent
*Clone() const { return new wxHyperlinkEvent(*this); }
119 // URL associated with the hyperlink control that the used clicked on.
122 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHyperlinkEvent
)
126 // ----------------------------------------------------------------------------
127 // event types and macros
128 // ----------------------------------------------------------------------------
130 typedef void (wxEvtHandler::*wxHyperlinkEventFunction
)(wxHyperlinkEvent
&);
132 #define wxHyperlinkEventHandler(func) \
133 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHyperlinkEventFunction, &func)
135 #define EVT_HYPERLINK(id, fn) \
136 wx__DECLARE_EVT1(wxEVT_COMMAND_HYPERLINK, id, wxHyperlinkEventHandler(fn))
138 #ifdef _WX_DEFINE_DATE_EVENTS_
139 DEFINE_EVENT_TYPE(wxEVT_COMMAND_HYPERLINK
)
141 IMPLEMENT_DYNAMIC_CLASS(wxHyperlinkEvent
, wxCommandEvent
)
146 #if defined(__WXGTK210__)
147 #include "wx/gtk/hyperlink.h"
149 #include "wx/generic/hyperlink.h"
150 #define wxHyperlinkCtrl wxGenericHyperlinkCtrl
154 #endif // wxUSE_HYPERLINKCTRL
156 #endif // _WX_HYPERLINK_H__