]> git.saurik.com Git - wxWidgets.git/blob - include/wx/hyperlink.h
cleanup
[wxWidgets.git] / 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 wxChar) 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 // Declare an event identifier.
92 BEGIN_DECLARE_EVENT_TYPES()
93 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_HYPERLINK, 3700)
94 END_DECLARE_EVENT_TYPES()
95
96 //
97 // An event fired when the user clicks on the label in a hyperlink control.
98 // See HyperlinkControl for details.
99 //
100 class WXDLLIMPEXP_ADV wxHyperlinkEvent : public wxCommandEvent
101 {
102 public:
103 wxHyperlinkEvent() {}
104 wxHyperlinkEvent(wxObject *generator, wxWindowID id, const wxString& url)
105 : wxCommandEvent(wxEVT_COMMAND_HYPERLINK, id),
106 m_url(url)
107 {
108 SetEventObject(generator);
109 }
110
111 // Returns the URL associated with the hyperlink control
112 // that the user clicked on.
113 wxString GetURL() const { return m_url; }
114 void SetURL(const wxString &url) { m_url=url; }
115
116 // default copy ctor, assignment operator and dtor are ok
117 virtual wxEvent *Clone() const { return new wxHyperlinkEvent(*this); }
118
119 private:
120
121 // URL associated with the hyperlink control that the used clicked on.
122 wxString m_url;
123
124 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHyperlinkEvent)
125 };
126
127
128 // ----------------------------------------------------------------------------
129 // event types and macros
130 // ----------------------------------------------------------------------------
131
132 typedef void (wxEvtHandler::*wxHyperlinkEventFunction)(wxHyperlinkEvent&);
133
134 #define wxHyperlinkEventHandler(func) \
135 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHyperlinkEventFunction, &func)
136
137 #define EVT_HYPERLINK(id, fn) \
138 wx__DECLARE_EVT1(wxEVT_COMMAND_HYPERLINK, id, wxHyperlinkEventHandler(fn))
139
140 #ifdef _WX_DEFINE_DATE_EVENTS_
141 DEFINE_EVENT_TYPE(wxEVT_COMMAND_HYPERLINK)
142
143 IMPLEMENT_DYNAMIC_CLASS(wxHyperlinkEvent, wxCommandEvent)
144 #endif
145
146
147
148 #if defined(__WXGTK210__) && !defined(__WXUNIVERSAL__)
149 #include "wx/gtk/hyperlink.h"
150 #else
151 #include "wx/generic/hyperlink.h"
152 #define wxHyperlinkCtrl wxGenericHyperlinkCtrl
153 #endif
154
155
156 #endif // wxUSE_HYPERLINKCTRL
157
158 #endif // _WX_HYPERLINK_H_