This file is indexed.

/usr/share/gtk-doc/html/pigment/pigment-PgmPlugin.html is in libpigment0.3-dev 0.3.17-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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PgmPlugin</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Pigment 0.3 Reference Manual">
<link rel="up" href="pigment-core.html" title="Part II. Pigment Core Reference">
<link rel="prev" href="pigment-PgmLinearAlgebra.html" title="PgmLinearAlgebra">
<link rel="next" href="PgmText.html" title="PgmText">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="preface" href="introduction.html" title="Introduction">
<link rel="part" href="pigment-overview.html" title="Part I. Pigment Overview">
<link rel="part" href="pigment-core.html" title="Part II. Pigment Core Reference">
<link rel="part" href="pigment-library.html" title="Part III. Pigment Library Reference">
<link rel="index" href="pigment-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="api-index.html" title="Index">
</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="pigment-PgmLinearAlgebra.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pigment-core.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">Pigment 0.3
 Reference Manual</th>
<td><a accesskey="n" href="PgmText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#pigment-PgmPlugin.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#pigment-PgmPlugin.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="pigment-PgmPlugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="pigment-PgmPlugin.top_of_page"></a>PgmPlugin</span></h2>
<p>PgmPlugin — Various structs and macros used for plugins handling.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="pigment-PgmPlugin.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;pgm/pgm.h&gt;

#define             <a class="link" href="pigment-PgmPlugin.html#PGM-PLUGIN-PATH-NAME--CAPS" title="PGM_PLUGIN_PATH_NAME">PGM_PLUGIN_PATH_NAME</a>
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            (<a class="link" href="pigment-PgmPlugin.html#PgmPluginInitFunc" title="PgmPluginInitFunc ()">*PgmPluginInitFunc</a>)                (<a
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
>GTypeModule</a> *module);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            (<a class="link" href="pigment-PgmPlugin.html#PgmPluginShutdownFunc" title="PgmPluginShutdownFunc ()">*PgmPluginShutdownFunc</a>)            (<a
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
>GTypeModule</a> *module);
<a class="link" href="PgmViewport.html" title="PgmViewport">PgmViewport</a> *       (<a class="link" href="pigment-PgmPlugin.html#PgmPluginCreateFunc" title="PgmPluginCreateFunc ()">*PgmPluginCreateFunc</a>)              (void);
                    <a class="link" href="pigment-PgmPlugin.html#PgmPluginDesc" title="PgmPluginDesc">PgmPluginDesc</a>;
#define             <a class="link" href="pigment-PgmPlugin.html#PGM-PLUGIN-DEFINE--CAPS" title="PGM_PLUGIN_DEFINE()">PGM_PLUGIN_DEFINE</a>                   (init,shutdown,create,name,version,description,license,origin,author)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="pigment-PgmPlugin.description"></a><h2>Description</h2>
<p>
Various structs and macros used by Pigment for plugins handling.
</p>
<p>
Last reviewed on 2007-04-12 (0.1.5)</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="pigment-PgmPlugin.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="PGM-PLUGIN-PATH-NAME--CAPS"></a><h3>PGM_PLUGIN_PATH_NAME</h3>
<pre class="programlisting">#define PGM_PLUGIN_PATH_NAME "PGM_PLUGIN_PATH"
</pre>
<p>
The name of the plugin path environment variable name.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PgmPluginInitFunc"></a><h3>PgmPluginInitFunc ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            (*PgmPluginInitFunc)                (<a
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
>GTypeModule</a> *module);</pre>
<p>
A plugin should provide a pointer to a function of this type in the
<a class="link" href="pigment-PgmPlugin.html#PgmPluginDesc" title="PgmPluginDesc"><span class="type">PgmPluginDesc</span></a> struct. This function will be called to initialize the
plugin.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td> the <a
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
><span class="type">GTypeModule</span></a> to use in the init func to register your types
(with <a
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html#g-type-module-register-type"
><code class="function">g_type_module_register_type()</code></a> or <span class="type">PGM_DEFINE_DYNAMIC_TYPE</span> or
<span class="type">PGM_DEFINE_DYNAMIC_TYPE_EXTENDED</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> if the initialization successes, <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PgmPluginShutdownFunc"></a><h3>PgmPluginShutdownFunc ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            (*PgmPluginShutdownFunc)            (<a
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
>GTypeModule</a> *module);</pre>
<p>
A plugin should provide a pointer to a function of this type in the
<a class="link" href="pigment-PgmPlugin.html#PgmPluginDesc" title="PgmPluginDesc"><span class="type">PgmPluginDesc</span></a>  struct. This function will be called to shutdown the plugin.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td> the <a
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
><span class="type">GTypeModule</span></a> that was passed to the <a class="link" href="pigment-PgmPlugin.html#PgmPluginInitFunc" title="PgmPluginInitFunc ()"><span class="type">PgmPluginInitFunc</span></a> function.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> if the deinitialization successes, <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PgmPluginCreateFunc"></a><h3>PgmPluginCreateFunc ()</h3>
<pre class="programlisting"><a class="link" href="PgmViewport.html" title="PgmViewport">PgmViewport</a> *       (*PgmPluginCreateFunc)              (void);</pre>
<p>
A plugin should provide a pointer to a function of this prototype in the
<a class="link" href="pigment-PgmPlugin.html#PgmPluginDesc" title="PgmPluginDesc"><code class="literal">PgmPluginDesc</code></a> struct. This function will be called by the user to create
the <a class="link" href="PgmViewport.html" title="PgmViewport"><code class="literal">PgmViewport</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="PgmViewport.html" title="PgmViewport"><span class="type">PgmViewport</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PgmPluginDesc"></a><h3>PgmPluginDesc</h3>
<pre class="programlisting">typedef struct {
  PgmPluginInitFunc      init;
  PgmPluginShutdownFunc  shutdown;
  PgmPluginCreateFunc    create;
  gchar                 *name;
  gchar                 *version;
  gchar                 *description;
  gchar                 *license;
  gchar                 *origin;
  gchar                 *author;
} PgmPluginDesc;
</pre>
<p>
Pigment Plugin description structure.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="pigment-PgmPlugin.html#PgmPluginInitFunc" title="PgmPluginInitFunc ()">PgmPluginInitFunc</a> <em class="structfield"><code>init</code></em>;</span></p></td>
<td> the plugin initialization function pointer.
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="pigment-PgmPlugin.html#PgmPluginShutdownFunc" title="PgmPluginShutdownFunc ()">PgmPluginShutdownFunc</a> <em class="structfield"><code>shutdown</code></em>;</span></p></td>
<td> the plugin shutdown function pointer.
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="pigment-PgmPlugin.html#PgmPluginCreateFunc" title="PgmPluginCreateFunc ()">PgmPluginCreateFunc</a> <em class="structfield"><code>create</code></em>;</span></p></td>
<td> the plugin create function pointer (returning a <a class="link" href="PgmViewport.html" title="PgmViewport"><code class="literal">PgmViewport</code></a>).
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>name</code></em>;</span></p></td>
<td> the plugin name.
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>version</code></em>;</span></p></td>
<td> the version string of Pigment that plugin was compiled for.
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>description</code></em>;</span></p></td>
<td> the plugin description.
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>license</code></em>;</span></p></td>
<td> the plugin license.
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>origin</code></em>;</span></p></td>
<td> the plugin origin URL.
</td>
</tr>
<tr>
<td><p><span class="term"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>author</code></em>;</span></p></td>
<td> the plugin author.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PGM-PLUGIN-DEFINE--CAPS"></a><h3>PGM_PLUGIN_DEFINE()</h3>
<pre class="programlisting">#define             PGM_PLUGIN_DEFINE(init,shutdown,create,name,version,description,license,origin,author)</pre>
<p>
Utility macro to create a <a class="link" href="pigment-PgmPlugin.html#PgmPluginDesc" title="PgmPluginDesc"><span class="type">PgmPluginDesc</span></a> plugin description structure.
This is the entry point for every Pigment plugin and it is highly
recommended to use this macro to avoid common mistakes maxking entry point
unusable.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>init</code></em> :</span></p></td>
<td> the plugin initialization function pointer.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shutdown</code></em> :</span></p></td>
<td> the plugin shutdown function pointer.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>create</code></em> :</span></p></td>
<td> the plugin creation function pointer (returning a <a class="link" href="PgmViewport.html" title="PgmViewport"><code class="literal">PgmViewport</code></a>).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the plugin name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
<td> the version string of Pigment that plugin was compiled for.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td> the plugin description.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>license</code></em> :</span></p></td>
<td> the plugin license.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>origin</code></em> :</span></p></td>
<td> the plugin origin URL.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>author</code></em> :</span></p></td>
<td> the plugin author.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>