25
25
<th width="100%" align="center">GIMP Module Library Reference Manual</th>
26
26
<td><a accesskey="n" href="GimpModuleDB.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="#id2601293" class="shortcut">Top</a>
30
<a href="#id2592449" class="shortcut">Description</a>
32
<a href="#id2550537" class="shortcut">Object Hierarchy</a>
34
<a href="#id2592403" class="shortcut">Implemented Interfaces</a>
36
<a href="#id2592424" class="shortcut">Signals</a></nobr></td></tr>
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpModule.synopsis" class="shortcut">Top</a>
30
<a href="#GimpModule.description" class="shortcut">Description</a>
32
<a href="#GimpModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
34
<a href="#GimpModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
36
<a href="#GimpModule.signals" class="shortcut">Signals</a></nobr></td></tr>
38
38
<div class="refentry" lang="en">
39
39
<a name="GimpModule"></a><div class="titlepage"></div>
40
40
<div class="refnamediv"><table width="100%"><tr>
43
<a name="id2601293"></a><span class="refentrytitle">GimpModule</span>
45
<p>GimpModule — A <a
46
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
47
><span class="type">GTypeModule</span></a> subclass which implements module loading using <a
48
href="/usr/share/gtk-doc/html/glib/glib-Dynamic-Loading-of-Modules.html#GModule"
49
><span class="type">GModule</span></a>.</p>
42
<h2><span class="refentrytitle"><a name="GimpModule.top_of_page"></a>GimpModule</span></h2>
43
<p>GimpModule — A <span class="type">GTypeModule</span> subclass which implements module loading using <span class="type">GModule</span>.</p>
51
45
<td valign="top" align="right"></td>
52
46
</tr></table></div>
53
47
<div class="refsynopsisdiv">
48
<a name="GimpModule.synopsis"></a><h2>Synopsis</h2>
55
49
<pre class="synopsis">
59
<a class="link" href="GimpModule.html#GimpModule-struct">GimpModule</a>;
60
<a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a>;
61
enum <a class="link" href="GimpModule.html#GimpModuleState">GimpModuleState</a>;
62
const <a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a>* (<a class="link" href="GimpModule.html#GimpModuleQueryFunc">*GimpModuleQueryFunc</a>) (<a
63
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
64
>GTypeModule</a> *module);
66
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
67
>gboolean</a> (<a class="link" href="GimpModule.html#GimpModuleRegisterFunc">*GimpModuleRegisterFunc</a>) (<a
68
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
69
>GTypeModule</a> *module);
70
#define <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS">GIMP_MODULE_ABI_VERSION</a>
71
#define <a class="link" href="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE:CAPS">GIMP_MODULE_PARAM_SERIALIZE</a>
72
<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a>* <a class="link" href="GimpModule.html#gimp-module-new">gimp_module_new</a> (const <a
73
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
76
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
77
>gboolean</a> load_inhibit,
79
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
80
>gboolean</a> verbose);
81
void <a class="link" href="GimpModule.html#gimp-module-modified">gimp_module_modified</a> (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);
83
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
84
>gboolean</a> <a class="link" href="GimpModule.html#gimp-module-query-module">gimp_module_query_module</a> (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);
85
void <a class="link" href="GimpModule.html#gimp-module-set-load-inhibit">gimp_module_set_load_inhibit</a> (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module,
87
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
88
>gboolean</a> load_inhibit);
90
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
91
>gchar</a>* <a class="link" href="GimpModule.html#gimp-module-state-name">gimp_module_state_name</a> (<a class="link" href="GimpModule.html#GimpModuleState">GimpModuleState</a> state);
93
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
94
>GType</a> <a class="link" href="GimpModule.html#gimp-module-register-enum">gimp_module_register_enum</a> (<a
95
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
96
>GTypeModule</a> *module,
98
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
101
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
102
>GEnumValue</a> *const_static_values);
103
<a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a>* <a class="link" href="GimpModule.html#gimp-module-info-new">gimp_module_info_new</a> (<a
104
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
105
>guint32</a> abi_version,
107
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
110
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
113
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
116
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
117
>gchar</a> *copyright,
119
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
121
<a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a>* <a class="link" href="GimpModule.html#gimp-module-info-copy">gimp_module_info_copy</a> (const <a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a> *info);
122
void <a class="link" href="GimpModule.html#gimp-module-info-free">gimp_module_info_free</a> (<a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a> *info);
50
<a class="link" href="GimpModule.html#GimpModule-struct" title="GimpModule">GimpModule</a>;
51
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>;
52
enum <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a>;
53
const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>* (<a class="link" href="GimpModule.html#GimpModuleQueryFunc" title="GimpModuleQueryFunc ()">*GimpModuleQueryFunc</a>) (GTypeModule *module);
54
gboolean (<a class="link" href="GimpModule.html#GimpModuleRegisterFunc" title="GimpModuleRegisterFunc ()">*GimpModuleRegisterFunc</a>) (GTypeModule *module);
55
#define <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS" title="GIMP_MODULE_ABI_VERSION">GIMP_MODULE_ABI_VERSION</a>
56
#define <a class="link" href="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE:CAPS" title="GIMP_MODULE_PARAM_SERIALIZE">GIMP_MODULE_PARAM_SERIALIZE</a>
57
<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 gchar *filename,
58
gboolean load_inhibit,
60
void <a class="link" href="GimpModule.html#gimp-module-modified" title="gimp_module_modified ()">gimp_module_modified</a> (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);
61
gboolean <a class="link" href="GimpModule.html#gimp-module-query-module" title="gimp_module_query_module ()">gimp_module_query_module</a> (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);
62
void <a class="link" href="GimpModule.html#gimp-module-set-load-inhibit" title="gimp_module_set_load_inhibit ()">gimp_module_set_load_inhibit</a> (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module,
63
gboolean load_inhibit);
64
const gchar* <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);
65
GType <a class="link" href="GimpModule.html#gimp-module-register-enum" title="gimp_module_register_enum ()">gimp_module_register_enum</a> (GTypeModule *module,
67
const GEnumValue *const_static_values);
68
<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,
72
const gchar *copyright,
74
<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);
75
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);
126
78
<div class="refsect1" lang="en">
127
<a name="id2550537"></a><h2>Object Hierarchy</h2>
79
<a name="GimpModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
128
80
<pre class="synopsis">
131
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
134
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
139
86
<div class="refsect1" lang="en">
140
<a name="id2592403"></a><h2>Implemented Interfaces</h2>
87
<a name="GimpModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
142
89
GimpModule implements
144
href="/usr/share/gtk-doc/html/gobject/GTypePlugin.html"
145
>GTypePlugin</a>.</p>
147
92
<div class="refsect1" lang="en">
148
<a name="id2592424"></a><h2>Signals</h2>
93
<a name="GimpModule.signals"></a><h2>Signals</h2>
149
94
<pre class="synopsis">
151
"<a class="link" href="GimpModule.html#GimpModule-modified">modified</a>" : Run First
95
"<a class="link" href="GimpModule.html#GimpModule-modified" title='The "modified" signal'>modified</a>" : Run First
154
98
<div class="refsect1" lang="en">
155
<a name="id2592449"></a><h2>Description</h2>
99
<a name="GimpModule.description"></a><h2>Description</h2>
158
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
159
><span class="type">GTypeModule</span></a> subclass which implements module loading using <a
160
href="/usr/share/gtk-doc/html/glib/glib-Dynamic-Loading-of-Modules.html#GModule"
161
><span class="type">GModule</span></a>.
101
A <span class="type">GTypeModule</span> subclass which implements module loading using <span class="type">GModule</span>.
164
104
<div class="refsect1" lang="en">
165
<a name="id2592479"></a><h2>Details</h2>
105
<a name="GimpModule.details"></a><h2>Details</h2>
166
106
<div class="refsect2" lang="en">
167
<a name="id2592490"></a><h3>
168
<a name="GimpModule-struct"></a>GimpModule</h3>
169
<a class="indexterm" name="id2592503"></a><pre class="programlisting">typedef struct {
107
<a name="GimpModule-struct"></a><h3>GimpModule</h3>
108
<pre class="programlisting">typedef struct {
170
109
gchar *filename; /* path to the module */
171
110
gboolean verbose; /* verbose error reporting */
172
111
GimpModuleState state; /* what's happened to the module */
212
144
<col align="left" valign="top">
215
<td><p><span class="term"><a
216
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
217
>guint32</a> <em class="structfield"><code>abi_version</code></em>;</span></p></td>
218
<td>The <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS"><span class="type">GIMP_MODULE_ABI_VERSION</span></a> the module was compiled against.
147
<td><p><span class="term">guint32 <em class="structfield"><code>abi_version</code></em>;</span></p></td>
148
<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.
222
<td><p><span class="term"><a
223
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
224
>gchar</a> *<em class="structfield"><code>purpose</code></em>;</span></p></td>
152
<td><p><span class="term">gchar *<em class="structfield"><code>purpose</code></em>;</span></p></td>
225
153
<td> The module's general purpose.
229
<td><p><span class="term"><a
230
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
231
>gchar</a> *<em class="structfield"><code>author</code></em>;</span></p></td>
157
<td><p><span class="term">gchar *<em class="structfield"><code>author</code></em>;</span></p></td>
232
158
<td> The module's author.
236
<td><p><span class="term"><a
237
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
238
>gchar</a> *<em class="structfield"><code>version</code></em>;</span></p></td>
162
<td><p><span class="term">gchar *<em class="structfield"><code>version</code></em>;</span></p></td>
239
163
<td> The module's version.
243
<td><p><span class="term"><a
244
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
245
>gchar</a> *<em class="structfield"><code>copyright</code></em>;</span></p></td>
167
<td><p><span class="term">gchar *<em class="structfield"><code>copyright</code></em>;</span></p></td>
246
168
<td> The module's copyright.
250
<td><p><span class="term"><a
251
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
252
>gchar</a> *<em class="structfield"><code>date</code></em>;</span></p></td>
172
<td><p><span class="term">gchar *<em class="structfield"><code>date</code></em>;</span></p></td>
253
173
<td> The module's release date.
660
512
<col align="left" valign="top">
663
<td><p><span class="term"><em class="parameter"><code>abi_version</code></em> :</span></p></td>
664
<td> The <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS"><span class="type">GIMP_MODULE_ABI_VERSION</span></a> the module was compiled against.
515
<td><p><span class="term"><em class="parameter"><code>abi_version</code></em> :</span></p></td>
516
<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.
668
<td><p><span class="term"><em class="parameter"><code>purpose</code></em> :</span></p></td>
520
<td><p><span class="term"><em class="parameter"><code>purpose</code></em> :</span></p></td>
669
521
<td> The module's general purpose.
673
<td><p><span class="term"><em class="parameter"><code>author</code></em> :</span></p></td>
525
<td><p><span class="term"><em class="parameter"><code>author</code></em> :</span></p></td>
674
526
<td> The module's author.
678
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
530
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
679
531
<td> The module's version.
683
<td><p><span class="term"><em class="parameter"><code>copyright</code></em> :</span></p></td>
535
<td><p><span class="term"><em class="parameter"><code>copyright</code></em> :</span></p></td>
684
536
<td> The module's copyright.
688
<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
540
<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
689
541
<td> The module's release date.
693
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
694
<td> The new <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.
545
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
546
<td> The new <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.
727
578
<div class="refsect2" lang="en">
728
<a name="id2617588"></a><h3>
729
<a name="gimp-module-info-free"></a>gimp_module_info_free ()</h3>
730
<a class="indexterm" name="id2617598"></a><pre class="programlisting">void gimp_module_info_free (<a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a> *info);</pre>
579
<a name="gimp-module-info-free"></a><h3>gimp_module_info_free ()</h3>
580
<pre class="programlisting">void gimp_module_info_free (<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a> *info);</pre>
732
Frees the passed <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a>.</p>
582
Frees the passed <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a>.</p>
736
586
<div class="variablelist"><table border="0">
737
587
<col align="left" valign="top">
739
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
740
<td> The <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to free
589
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
590
<td> The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to free
746
596
<div class="refsect1" lang="en">
747
<a name="id2617656"></a><h2>Signal Details</h2>
597
<a name="GimpModule.signal-details"></a><h2>Signal Details</h2>
748
598
<div class="refsect2" lang="en">
749
<a name="id2617665"></a><h3>
750
<a name="GimpModule-modified"></a>The <code class="literal">"modified"</code> signal</h3>
751
<a class="indexterm" name="id2617677"></a><pre class="programlisting">void user_function (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *gimpmodule,
753
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
754
>gpointer</a> user_data) : Run First</pre>
599
<a name="GimpModule-modified"></a><h3>The <code class="literal">"modified"</code> signal</h3>
600
<pre class="programlisting">void user_function (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *gimpmodule,
601
gpointer user_data) : Run First</pre>