This file is indexed.

/usr/share/gtk-doc/html/libatspi/libatspi-atspi-document.html is in at-spi2-doc 2.4.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
<!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-document</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="AtspiMatchRule.html" title="atspi-matchrule">
<link rel="next" href="AtspiObject.html" title="AtspiObject">
<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="AtspiMatchRule.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libatspi Reference Manual</th>
<td><a accesskey="n" href="AtspiObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-document.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libatspi-atspi-document.description" class="shortcut">Description</a>
                   | 
                  <a href="#libatspi-atspi-document.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libatspi-atspi-document.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-document"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-document.top_of_page"></a>atspi-document</span></h2>
<p>atspi-document</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-document.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiDocument"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-document.html#AtspiDocument-struct" title="AtspiDocument">AtspiDocument</a>;
<span class="returnvalue">gchar</span> *             <a class="link" href="libatspi-atspi-document.html#atspi-document-get-locale" title="atspi_document_get_locale ()">atspi_document_get_locale</a>           (<em class="parameter"><code><a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="libatspi-atspi-document.html#atspi-document-get-attribute-value" title="atspi_document_get_attribute_value ()">atspi_document_get_attribute_value</a>  (<em class="parameter"><code><a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *attribute</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GHashTable</span> *        <a class="link" href="libatspi-atspi-document.html#atspi-document-get-attributes" title="atspi_document_get_attributes ()">atspi_document_get_attributes</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-document.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----AtspiDocument
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-document.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiDocument is implemented by
 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-document.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-document.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiDocument-struct"></a><h3>AtspiDocument</h3>
<pre class="programlisting">typedef struct _AtspiDocument AtspiDocument;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-document-get-locale"></a><h3>atspi_document_get_locale ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             atspi_document_get_locale           (<em class="parameter"><code><a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the locale associated with the document's content, 
e.g. the locale for LOCALE_TYPE_MESSAGES.
</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 <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a string compliant with the POSIX standard for locale description.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-document-get-attribute-value"></a><h3>atspi_document_get_attribute_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             atspi_document_get_attribute_value  (<em class="parameter"><code><a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *attribute</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the value of a single attribute, if specified for the document as a whole.
</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 <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
<td>a string indicating the name of a specific attribute.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a string corresponding to the value of the specified attribute, or
an empty string if the attribute is unspecified for the object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-document-get-attributes"></a><h3>atspi_document_get_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *        atspi_document_get_attributes       (<em class="parameter"><code><a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets all constant attributes for the document as a whole. For attributes
that change within the document content, see <em class="parameter"><code>atspi_text_get_attribute_run</code></em> instead.
</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 <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> object 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">GHashTable</span>
containing the constant attributes of the document, as name-value pairs. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>