python-kiwi 1.9.22-2 / usr / share / doc / python-kiwi / api / kiwi.ui.hyperlink.HyperLink.html

This file is indexed.

/usr/share/doc/python-kiwi/api/kiwi.ui.hyperlink.HyperLink.html is in python-kiwi 1.9.22-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>kiwi.ui.hyperlink.HyperLink : API documentation</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="class">k.u.h.HyperLink(<a href="kiwi.utils.PropertyObject.html">PropertyObject</a>, <span title="gtk.EventBox">gtk.EventBox</span>) : class documentation</h1>
    <p>
      <span id="part">Part of <a href="kiwi.html">kiwi</a>.<a href="kiwi.ui.html">ui</a>.<a href="kiwi.ui.hyperlink.html">hyperlink</a></span>
      
      <a href="classIndex.html#kiwi.ui.hyperlink.HyperLink">View In Hierarchy</a>
    </p>
    <div>
      
    </div>
    <div class="undocumented">No class docstring</div>

    
    
    <div id="splitTables">
      <table class="children sortable" id="id252">
  
  
<tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#__init__">__init__</a></td>
    <td><span>Create a new hyperlink.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#get_text">get_text</a></td>
    <td><span>Return the hyperlink text.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#set_text">set_text</a></td>
    <td><span>Set the text of the hyperlink.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#set_menu">set_menu</a></td>
    <td><span>Set the menu to be used for popups.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#has_menu">has_menu</a></td>
    <td><span>Return whether the widget has a menu set.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#popup">popup</a></td>
    <td><span>Popup the menu and emit the popup signal.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#clicked">clicked</a></td>
    <td><span>Fire a clicked signal.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#get_label">get_label</a></td>
    <td><span>Get the internally stored widget.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#_update_look">_update_look</a></td>
    <td><span>Update the look of the hyperlink depending on state.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#_build_markup">_build_markup</a></td>
    <td><span>Build a marked up string depending on parameters.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#_on_button_press_event">_on_button_press_event</a></td>
    <td><span>Called on mouse down.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#_on_button_release_event">_on_button_release_event</a></td>
    <td><span>Called on mouse up.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#_on_hover_changed">_on_hover_changed</a></td>
    <td><span>Called when the mouse pinter enters or leaves the widget.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#_on_notify">_on_notify</a></td>
    <td><span>Called on property notification.</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="kiwi.ui.hyperlink.HyperLink.html#_on_map_event">_on_map_event</a></td>
    <td><span>Called on initially mapping the widget.</span></td>
  </tr>
  
</table>
      
        <p>
          Inherited from <a href="kiwi.utils.PropertyObject.html">PropertyObject</a>:
        </p>
        <table class="children sortable" id="id253">
  
  
<tr class="baseclassmethod">
    
    
    <td>Class Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#__class_init__">__class_init__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#__post_init__">__post_init__</a></td>
    <td><span>A hook which is called after the constructor is called.</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#get_attribute_names">get_attribute_names</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#is_default_value">is_default_value</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#do_set_property">do_set_property</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#do_get_property">do_get_property</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    
    <td>Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#_set">_set</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    
    <td>Method</td>
    <td><a href="kiwi.utils.PropertyObject.html#_get">_get</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    

    <div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self, text=None, menu=None):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="kiwi.utils.PropertyObject.html#__init__">kiwi.utils.PropertyObject.__init__</a></div>
    <div>Create a new hyperlink.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">text</td><td>The text of the hyperlink.
 (type: str
)</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.get_text">
    
  </a>
  <a name="get_text">
    
  </a>
  <div class="functionHeader">
    
    def
    get_text(self):
    
  </div>
  <div class="functionBody">
    
    <div>Return the hyperlink text.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.set_text">
    
  </a>
  <a name="set_text">
    
  </a>
  <div class="functionHeader">
    
    def
    set_text(self, text):
    
  </div>
  <div class="functionBody">
    
    <div>Set the text of the hyperlink.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">text</td><td>The text to set the hyperlink to.
 (type: str
)</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.set_menu">
    
  </a>
  <a name="set_menu">
    
  </a>
  <div class="functionHeader">
    
    def
    set_menu(self, menu):
    
  </div>
  <div class="functionBody">
    
    <div>Set the menu to be used for popups.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">menu</td><td>the gtk.Menu to be used.
 (type: gtk.Menu
)</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.has_menu">
    
  </a>
  <a name="has_menu">
    
  </a>
  <div class="functionHeader">
    
    def
    has_menu(self):
    
  </div>
  <div class="functionBody">
    
    <div>Return whether the widget has a menu set.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">a boolean value indicating whether the internal menu has been set.
</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.popup">
    
  </a>
  <a name="popup">
    
  </a>
  <div class="functionHeader">
    
    def
    popup(self, menu=None, button=3, etime=0L):
    
  </div>
  <div class="functionBody">
    
    <div>Popup the menu and emit the popup signal.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">menu</td><td>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: gtk.Menu
)</td></tr><tr><td></td><td class="fieldArg">button</td><td>An integer representing the button number pressed to cause the popup 
action.
 (type: int
)</td></tr><tr><td></td><td class="fieldArg">etime</td><td>The time that the popup event was initiated.
 (type: long
)</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.clicked">
    
  </a>
  <a name="clicked">
    
  </a>
  <div class="functionHeader">
    
    def
    clicked(self):
    
  </div>
  <div class="functionBody">
    
    <div>Fire a clicked signal.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink.get_label">
    
  </a>
  <a name="get_label">
    
  </a>
  <div class="functionHeader">
    
    def
    get_label(self):
    
  </div>
  <div class="functionBody">
    
    <div>Get the internally stored widget.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink._update_look">
    
  </a>
  <a name="_update_look">
    
  </a>
  <div class="functionHeader">
    
    def
    _update_look(self):
    
  </div>
  <div class="functionBody">
    
    <div>Update the look of the hyperlink depending on state.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink._build_markup">
    
  </a>
  <a name="_build_markup">
    
  </a>
  <div class="functionHeader">
    
    def
    _build_markup(self, text, color, underline, bold):
    
  </div>
  <div class="functionBody">
    
    <div>Build a marked up string depending on parameters.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink._on_button_press_event">
    
  </a>
  <a name="_on_button_press_event">
    
  </a>
  <div class="functionHeader">
    
    def
    _on_button_press_event(self, eventbox, event):
    
  </div>
  <div class="functionBody">
    
    <div><p>Called on mouse down.</p>
<p>Behaves in 2 ways.</p>
<ol start="1">
  <li>
    if left-button, register the start of a click and grab the mouse.
  </li>
</ol>
<ol start="1">
  <li>
    if right-button, emit a right-clicked signal +/- popup the menu.
  </li>
</ol>
<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink._on_button_release_event">
    
  </a>
  <a name="_on_button_release_event">
    
  </a>
  <div class="functionHeader">
    
    def
    _on_button_release_event(self, eventbox, event):
    
  </div>
  <div class="functionBody">
    
    <div>Called on mouse up.</p>
<p>If the left-button is released and the widget was earlier activated by a
mouse down event a clicked signal is fired.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink._on_hover_changed">
    
  </a>
  <a name="_on_hover_changed">
    
  </a>
  <div class="functionHeader">
    
    def
    _on_hover_changed(self, eb, event, hover):
    
  </div>
  <div class="functionBody">
    
    <div>Called when the mouse pinter enters or leaves the widget.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">hover</td><td>Whether the mouse has entered the widget.
 (type: boolean
)</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink._on_notify">
    
  </a>
  <a name="_on_notify">
    
  </a>
  <div class="functionHeader">
    
    def
    _on_notify(self, eventbox, param):
    
  </div>
  <div class="functionBody">
    
    <div>Called on property notification.</p>
<p>Ensure that the look is up to date with the properties<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="kiwi.ui.hyperlink.HyperLink._on_map_event">
    
  </a>
  <a name="_on_map_event">
    
  </a>
  <div class="functionHeader">
    
    def
    _on_map_event(self, eventbox, event):
    
  </div>
  <div class="functionBody">
    
    <div>Called on initially mapping the widget.</p>
<p>Used here to set the cursor type.<table class="fieldTable"></table></div>
  </div>
</div>
    <address>
      <a href="index.html">API Documentation</a> for Kiwi, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2010-05-20 02:10:57.
    </address>
  </body>
</html>

APT Browse - Built by Thomas Orozco.