← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpmodule/html/GimpModule.html

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpmodule/html/GimpModule.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpModule</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIMP Module Library Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GIMP Module Library Reference Manual">
8
8
<link rel="up" href="libgimpmodule.html" title="Part I. GIMP Module Library">
9
9
<link rel="prev" href="libgimpmodule.html" title="Part I. GIMP Module Library">
10
10
<link rel="next" href="GimpModuleDB.html" title="GimpModuleDB">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpmodule.html" title="Part I. GIMP Module Library">
14
14
<link rel="index" href="libgimpmodule-index.html" title="Index">
26
26
<th width="100%" align="center">GIMP Module Library Reference Manual</th>
27
27
<td><a accesskey="n" href="GimpModuleDB.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
28
28
</tr>
29
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpModule.synopsis" class="shortcut">Top</a>
30
 
                   | 
31
 
                  <a href="#GimpModule.description" class="shortcut">Description</a>
32
 
                   | 
33
 
                  <a href="#GimpModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
34
 
                   | 
35
 
                  <a href="#GimpModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
36
 
                   | 
37
 
                  <a href="#GimpModule.signals" class="shortcut">Signals</a></nobr></td></tr>
 
29
<tr><td colspan="5" class="shortcuts">
 
30
<a href="#GimpModule.synopsis" class="shortcut">Top</a>
 
31
                 | 
 
32
                <a href="#GimpModule.description" class="shortcut">Description</a>
 
33
                 | 
 
34
                <a href="#GimpModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
35
                 | 
 
36
                <a href="#GimpModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
37
                 | 
 
38
                <a href="#GimpModule.signals" class="shortcut">Signals</a>
 
39
</td></tr>
38
40
</table>
39
 
<div class="refentry" lang="en">
 
41
<div class="refentry" title="GimpModule">
40
42
<a name="GimpModule"></a><div class="titlepage"></div>
41
43
<div class="refnamediv"><table width="100%"><tr>
42
44
<td valign="top">
43
45
<h2><span class="refentrytitle"><a name="GimpModule.top_of_page"></a>GimpModule</span></h2>
44
46
<p>GimpModule — A <a
45
47
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
46
 
><span class="type">GTypeModule</span></a> subclass which implements module loading using <span class="type">GModule</span>.</p>
 
48
><span class="type">GTypeModule</span></a> subclass which implements module loading using <a
 
49
href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"
 
50
><span class="type">GModule</span></a>.</p>
47
51
</td>
48
52
<td valign="top" align="right"></td>
49
53
</tr></table></div>
50
 
<div class="refsynopsisdiv">
 
54
<div class="refsynopsisdiv" title="Synopsis">
51
55
<a name="GimpModule.synopsis"></a><h2>Synopsis</h2>
52
56
<pre class="synopsis">
53
57
                    <a class="link" href="GimpModule.html#GimpModule-struct" title="GimpModule">GimpModule</a>;
54
58
                    <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>;
55
59
enum                <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a>;
56
 
const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>* (<a class="link" href="GimpModule.html#GimpModuleQueryFunc" title="GimpModuleQueryFunc ()">*GimpModuleQueryFunc</a>)            (<a
 
60
const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> * (<a class="link" href="GimpModule.html#GimpModuleQueryFunc" title="GimpModuleQueryFunc ()">*GimpModuleQueryFunc</a>)           (<a
57
61
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
58
62
>GTypeModule</a> *module);
59
63
<a
61
65
>gboolean</a>            (<a class="link" href="GimpModule.html#GimpModuleRegisterFunc" title="GimpModuleRegisterFunc ()">*GimpModuleRegisterFunc</a>)           (<a
62
66
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
63
67
>GTypeModule</a> *module);
64
 
#define             <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS" title="GIMP_MODULE_ABI_VERSION">GIMP_MODULE_ABI_VERSION</a>
65
 
#define             <a class="link" href="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE:CAPS" title="GIMP_MODULE_PARAM_SERIALIZE">GIMP_MODULE_PARAM_SERIALIZE</a>
66
 
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a>*         <a class="link" href="GimpModule.html#gimp-module-new" title="gimp_module_new ()">gimp_module_new</a>                     (const <a
 
68
#define             <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION--CAPS" title="GIMP_MODULE_ABI_VERSION">GIMP_MODULE_ABI_VERSION</a>
 
69
#define             <a class="link" href="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE--CAPS" title="GIMP_MODULE_PARAM_SERIALIZE">GIMP_MODULE_PARAM_SERIALIZE</a>
 
70
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *        <a class="link" href="GimpModule.html#gimp-module-new" title="gimp_module_new ()">gimp_module_new</a>                     (const <a
67
71
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
68
72
>gchar</a> *filename,
69
73
                                                         <a
82
86
>gboolean</a> load_inhibit);
83
87
const <a
84
88
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
85
 
>gchar</a>*        <a class="link" href="GimpModule.html#gimp-module-state-name" title="gimp_module_state_name ()">gimp_module_state_name</a>              (<a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a> state);
 
89
>gchar</a> *       <a class="link" href="GimpModule.html#gimp-module-state-name" title="gimp_module_state_name ()">gimp_module_state_name</a>              (<a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a> state);
86
90
<a
87
91
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
88
92
>GType</a>               <a class="link" href="GimpModule.html#gimp-module-register-enum" title="gimp_module_register_enum ()">gimp_module_register_enum</a>           (<a
94
98
                                                         const <a
95
99
href="http://library.gnome.org/devel/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
96
100
>GEnumValue</a> *const_static_values);
97
 
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>*     <a class="link" href="GimpModule.html#gimp-module-info-new" title="gimp_module_info_new ()">gimp_module_info_new</a>                (guint32 abi_version,
 
101
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *    <a class="link" href="GimpModule.html#gimp-module-info-new" title="gimp_module_info_new ()">gimp_module_info_new</a>                (<a
 
102
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
 
103
>guint32</a> abi_version,
98
104
                                                         const <a
99
105
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
100
106
>gchar</a> *purpose,
110
116
                                                         const <a
111
117
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
112
118
>gchar</a> *date);
113
 
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>*     <a class="link" href="GimpModule.html#gimp-module-info-copy" title="gimp_module_info_copy ()">gimp_module_info_copy</a>               (const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *info);
 
119
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *    <a class="link" href="GimpModule.html#gimp-module-info-copy" title="gimp_module_info_copy ()">gimp_module_info_copy</a>               (const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *info);
114
120
void                <a class="link" href="GimpModule.html#gimp-module-info-free" title="gimp_module_info_free ()">gimp_module_info_free</a>               (<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *info);
115
121
</pre>
116
122
</div>
117
 
<div class="refsect1" lang="en">
 
123
<div class="refsect1" title="Object Hierarchy">
118
124
<a name="GimpModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
119
125
<pre class="synopsis">
120
126
  <a
126
132
         +----GimpModule
127
133
</pre>
128
134
</div>
129
 
<div class="refsect1" lang="en">
 
135
<div class="refsect1" title="Implemented Interfaces">
130
136
<a name="GimpModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
131
137
<p>
132
138
GimpModule implements
134
140
href="http://library.gnome.org/devel/gobject/unstable/GTypePlugin.html"
135
141
>GTypePlugin</a>.</p>
136
142
</div>
137
 
<div class="refsect1" lang="en">
 
143
<div class="refsect1" title="Signals">
138
144
<a name="GimpModule.signals"></a><h2>Signals</h2>
139
145
<pre class="synopsis">
140
146
  "<a class="link" href="GimpModule.html#GimpModule-modified" title='The "modified" signal'>modified</a>"                                       : Run First
141
147
</pre>
142
148
</div>
143
 
<div class="refsect1" lang="en">
 
149
<div class="refsect1" title="Description">
144
150
<a name="GimpModule.description"></a><h2>Description</h2>
145
151
<p>
146
152
A <a
147
153
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
148
 
><span class="type">GTypeModule</span></a> subclass which implements module loading using <span class="type">GModule</span>.
 
154
><span class="type">GTypeModule</span></a> subclass which implements module loading using <a
 
155
href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"
 
156
><span class="type">GModule</span></a>.
149
157
</p>
150
158
</div>
151
 
<div class="refsect1" lang="en">
 
159
<div class="refsect1" title="Details">
152
160
<a name="GimpModule.details"></a><h2>Details</h2>
153
 
<div class="refsect2" lang="en">
 
161
<div class="refsect2" title="GimpModule">
154
162
<a name="GimpModule-struct"></a><h3>GimpModule</h3>
155
163
<pre class="programlisting">typedef struct {
156
164
  gchar           *filename;     /* path to the module                       */
169
177
GIMP.  It is a <a
170
178
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
171
179
><span class="type">GTypeModule</span></a> subclass, implementing module loading
172
 
using <span class="type">GModule</span>.  <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> does not know which functionality is
 
180
using <a
 
181
href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"
 
182
><span class="type">GModule</span></a>.  <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> does not know which functionality is
173
183
implemented by the modules, it just provides a framework to get
174
184
arbitrary <a
175
185
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
177
187
</p>
178
188
</div>
179
189
<hr>
180
 
<div class="refsect2" lang="en">
 
190
<div class="refsect2" title="GimpModuleInfo">
181
191
<a name="GimpModuleInfo"></a><h3>GimpModuleInfo</h3>
182
192
<pre class="programlisting">typedef struct {
183
193
  guint32  abi_version;
195
205
<col align="left" valign="top">
196
206
<tbody>
197
207
<tr>
198
 
<td><p><span class="term">guint32 <em class="structfield"><code>abi_version</code></em>;</span></p></td>
199
 
<td>The <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS" title="GIMP_MODULE_ABI_VERSION"><span class="type">GIMP_MODULE_ABI_VERSION</span></a> the module was compiled against.
 
208
<td><p><span class="term"><a
 
209
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
 
210
>guint32</a> <em class="structfield"><code>abi_version</code></em>;</span></p></td>
 
211
<td>The <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION--CAPS" title="GIMP_MODULE_ABI_VERSION"><span class="type">GIMP_MODULE_ABI_VERSION</span></a> the module was compiled against.
200
212
</td>
201
213
</tr>
202
214
<tr>
232
244
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
233
245
>gchar</a> *<em class="structfield"><code>date</code></em>;</span></p></td>
234
246
<td>       The module's release date.
235
 
 
236
247
</td>
237
248
</tr>
238
249
</tbody>
239
250
</table></div>
240
251
</div>
241
252
<hr>
242
 
<div class="refsect2" lang="en">
 
253
<div class="refsect2" title="enum GimpModuleState">
243
254
<a name="GimpModuleState"></a><h3>enum GimpModuleState</h3>
244
255
<pre class="programlisting">typedef enum
245
256
{
263
274
<col align="left" valign="top">
264
275
<tbody>
265
276
<tr>
266
 
<td><p><a name="GIMP-MODULE-STATE-ERROR:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_ERROR</code></span></p></td>
 
277
<td><p><a name="GIMP-MODULE-STATE-ERROR--CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_ERROR</code></span></p></td>
267
278
<td>      Missing <code class="function">gimp_module_register()</code> function
268
279
                                or other error.
269
280
</td>
270
281
</tr>
271
282
<tr>
272
 
<td><p><a name="GIMP-MODULE-STATE-LOADED:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_LOADED</code></span></p></td>
 
283
<td><p><a name="GIMP-MODULE-STATE-LOADED--CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_LOADED</code></span></p></td>
273
284
<td>     An instance of a type implemented by
274
285
                                this module is allocated.
275
286
</td>
276
287
</tr>
277
288
<tr>
278
 
<td><p><a name="GIMP-MODULE-STATE-LOAD-FAILED:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_LOAD_FAILED</code></span></p></td>
 
289
<td><p><a name="GIMP-MODULE-STATE-LOAD-FAILED--CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_LOAD_FAILED</code></span></p></td>
279
290
<td>
280
291
<code class="function">gimp_module_register()</code> returned <a
281
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
292
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
282
293
><span class="type">FALSE</span></a>.
283
294
</td>
284
295
</tr>
285
296
<tr>
286
 
<td><p><a name="GIMP-MODULE-STATE-NOT-LOADED:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_NOT_LOADED</code></span></p></td>
 
297
<td><p><a name="GIMP-MODULE-STATE-NOT-LOADED--CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_NOT_LOADED</code></span></p></td>
287
298
<td> There are no instances allocated of
288
299
                                types implemented by this module.
289
 
 
290
300
</td>
291
301
</tr>
292
302
</tbody>
293
303
</table></div>
294
304
</div>
295
305
<hr>
296
 
<div class="refsect2" lang="en">
 
306
<div class="refsect2" title="GimpModuleQueryFunc ()">
297
307
<a name="GimpModuleQueryFunc"></a><h3>GimpModuleQueryFunc ()</h3>
298
 
<pre class="programlisting">const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>* (*GimpModuleQueryFunc)            (<a
 
308
<pre class="programlisting">const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> * (*GimpModuleQueryFunc)           (<a
299
309
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"
300
310
>GTypeModule</a> *module);</pre>
301
311
<p>
319
329
<tr>
320
330
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
321
331
<td>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct describing the module.
322
 
 
323
 
 
324
332
</td>
325
333
</tr>
326
334
</tbody>
327
335
</table></div>
328
336
</div>
329
337
<hr>
330
 
<div class="refsect2" lang="en">
 
338
<div class="refsect2" title="GimpModuleRegisterFunc ()">
331
339
<a name="GimpModuleRegisterFunc"></a><h3>GimpModuleRegisterFunc ()</h3>
332
340
<pre class="programlisting"><a
333
341
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
353
361
</tr>
354
362
<tr>
355
363
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
356
 
<td>
357
 
<a
358
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
359
 
><span class="type">TRUE</span></a> on success, <a
360
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
364
<td>#TRUE on success, <a
 
365
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
361
366
><span class="type">FALSE</span></a> otherwise.
362
 
 
363
 
 
364
367
</td>
365
368
</tr>
366
369
</tbody>
367
370
</table></div>
368
371
</div>
369
372
<hr>
370
 
<div class="refsect2" lang="en">
371
 
<a name="GIMP-MODULE-ABI-VERSION:CAPS"></a><h3>GIMP_MODULE_ABI_VERSION</h3>
 
373
<div class="refsect2" title="GIMP_MODULE_ABI_VERSION">
 
374
<a name="GIMP-MODULE-ABI-VERSION--CAPS"></a><h3>GIMP_MODULE_ABI_VERSION</h3>
372
375
<pre class="programlisting">#define GIMP_MODULE_ABI_VERSION 0x0004
373
376
</pre>
374
377
<p>
379
382
</p>
380
383
</div>
381
384
<hr>
382
 
<div class="refsect2" lang="en">
383
 
<a name="GIMP-MODULE-PARAM-SERIALIZE:CAPS"></a><h3>GIMP_MODULE_PARAM_SERIALIZE</h3>
 
385
<div class="refsect2" title="GIMP_MODULE_PARAM_SERIALIZE">
 
386
<a name="GIMP-MODULE-PARAM-SERIALIZE--CAPS"></a><h3>GIMP_MODULE_PARAM_SERIALIZE</h3>
384
387
<pre class="programlisting">#define GIMP_MODULE_PARAM_SERIALIZE (1 &lt;&lt; (0 + G_PARAM_USER_SHIFT))
385
388
</pre>
386
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
389
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
387
390
<h3 class="title">Warning</h3>
388
391
<p><code class="literal">GIMP_MODULE_PARAM_SERIALIZE</code> is deprecated and should not be used in newly-written code.</p>
389
392
</div>
390
393
<p>
391
 
 
392
394
</p>
393
395
</div>
394
396
<hr>
395
 
<div class="refsect2" lang="en">
 
397
<div class="refsect2" title="gimp_module_new ()">
396
398
<a name="gimp-module-new"></a><h3>gimp_module_new ()</h3>
397
 
<pre class="programlisting"><a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a>*         gimp_module_new                     (const <a
 
399
<pre class="programlisting"><a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *        gimp_module_new                     (const <a
398
400
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
399
401
>gchar</a> *filename,
400
402
                                                         <a
406
408
<p>
407
409
Creates a new <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instance.</p>
408
410
<p>
409
 
 
410
411
</p>
411
412
<div class="variablelist"><table border="0">
412
413
<col align="left" valign="top">
419
420
<tr>
420
421
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></p></td>
421
422
<td> Pass <a
422
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
423
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
423
424
><code class="literal">TRUE</code></a> to exclude this module from auto-loading.
424
425
</td>
425
426
</tr>
426
427
<tr>
427
428
<td><p><span class="term"><em class="parameter"><code>verbose</code></em> :</span></p></td>
428
429
<td>      Pass <a
429
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
430
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
430
431
><code class="literal">TRUE</code></a> to enable debugging output.
431
432
</td>
432
433
</tr>
439
440
</table></div>
440
441
</div>
441
442
<hr>
442
 
<div class="refsect2" lang="en">
 
443
<div class="refsect2" title="gimp_module_modified ()">
443
444
<a name="gimp-module-modified"></a><h3>gimp_module_modified ()</h3>
444
445
<pre class="programlisting">void                gimp_module_modified                (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);</pre>
445
446
<p>
446
447
Emits the "modified" signal. Call it whenever you have modified the module
447
448
manually (which you shouldn't do).</p>
448
449
<p>
449
 
 
450
450
</p>
451
451
<div class="variablelist"><table border="0">
452
452
<col align="left" valign="top">
458
458
</table></div>
459
459
</div>
460
460
<hr>
461
 
<div class="refsect2" lang="en">
 
461
<div class="refsect2" title="gimp_module_query_module ()">
462
462
<a name="gimp-module-query-module"></a><h3>gimp_module_query_module ()</h3>
463
463
<pre class="programlisting"><a
464
464
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
468
468
may implement. After successful query, the <em class="parameter"><code>info</code></em> field of the
469
469
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> struct will be available for further inspection.</p>
470
470
<p>
471
 
 
472
471
</p>
473
472
<div class="variablelist"><table border="0">
474
473
<col align="left" valign="top">
481
480
<tr>
482
481
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
483
482
<td> <a
484
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
483
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
485
484
><code class="literal">TRUE</code></a> on success.
486
485
</td>
487
486
</tr>
489
488
</table></div>
490
489
</div>
491
490
<hr>
492
 
<div class="refsect2" lang="en">
 
491
<div class="refsect2" title="gimp_module_set_load_inhibit ()">
493
492
<a name="gimp-module-set-load-inhibit"></a><h3>gimp_module_set_load_inhibit ()</h3>
494
493
<pre class="programlisting">void                gimp_module_set_load_inhibit        (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module,
495
494
                                                         <a
498
497
<p>
499
498
Sets the <em class="parameter"><code>load_inhibit</code></em> property if the module. Emits "modified".</p>
500
499
<p>
501
 
 
502
500
</p>
503
501
<div class="variablelist"><table border="0">
504
502
<col align="left" valign="top">
511
509
<tr>
512
510
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></p></td>
513
511
<td> Pass <a
514
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
512
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
515
513
><code class="literal">TRUE</code></a> to exclude this module from auto-loading.
516
514
</td>
517
515
</tr>
519
517
</table></div>
520
518
</div>
521
519
<hr>
522
 
<div class="refsect2" lang="en">
 
520
<div class="refsect2" title="gimp_module_state_name ()">
523
521
<a name="gimp-module-state-name"></a><h3>gimp_module_state_name ()</h3>
524
522
<pre class="programlisting">const <a
525
523
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
526
 
>gchar</a>*        gimp_module_state_name              (<a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a> state);</pre>
 
524
>gchar</a> *       gimp_module_state_name              (<a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a> state);</pre>
527
525
<p>
528
526
Returns the translated textual representation of a <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a>.
529
527
The returned string must not be freed.</p>
530
528
<p>
531
 
 
532
529
</p>
533
530
<div class="variablelist"><table border="0">
534
531
<col align="left" valign="top">
547
544
</table></div>
548
545
</div>
549
546
<hr>
550
 
<div class="refsect2" lang="en">
 
547
<div class="refsect2" title="gimp_module_register_enum ()">
551
548
<a name="gimp-module-register-enum"></a><h3>gimp_module_register_enum ()</h3>
552
549
<pre class="programlisting"><a
553
550
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
560
557
                                                         const <a
561
558
href="http://library.gnome.org/devel/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
562
559
>GEnumValue</a> *const_static_values);</pre>
563
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
560
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
564
561
<h3 class="title">Warning</h3>
565
562
<p><code class="literal">gimp_module_register_enum</code> is deprecated and should not be used in newly-written code.</p>
566
563
</div>
569
566
href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html#g-type-module-register-enum"
570
567
><code class="function">g_type_module_register_enum()</code></a> instead.</p>
571
568
<p>
572
 
 
573
569
</p>
574
570
<div class="variablelist"><table border="0">
575
571
<col align="left" valign="top">
600
596
</table></div>
601
597
</div>
602
598
<hr>
603
 
<div class="refsect2" lang="en">
 
599
<div class="refsect2" title="gimp_module_info_new ()">
604
600
<a name="gimp-module-info-new"></a><h3>gimp_module_info_new ()</h3>
605
 
<pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>*     gimp_module_info_new                (guint32 abi_version,
 
601
<pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *    gimp_module_info_new                (<a
 
602
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
 
603
>guint32</a> abi_version,
606
604
                                                         const <a
607
605
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
608
606
>gchar</a> *purpose,
621
619
<p>
622
620
Creates a newly allocated <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p>
623
621
<p>
624
 
 
625
622
</p>
626
623
<div class="variablelist"><table border="0">
627
624
<col align="left" valign="top">
628
625
<tbody>
629
626
<tr>
630
627
<td><p><span class="term"><em class="parameter"><code>abi_version</code></em> :</span></p></td>
631
 
<td> The <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS" title="GIMP_MODULE_ABI_VERSION"><span class="type">GIMP_MODULE_ABI_VERSION</span></a> the module was compiled against.
 
628
<td> The <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION--CAPS" title="GIMP_MODULE_ABI_VERSION"><span class="type">GIMP_MODULE_ABI_VERSION</span></a> the module was compiled against.
632
629
</td>
633
630
</tr>
634
631
<tr>
665
662
</table></div>
666
663
</div>
667
664
<hr>
668
 
<div class="refsect2" lang="en">
 
665
<div class="refsect2" title="gimp_module_info_copy ()">
669
666
<a name="gimp-module-info-copy"></a><h3>gimp_module_info_copy ()</h3>
670
 
<pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>*     gimp_module_info_copy               (const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *info);</pre>
 
667
<pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *    gimp_module_info_copy               (const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *info);</pre>
671
668
<p>
672
669
Copies a <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p>
673
670
<p>
674
 
 
675
671
</p>
676
672
<div class="variablelist"><table border="0">
677
673
<col align="left" valign="top">
690
686
</table></div>
691
687
</div>
692
688
<hr>
693
 
<div class="refsect2" lang="en">
 
689
<div class="refsect2" title="gimp_module_info_free ()">
694
690
<a name="gimp-module-info-free"></a><h3>gimp_module_info_free ()</h3>
695
691
<pre class="programlisting">void                gimp_module_info_free               (<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *info);</pre>
696
692
<p>
697
693
Frees the passed <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a>.</p>
698
694
<p>
699
 
 
700
695
</p>
701
696
<div class="variablelist"><table border="0">
702
697
<col align="left" valign="top">
708
703
</table></div>
709
704
</div>
710
705
</div>
711
 
<div class="refsect1" lang="en">
 
706
<div class="refsect1" title="Signal Details">
712
707
<a name="GimpModule.signal-details"></a><h2>Signal Details</h2>
713
 
<div class="refsect2" lang="en">
 
708
<div class="refsect2" title='The "modified" signal'>
714
709
<a name="GimpModule-modified"></a><h3>The <code class="literal">"modified"</code> signal</h3>
715
710
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *gimpmodule,
716
711
                                                        <a
717
712
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
718
713
>gpointer</a>    user_data)       : Run First</pre>
719
714
<p>
720
 
 
721
715
</p>
722
716
<div class="variablelist"><table border="0">
723
717
<col align="left" valign="top">
725
719
<tr>
726
720
<td><p><span class="term"><em class="parameter"><code>gimpmodule</code></em> :</span></p></td>
727
721
<td>the object which received the signal.
728
 
 
729
722
</td>
730
723
</tr>
731
724
<tr>
736
729
</table></div>
737
730
</div>
738
731
</div>
739
 
<div class="refsect1" lang="en">
 
732
<div class="refsect1" title="See Also">
740
733
<a name="GimpModule.see-also"></a><h2>See Also</h2>
741
734
<p>
742
 
<span class="type">GModule</span>
 
735
<a
 
736
href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"
 
737
><span class="type">GModule</span></a>
743
738
</p>
744
739
<p>
745
740
<a
750
745
</div>
751
746
<div class="footer">
752
747
<hr>
753
 
          Generated by GTK-Doc V1.10</div>
 
748
          Generated by GTK-Doc V1.11</div>
754
749
</body>
755
750
</html>