1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Hyperlink</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkgobjectaccessible.html" title="atk.GObjectAccessible"><link rel="next" href="class-atkhypertext.html" title="atk.Hypertext"></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">atk.Hyperlink</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkgobjectaccessible.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkhypertext.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atkhyperlink"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Hyperlink</h2><p>atk.Hyperlink — An ATK object which encapsulates a link or set of links in a hypertext document. </p></div><div class="refsect1" lang="en"><a name="id2768393"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Hyperlink</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-uri" title="atk.Hyperlink.get_uri">get_uri</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-object" title="atk.Hyperlink.get_object">get_object</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-end-index" title="atk.Hyperlink.get_end_index">get_end_index</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-start-index" title="atk.Hyperlink.get_start_index">get_start_index</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--is-valid" title="atk.Hyperlink.is_valid">is_valid</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-n-anchors" title="atk.Hyperlink.get_n_anchors">get_n_anchors</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--is-inline" title="atk.Hyperlink.is_inline">is_inline</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--is-selected-link" title="atk.Hyperlink.is_selected_link">is_selected_link</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id2815118"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Hyperlink</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkgobjectaccessible.html" title="atk.GObjectAccessible"><link rel="next" href="class-atkhypertext.html" title="atk.Hypertext"></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">atk.Hyperlink</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkgobjectaccessible.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkhypertext.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atkhyperlink"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Hyperlink</h2><p>atk.Hyperlink — An ATK object which encapsulates a link or set of links in a hypertext document. </p></div><div class="refsect1" lang="en"><a name="id2969097"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Hyperlink</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-uri" title="atk.Hyperlink.get_uri">get_uri</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-object" title="atk.Hyperlink.get_object">get_object</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-end-index" title="atk.Hyperlink.get_end_index">get_end_index</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-start-index" title="atk.Hyperlink.get_start_index">get_start_index</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--is-valid" title="atk.Hyperlink.is_valid">is_valid</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--get-n-anchors" title="atk.Hyperlink.get_n_anchors">get_n_anchors</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--is-inline" title="atk.Hyperlink.is_inline">is_inline</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhyperlink.html#method-atkhyperlink--is-selected-link" title="atk.Hyperlink.is_selected_link">is_selected_link</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3015822"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3
3
+-- <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink">atk.Hyperlink</a>
4
4
</pre></div><div class="refsect1" lang="en"><a name="properties-atkhyperlink"></a><h2>atk.Hyperlink Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"end-index"</td><td valign="top">Read</td><td valign="top">The end index of the <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink"><code class="classname">atk.Hyperlink</code></a>
5
5
object. Allowed values: >= 0. Default value: 0.</td></tr><tr valign="top"><td valign="top">"number-of-anchors"</td><td valign="top">Read</td><td valign="top">The number of anchors associated with the <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink"><code class="classname">atk.Hyperlink</code></a>
6
6
object. Allowed values: >= 0. Default value: 0.</td></tr><tr valign="top"><td valign="top">"selected-link"</td><td valign="top">Read</td><td valign="top">if <code class="literal">True</code> the <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink"><code class="classname">atk.Hyperlink</code></a>
7
7
object is selected. Default value:
8
8
<code class="literal">False</code>.</td></tr><tr valign="top"><td valign="top">"start-index"</td><td valign="top">Read</td><td valign="top">The start index of the AtkHyperlink object. Allowed values:
9
>= 0. Default value: 0.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-atkhyperlink"></a><h2>atk.Hyperlink Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-atkhyperlink.html#signal-atkhyperlink--link-activated" title='The "link-activated" atk.Hyperlink Signal'>link-activated</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhyperlink</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id2770016"></a><h2>Description</h2><p>An ATK object which encapsulates a link or set of links in a
9
>= 0. Default value: 0.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-atkhyperlink"></a><h2>atk.Hyperlink Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-atkhyperlink.html#signal-atkhyperlink--link-activated" title='The "link-activated" atk.Hyperlink Signal'>link-activated</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhyperlink</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id2970720"></a><h2>Description</h2><p>An ATK object which encapsulates a link or set of links in a
10
10
hypertext document. It implements the <a class="link" href="class-atkaction.html" title="atk.Action"><code class="classname">atk.Action</code></a>
11
interface.</p></div><div class="refsect1" lang="en"><a name="id2769943"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atkhyperlink--get-uri"></a><h3>atk.Hyperlink.get_uri</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_uri</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</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>i</code></strong> :</span></p></td><td>a (zero-index) integer specifying the desired
11
interface.</p></div><div class="refsect1" lang="en"><a name="id2970647"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atkhyperlink--get-uri"></a><h3>atk.Hyperlink.get_uri</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_uri</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</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>i</code></strong> :</span></p></td><td>a (zero-index) integer specifying the desired
12
12
anchor</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a string specifying the
13
13
URI</td></tr></tbody></table><p>Get a the URI associated with the anchor specified by
14
14
<em class="parameter"><code>i</code></em>.</p><p>Multiple anchors are primarily used by client-side image
35
35
<code class="literal">False</code>, but an inline <src> HTML element will
36
36
return <code class="literal">True</code>.</p></div><div class="refsect2" lang="en"><a name="method-atkhyperlink--is-selected-link"></a><h3>atk.Hyperlink.is_selected_link</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">is_selected_link</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 <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink"><code class="classname">atk.Hyperlink</code></a>
37
37
is selected.</td></tr></tbody></table><p>Determines whether this <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink"><code class="classname">atk.Hyperlink</code></a>
38
is selected</p></div></div><div class="refsect1" lang="en"><a name="id2818425"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-atkhyperlink--link-activated"></a><h3>The "link-activated" atk.Hyperlink Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhyperlink</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>atkhyperlink</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
38
is selected</p></div></div><div class="refsect1" lang="en"><a name="id3019129"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-atkhyperlink--link-activated"></a><h3>The "link-activated" atk.Hyperlink Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhyperlink</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>atkhyperlink</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
39
39
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
40
40
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr></tbody></table><p>The signal "link-activated" is emitted when a link is
41
41
activated.</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-atkgobjectaccessible.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="atk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-atkhypertext.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.GObjectAccessible </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk.Hypertext</td></tr></table></div></body></html>