/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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head>
<link rel="stylesheet" type="text/css" href="apidocs.css"/>
<title>API docs for “kiwi.ui.hyperlink.HyperLink”</title>
</head>
<body><h1 class="class">Class k.u.h.HyperLink(<a href="kiwi.utils.PropertyObject.html">PropertyObject</a>, gtk.EventBox):</h1><span id="part">Part of <a href="kiwi.ui.hyperlink.html">kiwi.ui.hyperlink</a></span><div class="toplevel"><div class="undocumented">Undocumented</div></div><table class="children"><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.__init__">__init__</a></td><td><div><p>Create a new hyperlink.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.get_text">get_text</a></td><td><div><p>Return the hyperlink text.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.set_text">set_text</a></td><td><div><p>Set the text of the hyperlink.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.set_menu">set_menu</a></td><td><div><p>Set the menu to be used for popups.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.has_menu">has_menu</a></td><td><div><p>Return whether the widget has a menu set.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.popup">popup</a></td><td><div><p>Popup the menu and emit the popup signal.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.clicked">clicked</a></td><td><div><p>Fire a clicked signal.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink.get_label">get_label</a></td><td><div><p>Get the internally stored widget.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink._update_look">_update_look</a></td><td><div><p>Update the look of the hyperlink depending on state.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink._build_markup">_build_markup</a></td><td><div><p>Build a marked up string depending on parameters.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink._on_button_press_event">_on_button_press_event</a></td><td><div><p>Called on mouse down.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink._on_button_release_event">_on_button_release_event</a></td><td><div><p>Called on mouse up.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink._on_hover_changed">_on_hover_changed</a></td><td><div><p>Called when the mouse pinter enters or leaves the widget.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink._on_notify">_on_notify</a></td><td><div><p>Called on property notification.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.hyperlink.HyperLink._on_map_event">_on_map_event</a></td><td><div><p>Called on initially mapping the widget.</p>
</div></td></tr></table>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.__init__">__init__(self, text=None, menu=None):</a></div>
<div class="functionBody"><div><p>Create a new hyperlink.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">text</span><span class="body">The text of the hyperlink.
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">text</span><span class="body">str
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.get_text">get_text(self):</a></div>
<div class="functionBody"><div><p>Return the hyperlink text.</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.set_text">set_text(self, text):</a></div>
<div class="functionBody"><div><p>Set the text of the hyperlink.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">text</span><span class="body">The text to set the hyperlink to.
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">text</span><span class="body">str
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.set_menu">set_menu(self, menu):</a></div>
<div class="functionBody"><div><p>Set the menu to be used for popups.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">menu</span><span class="body">the gtk.Menu to be used.
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">menu</span><span class="body">gtk.Menu
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.has_menu">has_menu(self):</a></div>
<div class="functionBody"><div><p>Return whether the widget has a menu set.</p>
</div><div class="metadata"><span class="tag">return</span> <span class="arg">None</span><span class="body">a boolean value indicating whether the internal menu has been set.
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.popup">popup(self, menu=None, button=3, etime=0L):</a></div>
<div class="functionBody"><div><p>Popup the menu and emit the popup signal.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">menu</span><span class="body">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.
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">menu</span><span class="body">gtk.Menu
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">button</span><span class="body">An integer representing the button number pressed to cause the popup
action.
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">button</span><span class="body">int
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">etime</span><span class="body">The time that the popup event was initiated.
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">etime</span><span class="body">long
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.clicked">clicked(self):</a></div>
<div class="functionBody"><div><p>Fire a clicked signal.</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink.get_label">get_label(self):</a></div>
<div class="functionBody"><div><p>Get the internally stored widget.</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink._update_look">_update_look(self):</a></div>
<div class="functionBody"><div><p>Update the look of the hyperlink depending on state.</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink._build_markup">_build_markup(self, text, color, underline, bold):</a></div>
<div class="functionBody"><div><p>Build a marked up string depending on parameters.</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink._on_button_press_event">_on_button_press_event(self, eventbox, event):</a></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>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink._on_button_release_event">_on_button_release_event(self, eventbox, event):</a></div>
<div class="functionBody"><div><p>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.</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink._on_hover_changed">_on_hover_changed(self, eb, event, hover):</a></div>
<div class="functionBody"><div><p>Called when the mouse pinter enters or leaves the widget.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">hover</span><span class="body">Whether the mouse has entered the widget.
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">hover</span><span class="body">boolean
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink._on_notify">_on_notify(self, eventbox, param):</a></div>
<div class="functionBody"><div><p>Called on property notification.</p>
<p>Ensure that the look is up to date with the properties</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.ui.hyperlink.HyperLink._on_map_event">_on_map_event(self, eventbox, event):</a></div>
<div class="functionBody"><div><p>Called on initially mapping the widget.</p>
<p>Used here to set the cursor type.</p>
</div></div>
</div></body>
|