blob: 6098f84fa6fdc1910c3614c188aa111ff99ba89e (
plain)
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
333
334
335
336
337
338
339
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpModuleDB: GIMP Module Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Module Library Reference Manual">
<link rel="up" href="pt01.html" title="Part I. GIMP Module Library">
<link rel="prev" href="GimpModule.html" title="GimpModule">
<link rel="next" href="api-index-full.html" title="Index">
<meta name="generator" content="GTK-Doc V1.33.1 (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="#GimpModuleDB.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GimpModuleDB.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GimpModuleDB.signals" class="shortcut">Signals</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="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpModule.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpModuleDB"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpModuleDB.top_of_page"></a>GimpModuleDB</span></h2>
<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>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpModuleDB.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="returnvalue">GimpModuleDB</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpModuleDB.html#gimp-module-db-new" title="gimp_module_db_new ()">gimp_module_db_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpModuleDB.html#gimp-module-db-load" title="gimp_module_db_load ()">gimp_module_db_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpModuleDB.html#gimp-module-db-refresh" title="gimp_module_db_refresh ()">gimp_module_db_refresh</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpModuleDB.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-add" title="The “add” signal">add</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-module-modified" title="The “module-modified” signal">module-modified</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-remove" title="The “remove” signal">remove</a></td>
<td class="signal_flags">Run First</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpModuleDB.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-struct" title="GimpModuleDB">GimpModuleDB</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpModuleDB.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GimpModuleDB
</pre>
</div>
<div class="refsect1">
<a name="GimpModuleDB.description"></a><h2>Description</h2>
<p>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>
</div>
<div class="refsect1">
<a name="GimpModuleDB.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-module-db-new"></a><h3>gimp_module_db_new ()</h3>
<pre class="programlisting"><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="returnvalue">GimpModuleDB</span></a> *
gimp_module_db_new (<em class="parameter"><code><span class="type">gboolean</span> verbose</code></em>);</pre>
<p>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
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>
<div class="refsect3">
<a name="gimp-module-db-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>verbose</p></td>
<td class="parameter_description"><p>Pass <code class="literal">TRUE</code> to enable debugging output.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-module-db-new.returns"></a><h4>Returns</h4>
<p> The new <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> instance.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-module-db-set-load-inhibit"></a><h3>gimp_module_db_set_load_inhibit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_module_db_set_load_inhibit (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *load_inhibit</code></em>);</pre>
<p>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
by <em class="parameter"><code>db</code></em>
(using <a class="link" href="GimpModule.html#gimp-module-set-load-inhibit" title="gimp_module_set_load_inhibit ()"><code class="function">gimp_module_set_load_inhibit()</code></a>).</p>
<div class="refsect3">
<a name="gimp-module-db-set-load-inhibit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>db</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>load_inhibit</p></td>
<td class="parameter_description"><p>A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of module
filenames to exclude from auto-loading.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-module-db-get-load-inhibit"></a><h3>gimp_module_db_get_load_inhibit ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_module_db_get_load_inhibit (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>);</pre>
<p>Return the <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of module filenames
which are excluded from auto-loading.</p>
<div class="refsect3">
<a name="gimp-module-db-get-load-inhibit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>db</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-module-db-get-load-inhibit.returns"></a><h4>Returns</h4>
<p> the <em class="parameter"><code>db</code></em>
's <em class="parameter"><code>load_inhibit</code></em>
string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-module-db-load"></a><h3>gimp_module_db_load ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_module_db_load (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *module_path</code></em>);</pre>
<p>Scans the directories contained in <em class="parameter"><code>module_path</code></em>
and creates a
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instance for every loadable module contained in the
directories.</p>
<div class="refsect3">
<a name="gimp-module-db-load.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>db</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>module_path</p></td>
<td class="parameter_description"><p>A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of directories
to load modules from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-module-db-refresh"></a><h3>gimp_module_db_refresh ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_module_db_refresh (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *module_path</code></em>);</pre>
<p>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>
instances whose modules have been deleted from disk.</p>
<p>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
list and not freed as this is not possible with <span class="type">GTypeModule</span>
instances which actually implement types.</p>
<div class="refsect3">
<a name="gimp-module-db-refresh.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>db</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>module_path</p></td>
<td class="parameter_description"><p>A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of directories
to load modules from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GimpModuleDB.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpModuleDB-struct"></a><h3>GimpModuleDB</h3>
<pre class="programlisting">typedef struct _GimpModuleDB GimpModuleDB;</pre>
</div>
</div>
<div class="refsect1">
<a name="GimpModuleDB.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GimpModuleDB-add"></a><h3>The <code class="literal">“add”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *gimpmoduledb,
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Flags: Run First</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpModuleDB-module-modified"></a><h3>The <code class="literal">“module-modified”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *gimpmoduledb,
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Flags: Run First</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpModuleDB-remove"></a><h3>The <code class="literal">“remove”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *gimpmoduledb,
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Flags: Run First</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
