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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
#
# Kiwi: a Framework and Enhanced Widgets for Python
#
# Copyright (C) 2005 Async Open Source
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA
#
# Author(s): (C) Ali Afshar <aafshar@gmail.com>
#
# Contact Ali if you require release under a different license.
"""A hyper link widget."""
from cgi import escape
import gtk
from kiwi.utils import gsignal, gproperty, PropertyObject, type_register
class HyperLink(PropertyObject, gtk.EventBox):
__gtype_name__ = 'HyperLink'
"""
A hyperlink widget.
This widget behaves much like a hyperlink from a browser. The markup that
will be displayed is contained in the properties normal-markup
hover-markup and active-markup. There is a clicked signal which is fired
when hyperlink is clicked with the left mouse button.
Additionally, the user may set a menu that will be popped up when the user
right clicks the hyperlink.
"""
gproperty('text', str, '')
gproperty('normal-color', str, '#0000c0')
gproperty('normal-underline', bool, False)
gproperty('normal-bold', bool, False)
gproperty('hover-color', str, '#0000c0')
gproperty('hover-underline', bool, True)
gproperty('hover-bold', bool, False)
gproperty('active-color', str, '#c00000')
gproperty('active-underline', bool, True)
gproperty('active-bold', bool, False)
gsignal('clicked')
gsignal('right-clicked')
def __init__(self, text=None, menu=None):
"""
Create a new hyperlink.
@param text: The text of the hyperlink.
@type text: str
"""
gtk.EventBox.__init__(self)
self.set_above_child(False)
self.set_visible_window(False)
PropertyObject.__init__(self)
self._gproperties = {}
if text is not None:
self.set_property('text', text)
self._is_active = False
self._is_hover = False
self._menu = menu
self._label = gtk.Label()
self.add(self._label)
self.add_events(gtk.gdk.BUTTON_PRESS_MASK |
gtk.gdk.BUTTON_RELEASE_MASK |
gtk.gdk.ENTER_NOTIFY_MASK |
gtk.gdk.LEAVE_NOTIFY_MASK)
self.connect('button-press-event', self._on_button_press_event)
self.connect('button-release-event', self._on_button_release_event)
self.connect('enter-notify-event', self._on_hover_changed, True)
self.connect('leave-notify-event', self._on_hover_changed, False)
self.connect('map-event', self._on_map_event)
self.connect('notify', self._on_notify)
self.set_text(text)
# public API
def get_text(self):
"""
Return the hyperlink text.
"""
return self.text
def set_text(self, text):
"""
Set the text of the hyperlink.
@param text: The text to set the hyperlink to.
@type text: str
"""
self.text = text
self._update_look()
def set_menu(self, menu):
"""
Set the menu to be used for popups.
@param menu: the gtk.Menu to be used.
@type menu: gtk.Menu
"""
self._menu = menu
def has_menu(self):
"""
Return whether the widget has a menu set.
@return: a boolean value indicating whether the internal menu has been
set.
"""
return self._menu is not None
def popup(self, menu=None, button=3, etime=0L):
"""
Popup the menu and emit the popup signal.
@param menu: The gtk.Menu to be popped up. This menu will be
used instead of the internally set menu. If this parameter is not
passed or None, the internal menu will be used.
@type menu: gtk.Menu
@param button: An integer representing the button number pressed to
cause the popup action.
@type button: int
@param etime: The time that the popup event was initiated.
@type etime: long
"""
if menu is None:
menu = self._menu
if menu is not None:
menu.popup(None, None, None, button, etime)
self.emit('right-clicked')
def clicked(self):
"""
Fire a clicked signal.
"""
self.emit('clicked')
def get_label(self):
"""
Get the internally stored widget.
"""
return self._label
# private API
def _update_look(self):
"""
Update the look of the hyperlink depending on state.
"""
if self._is_active:
state = 'active'
elif self._is_hover:
state = 'hover'
else:
state = 'normal'
color = self.get_property('%s-color' % state)
underline = self.get_property('%s-underline' % state)
bold = self.get_property('%s-bold' % state)
markup_string = self._build_markup(self.get_text() or '',
color, underline, bold)
self._label.set_markup(markup_string)
def _build_markup(self, text, color, underline, bold):
"""
Build a marked up string depending on parameters.
"""
out = '<span color="%s">%s</span>' % (color, escape(text))
if underline:
out = '<u>%s</u>' % out
if bold:
out = '<b>%s</b>' % out
return out
# signal callbacks
def _on_button_press_event(self, eventbox, event):
"""
Called on mouse down.
Behaves in 2 ways.
1. if left-button, register the start of a click and grab the
mouse.
1. if right-button, emit a right-clicked signal +/- popup the
menu.
"""
if event.button == 1:
self.grab_add()
self._is_active = True
self._update_look()
elif event.button == 3:
if event.type == gtk.gdk.BUTTON_PRESS:
self.popup(button=event.button, etime=event.time)
def _on_button_release_event(self, eventbox, event):
"""
Called on mouse up.
If the left-button is released and the widget was earlier activated by
a mouse down event a clicked signal is fired.
"""
if event.button == 1:
self.grab_remove()
if self._is_active:
self.clicked()
self._is_active = False
self._update_look()
def _on_hover_changed(self, eb, event, hover):
"""
Called when the mouse pinter enters or leaves the widget.
@param hover: Whether the mouse has entered the widget.
@type hover: boolean
"""
self._is_hover = hover
self._update_look()
def _on_notify(self, eventbox, param):
"""
Called on property notification.
Ensure that the look is up to date with the properties
"""
if (param.name == 'text' or
param.name.endswith('-color') or
param.name.endswith('-underline') or
param.name.endswith('-bold')):
self._update_look()
def _on_map_event(self, eventbox, event):
"""
Called on initially mapping the widget.
Used here to set the cursor type.
"""
cursor = gtk.gdk.Cursor(gtk.gdk.HAND1)
self.window.set_cursor(cursor)
type_register(HyperLink)
|
