← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/at-spi/intrepid-updates

« back to all changes in this revision

Viewing changes to docs/reference/cspi/html/at-spi-cspi-AccessibleHyperlink-Interface.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-09-01 16:58:56 UTC
  • mfrom: (1.1.34 upstream)
  • Revision ID: james.westby@ubuntu.com-20080901165856-itp2lms1sml4a63s
Tags: 1.23.91-0ubuntu1
https://launchpad.net/bugs/263729
* New upstream release (LP: #263729)
  - Bugfixes: #548559, #350552, #547875.
  - Translation update
* debian/control.in:
  - Add B-d on intltool (>= 0.40.0)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/html/at-spi-cspi-AccessibleHyperlink-Interface.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>AccessibleHyperlink Interface</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7
7
<link rel="start" href="index.html" title="AT-SPI C Bindings Reference Manual">
8
8
<link rel="up" href="ch05.html" title="Auxiliary Types">
9
9
<link rel="prev" href="ch05.html" title="Auxiliary Types">
33
33
<div class="refnamediv"><table width="100%"><tr>
34
34
<td valign="top">
35
35
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleHyperlink-Interface.top_of_page"></a>AccessibleHyperlink Interface</span></h2>
36
 
<p>AccessibleHyperlink Interface</p>
 
36
<p>AccessibleHyperlink Interface — </p>
37
37
</td>
38
38
<td valign="top" align="right"></td>
39
39
</tr></table></div>
40
40
<div class="refsynopsisdiv">
41
41
<a name="at-spi-cspi-AccessibleHyperlink-Interface.synopsis"></a><h2>Synopsis</h2>
42
42
<pre class="synopsis">
43
 
void                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-ref" title="AccessibleHyperlink_ref ()">AccessibleHyperlink_ref</a>             (AccessibleHyperlink *obj);
44
 
void                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-unref" title="AccessibleHyperlink_unref ()">AccessibleHyperlink_unref</a>           (AccessibleHyperlink *obj);
45
 
long                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getNAnchors" title="AccessibleHyperlink_getNAnchors ()">AccessibleHyperlink_getNAnchors</a>     (AccessibleHyperlink *obj);
46
 
void                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getIndexRange" title="AccessibleHyperlink_getIndexRange ()">AccessibleHyperlink_getIndexRange</a>   (AccessibleHyperlink *obj,
 
43
void                <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-ref" title="AccessibleHyperlink_ref ()">AccessibleHyperlink_ref</a>             (AccessibleHyperlink *obj);
 
44
void                <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-unref" title="AccessibleHyperlink_unref ()">AccessibleHyperlink_unref</a>           (AccessibleHyperlink *obj);
 
45
long                <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getNAnchors" title="AccessibleHyperlink_getNAnchors ()">AccessibleHyperlink_getNAnchors</a>     (AccessibleHyperlink *obj);
 
46
void                <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getIndexRange" title="AccessibleHyperlink_getIndexRange ()">AccessibleHyperlink_getIndexRange</a>   (AccessibleHyperlink *obj,
47
47
                                                         long int *startIndex,
48
48
                                                         long int *endIndex);
49
 
<a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getObject" title="AccessibleHyperlink_getObject ()">AccessibleHyperlink_getObject</a>       (AccessibleHyperlink *obj,
50
 
                                                         long int i);
51
 
char*               <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getURI" title="AccessibleHyperlink_getURI ()">AccessibleHyperlink_getURI</a>          (AccessibleHyperlink *obj,
52
 
                                                         long int i);
53
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-isValid" title="AccessibleHyperlink_isValid ()">AccessibleHyperlink_isValid</a>         (AccessibleHyperlink *obj);
 
49
<a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getObject" title="AccessibleHyperlink_getObject ()">AccessibleHyperlink_getObject</a>       (AccessibleHyperlink *obj,
 
50
                                                         long int i);
 
51
char*               <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getURI" title="AccessibleHyperlink_getURI ()">AccessibleHyperlink_getURI</a>          (AccessibleHyperlink *obj,
 
52
                                                         long int i);
 
53
SPIBoolean          <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-isValid" title="AccessibleHyperlink_isValid ()">AccessibleHyperlink_isValid</a>         (AccessibleHyperlink *obj);
54
54
</pre>
55
55
</div>
56
56
<div class="refsect1" lang="en">
72
72
<div class="variablelist"><table border="0">
73
73
<col align="left" valign="top">
74
74
<tbody><tr>
75
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
75
<td>
 
76
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
76
77
<td> a pointer to the <span class="type">AccessibleHyperlink</span> object on which to operate.
77
78
</td>
78
79
</tr></tbody>
90
91
<div class="variablelist"><table border="0">
91
92
<col align="left" valign="top">
92
93
<tbody><tr>
93
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
94
<td>
 
95
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
94
96
<td> a pointer to the <span class="type">AccessibleHyperlink</span> object on which to operate.
95
97
</td>
96
98
</tr></tbody>
105
107
      Though typical hyperlinks have only one anchor, client-side image maps and
106
108
      other hypertext objects may potentially activate or refer to multiple
107
109
      URIs.  For each anchor there is a corresponding URI and object.
108
 
<em class="parameter"><code>see</code></em> <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getURI" title="AccessibleHyperlink_getURI ()"><code class="function">AccessibleHyperlink_getURI()</code></a> and <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getObject" title="AccessibleHyperlink_getObject ()"><code class="function">AccessibleHyperlink_getObject()</code></a>.</p>
 
110
<em class="parameter"><code>see</code></em> <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getURI" title="AccessibleHyperlink_getURI ()"><code class="function">AccessibleHyperlink_getURI()</code></a> and <a href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getObject" title="AccessibleHyperlink_getObject ()"><code class="function">AccessibleHyperlink_getObject()</code></a>.</p>
109
111
<p>
110
112
 
111
113
</p>
113
115
<col align="left" valign="top">
114
116
<tbody>
115
117
<tr>
116
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
118
<td>
 
119
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
117
120
<td> a pointer to the <span class="type">AccessibleHyperlink</span> object on which to operate.
118
121
</td>
119
122
</tr>
120
123
<tr>
121
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
124
<td>
 
125
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
122
126
<td> a <span class="type">long</span> indicating the number of anchors in this hyperlink.
123
127
</td>
124
128
</tr>
141
145
<col align="left" valign="top">
142
146
<tbody>
143
147
<tr>
144
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
148
<td>
 
149
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
145
150
<td> a pointer to the <span class="type">AccessibleHyperlink</span> implementor on which to operate.
146
151
</td>
147
152
</tr>
148
153
<tr>
149
 
<td><p><span class="term"><em class="parameter"><code>startIndex</code></em> :</span></p></td>
 
154
<td>
 
155
<span class="term"><em class="parameter"><code>startIndex</code></em> :</span></td>
150
156
<td> a pointer to a long integer into which the starting
151
157
      offset of the text associated with this <span class="type">AccessibleHyperlink</span> is returned.
152
158
</td>
153
159
</tr>
154
160
<tr>
155
 
<td><p><span class="term"><em class="parameter"><code>endIndex</code></em> :</span></p></td>
 
161
<td>
 
162
<span class="term"><em class="parameter"><code>endIndex</code></em> :</span></td>
156
163
<td> a pointer to a long integer into which the offset of the first character
157
164
      after the text associated with this <span class="type">AccessibleHyperlink</span> is returned.
158
165
</td>
163
170
<hr>
164
171
<div class="refsect2" lang="en">
165
172
<a name="AccessibleHyperlink-getObject"></a><h3>AccessibleHyperlink_getObject ()</h3>
166
 
<pre class="programlisting"><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         AccessibleHyperlink_getObject       (AccessibleHyperlink *obj,
 
173
<pre class="programlisting"><a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         AccessibleHyperlink_getObject       (AccessibleHyperlink *obj,
167
174
                                                         long int i);</pre>
168
175
<p>
169
 
Get the object associated with a particular hyperlink anchor, as an <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a>.</p>
 
176
Get the object associated with a particular hyperlink anchor, as an <a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a>.</p>
170
177
<p>
171
178
 
172
179
</p>
174
181
<col align="left" valign="top">
175
182
<tbody>
176
183
<tr>
177
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
184
<td>
 
185
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
178
186
<td> a pointer to the <span class="type">AccessibleHyperlink</span> implementor on which to operate.
179
187
</td>
180
188
</tr>
181
189
<tr>
182
 
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 
190
<td>
 
191
<span class="term"><em class="parameter"><code>i</code></em> :</span></td>
183
192
<td> a (zero-index) long integer indicating which hyperlink anchor to query.
184
193
</td>
185
194
</tr>
186
195
<tr>
187
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
188
 
<td> an <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> that represents the object associated with the <em class="parameter"><code>ith</code></em> anchor
 
196
<td>
 
197
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
198
<td> an <a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> that represents the object associated with the <em class="parameter"><code>ith</code></em> anchor
189
199
       of the specified <span class="type">AccessibleHyperlink</span>.
190
200
</td>
191
201
</tr>
206
216
<col align="left" valign="top">
207
217
<tbody>
208
218
<tr>
209
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
219
<td>
 
220
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
210
221
<td> a pointer to the <span class="type">AccessibleHyperlink</span> implementor on which to operate.
211
222
</td>
212
223
</tr>
213
224
<tr>
214
 
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 
225
<td>
 
226
<span class="term"><em class="parameter"><code>i</code></em> :</span></td>
215
227
<td> a (zero-index) long integer indicating which hyperlink anchor to query.
216
228
</td>
217
229
</tr>
218
230
<tr>
219
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
231
<td>
 
232
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
220
233
<td> a UTF-8 string giving the URI of the <em class="parameter"><code>ith</code></em> hyperlink anchor.
221
234
</td>
222
235
</tr>
237
250
<col align="left" valign="top">
238
251
<tbody>
239
252
<tr>
240
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
253
<td>
 
254
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
241
255
<td> a pointer to the <span class="type">AccessibleHyperlink</span> on which to operate.
242
256
</td>
243
257
</tr>
244
258
<tr>
245
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
246
 
<td> <span class="type">TRUE</span> of the specified <span class="type">AccessibleHyperlink</span> is still valid with respect
247
 
         to its originating <span class="type">AccessibleHypertext</span> object, <span class="type">FALSE</span> otherwise.
 
259
<td>
 
260
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
261
<td> <a
 
262
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
263
><span class="type">TRUE</span></a> of the specified <span class="type">AccessibleHyperlink</span> is still valid with respect
 
264
         to its originating <span class="type">AccessibleHypertext</span> object, <a
 
265
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
266
><span class="type">FALSE</span></a> otherwise.
248
267
</td>
249
268
</tr>
250
269
</tbody>