1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>atspi-hyperlink: libatspi Reference Manual</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
<link rel="home" href="index.html" title="libatspi Reference Manual">
8
<link rel="up" href="ch01.html" title="API reference">
9
<link rel="prev" href="AtspiDeviceListener.html" title="atspi-devicelistener">
10
<link rel="next" href="libatspi-atspi-editabletext.html" title="atspi-editabletext">
11
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#AtspiHyperlink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#AtspiHyperlink.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23
<td><a accesskey="p" href="AtspiDeviceListener.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24
<td><a accesskey="n" href="libatspi-atspi-editabletext.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26
<div class="refentry">
27
<a name="AtspiHyperlink"></a><div class="titlepage"></div>
28
<div class="refnamediv"><table width="100%"><tr>
30
<h2><span class="refentrytitle"><a name="AtspiHyperlink.top_of_page"></a>atspi-hyperlink</span></h2>
31
<p>atspi-hyperlink — Instances of atspi-hyperlink are the means by which end users
32
and clients interact with linked content.</p>
34
<td class="gallery_image" valign="top" align="right"></td>
36
<div class="refsect1">
37
<a name="AtspiHyperlink.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table width="100%" border="0">
40
<col width="150px" class="functions_return">
41
<col class="functions_name">
45
<td class="function_type">
46
<span class="returnvalue">gint</span>
48
<td class="function_name">
49
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-n-anchors" title="atspi_hyperlink_get_n_anchors ()">atspi_hyperlink_get_n_anchors</a> <span class="c_punctuation">()</span>
53
<td class="function_type">
54
<span class="returnvalue">gchar</span> *
56
<td class="function_name">
57
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-uri" title="atspi_hyperlink_get_uri ()">atspi_hyperlink_get_uri</a> <span class="c_punctuation">()</span>
61
<td class="function_type">
62
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
64
<td class="function_name">
65
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-object" title="atspi_hyperlink_get_object ()">atspi_hyperlink_get_object</a> <span class="c_punctuation">()</span>
69
<td class="function_type">
70
<a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *
72
<td class="function_name">
73
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-index-range" title="atspi_hyperlink_get_index_range ()">atspi_hyperlink_get_index_range</a> <span class="c_punctuation">()</span>
77
<td class="function_type">
78
<span class="returnvalue">gint</span>
80
<td class="function_name">
81
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-start-index" title="atspi_hyperlink_get_start_index ()">atspi_hyperlink_get_start_index</a> <span class="c_punctuation">()</span>
85
<td class="function_type">
86
<span class="returnvalue">gint</span>
88
<td class="function_name">
89
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-end-index" title="atspi_hyperlink_get_end_index ()">atspi_hyperlink_get_end_index</a> <span class="c_punctuation">()</span>
93
<td class="function_type">
94
<span class="returnvalue">gboolean</span>
96
<td class="function_name">
97
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-is-valid" title="atspi_hyperlink_is_valid ()">atspi_hyperlink_is_valid</a> <span class="c_punctuation">()</span>
103
<div class="refsect1">
104
<a name="AtspiHyperlink.other"></a><h2>Types and Values</h2>
105
<div class="informaltable"><table width="100%" border="0">
107
<col width="150px" class="name">
108
<col class="description">
112
<td class="datatype_keyword"> </td>
113
<td class="function_name"><a class="link" href="AtspiHyperlink.html#AtspiHyperlink-struct" title="AtspiHyperlink">AtspiHyperlink</a></td>
116
<td class="datatype_keyword">struct</td>
117
<td class="function_name"><a class="link" href="AtspiHyperlink.html#AtspiHyperlinkClass" title="struct AtspiHyperlinkClass">AtspiHyperlinkClass</a></td>
122
<div class="refsect1">
123
<a name="AtspiHyperlink.object-hierarchy"></a><h2>Object Hierarchy</h2>
124
<pre class="screen"> GObject
125
<span class="lineart">╰──</span> <a class="link" href="AtspiObject.html" title="AtspiObject">AtspiObject</a>
126
<span class="lineart">╰──</span> AtspiHyperlink
129
<div class="refsect1">
130
<a name="AtspiHyperlink.description"></a><h2>Description</h2>
132
Instances of atspi-hyperlink are returned by
133
atspi-hypertext objects, and are the means by
134
which end users and clients interact with linked,
135
and in some cases embedded, content. These instances
136
may have multiple "anchors", where an anchor corresponds to a
137
reference to a particular resource with a corresponding resource
141
<div class="refsect1">
142
<a name="AtspiHyperlink.functions_details"></a><h2>Functions</h2>
143
<div class="refsect2">
144
<a name="atspi-hyperlink-get-n-anchors"></a><h3>atspi_hyperlink_get_n_anchors ()</h3>
145
<pre class="programlisting"><span class="returnvalue">gint</span>
146
atspi_hyperlink_get_n_anchors (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
147
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
148
<p>Gets the total number of anchors which an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor has.
149
Though typical hyperlinks have only one anchor, client-side image maps and
150
other hypertext objects may potentially activate or refer to multiple
151
URIs. For each anchor there is a corresponding URI and object.</p>
152
<p>see: <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-uri" title="atspi_hyperlink_get_uri ()"><span class="type">atspi_hyperlink_get_uri</span></a> and <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-object" title="atspi_hyperlink_get_object ()"><span class="type">atspi_hyperlink_get_object</span></a>.</p>
153
<div class="refsect3">
154
<a name="id-1.2.14.7.2.6"></a><h4>Parameters</h4>
155
<div class="informaltable"><table width="100%" border="0">
157
<col width="150px" class="parameters_name">
158
<col class="parameters_description">
159
<col width="200px" class="parameters_annotations">
162
<td class="parameter_name"><p>obj</p></td>
163
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object on which to operate.</p></td>
164
<td class="parameter_annotations"> </td>
168
<div class="refsect3">
169
<a name="id-1.2.14.7.2.7"></a><h4>Returns</h4>
170
<p> a <span class="type">gint</span> indicating the number of anchors in this hyperlink.</p>
174
<div class="refsect2">
175
<a name="atspi-hyperlink-get-uri"></a><h3>atspi_hyperlink_get_uri ()</h3>
176
<pre class="programlisting"><span class="returnvalue">gchar</span> *
177
atspi_hyperlink_get_uri (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
178
<em class="parameter"><code><span class="type">int</span> i</code></em>,
179
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
180
<p>Gets the URI associated with a particular hyperlink anchor.</p>
181
<div class="refsect3">
182
<a name="id-1.2.14.7.3.5"></a><h4>Parameters</h4>
183
<div class="informaltable"><table width="100%" border="0">
185
<col width="150px" class="parameters_name">
186
<col class="parameters_description">
187
<col width="200px" class="parameters_annotations">
191
<td class="parameter_name"><p>obj</p></td>
192
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
193
<td class="parameter_annotations"> </td>
196
<td class="parameter_name"><p>i</p></td>
197
<td class="parameter_description"><p>a (zero-index) integer indicating which hyperlink anchor to query.</p></td>
198
<td class="parameter_annotations"> </td>
203
<div class="refsect3">
204
<a name="id-1.2.14.7.3.6"></a><h4>Returns</h4>
205
<p> a UTF-8 string giving the URI of the <em class="parameter"><code>ith</code></em>
206
hyperlink anchor.</p>
210
<div class="refsect2">
211
<a name="atspi-hyperlink-get-object"></a><h3>atspi_hyperlink_get_object ()</h3>
212
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
213
atspi_hyperlink_get_object (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
214
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
215
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
216
<p>Gets the object associated with a particular hyperlink anchor, as an
217
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
218
<div class="refsect3">
219
<a name="id-1.2.14.7.4.5"></a><h4>Parameters</h4>
220
<div class="informaltable"><table width="100%" border="0">
222
<col width="150px" class="parameters_name">
223
<col class="parameters_description">
224
<col width="200px" class="parameters_annotations">
228
<td class="parameter_name"><p>obj</p></td>
229
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
230
<td class="parameter_annotations"> </td>
233
<td class="parameter_name"><p>i</p></td>
234
<td class="parameter_description"><p>a (zero-index) <span class="type">gint</span> indicating which hyperlink anchor to query.</p></td>
235
<td class="parameter_annotations"> </td>
240
<div class="refsect3">
241
<a name="id-1.2.14.7.4.6"></a><h4>Returns</h4>
242
<p> an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> that represents the object
243
associated with the <em class="parameter"><code>ith</code></em>
244
anchor of the specified <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>. </p>
245
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
249
<div class="refsect2">
250
<a name="atspi-hyperlink-get-index-range"></a><h3>atspi_hyperlink_get_index_range ()</h3>
251
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *
252
atspi_hyperlink_get_index_range (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
253
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
254
<p>Gets the starting and ending character offsets of the text range
255
associated with an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.</p>
256
<div class="refsect3">
257
<a name="id-1.2.14.7.5.5"></a><h4>Parameters</h4>
258
<div class="informaltable"><table width="100%" border="0">
260
<col width="150px" class="parameters_name">
261
<col class="parameters_description">
262
<col width="200px" class="parameters_annotations">
265
<td class="parameter_name"><p>obj</p></td>
266
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
267
<td class="parameter_annotations"> </td>
273
<div class="refsect2">
274
<a name="atspi-hyperlink-get-start-index"></a><h3>atspi_hyperlink_get_start_index ()</h3>
275
<pre class="programlisting"><span class="returnvalue">gint</span>
276
atspi_hyperlink_get_start_index (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
277
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
278
<p>Gets the starting character offset of the text range associated with
279
an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.</p>
280
<div class="refsect3">
281
<a name="id-1.2.14.7.6.5"></a><h4>Parameters</h4>
282
<div class="informaltable"><table width="100%" border="0">
284
<col width="150px" class="parameters_name">
285
<col class="parameters_description">
286
<col width="200px" class="parameters_annotations">
289
<td class="parameter_name"><p>obj</p></td>
290
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
291
<td class="parameter_annotations"> </td>
297
<div class="refsect2">
298
<a name="atspi-hyperlink-get-end-index"></a><h3>atspi_hyperlink_get_end_index ()</h3>
299
<pre class="programlisting"><span class="returnvalue">gint</span>
300
atspi_hyperlink_get_end_index (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
301
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
302
<p>Gets the ending character offset of the text range associated with
303
an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.</p>
304
<div class="refsect3">
305
<a name="id-1.2.14.7.7.5"></a><h4>Parameters</h4>
306
<div class="informaltable"><table width="100%" border="0">
308
<col width="150px" class="parameters_name">
309
<col class="parameters_description">
310
<col width="200px" class="parameters_annotations">
313
<td class="parameter_name"><p>obj</p></td>
314
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
315
<td class="parameter_annotations"> </td>
321
<div class="refsect2">
322
<a name="atspi-hyperlink-is-valid"></a><h3>atspi_hyperlink_is_valid ()</h3>
323
<pre class="programlisting"><span class="returnvalue">gboolean</span>
324
atspi_hyperlink_is_valid (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
325
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
326
<p>Tells whether an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object is still valid with respect to its
327
originating hypertext object.</p>
328
<div class="refsect3">
329
<a name="id-1.2.14.7.8.5"></a><h4>Parameters</h4>
330
<div class="informaltable"><table width="100%" border="0">
332
<col width="150px" class="parameters_name">
333
<col class="parameters_description">
334
<col width="200px" class="parameters_annotations">
337
<td class="parameter_name"><p>obj</p></td>
338
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> on which to operate.</p></td>
339
<td class="parameter_annotations"> </td>
343
<div class="refsect3">
344
<a name="id-1.2.14.7.8.6"></a><h4>Returns</h4>
345
<p> <span class="type">TRUE</span> if the specified <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> is still valid with respect
346
to its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> object, <span class="type">FALSE</span> otherwise.</p>
350
<div class="refsect1">
351
<a name="AtspiHyperlink.other_details"></a><h2>Types and Values</h2>
352
<div class="refsect2">
353
<a name="AtspiHyperlink-struct"></a><h3>AtspiHyperlink</h3>
354
<pre class="programlisting">typedef struct _AtspiHyperlink AtspiHyperlink;</pre>
359
<div class="refsect2">
360
<a name="AtspiHyperlinkClass"></a><h3>struct AtspiHyperlinkClass</h3>
361
<pre class="programlisting">struct AtspiHyperlinkClass {
362
AtspiObjectClass parent_class;
371
<hr>Generated by GTK-Doc V1.24.1</div>
b'\\ No newline at end of file'
added
removed
doc/libatspi/html/AtspiHyperlink.html
