← Back to branch summary

~ubuntu-branches/ubuntu/lucid/atk1.0/lucid

« back to all changes in this revision

Viewing changes to docs/html/AtkHypertext.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-01-14 16:25:56 UTC
  • mfrom: (1.2.16 upstream)
  • Revision ID: james.westby@ubuntu.com-20080114162556-f3dbeslu5w2hspoe
Tags: 1.21.5-0ubuntu1
https://launchpad.net/bugs/182900
* New upstream bugfix release (LP: #182900)
* Bump Standards-Version to 3.7.3
* Modify Maintainer value to match Debian-Maintainer-Field Spec

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/AtkHypertext.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>AtkHypertext</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="atk-AtkHyperlinkImpl.html" title="AtkHyperlinkImpl">
10
10
<link rel="next" href="AtkImage.html" title="AtkImage">
11
 
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="atk.html" title="ATK Library">
14
14
<link rel="index" href="ix01.html" title="Index">
28
28
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
29
29
<td><a accesskey="n" href="AtkImage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
30
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id342680" class="shortcut">Top</a>
32
 
                  &#160;|&#160;
33
 
                  <a href="#id343418" class="shortcut">Description</a>
34
 
                  &#160;|&#160;
35
 
                  <a href="#id343347" class="shortcut">Object Hierarchy</a>
36
 
                  &#160;|&#160;
37
 
                  <a href="#id343370" class="shortcut">Known Implementations</a>
38
 
                  &#160;|&#160;
39
 
                  <a href="#id343392" class="shortcut">Signals</a></nobr></td></tr>
 
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id358600" class="shortcut">Top</a>
 
32
                  &#160;|&#160;
 
33
                  <a href="#id359342" class="shortcut">Description</a>
 
34
                  &#160;|&#160;
 
35
                  <a href="#id359271" class="shortcut">Object Hierarchy</a>
 
36
                  &#160;|&#160;
 
37
                  <a href="#id359295" class="shortcut">Known Implementations</a>
 
38
                  &#160;|&#160;
 
39
                  <a href="#id359316" class="shortcut">Signals</a></nobr></td></tr>
40
40
</table>
41
41
<div class="refentry" lang="en">
42
42
<a name="AtkHypertext"></a><div class="titlepage"></div>
43
43
<div class="refnamediv"><table width="100%"><tr>
44
44
<td valign="top">
45
45
<h2>
46
 
<a name="id342680"></a><span class="refentrytitle">AtkHypertext</span>
 
46
<a name="id358600"></a><span class="refentrytitle">AtkHypertext</span>
47
47
</h2>
48
48
<p>AtkHypertext &#8212; The ATK interface which provides standard mechanism for manipulating hyperlinks.</p>
49
49
</td>
55
55
 
56
56
 
57
57
 
58
 
                    <a href="AtkHypertext.html#AtkHypertext-struct">AtkHypertext</a>;
59
 
<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a>*       <a href="AtkHypertext.html#atk-hypertext-get-link">atk_hypertext_get_link</a>              (<a href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
 
58
                    <a class="link" href="AtkHypertext.html#AtkHypertext-struct">AtkHypertext</a>;
 
59
<a class="link" href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a>*       <a class="link" href="AtkHypertext.html#atk-hypertext-get-link">atk_hypertext_get_link</a>              (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
60
60
                                                         gint link_index);
61
 
gint                <a href="AtkHypertext.html#atk-hypertext-get-n-links">atk_hypertext_get_n_links</a>           (<a href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext);
62
 
gint                <a href="AtkHypertext.html#atk-hypertext-get-link-index">atk_hypertext_get_link_index</a>        (<a href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
 
61
gint                <a class="link" href="AtkHypertext.html#atk-hypertext-get-n-links">atk_hypertext_get_n_links</a>           (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext);
 
62
gint                <a class="link" href="AtkHypertext.html#atk-hypertext-get-link-index">atk_hypertext_get_link_index</a>        (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
63
63
                                                         gint char_index);
64
64
 
65
65
</pre>
66
66
</div>
67
67
<div class="refsect1" lang="en">
68
 
<a name="id343347"></a><h2>Object Hierarchy</h2>
 
68
<a name="id359271"></a><h2>Object Hierarchy</h2>
69
69
<pre class="synopsis">
70
70
 
71
71
  GInterface
73
73
</pre>
74
74
</div>
75
75
<div class="refsect1" lang="en">
76
 
<a name="id343370"></a><h2>Known Implementations</h2>
 
76
<a name="id359295"></a><h2>Known Implementations</h2>
77
77
<p>
78
78
AtkHypertext is implemented by
79
 
 <a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
 
79
 <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
80
80
</div>
81
81
<div class="refsect1" lang="en">
82
 
<a name="id343392"></a><h2>Signals</h2>
 
82
<a name="id359316"></a><h2>Signals</h2>
83
83
<pre class="synopsis">
84
84
 
85
 
  "<a href="AtkHypertext.html#AtkHypertext-link-selected">link-selected</a>"                                  : Run Last
 
85
  "<a class="link" href="AtkHypertext.html#AtkHypertext-link-selected">link-selected</a>"                                  : Run Last
86
86
</pre>
87
87
</div>
88
88
<div class="refsect1" lang="en">
89
 
<a name="id343418"></a><h2>Description</h2>
 
89
<a name="id359342"></a><h2>Description</h2>
90
90
<p>
91
91
An interface used for objects which implement linking between multiple
92
92
resource or content locations, or multiple 'markers' within a single
96
96
</p>
97
97
</div>
98
98
<div class="refsect1" lang="en">
99
 
<a name="id343436"></a><h2>Details</h2>
 
99
<a name="id359361"></a><h2>Details</h2>
100
100
<div class="refsect2" lang="en">
101
 
<a name="id343446"></a><h3>
 
101
<a name="id359371"></a><h3>
102
102
<a name="AtkHypertext-struct"></a>AtkHypertext</h3>
103
 
<a class="indexterm" name="id343458"></a><pre class="programlisting">typedef struct _AtkHypertext AtkHypertext;</pre>
 
103
<a class="indexterm" name="id359383"></a><pre class="programlisting">typedef struct _AtkHypertext AtkHypertext;</pre>
104
104
<p>
105
105
The AtkHypertext structure does not contain any fields.
106
106
</p>
107
107
</div>
108
108
<hr>
109
109
<div class="refsect2" lang="en">
110
 
<a name="id343474"></a><h3>
 
110
<a name="id359398"></a><h3>
111
111
<a name="atk-hypertext-get-link"></a>atk_hypertext_get_link ()</h3>
112
 
<a class="indexterm" name="id343486"></a><pre class="programlisting"><a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a>*       atk_hypertext_get_link              (<a href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
 
112
<a class="indexterm" name="id359411"></a><pre class="programlisting"><a class="link" href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a>*       atk_hypertext_get_link              (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
113
113
                                                         gint link_index);</pre>
114
114
<p>
115
115
Gets the link in this hypertext document at index 
121
121
<col align="left" valign="top">
122
122
<tbody>
123
123
<tr>
124
 
<td><span class="term"><em class="parameter"><code>hypertext</code></em>&#160;:</span></td>
125
 
<td> an <a href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
 
124
<td><p><span class="term"><em class="parameter"><code>hypertext</code></em>&#160;:</span></p></td>
 
125
<td> an <a class="link" href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
126
126
</td>
127
127
</tr>
128
128
<tr>
129
 
<td><span class="term"><em class="parameter"><code>link_index</code></em>&#160;:</span></td>
 
129
<td><p><span class="term"><em class="parameter"><code>link_index</code></em>&#160;:</span></p></td>
130
130
<td> an integer specifying the desired link
131
131
</td>
132
132
</tr>
133
133
<tr>
134
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
134
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
135
135
<td> the link in this hypertext document at
136
136
index <em class="parameter"><code>link_index</code></em>
137
137
</td>
141
141
</div>
142
142
<hr>
143
143
<div class="refsect2" lang="en">
144
 
<a name="id343586"></a><h3>
 
144
<a name="id359510"></a><h3>
145
145
<a name="atk-hypertext-get-n-links"></a>atk_hypertext_get_n_links ()</h3>
146
 
<a class="indexterm" name="id343598"></a><pre class="programlisting">gint                atk_hypertext_get_n_links           (<a href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext);</pre>
 
146
<a class="indexterm" name="id359523"></a><pre class="programlisting">gint                atk_hypertext_get_n_links           (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext);</pre>
147
147
<p>
148
148
Gets the number of links within this hypertext document.</p>
149
149
<p>
153
153
<col align="left" valign="top">
154
154
<tbody>
155
155
<tr>
156
 
<td><span class="term"><em class="parameter"><code>hypertext</code></em>&#160;:</span></td>
157
 
<td> an <a href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
 
156
<td><p><span class="term"><em class="parameter"><code>hypertext</code></em>&#160;:</span></p></td>
 
157
<td> an <a class="link" href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
158
158
</td>
159
159
</tr>
160
160
<tr>
161
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
161
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
162
162
<td> the number of links within this hypertext document
163
163
</td>
164
164
</tr>
167
167
</div>
168
168
<hr>
169
169
<div class="refsect2" lang="en">
170
 
<a name="id343666"></a><h3>
 
170
<a name="id359591"></a><h3>
171
171
<a name="atk-hypertext-get-link-index"></a>atk_hypertext_get_link_index ()</h3>
172
 
<a class="indexterm" name="id343679"></a><pre class="programlisting">gint                atk_hypertext_get_link_index        (<a href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
 
172
<a class="indexterm" name="id359603"></a><pre class="programlisting">gint                atk_hypertext_get_link_index        (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
173
173
                                                         gint char_index);</pre>
174
174
<p>
175
175
Gets the index into the array of hyperlinks that is associated with
181
181
<col align="left" valign="top">
182
182
<tbody>
183
183
<tr>
184
 
<td><span class="term"><em class="parameter"><code>hypertext</code></em>&#160;:</span></td>
185
 
<td> an <a href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
 
184
<td><p><span class="term"><em class="parameter"><code>hypertext</code></em>&#160;:</span></p></td>
 
185
<td> an <a class="link" href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
186
186
</td>
187
187
</tr>
188
188
<tr>
189
 
<td><span class="term"><em class="parameter"><code>char_index</code></em>&#160;:</span></td>
 
189
<td><p><span class="term"><em class="parameter"><code>char_index</code></em>&#160;:</span></p></td>
190
190
<td> a character index
191
191
</td>
192
192
</tr>
193
193
<tr>
194
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
194
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
195
195
<td> an index into the array of hyperlinks in <em class="parameter"><code>hypertext</code></em>,
196
196
or -1 if there is no hyperlink associated with this character.
197
197
</td>
201
201
</div>
202
202
</div>
203
203
<div class="refsect1" lang="en">
204
 
<a name="id343781"></a><h2>Signal Details</h2>
 
204
<a name="id359706"></a><h2>Signal Details</h2>
205
205
<div class="refsect2" lang="en">
206
 
<a name="id343791"></a><h3>
207
 
<a name="AtkHypertext-link-selected"></a>The "link-selected" signal</h3>
208
 
<a class="indexterm" name="id343801"></a><pre class="programlisting">void                user_function                      (<a href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *atkhypertext,
 
206
<a name="id359716"></a><h3>
 
207
<a name="AtkHypertext-link-selected"></a>The <code class="literal">"link-selected"</code> signal</h3>
 
208
<a class="indexterm" name="id359731"></a><pre class="programlisting">void                user_function                      (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *atkhypertext,
209
209
                                                        gint          arg1,
210
210
                                                        gpointer      user_data)         : Run Last</pre>
211
211
<p>
216
216
<col align="left" valign="top">
217
217
<tbody>
218
218
<tr>
219
 
<td><span class="term"><em class="parameter"><code>atkhypertext</code></em>&#160;:</span></td>
 
219
<td><p><span class="term"><em class="parameter"><code>atkhypertext</code></em>&#160;:</span></p></td>
220
220
<td>the object which received the signal.
221
221
</td>
222
222
</tr>
223
223
<tr>
224
 
<td><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
 
224
<td><p><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></p></td>
225
225
<td>the index of the hyperlink which is selected
226
226
 
227
227
</td>
228
228
</tr>
229
229
<tr>
230
 
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
230
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
231
231
<td>user data set when the signal handler was connected.</td>
232
232
</tr>
233
233
</tbody>
235
235
</div>
236
236
</div>
237
237
<div class="refsect1" lang="en">
238
 
<a name="id343892"></a><h2>See Also</h2>
 
238
<a name="id359822"></a><h2>See Also</h2>
239
239
<p>
240
240
AtkHyperlink
241
241
</p>
242
242
</div>
 
243
<div class="refsect1" lang="en">
 
244
<a name="id359832"></a><div class="refsect2" lang="en"><a name="id359833"></a></div>
 
245
<hr>
 
246
<div class="refsect2" lang="en"><a name="id359834"></a></div>
 
247
</div>
243
248
</div>
244
249
</body>
245
250
</html>