~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-08-22 11:50:05 UTC
  • mfrom: (0.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20080822115005-yxj5svf3v9x1mkr7
Tags: upstream-2.4.7
Import upstream version 2.4.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
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>GimpModule</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&#160;I.&#160;GIMP Module Library">
9
 
<link rel="prev" href="libgimpmodule.html" title="Part&#160;I.&#160;GIMP Module Library">
 
8
<link rel="up" href="libgimpmodule.html" title="Part I. GIMP Module Library">
 
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.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&#160;I.&#160;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="GimpModuleDB.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
27
</tr>
28
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2601293" class="shortcut">Top</a>
29
 
                  &#160;|&#160;
30
 
                  <a href="#id2592449" class="shortcut">Description</a>
31
 
                  &#160;|&#160;
32
 
                  <a href="#id2550537" class="shortcut">Object Hierarchy</a>
33
 
                  &#160;|&#160;
34
 
                  <a href="#id2592403" class="shortcut">Implemented Interfaces</a>
35
 
                  &#160;|&#160;
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>
 
29
                   | 
 
30
                  <a href="#GimpModule.description" class="shortcut">Description</a>
 
31
                   | 
 
32
                  <a href="#GimpModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
33
                   | 
 
34
                  <a href="#GimpModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
35
                   | 
 
36
                  <a href="#GimpModule.signals" class="shortcut">Signals</a></nobr></td></tr>
37
37
</table>
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>
41
41
<td valign="top">
42
 
<h2>
43
 
<a name="id2601293"></a><span class="refentrytitle">GimpModule</span>
44
 
</h2>
45
 
<p>GimpModule &#8212; 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>
50
44
</td>
51
45
<td valign="top" align="right"></td>
52
46
</tr></table></div>
53
47
<div class="refsynopsisdiv">
54
 
<h2>Synopsis</h2>
 
48
<a name="GimpModule.synopsis"></a><h2>Synopsis</h2>
55
49
<pre class="synopsis">
56
 
 
57
 
 
58
 
 
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);
65
 
<a
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"
74
 
>gchar</a> *filename,
75
 
                                                         <a
76
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
77
 
>gboolean</a> load_inhibit,
78
 
                                                         <a
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);
82
 
<a
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,
86
 
                                                         <a
87
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
88
 
>gboolean</a> load_inhibit);
89
 
const <a
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);
92
 
<a
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,
97
 
                                                         const <a
98
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
99
 
>gchar</a> *name,
100
 
                                                         const <a
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,
106
 
                                                         const <a
107
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
108
 
>gchar</a> *purpose,
109
 
                                                         const <a
110
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
111
 
>gchar</a> *author,
112
 
                                                         const <a
113
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
114
 
>gchar</a> *version,
115
 
                                                         const <a
116
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
117
 
>gchar</a> *copyright,
118
 
                                                         const <a
119
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
120
 
>gchar</a> *date);
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);
123
 
 
 
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,
 
59
                                                         gboolean verbose);
 
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,
 
66
                                                         const gchar *name,
 
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,
 
69
                                                         const gchar *purpose,
 
70
                                                         const gchar *author,
 
71
                                                         const gchar *version,
 
72
                                                         const gchar *copyright,
 
73
                                                         const gchar *date);
 
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);
124
76
</pre>
125
77
</div>
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">
129
 
 
130
 
  <a
131
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
132
 
>GObject</a>
133
 
   +----<a
134
 
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
135
 
>GTypeModule</a>
 
81
  GObject
 
82
   +----GTypeModule
136
83
         +----GimpModule
137
84
</pre>
138
85
</div>
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>
141
88
<p>
142
89
GimpModule implements
143
 
 <a
144
 
href="/usr/share/gtk-doc/html/gobject/GTypePlugin.html"
145
 
>GTypePlugin</a>.</p>
 
90
 GTypePlugin.</p>
146
91
</div>
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">
150
 
 
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
152
96
</pre>
153
97
</div>
154
98
<div class="refsect1" lang="en">
155
 
<a name="id2592449"></a><h2>Description</h2>
 
99
<a name="GimpModule.description"></a><h2>Description</h2>
156
100
<p>
157
 
A <a
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>.
162
102
</p>
163
103
</div>
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            */
180
119
</pre>
181
120
<p>
182
121
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> is a generic mechanism to dynamically load modules into
183
 
GIMP.  It is a <a
184
 
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
185
 
><span class="type">GTypeModule</span></a> subclass, implementing module loading
186
 
using <a
187
 
href="/usr/share/gtk-doc/html/glib/glib-Dynamic-Loading-of-Modules.html#GModule"
188
 
><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
 
122
GIMP.  It is a <span class="type">GTypeModule</span> subclass, implementing module loading
 
123
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
189
124
implemented by the modules, it just provides a framework to get
190
 
arbitrary <a
191
 
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
192
 
><span class="type">GType</span></a> implementations loaded from disk.
 
125
arbitrary <span class="type">GType</span> implementations loaded from disk.
193
126
</p>
194
127
</div>
195
128
<hr>
196
129
<div class="refsect2" lang="en">
197
 
<a name="id2592534"></a><h3>
198
 
<a name="GimpModuleInfo"></a>GimpModuleInfo</h3>
199
 
<a class="indexterm" name="id2592546"></a><pre class="programlisting">typedef struct {
 
130
<a name="GimpModuleInfo"></a><h3>GimpModuleInfo</h3>
 
131
<pre class="programlisting">typedef struct {
200
132
  guint32  abi_version;
201
133
  gchar   *purpose;
202
134
  gchar   *author;
212
144
<col align="left" valign="top">
213
145
<tbody>
214
146
<tr>
215
 
<td><p><span class="term"><a
216
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
217
 
>guint32</a>&#160;<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.
219
149
</td>
220
150
</tr>
221
151
<tr>
222
 
<td><p><span class="term"><a
223
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
224
 
>gchar</a>&#160;*<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.
226
154
</td>
227
155
</tr>
228
156
<tr>
229
 
<td><p><span class="term"><a
230
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
231
 
>gchar</a>&#160;*<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.
233
159
</td>
234
160
</tr>
235
161
<tr>
236
 
<td><p><span class="term"><a
237
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
238
 
>gchar</a>&#160;*<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.
240
164
</td>
241
165
</tr>
242
166
<tr>
243
 
<td><p><span class="term"><a
244
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
245
 
>gchar</a>&#160;*<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.
247
169
</td>
248
170
</tr>
249
171
<tr>
250
 
<td><p><span class="term"><a
251
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
252
 
>gchar</a>&#160;*<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.
254
174
 
255
175
</td>
259
179
</div>
260
180
<hr>
261
181
<div class="refsect2" lang="en">
262
 
<a name="id2532591"></a><h3>
263
 
<a name="GimpModuleState"></a>enum GimpModuleState</h3>
264
 
<a class="indexterm" name="id2532604"></a><pre class="programlisting">typedef enum
 
182
<a name="GimpModuleState"></a><h3>enum GimpModuleState</h3>
 
183
<pre class="programlisting">typedef enum
265
184
{
266
185
  GIMP_MODULE_STATE_ERROR,       /* missing gimp_module_register function
267
186
                                  * or other error
283
202
<col align="left" valign="top">
284
203
<tbody>
285
204
<tr>
286
 
<td><p><span class="term"><a name="GIMP-MODULE-STATE-ERROR:CAPS"></a><code class="literal">GIMP_MODULE_STATE_ERROR</code></span></p></td>
 
205
<td><p><a name="GIMP-MODULE-STATE-ERROR:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_ERROR</code></span></p></td>
287
206
<td>      Missing <code class="function">gimp_module_register()</code> function
288
207
                                or other error.
289
208
</td>
290
209
</tr>
291
210
<tr>
292
 
<td><p><span class="term"><a name="GIMP-MODULE-STATE-LOADED:CAPS"></a><code class="literal">GIMP_MODULE_STATE_LOADED</code></span></p></td>
 
211
<td><p><a name="GIMP-MODULE-STATE-LOADED:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_LOADED</code></span></p></td>
293
212
<td>     An instance of a type implemented by
294
213
                                this module is allocated.
295
214
</td>
296
215
</tr>
297
216
<tr>
298
 
<td><p><span class="term"><a name="GIMP-MODULE-STATE-LOAD-FAILED:CAPS"></a><code class="literal">GIMP_MODULE_STATE_LOAD_FAILED</code></span></p></td>
 
217
<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>
299
218
<td>
300
 
<code class="function">gimp_module_register()</code> returned <a
301
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
302
 
><span class="type">FALSE</span></a>.
 
219
<code class="function">gimp_module_register()</code> returned <span class="type">FALSE</span>.
303
220
</td>
304
221
</tr>
305
222
<tr>
306
 
<td><p><span class="term"><a name="GIMP-MODULE-STATE-NOT-LOADED:CAPS"></a><code class="literal">GIMP_MODULE_STATE_NOT_LOADED</code></span></p></td>
 
223
<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>
307
224
<td> There are no instances allocated of
308
225
                                types implemented by this module.
309
226
 
314
231
</div>
315
232
<hr>
316
233
<div class="refsect2" lang="en">
317
 
<a name="id2532758"></a><h3>
318
 
<a name="GimpModuleQueryFunc"></a>GimpModuleQueryFunc ()</h3>
319
 
<a class="indexterm" name="id2532770"></a><pre class="programlisting">const <a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a>* (*GimpModuleQueryFunc)            (<a
320
 
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
321
 
>GTypeModule</a> *module);</pre>
 
234
<a name="GimpModuleQueryFunc"></a><h3>GimpModuleQueryFunc ()</h3>
 
235
<pre class="programlisting">const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>* (*GimpModuleQueryFunc)            (GTypeModule *module);</pre>
322
236
<p>
323
237
The signature of the query function a loadable GIMP module must
324
238
implement.  In the module, the function must be called
325
239
<code class="function">gimp_module_query()</code>.
326
240
</p>
327
241
<p>
328
 
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> will copy the returned <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct, so the
 
242
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> will copy the returned <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct, so the
329
243
module doesn't need to keep these values around (however in most cases
330
244
the module will just return a pointer to a constant structure).
331
245
</p>
333
247
<col align="left" valign="top">
334
248
<tbody>
335
249
<tr>
336
 
<td><p><span class="term"><em class="parameter"><code>module</code></em>&#160;:</span></p></td>
 
250
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
337
251
<td> The <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> responsible for this loadable module.
338
252
</td>
339
253
</tr>
340
254
<tr>
341
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
342
 
<td>The <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct describing the module.
 
255
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
256
<td>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct describing the module.
343
257
 
344
258
 
345
259
</td>
349
263
</div>
350
264
<hr>
351
265
<div class="refsect2" lang="en">
352
 
<a name="id2616546"></a><h3>
353
 
<a name="GimpModuleRegisterFunc"></a>GimpModuleRegisterFunc ()</h3>
354
 
<a class="indexterm" name="id2616556"></a><pre class="programlisting"><a
355
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
356
 
>gboolean</a>            (*GimpModuleRegisterFunc)           (<a
357
 
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
358
 
>GTypeModule</a> *module);</pre>
 
266
<a name="GimpModuleRegisterFunc"></a><h3>GimpModuleRegisterFunc ()</h3>
 
267
<pre class="programlisting">gboolean            (*GimpModuleRegisterFunc)           (GTypeModule *module);</pre>
359
268
<p>
360
269
The signature of the register function a loadable GIMP module must
361
270
implement.  In the module, the function must be called
369
278
<col align="left" valign="top">
370
279
<tbody>
371
280
<tr>
372
 
<td><p><span class="term"><em class="parameter"><code>module</code></em>&#160;:</span></p></td>
 
281
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
373
282
<td> The <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> responsible for this loadable module.
374
283
</td>
375
284
</tr>
376
285
<tr>
377
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
286
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
378
287
<td>
379
 
<a
380
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
381
 
><span class="type">TRUE</span></a> on success, <a
382
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
383
 
><span class="type">FALSE</span></a> otherwise.
 
288
<span class="type">TRUE</span> on success, <span class="type">FALSE</span> otherwise.
384
289
 
385
290
 
386
291
</td>
390
295
</div>
391
296
<hr>
392
297
<div class="refsect2" lang="en">
393
 
<a name="id2616645"></a><h3>
394
 
<a name="GIMP-MODULE-ABI-VERSION:CAPS"></a>GIMP_MODULE_ABI_VERSION</h3>
395
 
<a class="indexterm" name="id2616657"></a><pre class="programlisting">#define GIMP_MODULE_ABI_VERSION 0x0004
 
298
<a name="GIMP-MODULE-ABI-VERSION:CAPS"></a><h3>GIMP_MODULE_ABI_VERSION</h3>
 
299
<pre class="programlisting">#define GIMP_MODULE_ABI_VERSION 0x0004
396
300
</pre>
397
301
<p>
398
302
The version of the module system's ABI. Modules put this value into
399
 
<a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a>'s <em class="parameter"><code>abi_version</code></em> field so the code loading the modules
 
303
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a>'s <em class="parameter"><code>abi_version</code></em> field so the code loading the modules
400
304
can check if it was compiled against the same module ABI the modules
401
305
are compiled against.
402
306
</p>
403
307
</div>
404
308
<hr>
405
309
<div class="refsect2" lang="en">
406
 
<a name="id2616686"></a><h3>
407
 
<a name="GIMP-MODULE-PARAM-SERIALIZE:CAPS"></a>GIMP_MODULE_PARAM_SERIALIZE</h3>
408
 
<a class="indexterm" name="id2616700"></a><pre class="programlisting">#define GIMP_MODULE_PARAM_SERIALIZE (1 &lt;&lt; (0 + G_PARAM_USER_SHIFT))
 
310
<a name="GIMP-MODULE-PARAM-SERIALIZE:CAPS"></a><h3>GIMP_MODULE_PARAM_SERIALIZE</h3>
 
311
<pre class="programlisting">#define GIMP_MODULE_PARAM_SERIALIZE (1 &lt;&lt; (0 + G_PARAM_USER_SHIFT))
409
312
</pre>
410
313
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
411
314
<h3 class="title">Warning</h3>
417
320
</div>
418
321
<hr>
419
322
<div class="refsect2" lang="en">
420
 
<a name="id2616727"></a><h3>
421
 
<a name="gimp-module-new"></a>gimp_module_new ()</h3>
422
 
<a class="indexterm" name="id2616737"></a><pre class="programlisting"><a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a>*         gimp_module_new                     (const <a
423
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
424
 
>gchar</a> *filename,
425
 
                                                         <a
426
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
427
 
>gboolean</a> load_inhibit,
428
 
                                                         <a
429
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
430
 
>gboolean</a> verbose);</pre>
 
323
<a name="gimp-module-new"></a><h3>gimp_module_new ()</h3>
 
324
<pre class="programlisting"><a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a>*         gimp_module_new                     (const gchar *filename,
 
325
                                                         gboolean load_inhibit,
 
326
                                                         gboolean verbose);</pre>
431
327
<p>
432
328
Creates a new <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instance.</p>
433
329
<p>
437
333
<col align="left" valign="top">
438
334
<tbody>
439
335
<tr>
440
 
<td><p><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></p></td>
 
336
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
441
337
<td>     The filename of a loadable module.
442
338
</td>
443
339
</tr>
444
340
<tr>
445
 
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em>&#160;:</span></p></td>
446
 
<td> Pass <a
447
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
448
 
><code class="literal">TRUE</code></a> to exclude this module from auto-loading.
449
 
</td>
450
 
</tr>
451
 
<tr>
452
 
<td><p><span class="term"><em class="parameter"><code>verbose</code></em>&#160;:</span></p></td>
453
 
<td>      Pass <a
454
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
455
 
><code class="literal">TRUE</code></a> to enable debugging output.
456
 
</td>
457
 
</tr>
458
 
<tr>
459
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
341
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></p></td>
 
342
<td> Pass <code class="literal">TRUE</code> to exclude this module from auto-loading.
 
343
</td>
 
344
</tr>
 
345
<tr>
 
346
<td><p><span class="term"><em class="parameter"><code>verbose</code></em> :</span></p></td>
 
347
<td>      Pass <code class="literal">TRUE</code> to enable debugging output.
 
348
</td>
 
349
</tr>
 
350
<tr>
 
351
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
460
352
<td> The new <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> object.
461
353
</td>
462
354
</tr>
465
357
</div>
466
358
<hr>
467
359
<div class="refsect2" lang="en">
468
 
<a name="id2616860"></a><h3>
469
 
<a name="gimp-module-modified"></a>gimp_module_modified ()</h3>
470
 
<a class="indexterm" name="id2616870"></a><pre class="programlisting">void                gimp_module_modified                (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);</pre>
 
360
<a name="gimp-module-modified"></a><h3>gimp_module_modified ()</h3>
 
361
<pre class="programlisting">void                gimp_module_modified                (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);</pre>
471
362
<p>
472
363
Emits the "modified" signal. Call it whenever you have modified the module
473
364
manually (which you shouldn't do).</p>
477
368
<div class="variablelist"><table border="0">
478
369
<col align="left" valign="top">
479
370
<tbody><tr>
480
 
<td><p><span class="term"><em class="parameter"><code>module</code></em>&#160;:</span></p></td>
 
371
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
481
372
<td> A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.
482
373
</td>
483
374
</tr></tbody>
485
376
</div>
486
377
<hr>
487
378
<div class="refsect2" lang="en">
488
 
<a name="id2616922"></a><h3>
489
 
<a name="gimp-module-query-module"></a>gimp_module_query_module ()</h3>
490
 
<a class="indexterm" name="id2616933"></a><pre class="programlisting"><a
491
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
492
 
>gboolean</a>            gimp_module_query_module            (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);</pre>
 
379
<a name="gimp-module-query-module"></a><h3>gimp_module_query_module ()</h3>
 
380
<pre class="programlisting">gboolean            gimp_module_query_module            (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module);</pre>
493
381
<p>
494
382
Queries the module without actually registering any of the types it
495
383
may implement. After successful query, the <em class="parameter"><code>info</code></em> field of the
501
389
<col align="left" valign="top">
502
390
<tbody>
503
391
<tr>
504
 
<td><p><span class="term"><em class="parameter"><code>module</code></em>&#160;:</span></p></td>
 
392
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
505
393
<td> A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.
506
394
</td>
507
395
</tr>
508
396
<tr>
509
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
510
 
<td> <a
511
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
512
 
><code class="literal">TRUE</code></a> on success.
 
397
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
398
<td> <code class="literal">TRUE</code> on success.
513
399
</td>
514
400
</tr>
515
401
</tbody>
517
403
</div>
518
404
<hr>
519
405
<div class="refsect2" lang="en">
520
 
<a name="id2617015"></a><h3>
521
 
<a name="gimp-module-set-load-inhibit"></a>gimp_module_set_load_inhibit ()</h3>
522
 
<a class="indexterm" name="id2617028"></a><pre class="programlisting">void                gimp_module_set_load_inhibit        (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module,
523
 
                                                         <a
524
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
525
 
>gboolean</a> load_inhibit);</pre>
 
406
<a name="gimp-module-set-load-inhibit"></a><h3>gimp_module_set_load_inhibit ()</h3>
 
407
<pre class="programlisting">void                gimp_module_set_load_inhibit        (<a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> *module,
 
408
                                                         gboolean load_inhibit);</pre>
526
409
<p>
527
410
Sets the <em class="parameter"><code>load_inhibit</code></em> property if the module. Emits "modified".</p>
528
411
<p>
532
415
<col align="left" valign="top">
533
416
<tbody>
534
417
<tr>
535
 
<td><p><span class="term"><em class="parameter"><code>module</code></em>&#160;:</span></p></td>
 
418
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
536
419
<td>       A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.
537
420
</td>
538
421
</tr>
539
422
<tr>
540
 
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em>&#160;:</span></p></td>
541
 
<td> Pass <a
542
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
543
 
><code class="literal">TRUE</code></a> to exclude this module from auto-loading.
 
423
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></p></td>
 
424
<td> Pass <code class="literal">TRUE</code> to exclude this module from auto-loading.
544
425
</td>
545
426
</tr>
546
427
</tbody>
548
429
</div>
549
430
<hr>
550
431
<div class="refsect2" lang="en">
551
 
<a name="id2617113"></a><h3>
552
 
<a name="gimp-module-state-name"></a>gimp_module_state_name ()</h3>
553
 
<a class="indexterm" name="id2617123"></a><pre class="programlisting">const <a
554
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
555
 
>gchar</a>*        gimp_module_state_name              (<a class="link" href="GimpModule.html#GimpModuleState">GimpModuleState</a> state);</pre>
 
432
<a name="gimp-module-state-name"></a><h3>gimp_module_state_name ()</h3>
 
433
<pre class="programlisting">const gchar*        gimp_module_state_name              (<a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a> state);</pre>
556
434
<p>
557
 
Returns the translated textual representation of a <a class="link" href="GimpModule.html#GimpModuleState"><span class="type">GimpModuleState</span></a>.
 
435
Returns the translated textual representation of a <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a>.
558
436
The returned string must not be freed.</p>
559
437
<p>
560
438
 
563
441
<col align="left" valign="top">
564
442
<tbody>
565
443
<tr>
566
 
<td><p><span class="term"><em class="parameter"><code>state</code></em>&#160;:</span></p></td>
567
 
<td> A <a class="link" href="GimpModule.html#GimpModuleState"><span class="type">GimpModuleState</span></a>.
 
444
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 
445
<td> A <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a>.
568
446
</td>
569
447
</tr>
570
448
<tr>
571
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
449
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
572
450
<td> The <em class="parameter"><code>state</code></em>'s name.
573
451
</td>
574
452
</tr>
577
455
</div>
578
456
<hr>
579
457
<div class="refsect2" lang="en">
580
 
<a name="id2617197"></a><h3>
581
 
<a name="gimp-module-register-enum"></a>gimp_module_register_enum ()</h3>
582
 
<a class="indexterm" name="id2617210"></a><pre class="programlisting"><a
583
 
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
584
 
>GType</a>               gimp_module_register_enum           (<a
585
 
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
586
 
>GTypeModule</a> *module,
587
 
                                                         const <a
588
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
589
 
>gchar</a> *name,
590
 
                                                         const <a
591
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
592
 
>GEnumValue</a> *const_static_values);</pre>
 
458
<a name="gimp-module-register-enum"></a><h3>gimp_module_register_enum ()</h3>
 
459
<pre class="programlisting">GType               gimp_module_register_enum           (GTypeModule *module,
 
460
                                                         const gchar *name,
 
461
                                                         const GEnumValue *const_static_values);</pre>
593
462
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
594
463
<h3 class="title">Warning</h3>
595
464
<p><code class="literal">gimp_module_register_enum</code> is deprecated and should not be used in newly-written code.</p>
596
465
</div>
597
466
<p>
598
 
This function is deprecated! Use <a
599
 
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html#g-type-module-register-enum"
600
 
><code class="function">g_type_module_register_enum()</code></a> instead.</p>
 
467
This function is deprecated! Use <code class="function">g_type_module_register_enum()</code> instead.</p>
601
468
<p>
602
469
 
603
470
</p>
605
472
<col align="left" valign="top">
606
473
<tbody>
607
474
<tr>
608
 
<td><p><span class="term"><em class="parameter"><code>module</code></em>&#160;:</span></p></td>
609
 
<td>
610
 
</td>
611
 
</tr>
612
 
<tr>
613
 
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
614
 
<td>
615
 
</td>
616
 
</tr>
617
 
<tr>
618
 
<td><p><span class="term"><em class="parameter"><code>const_static_values</code></em>&#160;:</span></p></td>
619
 
<td>
620
 
</td>
621
 
</tr>
622
 
<tr>
623
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
624
 
<td> a new enum <a
625
 
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
626
 
><span class="type">GType</span></a>
 
475
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
 
476
<td>
 
477
</td>
 
478
</tr>
 
479
<tr>
 
480
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
481
<td>
 
482
</td>
 
483
</tr>
 
484
<tr>
 
485
<td><p><span class="term"><em class="parameter"><code>const_static_values</code></em> :</span></p></td>
 
486
<td>
 
487
</td>
 
488
</tr>
 
489
<tr>
 
490
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
491
<td> a new enum <span class="type">GType</span>
627
492
</td>
628
493
</tr>
629
494
</tbody>
631
496
</div>
632
497
<hr>
633
498
<div class="refsect2" lang="en">
634
 
<a name="id2617330"></a><h3>
635
 
<a name="gimp-module-info-new"></a>gimp_module_info_new ()</h3>
636
 
<a class="indexterm" name="id2617340"></a><pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a>*     gimp_module_info_new                (<a
637
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
638
 
>guint32</a> abi_version,
639
 
                                                         const <a
640
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
641
 
>gchar</a> *purpose,
642
 
                                                         const <a
643
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
644
 
>gchar</a> *author,
645
 
                                                         const <a
646
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
647
 
>gchar</a> *version,
648
 
                                                         const <a
649
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
650
 
>gchar</a> *copyright,
651
 
                                                         const <a
652
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
653
 
>gchar</a> *date);</pre>
 
499
<a name="gimp-module-info-new"></a><h3>gimp_module_info_new ()</h3>
 
500
<pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>*     gimp_module_info_new                (guint32 abi_version,
 
501
                                                         const gchar *purpose,
 
502
                                                         const gchar *author,
 
503
                                                         const gchar *version,
 
504
                                                         const gchar *copyright,
 
505
                                                         const gchar *date);</pre>
654
506
<p>
655
 
Creates a newly allocated <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p>
 
507
Creates a newly allocated <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p>
656
508
<p>
657
509
 
658
510
</p>
660
512
<col align="left" valign="top">
661
513
<tbody>
662
514
<tr>
663
 
<td><p><span class="term"><em class="parameter"><code>abi_version</code></em>&#160;:</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.
665
517
</td>
666
518
</tr>
667
519
<tr>
668
 
<td><p><span class="term"><em class="parameter"><code>purpose</code></em>&#160;:</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.
670
522
</td>
671
523
</tr>
672
524
<tr>
673
 
<td><p><span class="term"><em class="parameter"><code>author</code></em>&#160;:</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.
675
527
</td>
676
528
</tr>
677
529
<tr>
678
 
<td><p><span class="term"><em class="parameter"><code>version</code></em>&#160;:</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.
680
532
</td>
681
533
</tr>
682
534
<tr>
683
 
<td><p><span class="term"><em class="parameter"><code>copyright</code></em>&#160;:</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.
685
537
</td>
686
538
</tr>
687
539
<tr>
688
 
<td><p><span class="term"><em class="parameter"><code>date</code></em>&#160;:</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.
690
542
</td>
691
543
</tr>
692
544
<tr>
693
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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.
695
547
</td>
696
548
</tr>
697
549
</tbody>
699
551
</div>
700
552
<hr>
701
553
<div class="refsect2" lang="en">
702
 
<a name="id2617511"></a><h3>
703
 
<a name="gimp-module-info-copy"></a>gimp_module_info_copy ()</h3>
704
 
<a class="indexterm" name="id2617522"></a><pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a>*     gimp_module_info_copy               (const <a class="link" href="GimpModule.html#GimpModuleInfo">GimpModuleInfo</a> *info);</pre>
 
554
<a name="gimp-module-info-copy"></a><h3>gimp_module_info_copy ()</h3>
 
555
<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>
705
556
<p>
706
 
Copies a <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p>
 
557
Copies a <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p>
707
558
<p>
708
559
 
709
560
</p>
711
562
<col align="left" valign="top">
712
563
<tbody>
713
564
<tr>
714
 
<td><p><span class="term"><em class="parameter"><code>info</code></em>&#160;:</span></p></td>
715
 
<td> The <a class="link" href="GimpModule.html#GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to copy.
 
565
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
566
<td> The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to copy.
716
567
</td>
717
568
</tr>
718
569
<tr>
719
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
570
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
720
571
<td> The new copy.
721
572
</td>
722
573
</tr>
725
576
</div>
726
577
<hr>
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>
731
581
<p>
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>
733
583
<p>
734
584
 
735
585
</p>
736
586
<div class="variablelist"><table border="0">
737
587
<col align="left" valign="top">
738
588
<tbody><tr>
739
 
<td><p><span class="term"><em class="parameter"><code>info</code></em>&#160;:</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
741
591
</td>
742
592
</tr></tbody>
743
593
</table></div>
744
594
</div>
745
595
</div>
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,
752
 
                                                        <a
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>
755
602
<p>
756
603
 
757
604
</p>
759
606
<col align="left" valign="top">
760
607
<tbody>
761
608
<tr>
762
 
<td><p><span class="term"><em class="parameter"><code>gimpmodule</code></em>&#160;:</span></p></td>
 
609
<td><p><span class="term"><em class="parameter"><code>gimpmodule</code></em> :</span></p></td>
763
610
<td>the object which received the signal.
764
611
 
765
612
</td>
766
613
</tr>
767
614
<tr>
768
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
615
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
769
616
<td>user data set when the signal handler was connected.</td>
770
617
</tr>
771
618
</tbody>
773
620
</div>
774
621
</div>
775
622
<div class="refsect1" lang="en">
776
 
<a name="id2617741"></a><h2>See Also</h2>
777
 
<p>
778
 
<a
779
 
href="/usr/share/gtk-doc/html/glib/glib-Dynamic-Loading-of-Modules.html#GModule"
780
 
><span class="type">GModule</span></a>
781
 
</p>
782
 
<p>
783
 
<a
784
 
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
785
 
><span class="type">GTypeModule</span></a>
786
 
</p>
787
 
</div>
788
 
<div class="refsect1" lang="en">
789
 
<a name="id2617766"></a><div class="refsect2" lang="en"><a name="id2617767"></a></div>
 
623
<a name="GimpModule.see-also"></a><h2>See Also</h2>
 
624
<p>
 
625
<span class="type">GModule</span>
 
626
</p>
 
627
<p>
 
628
<span class="type">GTypeModule</span>
 
629
</p>
 
630
</div>
 
631
</div>
 
632
<div class="footer">
790
633
<hr>
791
 
<div class="refsect2" lang="en"><a name="id2617768"></a></div>
792
 
</div>
793
 
</div>
 
634
          Generated by GTK-Doc V1.10</div>
794
635
</body>
795
636
</html>