1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpModuleDB</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="GIMP Module Library Reference Manual">
8
<link rel="up" href="libgimpmodule.html" title="Part I. GIMP Module Library">
8
<link rel="up" href="libgimpmodule.html" title="Part I. GIMP Module Library">
9
9
<link rel="prev" href="GimpModule.html" title="GimpModule">
10
10
<link rel="next" href="libgimpmodule-index.html" title="Index">
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="libgimpmodule.html" title="Part I. GIMP Module Library">
13
<link rel="part" href="libgimpmodule.html" title="Part I. GIMP Module Library">
14
14
<link rel="index" href="libgimpmodule-index.html" title="Index">
15
15
<link rel="index" href="libgimpmodule-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
16
16
<link rel="index" href="libgimpmodule-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
25
25
<th width="100%" align="center">GIMP Module Library Reference Manual</th>
26
26
<td><a accesskey="n" href="libgimpmodule-index.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2611026" class="shortcut">Top</a>
30
<a href="#id2614770" class="shortcut">Description</a>
32
<a href="#id2614707" class="shortcut">Object Hierarchy</a>
34
<a href="#id2614731" class="shortcut">Signals</a></nobr></td></tr>
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpModuleDB.synopsis" class="shortcut">Top</a>
30
<a href="#GimpModuleDB.description" class="shortcut">Description</a>
32
<a href="#GimpModuleDB.object-hierarchy" class="shortcut">Object Hierarchy</a>
34
<a href="#GimpModuleDB.signals" class="shortcut">Signals</a></nobr></td></tr>
36
36
<div class="refentry" lang="en">
37
37
<a name="GimpModuleDB"></a><div class="titlepage"></div>
38
38
<div class="refnamediv"><table width="100%"><tr>
41
<a name="id2611026"></a><span class="refentrytitle">GimpModuleDB</span>
43
<p>GimpModuleDB — Keeps a list of <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.</p>
40
<h2><span class="refentrytitle"><a name="GimpModuleDB.top_of_page"></a>GimpModuleDB</span></h2>
41
<p>GimpModuleDB — Keeps a list of <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.</p>
45
43
<td valign="top" align="right"></td>
46
44
</tr></table></div>
47
45
<div class="refsynopsisdiv">
46
<a name="GimpModuleDB.synopsis"></a><h2>Synopsis</h2>
49
47
<pre class="synopsis">
53
<a class="link" href="GimpModuleDB.html#GimpModuleDB-struct">GimpModuleDB</a>;
54
<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* <a class="link" href="GimpModuleDB.html#gimp-module-db-new">gimp_module_db_new</a> (<a
55
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
56
>gboolean</a> verbose);
57
void <a class="link" href="GimpModuleDB.html#gimp-module-db-set-load-inhibit">gimp_module_db_set_load_inhibit</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
59
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
60
>gchar</a> *load_inhibit);
62
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
63
>gchar</a>* <a class="link" href="GimpModuleDB.html#gimp-module-db-get-load-inhibit">gimp_module_db_get_load_inhibit</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);
64
void <a class="link" href="GimpModuleDB.html#gimp-module-db-load">gimp_module_db_load</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
66
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
67
>gchar</a> *module_path);
68
void <a class="link" href="GimpModuleDB.html#gimp-module-db-refresh">gimp_module_db_refresh</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
70
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
71
>gchar</a> *module_path);
48
<a class="link" href="GimpModuleDB.html#GimpModuleDB-struct" title="GimpModuleDB">GimpModuleDB</a>;
49
<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* <a class="link" href="GimpModuleDB.html#gimp-module-db-new" title="gimp_module_db_new ()">gimp_module_db_new</a> (gboolean verbose);
50
void <a class="link" href="GimpModuleDB.html#gimp-module-db-set-load-inhibit" title="gimp_module_db_set_load_inhibit ()">gimp_module_db_set_load_inhibit</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
51
const gchar *load_inhibit);
52
const gchar* <a class="link" href="GimpModuleDB.html#gimp-module-db-get-load-inhibit" title="gimp_module_db_get_load_inhibit ()">gimp_module_db_get_load_inhibit</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);
53
void <a class="link" href="GimpModuleDB.html#gimp-module-db-load" title="gimp_module_db_load ()">gimp_module_db_load</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
54
const gchar *module_path);
55
void <a class="link" href="GimpModuleDB.html#gimp-module-db-refresh" title="gimp_module_db_refresh ()">gimp_module_db_refresh</a> (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
56
const gchar *module_path);
75
59
<div class="refsect1" lang="en">
76
<a name="id2614707"></a><h2>Object Hierarchy</h2>
60
<a name="GimpModuleDB.object-hierarchy"></a><h2>Object Hierarchy</h2>
77
61
<pre class="synopsis">
80
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
85
66
<div class="refsect1" lang="en">
86
<a name="id2614731"></a><h2>Signals</h2>
67
<a name="GimpModuleDB.signals"></a><h2>Signals</h2>
87
68
<pre class="synopsis">
89
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-add">add</a>" : Run First
90
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-module-modified">module-modified</a>" : Run First
91
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-remove">remove</a>" : Run First
69
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-add" title='The "add" signal'>add</a>" : Run First
70
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-module-modified" title='The "module-modified" signal'>module-modified</a>" : Run First
71
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-remove" title='The "remove" signal'>remove</a>" : Run First
94
74
<div class="refsect1" lang="en">
95
<a name="id2614770"></a><h2>Description</h2>
75
<a name="GimpModuleDB.description"></a><h2>Description</h2>
97
77
Keeps a list of <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.
100
80
<div class="refsect1" lang="en">
101
<a name="id2614793"></a><h2>Details</h2>
81
<a name="GimpModuleDB.details"></a><h2>Details</h2>
102
82
<div class="refsect2" lang="en">
103
<a name="id2614804"></a><h3>
104
<a name="GimpModuleDB-struct"></a>GimpModuleDB</h3>
105
<a class="indexterm" name="id2614816"></a><pre class="programlisting">typedef struct _GimpModuleDB GimpModuleDB;</pre>
83
<a name="GimpModuleDB-struct"></a><h3>GimpModuleDB</h3>
84
<pre class="programlisting">typedef struct _GimpModuleDB GimpModuleDB;</pre>
107
86
The <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> struct contains no public members.
111
90
<div class="refsect2" lang="en">
112
<a name="id2601996"></a><h3>
113
<a name="gimp-module-db-new"></a>gimp_module_db_new ()</h3>
114
<a class="indexterm" name="id2602009"></a><pre class="programlisting"><a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* gimp_module_db_new (<a
115
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
116
>gboolean</a> verbose);</pre>
91
<a name="gimp-module-db-new"></a><h3>gimp_module_db_new ()</h3>
92
<pre class="programlisting"><a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* gimp_module_db_new (gboolean verbose);</pre>
118
94
Creates a new <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> instance. The <em class="parameter"><code>verbose</code></em> parameter will be
119
passed to the created <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instances using <a class="link" href="GimpModule.html#gimp-module-new"><code class="function">gimp_module_new()</code></a>.</p>
95
passed to the created <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instances using <a class="link" href="GimpModule.html#gimp-module-new" title="gimp_module_new ()"><code class="function">gimp_module_new()</code></a>.</p>
206
170
<div class="refsect2" lang="en">
207
<a name="id2605635"></a><h3>
208
<a name="gimp-module-db-load"></a>gimp_module_db_load ()</h3>
209
<a class="indexterm" name="id2605647"></a><pre class="programlisting">void gimp_module_db_load (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
211
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
212
>gchar</a> *module_path);</pre>
171
<a name="gimp-module-db-load"></a><h3>gimp_module_db_load ()</h3>
172
<pre class="programlisting">void gimp_module_db_load (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
173
const gchar *module_path);</pre>
214
175
Scans the directories contained in <em class="parameter"><code>module_path</code></em> using
216
href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories"
217
><code class="function">gimp_datafiles_read_directories()</code></a> and creates a <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>
176
<code class="function">gimp_datafiles_read_directories()</code> and creates a <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>
218
177
instance for every loadable module contained in the directories.</p>
242
199
<div class="refsect2" lang="en">
243
<a name="id2606178"></a><h3>
244
<a name="gimp-module-db-refresh"></a>gimp_module_db_refresh ()</h3>
245
<a class="indexterm" name="id2606189"></a><pre class="programlisting">void gimp_module_db_refresh (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
247
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
248
>gchar</a> *module_path);</pre>
200
<a name="gimp-module-db-refresh"></a><h3>gimp_module_db_refresh ()</h3>
201
<pre class="programlisting">void gimp_module_db_refresh (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
202
const gchar *module_path);</pre>
250
Does the same as <a class="link" href="GimpModuleDB.html#gimp-module-db-load"><code class="function">gimp_module_db_load()</code></a>, plus removes all <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>
204
Does the same as <a class="link" href="GimpModuleDB.html#gimp-module-db-load" title="gimp_module_db_load ()"><code class="function">gimp_module_db_load()</code></a>, plus removes all <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>
251
205
instances whose modules have been deleted from disk.
254
208
Note that the <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s will just be removed from the internal
255
list and not freed as this is not possible with <a
256
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
257
><span class="type">GTypeModule</span></a>
209
list and not freed as this is not possible with <span class="type">GTypeModule</span>
258
210
instances which actually implement types.</p>
282
232
<div class="refsect1" lang="en">
283
<a name="id2606313"></a><h2>Signal Details</h2>
284
<div class="refsect2" lang="en">
285
<a name="id2606324"></a><h3>
286
<a name="GimpModuleDB-add"></a>The <code class="literal">"add"</code> signal</h3>
287
<a class="indexterm" name="id2606339"></a><pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
288
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
290
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
291
>gpointer</a> user_data) : Run First</pre>
295
<div class="variablelist"><table border="0">
296
<col align="left" valign="top">
299
<td><p><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></p></td>
300
<td>the object which received the signal.
304
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
310
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
311
<td>user data set when the signal handler was connected.</td>
317
<div class="refsect2" lang="en">
318
<a name="id2586141"></a><h3>
319
<a name="GimpModuleDB-module-modified"></a>The <code class="literal">"module-modified"</code> signal</h3>
320
<a class="indexterm" name="id2617824"></a><pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
321
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
323
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
324
>gpointer</a> user_data) : Run First</pre>
328
<div class="variablelist"><table border="0">
329
<col align="left" valign="top">
332
<td><p><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></p></td>
333
<td>the object which received the signal.
337
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
343
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
344
<td>user data set when the signal handler was connected.</td>
350
<div class="refsect2" lang="en">
351
<a name="id2617905"></a><h3>
352
<a name="GimpModuleDB-remove"></a>The <code class="literal">"remove"</code> signal</h3>
353
<a class="indexterm" name="id2617917"></a><pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
354
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
356
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
357
>gpointer</a> user_data) : Run First</pre>
361
<div class="variablelist"><table border="0">
362
<col align="left" valign="top">
365
<td><p><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></p></td>
366
<td>the object which received the signal.
370
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
376
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
377
<td>user data set when the signal handler was connected.</td>
383
<div class="refsect1" lang="en">
384
<a name="id2618000"></a><div class="refsect2" lang="en"><a name="id2618001"></a></div>
386
<div class="refsect2" lang="en"><a name="id2618002"></a></div>
233
<a name="GimpModuleDB.signal-details"></a><h2>Signal Details</h2>
234
<div class="refsect2" lang="en">
235
<a name="GimpModuleDB-add"></a><h3>The <code class="literal">"add"</code> signal</h3>
236
<pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
237
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
238
gpointer user_data) : Run First</pre>
242
<div class="variablelist"><table border="0">
243
<col align="left" valign="top">
246
<td><p><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></p></td>
247
<td>the object which received the signal.
251
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
257
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
258
<td>user data set when the signal handler was connected.</td>
264
<div class="refsect2" lang="en">
265
<a name="GimpModuleDB-module-modified"></a><h3>The <code class="literal">"module-modified"</code> signal</h3>
266
<pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
267
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
268
gpointer user_data) : Run First</pre>
272
<div class="variablelist"><table border="0">
273
<col align="left" valign="top">
276
<td><p><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></p></td>
277
<td>the object which received the signal.
281
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
287
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
288
<td>user data set when the signal handler was connected.</td>
294
<div class="refsect2" lang="en">
295
<a name="GimpModuleDB-remove"></a><h3>The <code class="literal">"remove"</code> signal</h3>
296
<pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
297
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
298
gpointer user_data) : Run First</pre>
302
<div class="variablelist"><table border="0">
303
<col align="left" valign="top">
306
<td><p><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></p></td>
307
<td>the object which received the signal.
311
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
317
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
318
<td>user data set when the signal handler was connected.</td>
327
Generated by GTK-Doc V1.10</div>