This file is indexed.

/usr/share/gtk-doc/html/ethos/EthosPlugin.html is in libethos-doc 0.2.2-2ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EthosPlugin</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Ethos Reference Manual">
<link rel="up" href="ch04.html" title="Ethos Reference">
<link rel="prev" href="ethos-EthosPluginLoader.html" title="EthosPluginLoader">
<link rel="next" href="EthosError.html" title="EthosError">
<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="ethos-EthosPluginLoader.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.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">Ethos Reference Manual</th>
<td><a accesskey="n" href="EthosError.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EthosPlugin.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#EthosPlugin.description" class="shortcut">Description</a>
                   | 
                  <a href="#EthosPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#EthosPlugin.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EthosPlugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EthosPlugin.top_of_page"></a>EthosPlugin</span></h2>
<p>EthosPlugin — plugin base class</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EthosPlugin.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define             <a class="link" href="EthosPlugin.html#ETHOS-PLUGIN-CONST:CAPS" title="ETHOS_PLUGIN_CONST()">ETHOS_PLUGIN_CONST</a>                  (obj)
struct              <a class="link" href="EthosPlugin.html#EthosPlugin-struct" title="struct EthosPlugin">EthosPlugin</a>;
struct              <a class="link" href="EthosPlugin.html#EthosPluginClass" title="struct EthosPluginClass">EthosPluginClass</a>;
<span class="returnvalue">void</span>                <a class="link" href="EthosPlugin.html#ethos-plugin-activate" title="ethos_plugin_activate ()">ethos_plugin_activate</a>               (<em class="parameter"><code><a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> *plugin</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EthosPlugin.html#ethos-plugin-deactivate" title="ethos_plugin_deactivate ()">ethos_plugin_deactivate</a>             (<em class="parameter"><code><a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> *plugin</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EthosPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----EthosPlugin
</pre>
</div>
<div class="refsect1">
<a name="EthosPlugin.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="EthosPlugin.html#EthosPlugin-activated" title='The "activated" signal'>activated</a>"                                      : <code class="literal">Run First</code>
  "<a class="link" href="EthosPlugin.html#EthosPlugin-deactivated" title='The "deactivated" signal'>deactivated</a>"                                    : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="EthosPlugin.description"></a><h2>Description</h2>
<p>
The <a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> class is a base class that can be inherited to create plugins.  It
can also be instantiated directly and have signals attached to build a plugin during
runtime.
</p>
<p>
Plugins should inherit this class within their module.
</p>
</div>
<div class="refsect1">
<a name="EthosPlugin.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ETHOS-PLUGIN-CONST:CAPS"></a><h3>ETHOS_PLUGIN_CONST()</h3>
<pre class="programlisting">#define ETHOS_PLUGIN_CONST(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), ETHOS_TYPE_PLUGIN, EthosPlugin const))
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPlugin-struct"></a><h3>struct EthosPlugin</h3>
<pre class="programlisting">struct EthosPlugin;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginClass"></a><h3>struct EthosPluginClass</h3>
<pre class="programlisting">struct EthosPluginClass {
	GObjectClass parent_class;

	void (*activated)   (EthosPlugin *plugin);
	void (*deactivated) (EthosPlugin *plugin);

	void (*reserved1)   (void);
	void (*reserved2)   (void);
	void (*reserved3)   (void);
	void (*reserved4)   (void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-activate"></a><h3>ethos_plugin_activate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ethos_plugin_activate               (<em class="parameter"><code><a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> *plugin</code></em>);</pre>
<p>
Activates the plugin so that it may prepare itself for execution.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-deactivate"></a><h3>ethos_plugin_deactivate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ethos_plugin_deactivate             (<em class="parameter"><code><a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> *plugin</code></em>);</pre>
<p>
Requests the plugin to deactivate itself so that it may be destroyed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EthosPlugin.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EthosPlugin-activated"></a><h3>The <code class="literal">"activated"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> *plugin,
                                                        <span class="type">gpointer</span>     user_data)      : <code class="literal">Run First</code></pre>
<p>
Signal emitted when the plugin has been activated by the <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
for the process.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>the <a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EthosPlugin-deactivated"></a><h3>The <code class="literal">"deactivated"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> *plugin,
                                                        <span class="type">gpointer</span>     user_data)      : <code class="literal">Run First</code></pre>
<p>
Signal emitted when the plugin has been deactivated by the <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
for the process.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>the <a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>