1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/////////////////////////////////////////////////////////////////////////////
// Name: hyperlink.h
// Purpose: interface of wxHyperlinkEvent
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#define wxHL_CONTEXTMENU 0x0001
#define wxHL_ALIGN_LEFT 0x0002
#define wxHL_ALIGN_RIGHT 0x0004
#define wxHL_ALIGN_CENTRE 0x0008
#define wxHL_DEFAULT_STYLE (wxHL_CONTEXTMENU|wxNO_BORDER|wxHL_ALIGN_CENTRE)
/**
@class wxHyperlinkEvent
This event class is used for the events generated by wxHyperlinkCtrl.
@beginEventTable{wxHyperlinkEvent}
@event{EVT_HYPERLINK(id, func)}
User clicked on an hyperlink.
@endEventTable
@library{wxadv}
@category{events}
*/
class wxHyperlinkEvent : public wxCommandEvent
{
public:
/**
The constructor is not normally used by the user code.
*/
wxHyperlinkEvent(wxObject* generator, int id, const wxString& url);
/**
Returns the URL of the hyperlink where the user has just clicked.
*/
wxString GetURL() const;
/**
Sets the URL associated with the event.
*/
void SetURL(const wxString& url);
};
wxEventType wxEVT_HYPERLINK;
/**
@class wxHyperlinkCtrl
This class shows a static text element which links to an URL.
Appearance and behaviour is completely customizable.
In fact, when the user clicks on the hyperlink, a wxHyperlinkEvent is
sent but if that event is not handled (or it's skipped; see wxEvent::Skip),
then a call to wxLaunchDefaultBrowser() is done with the hyperlink's URL.
Note that standard wxWindow functions like wxWindow::SetBackgroundColour,
wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to
customize appearance of the hyperlink.
@beginStyleTable
@style{wxHL_ALIGN_LEFT}
Align the text to the left.
@style{wxHL_ALIGN_RIGHT}
Align the text to the right. This style is not supported under
Windows XP but is supported under all the other Windows versions.
@style{wxHL_ALIGN_CENTRE}
Center the text (horizontally). This style is not supported by the
native MSW implementation used under Windows XP and later.
@style{wxHL_CONTEXTMENU}
Pop up a context menu when the hyperlink is right-clicked. The
context menu contains a "Copy URL" menu item which is automatically
handled by the hyperlink and which just copies in the clipboard the
URL (not the label) of the control.
@style{wxHL_DEFAULT_STYLE}
The default style for wxHyperlinkCtrl:
wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
@endStyleTable
@beginEventEmissionTable{wxHyperlinkEvent}
@event{EVT_HYPERLINK(id, func)}
The hyperlink was (left) clicked. If this event is not handled in user's
code (or it's skipped; see wxEvent::Skip), then a call to wxLaunchDefaultBrowser
is done with the hyperlink's URL.
@endEventTable
Currently this class is implemented using native support in wxGTK and wxMSW
(under Windows XP and later only) and a generic version is used by the
other ports.
@library{wxadv}
@category{ctrl}
@appearance{hyperlinkctrl}
@see wxURL, wxHyperlinkEvent
*/
class wxHyperlinkCtrl : public wxControl
{
public:
wxHyperlinkCtrl();
/**
Constructor. See Create() for more info.
*/
wxHyperlinkCtrl(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxString& url,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHL_DEFAULT_STYLE,
const wxString& name = wxHyperlinkCtrlNameStr);
/**
Creates the hyperlink control.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. A value of wxID_ANY indicates a default value.
@param label
The label of the hyperlink.
@param url
The URL associated with the given label.
@param pos
Window position.
@param size
Window size.
If the wxDefaultSize is specified then the window is sized appropriately.
@param style
Window style. See wxHyperlinkCtrl.
@param name
Window name.
*/
bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxString& url, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHL_DEFAULT_STYLE,
const wxString& name = wxHyperlinkCtrlNameStr);
/**
Returns the colour used to print the label of the hyperlink when the mouse is
over the control.
*/
virtual wxColour GetHoverColour() const;
/**
Returns the colour used to print the label when the link has never been clicked
before (i.e.\ the link has not been @e visited) and the mouse is not over the control.
*/
virtual wxColour GetNormalColour() const;
/**
Returns the URL associated with the hyperlink.
*/
virtual wxString GetURL() const;
/**
Returns @true if the hyperlink has already been clicked by the user at least
one time.
*/
virtual bool GetVisited() const = 0;
/**
Returns the colour used to print the label when the mouse is not over the
control and the link has already been clicked before (i.e.\ the link has
been @e visited).
*/
virtual wxColour GetVisitedColour() const;
/**
Sets the colour used to print the label of the hyperlink when the mouse is over
the control.
*/
virtual void SetHoverColour(const wxColour& colour);
/**
Sets the colour used to print the label when the link has never been clicked before
(i.e.\ the link has not been @e visited) and the mouse is not over the control.
*/
virtual void SetNormalColour(const wxColour& colour);
/**
Sets the URL associated with the hyperlink.
*/
virtual void SetURL(const wxString& url);
/**
Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour).
*/
virtual void SetVisited(bool visited = true) = 0;
/**
Sets the colour used to print the label when the mouse is not over the control
and the link has already been clicked before (i.e.\ the link has been @e visited).
*/
virtual void SetVisitedColour(const wxColour& colour);
};
|
