/usr/share/gtk-doc/html/libatspi/libatspi-atspi-hypertext.html is in at-spi2-doc 2.28.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-hypertext: libatspi Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="AtspiEventListener.html" title="AtspiEventListener">
<link rel="next" href="libatspi-atspi-component.html" title="atspi-component">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libatspi-atspi-hypertext.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libatspi-atspi-hypertext.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#libatspi-atspi-hypertext.implementations" class="shortcut">Known Implementations</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AtspiEventListener.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libatspi-atspi-component.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libatspi-atspi-hypertext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-hypertext.top_of_page"></a>atspi-hypertext</span></h2>
<p>atspi-hypertext</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-hypertext.html#atspi-hypertext-get-n-links" title="atspi_hypertext_get_n_links ()">atspi_hypertext_get_n_links</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="returnvalue">AtspiHyperlink</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-hypertext.html#atspi-hypertext-get-link" title="atspi_hypertext_get_link ()">atspi_hypertext_get_link</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-hypertext.html#atspi-hypertext-get-link-index" title="atspi_hypertext_get_link_index ()">atspi_hypertext_get_link_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="AtspiHypertext"></a><div class="refsect1">
<a name="libatspi-atspi-hypertext.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext-struct" title="AtspiHypertext">AtspiHypertext</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GInterface
<span class="lineart">╰──</span> AtspiHypertext
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiHypertext is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atspi-hypertext-get-n-links"></a><h3>atspi_hypertext_get_n_links ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_hypertext_get_n_links (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the total number of <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> objects that an
<a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor has.</p>
<div class="refsect3">
<a name="atspi-hypertext-get-n-links.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-hypertext-get-n-links.returns"></a><h4>Returns</h4>
<p> a <span class="type">gint</span> indicating the number of <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> objects
of the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor, or -1 if
the number cannot be determined (for example, if the
<a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> object is so large that it is not
all currently in the memory cache).</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hypertext-get-link"></a><h3>atspi_hypertext_get_link ()</h3>
<pre class="programlisting"><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="returnvalue">AtspiHyperlink</span></a> *
atspi_hypertext_get_link (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> link_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> object at a specified index.</p>
<div class="refsect3">
<a name="atspi-hypertext-get-link.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>link_index</p></td>
<td class="parameter_description"><p>a (zero-index) <span class="type">gint</span> indicating which hyperlink to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-hypertext-get-link.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> object
specified by <em class="parameter"><code>link_index</code></em>
. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hypertext-get-link-index"></a><h3>atspi_hypertext_get_link_index ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_hypertext_get_link_index (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> character_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the index of the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> object at a specified
character offset.</p>
<div class="refsect3">
<a name="atspi-hypertext-get-link-index.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>character_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> specifying the character offset to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-hypertext-get-link-index.returns"></a><h4>Returns</h4>
<p> the linkIndex of the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> active at
character offset <em class="parameter"><code>character_offset</code></em>
, or -1 if there is
no hyperlink at the specified character offset.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiHypertext-struct"></a><h3>AtspiHypertext</h3>
<pre class="programlisting">typedef struct _AtspiHypertext AtspiHypertext;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|