1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Hypertext</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-atkhyperlink.html" title="atk.Hyperlink"><link rel="next" href="class-atkimage.html" title="atk.Image"></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.Hypertext</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkhyperlink.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkimage.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atkhypertext"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Hypertext</h2><p>atk.Hypertext — the ATK interface which provides standard mechanism for
2
manipulating hyperlinks. </p></div><div class="refsect1" lang="en"><a name="id2808666"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Hypertext</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
3
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhypertext.html#method-atkhypertext--get-link" title="atk.Hypertext.get_link">get_link</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>link_index</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhypertext.html#method-atkhypertext--get-n-links" title="atk.Hypertext.get_n_links">get_n_links</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhypertext.html#method-atkhypertext--get-link-index" title="atk.Hypertext.get_link_index">get_link_index</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>char_index</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="signal-prototypes-atkhypertext"></a><h2>atk.Hypertext Signal Prototypes</h2><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-atkhypertext.html#signal-atkhypertext--link-selected" title='The "link-selected" atk.Hypertext Signal'>link-selected</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhypertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</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="id2799642"></a><h2>Description</h2><p>An interface used for objects which implement linking between
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Hypertext</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" 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-atkhyperlink.html" title="atk.Hyperlink"><link rel="next" href="class-atkimage.html" title="atk.Image"></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.Hypertext</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkhyperlink.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkimage.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Hypertext"><a name="class-atkhypertext"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Hypertext</h2><p>atk.Hypertext — the ATK interface which provides standard mechanism for
2
manipulating hyperlinks. </p></div><div class="refsect1" title="Synopsis"><a name="id3134113"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Hypertext</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
3
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhypertext.html#method-atkhypertext--get-link" title="atk.Hypertext.get_link">get_link</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>link_index</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhypertext.html#method-atkhypertext--get-n-links" title="atk.Hypertext.get_n_links">get_n_links</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkhypertext.html#method-atkhypertext--get-link-index" title="atk.Hypertext.get_link_index">get_link_index</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>char_index</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="atk.Hypertext Signal Prototypes"><a name="signal-prototypes-atkhypertext"></a><h2>atk.Hypertext Signal Prototypes</h2><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-atkhypertext.html#signal-atkhypertext--link-selected" title='The "link-selected" atk.Hypertext Signal'>link-selected</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhypertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</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" title="Description"><a name="id3118687"></a><h2>Description</h2><p>An interface used for objects which implement linking between
4
4
multiple resource or content locations, or multiple 'markers' within a
5
5
single document. A <a class="link" href="class-atkhypertext.html" title="atk.Hypertext"><code class="classname">atk.Hypertext</code></a>
6
6
instance is associated with one or more <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink"><code class="classname">atk.Hyperlink</code></a>
9
9
no requirement that <a class="link" href="class-atkhypertext.html" title="atk.Hypertext"><code class="classname">atk.Hypertext</code></a>
10
10
instances have textual content; they may implement <a class="link" href="class-atkimage.html" title="atk.Image"><code class="classname">atk.Image</code></a> as
11
11
well, and <a class="link" href="class-atkhyperlink.html" title="atk.Hyperlink"><code class="classname">atk.Hyperlink</code></a>
12
objects need not have non-zero text offsets.</p></div><div class="refsect1" lang="en"><a name="id2805934"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atkhypertext--get-link"></a><h3>atk.Hypertext.get_link</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_link</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>link_index</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>link_index</code></strong> :</span></p></td><td>an integer specifying the desired
12
objects need not have non-zero text offsets.</p></div><div class="refsect1" title="Methods"><a name="id3094351"></a><h2>Methods</h2><div class="refsect2" title="atk.Hypertext.get_link"><a name="method-atkhypertext--get-link"></a><h3>atk.Hypertext.get_link</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_link</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>link_index</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>link_index</code></strong> :</span></p></td><td>an integer specifying the desired
13
13
link</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the link in this hypertext document at
14
14
index <em class="parameter"><code>link_index</code></em></td></tr></tbody></table><p>Gets the link in this hypertext document at index
15
<em class="parameter"><code>link_index</code></em></p></div><div class="refsect2" lang="en"><a name="method-atkhypertext--get-n-links"></a><h3>atk.Hypertext.get_n_links</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_n_links</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 number of links within this hypertext
16
document</td></tr></tbody></table><p>Gets the number of links within this hypertext document.</p></div><div class="refsect2" lang="en"><a name="method-atkhypertext--get-link-index"></a><h3>atk.Hypertext.get_link_index</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_link_index</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>char_index</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>char_index</code></strong> :</span></p></td><td>a character index</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an index into the array of hyperlinks in the
15
<em class="parameter"><code>link_index</code></em></p></div><div class="refsect2" title="atk.Hypertext.get_n_links"><a name="method-atkhypertext--get-n-links"></a><h3>atk.Hypertext.get_n_links</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_n_links</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 number of links within this hypertext
16
document</td></tr></tbody></table><p>Gets the number of links within this hypertext document.</p></div><div class="refsect2" title="atk.Hypertext.get_link_index"><a name="method-atkhypertext--get-link-index"></a><h3>atk.Hypertext.get_link_index</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_link_index</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>char_index</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>char_index</code></strong> :</span></p></td><td>a character index</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an index into the array of hyperlinks in the
17
17
hypertext</td></tr></tbody></table><p>Gets the index into the array of hyperlinks that is associated
18
18
with the character specified by <em class="parameter"><code>char_index</code></em>, or
19
-1 if there is no hyperlink associated with this character.</p></div></div><div class="refsect1" lang="en"><a name="id2821176"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-atkhypertext--link-selected"></a><h3>The "link-selected" atk.Hypertext Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhypertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</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>atkhypertext</code></em> :</span></p></td><td>the object which received the
19
-1 if there is no hyperlink associated with this character.</p></div></div><div class="refsect1" title="Signals"><a name="id3121728"></a><h2>Signals</h2><div class="refsect2" title='The "link-selected" atk.Hypertext Signal'><a name="signal-atkhypertext--link-selected"></a><h3>The "link-selected" atk.Hypertext Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkhypertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</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>atkhypertext</code></em> :</span></p></td><td>the object which received the
20
20
signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td><td>the index of the hyperlink which is
21
21
selected</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
22
22
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
added
removed
docs/html/class-atkhypertext.html
