/usr/share/gtk-doc/html/at-spi-cspi/at-spi-cspi-AccessibleHypertext-Interface.html is in at-spi-doc 1.32.0-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AccessibleHypertext Interface</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
<link rel="up" href="spi-component.html" title="Subinterface Methods">
<link rel="prev" href="at-spi-cspi-AccessibleEditableText-Interface.html" title="AccessibleEditableText Interface">
<link rel="next" href="at-spi-cspi-AccessibleImage-Interface.html" title="AccessibleImage Interface">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="at-spi-cspi-AccessibleEditableText-Interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="spi-component.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">AT-SPI C Bindings Reference Manual</th>
<td><a accesskey="n" href="at-spi-cspi-AccessibleImage-Interface.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#at-spi-cspi-AccessibleHypertext-Interface.synopsis" class="shortcut">Top</a>
|
<a href="#at-spi-cspi-AccessibleHypertext-Interface.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="at-spi-cspi-AccessibleHypertext-Interface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleHypertext-Interface.top_of_page"></a>AccessibleHypertext Interface</span></h2>
<p>AccessibleHypertext Interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="at-spi-cspi-AccessibleHypertext-Interface.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleHypertext-Interface.html#AccessibleHypertext-ref" title="AccessibleHypertext_ref ()">AccessibleHypertext_ref</a> (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleHypertext-Interface.html#AccessibleHypertext-unref" title="AccessibleHypertext_unref ()">AccessibleHypertext_unref</a> (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>);
<span class="returnvalue">long</span> <a class="link" href="at-spi-cspi-AccessibleHypertext-Interface.html#AccessibleHypertext-getNLinks" title="AccessibleHypertext_getNLinks ()">AccessibleHypertext_getNLinks</a> (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>);
<span class="returnvalue">AccessibleHyperlink</span> * <a class="link" href="at-spi-cspi-AccessibleHypertext-Interface.html#AccessibleHypertext-getLink" title="AccessibleHypertext_getLink ()">AccessibleHypertext_getLink</a> (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> linkIndex</code></em>);
<span class="returnvalue">long</span> <a class="link" href="at-spi-cspi-AccessibleHypertext-Interface.html#AccessibleHypertext-getLinkIndex" title="AccessibleHypertext_getLinkIndex ()">AccessibleHypertext_getLinkIndex</a> (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> characterOffset</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleHypertext-Interface.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleHypertext-Interface.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AccessibleHypertext-ref"></a><h3>AccessibleHypertext_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleHypertext_ref (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>);</pre>
<p>
Increment the reference count for an <span class="type">AccessibleHypertext</span> object.
Since AccessibleHypertext is derived from AccessibleText,
this is the same as <a class="link" href="at-spi-cspi-AccessibleText-Interface.html#AccessibleText-unref" title="AccessibleText_unref ()"><code class="function">AccessibleText_unref()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHypertext</span> object on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHypertext-unref"></a><h3>AccessibleHypertext_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleHypertext_unref (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>);</pre>
<p>
Decrement the reference count for an <span class="type">AccessibleHypertext</span> object.
Since AccessibleHypertext is derived from AccessibleText,
this is the same as <a class="link" href="at-spi-cspi-AccessibleText-Interface.html#AccessibleText-unref" title="AccessibleText_unref ()"><code class="function">AccessibleText_unref()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHypertext</span> object on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHypertext-getNLinks"></a><h3>AccessibleHypertext_getNLinks ()</h3>
<pre class="programlisting"><span class="returnvalue">long</span> AccessibleHypertext_getNLinks (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>);</pre>
<p>
Get the total number of <span class="type">AccessibleHyperlinks</span> which an
<span class="type">AccessibleHypertext</span> implementor has.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHypertext</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">long</span> indicating the number of <span class="type">AccessibleHyperlinks</span>
of the <span class="type">AccessibleHypertext</span> implementor, or -1 if
the number cannot be determined (for example, if the
<span class="type">AccessibleHypertext</span> object is so large that it is not
all currently in the memory cache).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHypertext-getLink"></a><h3>AccessibleHypertext_getLink ()</h3>
<pre class="programlisting"><span class="returnvalue">AccessibleHyperlink</span> * AccessibleHypertext_getLink (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> linkIndex</code></em>);</pre>
<p>
Get the <span class="type">AccessibleHyperlink</span> object at a specified index.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHypertext</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>linkIndex</code></em> :</span></p></td>
<td>a (zero-index) long integer indicating which hyperlink to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">AccessibleHyperlink</span> object specified by <span class="type">linkIndex</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHypertext-getLinkIndex"></a><h3>AccessibleHypertext_getLinkIndex ()</h3>
<pre class="programlisting"><span class="returnvalue">long</span> AccessibleHypertext_getLinkIndex (<em class="parameter"><code><span class="type">AccessibleHypertext</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> characterOffset</code></em>);</pre>
<p>
Get the index of the <span class="type">AccessibleHyperlink</span> object at a specified
character offset.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHypertext</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>characterOffset</code></em> :</span></p></td>
<td>an integer specifying the character offset to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the linkIndex of the <span class="type">AccessibleHyperlink</span> active at
character offset <em class="parameter"><code>characterOffset</code></em>, or -1 if there is
no hyperlink at the specified character offset.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|