This file is indexed.

/usr/share/gtk-doc/html/clutter/clutter-General-API.html is in libclutter-1.0-doc 1.24.2-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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Cally: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch14.html" title="Utility API">
<link rel="prev" href="ch14.html" title="Utility API">
<link rel="next" href="CallyUtil.html" title="CallyUtil">
<meta name="generator" content="GTK-Doc V1.24 (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="#clutter-General-API.description" class="shortcut">Description</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="ch14.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch14.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CallyUtil.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-General-API"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-General-API.top_of_page"></a>Cally</span></h2>
<p>Cally — Cally initialization methods.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-General-API.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="clutter-General-API.html#cally-get-cally-initialized" title="cally_get_cally_initialized ()">cally_get_cally_initialized</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="clutter-General-API.html#cally-accessibility-init" title="cally_accessibility_init ()">cally_accessibility_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="clutter-General-API.html#CALLY-ACCESSIBLE-FACTORY:CAPS" title="CALLY_ACCESSIBLE_FACTORY()">CALLY_ACCESSIBLE_FACTORY</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="clutter-General-API.html#CALLY-ACTOR-SET-FACTORY:CAPS" title="CALLY_ACTOR_SET_FACTORY()">CALLY_ACTOR_SET_FACTORY</a><span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-General-API.description"></a><h2>Description</h2>
<p>Cally initialization methods.</p>
</div>
<div class="refsect1">
<a name="clutter-General-API.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cally-get-cally-initialized"></a><h3>cally_get_cally_initialized ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
cally_get_cally_initialized (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns if the accessibility support using cally is enabled.</p>
<div class="refsect3">
<a name="id-1.9.4.2.5.2.5"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if accessibility support has been correctly
initialized.</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="cally-accessibility-init"></a><h3>cally_accessibility_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
cally_accessibility_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initializes the accessibility support.</p>
<div class="refsect3">
<a name="id-1.9.4.2.5.3.5"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if accessibility support has been correctly
initialized.</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="CALLY-ACCESSIBLE-FACTORY:CAPS"></a><h3>CALLY_ACCESSIBLE_FACTORY()</h3>
<pre class="programlisting">#define             CALLY_ACCESSIBLE_FACTORY(type, type_as_function, opt_create_accessible)</pre>
<p>Defines a new <span class="type">AtkObjectFactory</span> factory to create accessible
objects of a specific GType. It defines the factory GType and also
overrides the proper <span class="type">AtkObjectFactory</span> methods.</p>
<p>It assumes that the accessibility object provides a
<em class="parameter"><code>opt_create_accessible</code></em>
 method in order to create the accessibility
object. It returns a <em class="parameter"><code>type</code></em>
 GType object.</p>
<div class="refsect3">
<a name="id-1.9.4.2.5.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>type</p></td>
<td class="parameter_description"><p>GType of the accessible which is created by the factory</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_as_function</p></td>
<td class="parameter_description"><p>prefix of the accessible object methods</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opt_create_accessible</p></td>
<td class="parameter_description"><p>method to instantiate the accessibility object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="CALLY-ACTOR-SET-FACTORY:CAPS"></a><h3>CALLY_ACTOR_SET_FACTORY()</h3>
<pre class="programlisting">#define             CALLY_ACTOR_SET_FACTORY(widget_type, type_as_function)</pre>
<p>Sets the <span class="type">AtkObjectFactory</span> to be used in order to instantiate
accessibility objects for the actor which GType is <em class="parameter"><code>widget_type</code></em>
.</p>
<div class="refsect3">
<a name="id-1.9.4.2.5.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>widget_type</p></td>
<td class="parameter_description"><p>GType of the clutter actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_as_function</p></td>
<td class="parameter_description"><p>prefix of the accessible object methods</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-General-API.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>