/usr/share/gtk-doc/html/pygtk/class-gtklinkbutton.html is in python-gtk2-doc 2.24.0-4ubuntu1.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.LinkButton</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtklayout.html" title="gtk.Layout"><link rel="next" href="class-gtkliststore.html" title="gtk.ListStore"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.LinkButton</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtklayout.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkliststore.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.LinkButton"><a name="class-gtklinkbutton"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.LinkButton</h2><p>gtk.LinkButton — a button bound to a URL (new in PyGTK 2.10)</p></div><div class="refsect1" title="Synopsis"><a name="id3780378"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.LinkButton</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbutton.html" title="gtk.Button">gtk.Button</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtklinkbutton.html#constructor-gtklinkbutton" title="gtk.LinkButton">gtk.LinkButton</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--get-uri" title="gtk.LinkButton.get_uri">get_uri</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--get-visited" title="gtk.LinkButton.get_visited">get_visited</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--set-uri" title="gtk.LinkButton.set_uri">set_uri</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--set-visited" title="gtk.LinkButton.set_visited">set_visited</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>visited</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtklinkbutton.html#function-gtk--link-button-set-uri-hook" title="gtk.link_button_set_uri_hook">gtk.link_button_set_uri_hook</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3780601"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtkbutton.html" title="gtk.Button">gtk.Button</a>
+-- <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton">gtk.LinkButton</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3780658"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" title="gtk.LinkButton Properties"><a name="properties-gtklinkbutton"></a><h2>gtk.LinkButton Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtkbutton.html#properties-gtkbutton" title="gtk.Button Properties">gtk.Button Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"uri"</td><td valign="top">Read-Write</td><td valign="top">The URI bound to this button. Available in GTK+
2.10.</td></tr><tr valign="top"><td valign="top">"visited"</td><td valign="top">Read-Write</td><td valign="top">The 'visited' state of this button. A visited link is drawn
in a different color. Default value: <code class="literal">False</code>.
Available in GTK+ 2.14.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.LinkButton Style Properties"><a name="style-properties-gtklinkbutton"></a><h2>gtk.LinkButton Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><p><a class="link" href="class-gtkbutton.html#style-properties-gtkbutton" title="gtk.Button Style Properties">gtk.Button Style Properties</a></p></div><div class="refsect1" title="gtk.LinkButton Signal Prototypes"><a name="signal-prototypes-gtklinkbutton"></a><h2>gtk.LinkButton Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><p><a class="link" href="class-gtkbutton.html#signal-prototypes-gtkbutton" title="gtk.Button Signal Prototypes">gtk.Button Signal Prototypes</a></p></div><div class="refsect1" title="Description"><a name="id3780893"></a><h2>Description</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
is available in PyGTK 2.10 and above.</p></div><p>A <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
is a <a class="link" href="class-gtkbutton.html" title="gtk.Button"><code class="classname">gtk.Button</code></a> with
a hyperlink, similar to the one used by web browsers, that triggers an
action when clicked. It is useful to show quick links to
resources.</p><p>A link button is created by calling the <a class="link" href="class-gtklinkbutton.html#constructor-gtklinkbutton" title="gtk.LinkButton">gtk.LinkButton</a>
constructor. The URI you pass to the constructor is used as a label for
the widget.</p><p>The URI bound to a <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
can be set specifically using the <a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--set-uri" title="gtk.LinkButton.set_uri"><code class="methodname">set_uri</code>()</a>)
method, and retrieved using the <a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--get-uri" title="gtk.LinkButton.get_uri"><code class="methodname">get_uri</code>()</a>
method.</p><p><a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
offers a global hook, which is called when the used clicks on it: see
the <a class="link" href="class-gtklinkbutton.html#function-gtk--link-button-set-uri-hook" title="gtk.link_button_set_uri_hook"><code class="function">gtk.link_button_set_uri_hook</code>()</a>
function.</p></div><div class="refsect1" title="Constructor"><a name="id3781001"></a><h2>Constructor</h2><div class="refsect2" title="gtk.LinkButton"><a name="constructor-gtklinkbutton"></a><h3>gtk.LinkButton</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.LinkButton</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong> :</span></p></td><td>a valid URI</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>label</code></strong> :</span></p></td><td>the text of the button or
<code class="literal">None</code></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new link button widget.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.10 and above.</p></div><p>Creates a new <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
with the URI specified by <em class="parameter"><code>uri</code></em> as its text if
<em class="parameter"><code>label</code></em> is <code class="literal">None</code>. If
<em class="parameter"><code>label</code></em> is not <code class="literal">None</code>, it is
used as the text of the button.</p></div></div><div class="refsect1" title="Methods"><a name="id3781177"></a><h2>Methods</h2><div class="refsect2" title="gtk.LinkButton.get_uri"><a name="method-gtklinkbutton--get-uri"></a><h3>gtk.LinkButton.get_uri</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_uri</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the associated URI.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_uri</code>() method returns the URI
set using the <a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--set-uri" title="gtk.LinkButton.set_uri"><code class="methodname">gtk.LinkButton.set_uri()</code></a>
method or the <a class="link" href="class-gtklinkbutton.html#constructor-gtklinkbutton" title="gtk.LinkButton">gtk.LinkButton</a>()
constructor.</p></div><div class="refsect2" title="gtk.LinkButton.get_visited"><a name="method-gtklinkbutton--get-visited"></a><h3>gtk.LinkButton.get_visited</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_visited</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the link has been visited,
<code class="literal">False</code> otherwise </td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">get_visited</code>() method retrieves the 'visited'
state of the URI where the GtkLinkButton points. The button becomes visited
when it is clicked. If the URI is changed on the button, the 'visited'
state is unset again.
</p></div><div class="refsect2" title="gtk.LinkButton.set_uri"><a name="method-gtklinkbutton--set-uri"></a><h3>gtk.LinkButton.set_uri</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_uri</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong> :</span></p></td><td>a valid URI</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_uri</code>() method sets the string
specified by <em class="parameter"><code>uri</code></em> as the URI the <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
points to.</p></div><div class="refsect2" title="gtk.LinkButton.set_visited"><a name="method-gtklinkbutton--set-visited"></a><h3>gtk.LinkButton.set_visited</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_visited</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>visited</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>visited</code></strong> :</span></p></td><td>the new 'visited' state.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_visited</code>() method setsthe 'visited' state
of the URI where the
<a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
points. See
<code class="methodname"><a class="link" href="class-gtklinkbutton.html#method-gtklinkbutton--get-visited" title="gtk.LinkButton.get_visited">gtk.LinkButton.get_visited</a></code>()
for more details.
</p></div></div><div class="refsect1" title="Functions"><a name="id3781534"></a><h2>Functions</h2><div class="refsect2" title="gtk.link_button_set_uri_hook"><a name="function-gtk--link-button-set-uri-hook"></a><h3>gtk.link_button_set_uri_hook</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.link_button_set_uri_hook</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>func</code></strong> :</span></p></td><td>a function called each time a <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>
is clicked, or <code class="literal">None</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>data</code></strong> :</span></p></td><td>user data to be passed to
<em class="parameter"><code>func</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.10 and above.</p></div><p>The <code class="function">gtk.link_button_set_uri_hook</code>() function
sets <em class="parameter"><code>func</code></em> as the function that should be
invoked every time a user clicks a <a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a>.
This function is called before every callback registered for the
"clicked" signal. If <em class="parameter"><code>func</code></em> is
<code class="literal">None</code> the current callback function will be
removed.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtklayout.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkliststore.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Layout </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.ListStore</td></tr></table></div></body></html>
|