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="#id2591604" class="shortcut">Top</a>
30
<a href="#id2614481" class="shortcut">Description</a>
32
<a href="#id2614418" class="shortcut">Object Hierarchy</a>
34
<a href="#id2614442" class="shortcut">Signals</a></nobr></td></tr>
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2597010" class="shortcut">Top</a>
30
<a href="#id2594177" class="shortcut">Description</a>
32
<a href="#id2594114" class="shortcut">Object Hierarchy</a>
34
<a href="#id2594138" 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="id2591604"></a><span class="refentrytitle">GimpModuleDB</span>
41
<a name="id2597010"></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>
43
<p>GimpModuleDB — Keeps a list of <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.</p>
45
45
<td valign="top" align="right"></td>
46
46
</tr></table></div>
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> (gboolean verbose);
55
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,
56
const gchar *load_inhibit);
57
const gchar* <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);
58
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,
59
const gchar *module_path);
60
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,
61
const gchar *module_path);
53
<a href="GimpModuleDB.html#GimpModuleDB-struct">GimpModuleDB</a>;
54
<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* <a href="GimpModuleDB.html#gimp-module-db-new">gimp_module_db_new</a> (<a
55
href="../glib/glib-Basic-Types.html#gboolean"
56
>gboolean</a> verbose);
57
void <a href="GimpModuleDB.html#gimp-module-db-set-load-inhibit">gimp_module_db_set_load_inhibit</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
59
href="../glib/glib-Basic-Types.html#gchar"
60
>gchar</a> *load_inhibit);
62
href="../glib/glib-Basic-Types.html#gchar"
63
>gchar</a>* <a href="GimpModuleDB.html#gimp-module-db-get-load-inhibit">gimp_module_db_get_load_inhibit</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);
64
void <a href="GimpModuleDB.html#gimp-module-db-load">gimp_module_db_load</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
66
href="../glib/glib-Basic-Types.html#gchar"
67
>gchar</a> *module_path);
68
void <a href="GimpModuleDB.html#gimp-module-db-refresh">gimp_module_db_refresh</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
70
href="../glib/glib-Basic-Types.html#gchar"
71
>gchar</a> *module_path);
65
75
<div class="refsect1" lang="en">
66
<a name="id2614418"></a><h2>Object Hierarchy</h2>
76
<a name="id2594114"></a><h2>Object Hierarchy</h2>
67
77
<pre class="synopsis">
80
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
73
85
<div class="refsect1" lang="en">
74
<a name="id2614442"></a><h2>Signals</h2>
86
<a name="id2594138"></a><h2>Signals</h2>
75
87
<pre class="synopsis">
77
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-add">add</a>" : Run First
78
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-module-modified">module-modified</a>" : Run First
79
"<a class="link" href="GimpModuleDB.html#GimpModuleDB-remove">remove</a>" : Run First
89
"<a href="GimpModuleDB.html#GimpModuleDB-add">add</a>" : Run First
90
"<a href="GimpModuleDB.html#GimpModuleDB-module-modified">module-modified</a>" : Run First
91
"<a href="GimpModuleDB.html#GimpModuleDB-remove">remove</a>" : Run First
82
94
<div class="refsect1" lang="en">
83
<a name="id2614481"></a><h2>Description</h2>
95
<a name="id2594177"></a><h2>Description</h2>
85
Keeps a list of <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.
97
Keeps a list of <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.
88
100
<div class="refsect1" lang="en">
89
<a name="id2614504"></a><h2>Details</h2>
101
<a name="id2594200"></a><h2>Details</h2>
90
102
<div class="refsect2" lang="en">
91
<a name="id2614515"></a><h3>
103
<a name="id2594211"></a><h3>
92
104
<a name="GimpModuleDB-struct"></a>GimpModuleDB</h3>
93
<a class="indexterm" name="id2614527"></a><pre class="programlisting">typedef struct _GimpModuleDB GimpModuleDB;</pre>
105
<a class="indexterm" name="id2594223"></a><pre class="programlisting">typedef struct _GimpModuleDB GimpModuleDB;</pre>
95
The <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> struct contains no public members.
107
The <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> struct contains no public members.
99
111
<div class="refsect2" lang="en">
100
<a name="id2588427"></a><h3>
112
<a name="id2566754"></a><h3>
101
113
<a name="gimp-module-db-new"></a>gimp_module_db_new ()</h3>
102
<a class="indexterm" name="id2588439"></a><pre class="programlisting"><a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* gimp_module_db_new (gboolean verbose);</pre>
114
<a class="indexterm" name="id2566767"></a><pre class="programlisting"><a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* gimp_module_db_new (<a
115
href="../glib/glib-Basic-Types.html#gboolean"
116
>gboolean</a> verbose);</pre>
104
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
105
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>
118
Creates a new <a 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 href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instances using <a href="GimpModule.html#gimp-module-new"><code class="function">gimp_module_new()</code></a>.</p>
126
142
<div class="refsect2" lang="en">
127
<a name="id2588546"></a><h3>
143
<a name="id2566874"></a><h3>
128
144
<a name="gimp-module-db-set-load-inhibit"></a>gimp_module_db_set_load_inhibit ()</h3>
129
<a class="indexterm" name="id2588557"></a><pre class="programlisting">void gimp_module_db_set_load_inhibit (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
130
const gchar *load_inhibit);</pre>
145
<a class="indexterm" name="id2566885"></a><pre class="programlisting">void gimp_module_db_set_load_inhibit (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
147
href="../glib/glib-Basic-Types.html#gchar"
148
>gchar</a> *load_inhibit);</pre>
132
Sets the <em class="parameter"><code>load_inhibit</code></em> flag for all <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s which are kept
133
by <em class="parameter"><code>db</code></em> (using <a class="link" href="GimpModule.html#gimp-module-set-load-inhibit"><code class="function">gimp_module_set_load_inhibit()</code></a>).</p>
150
Sets the <em class="parameter"><code>load_inhibit</code></em> flag for all <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s which are kept
151
by <em class="parameter"><code>db</code></em> (using <a href="GimpModule.html#gimp-module-set-load-inhibit"><code class="function">gimp_module_set_load_inhibit()</code></a>).</p>
138
156
<col align="left" valign="top">
141
<td><p><span class="term"><em class="parameter"><code>db</code></em> :</span></p></td>
142
<td> A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
159
<td><span class="term"><em class="parameter"><code>db</code></em> :</span></td>
160
<td> A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
146
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></p></td>
147
<td> A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of module
164
<td><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></td>
166
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
167
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> delimited list of module
148
168
filenames to exclude from auto-loading.
155
175
<div class="refsect2" lang="en">
156
<a name="id2605244"></a><h3>
176
<a name="id2588773"></a><h3>
157
177
<a name="gimp-module-db-get-load-inhibit"></a>gimp_module_db_get_load_inhibit ()</h3>
158
<a class="indexterm" name="id2605258"></a><pre class="programlisting">const gchar* gimp_module_db_get_load_inhibit (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);</pre>
178
<a class="indexterm" name="id2588786"></a><pre class="programlisting">const <a
179
href="../glib/glib-Basic-Types.html#gchar"
180
>gchar</a>* gimp_module_db_get_load_inhibit (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);</pre>
160
Return the <span class="type">G_SEARCHPATH_SEPARATOR</span> selimited list of module filenames
183
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
184
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> selimited list of module filenames
161
185
which are excluded from auto-loading.</p>
182
206
<div class="refsect2" lang="en">
183
<a name="id2605347"></a><h3>
207
<a name="id2588876"></a><h3>
184
208
<a name="gimp-module-db-load"></a>gimp_module_db_load ()</h3>
185
<a class="indexterm" name="id2605359"></a><pre class="programlisting">void gimp_module_db_load (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
186
const gchar *module_path);</pre>
209
<a class="indexterm" name="id2588888"></a><pre class="programlisting">void gimp_module_db_load (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
211
href="../glib/glib-Basic-Types.html#gchar"
212
>gchar</a> *module_path);</pre>
188
214
Scans the directories contained in <em class="parameter"><code>module_path</code></em> using
190
href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories"
191
><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>
216
href="../libgimpbase/libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories"
217
><code class="function">gimp_datafiles_read_directories()</code></a> and creates a <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>
192
218
instance for every loadable module contained in the directories.</p>
214
242
<div class="refsect2" lang="en">
215
<a name="id2584293"></a><h3>
243
<a name="id2588044"></a><h3>
216
244
<a name="gimp-module-db-refresh"></a>gimp_module_db_refresh ()</h3>
217
<a class="indexterm" name="id2584304"></a><pre class="programlisting">void gimp_module_db_refresh (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
218
const gchar *module_path);</pre>
245
<a class="indexterm" name="id2588055"></a><pre class="programlisting">void gimp_module_db_refresh (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
247
href="../glib/glib-Basic-Types.html#gchar"
248
>gchar</a> *module_path);</pre>
220
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>
250
Does the same as <a href="GimpModuleDB.html#gimp-module-db-load"><code class="function">gimp_module_db_load()</code></a>, plus removes all <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>
221
251
instances whose modules have been deleted from disk.
224
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
225
list and not freed as this is not possible with <span class="type">GTypeModule</span>
254
Note that the <a 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="../gobject/GTypeModule.html"
257
><span class="type">GTypeModule</span></a>
226
258
instances which actually implement types.</p>
248
282
<div class="refsect1" lang="en">
249
<a name="id2584429"></a><h2>Signal Details</h2>
283
<a name="id2588179"></a><h2>Signal Details</h2>
250
284
<div class="refsect2" lang="en">
251
<a name="id2584440"></a><h3>
285
<a name="id2588190"></a><h3>
252
286
<a name="GimpModuleDB-add"></a>The "add" signal</h3>
253
<a class="indexterm" name="id2584449"></a><pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
254
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
255
gpointer user_data) : Run First</pre>
287
<a class="indexterm" name="id2588199"></a><pre class="programlisting">void user_function (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
288
<a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
290
href="../glib/glib-Basic-Types.html#gpointer"
291
>gpointer</a> user_data) : Run First</pre>
281
317
<div class="refsect2" lang="en">
282
<a name="id2617526"></a><h3>
318
<a name="id2600365"></a><h3>
283
319
<a name="GimpModuleDB-module-modified"></a>The "module-modified" signal</h3>
284
<a class="indexterm" name="id2617535"></a><pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
285
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
286
gpointer user_data) : Run First</pre>
320
<a class="indexterm" name="id2600374"></a><pre class="programlisting">void user_function (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
321
<a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
323
href="../glib/glib-Basic-Types.html#gpointer"
324
>gpointer</a> user_data) : Run First</pre>
312
350
<div class="refsect2" lang="en">
313
<a name="id2617616"></a><h3>
351
<a name="id2600456"></a><h3>
314
352
<a name="GimpModuleDB-remove"></a>The "remove" signal</h3>
315
<a class="indexterm" name="id2617624"></a><pre class="programlisting">void user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
316
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
317
gpointer user_data) : Run First</pre>
353
<a class="indexterm" name="id2600463"></a><pre class="programlisting">void user_function (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
354
<a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
356
href="../glib/glib-Basic-Types.html#gpointer"
357
>gpointer</a> user_data) : Run First</pre>