← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpmodule/xml/gimpmodule.xml

  • 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/xml/gimpmodule.xml
12
12
<refnamediv>
13
13
<refname>GimpModule</refname>
14
14
<refpurpose>A <link linkend="GTypeModule"><type>GTypeModule</type></link> subclass which implements module loading using <link linkend="GModule"><type>GModule</type></link>.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpModule.synopsis" role="synopsis">
22
21
                    <link linkend="GimpModule-struct">GimpModule</link>;
23
22
                    <link linkend="GimpModuleInfo">GimpModuleInfo</link>;
24
23
enum                <link linkend="GimpModuleState">GimpModuleState</link>;
25
 
const <link linkend="GimpModuleInfo">GimpModuleInfo</link>* (<link linkend="GimpModuleQueryFunc">*GimpModuleQueryFunc</link>)            (<link linkend="GTypeModule">GTypeModule</link> *module);
 
24
const <link linkend="GimpModuleInfo">GimpModuleInfo</link> * (<link linkend="GimpModuleQueryFunc">*GimpModuleQueryFunc</link>)           (<link linkend="GTypeModule">GTypeModule</link> *module);
26
25
<link linkend="gboolean">gboolean</link>            (<link linkend="GimpModuleRegisterFunc">*GimpModuleRegisterFunc</link>)           (<link linkend="GTypeModule">GTypeModule</link> *module);
27
 
#define             <link linkend="GIMP-MODULE-ABI-VERSION:CAPS">GIMP_MODULE_ABI_VERSION</link>
28
 
#define             <link linkend="GIMP-MODULE-PARAM-SERIALIZE:CAPS">GIMP_MODULE_PARAM_SERIALIZE</link>
29
 
<link linkend="GimpModule">GimpModule</link>*         <link linkend="gimp-module-new">gimp_module_new</link>                     (const <link linkend="gchar">gchar</link> *filename,
 
26
#define             <link linkend="GIMP-MODULE-ABI-VERSION--CAPS">GIMP_MODULE_ABI_VERSION</link>
 
27
#define             <link linkend="GIMP-MODULE-PARAM-SERIALIZE--CAPS">GIMP_MODULE_PARAM_SERIALIZE</link>
 
28
<link linkend="GimpModule">GimpModule</link> *        <link linkend="gimp-module-new">gimp_module_new</link>                     (const <link linkend="gchar">gchar</link> *filename,
30
29
                                                         <link linkend="gboolean">gboolean</link> load_inhibit,
31
30
                                                         <link linkend="gboolean">gboolean</link> verbose);
32
31
<link linkend="void">void</link>                <link linkend="gimp-module-modified">gimp_module_modified</link>                (<link linkend="GimpModule">GimpModule</link> *module);
33
32
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-module-query-module">gimp_module_query_module</link>            (<link linkend="GimpModule">GimpModule</link> *module);
34
33
<link linkend="void">void</link>                <link linkend="gimp-module-set-load-inhibit">gimp_module_set_load_inhibit</link>        (<link linkend="GimpModule">GimpModule</link> *module,
35
34
                                                         <link linkend="gboolean">gboolean</link> load_inhibit);
36
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-module-state-name">gimp_module_state_name</link>              (<link linkend="GimpModuleState">GimpModuleState</link> state);
 
35
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-module-state-name">gimp_module_state_name</link>              (<link linkend="GimpModuleState">GimpModuleState</link> state);
37
36
<link linkend="GType">GType</link>               <link linkend="gimp-module-register-enum">gimp_module_register_enum</link>           (<link linkend="GTypeModule">GTypeModule</link> *module,
38
37
                                                         const <link linkend="gchar">gchar</link> *name,
39
38
                                                         const <link linkend="GEnumValue">GEnumValue</link> *const_static_values);
40
 
<link linkend="GimpModuleInfo">GimpModuleInfo</link>*     <link linkend="gimp-module-info-new">gimp_module_info_new</link>                (<link linkend="guint32">guint32</link> abi_version,
 
39
<link linkend="GimpModuleInfo">GimpModuleInfo</link> *    <link linkend="gimp-module-info-new">gimp_module_info_new</link>                (<link linkend="guint32">guint32</link> abi_version,
41
40
                                                         const <link linkend="gchar">gchar</link> *purpose,
42
41
                                                         const <link linkend="gchar">gchar</link> *author,
43
42
                                                         const <link linkend="gchar">gchar</link> *version,
44
43
                                                         const <link linkend="gchar">gchar</link> *copyright,
45
44
                                                         const <link linkend="gchar">gchar</link> *date);
46
 
<link linkend="GimpModuleInfo">GimpModuleInfo</link>*     <link linkend="gimp-module-info-copy">gimp_module_info_copy</link>               (const <link linkend="GimpModuleInfo">GimpModuleInfo</link> *info);
 
45
<link linkend="GimpModuleInfo">GimpModuleInfo</link> *    <link linkend="gimp-module-info-copy">gimp_module_info_copy</link>               (const <link linkend="GimpModuleInfo">GimpModuleInfo</link> *info);
47
46
<link linkend="void">void</link>                <link linkend="gimp-module-info-free">gimp_module_info_free</link>               (<link linkend="GimpModuleInfo">GimpModuleInfo</link> *info);
48
47
</synopsis>
49
48
</refsynopsisdiv>
55
54
   +----<link linkend="GTypeModule">GTypeModule</link>
56
55
         +----GimpModule
57
56
</synopsis>
58
 
 
59
57
</refsect1>
60
58
 
61
59
 
65
63
<para>
66
64
GimpModule implements
67
65
 <link linkend="GTypePlugin">GTypePlugin</link>.</para>
68
 
 
69
66
</refsect1>
70
67
 
71
68
 
89
86
<title role="details.title">Details</title>
90
87
<refsect2 id="GimpModule-struct" role="struct">
91
88
<title>GimpModule</title>
92
 
<indexterm zone="GimpModule-struct"><primary>GimpModule</primary></indexterm><programlisting>typedef struct {
 
89
<indexterm zone="GimpModule-struct"><primary sortas="GimpModule">GimpModule</primary></indexterm><programlisting>typedef struct {
93
90
  gchar           *filename;     /* path to the module                       */
94
91
  gboolean         verbose;      /* verbose error reporting                  */
95
92
  GimpModuleState  state;        /* what's happened to the module            */
110
107
</para></refsect2>
111
108
<refsect2 id="GimpModuleInfo" role="struct">
112
109
<title>GimpModuleInfo</title>
113
 
<indexterm zone="GimpModuleInfo"><primary>GimpModuleInfo</primary></indexterm><programlisting>typedef struct {
 
110
<indexterm zone="GimpModuleInfo"><primary sortas="GimpModuleInfo">GimpModuleInfo</primary></indexterm><programlisting>typedef struct {
114
111
  guint32  abi_version;
115
112
  gchar   *purpose;
116
113
  gchar   *author;
123
120
This structure contains information about a loadable module.
124
121
</para><variablelist role="struct">
125
122
<varlistentry>
126
 
<term><link linkend="guint32">guint32</link>&nbsp;<structfield>abi_version</structfield>;</term>
127
 
<listitem><simpara>The <link linkend="GIMP-MODULE-ABI-VERSION:CAPS"><type>GIMP_MODULE_ABI_VERSION</type></link> the module was compiled against.
 
123
<term><link linkend="guint32">guint32</link>&#160;<structfield>abi_version</structfield>;</term>
 
124
<listitem><simpara>The <link linkend="GIMP-MODULE-ABI-VERSION--CAPS"><type>GIMP_MODULE_ABI_VERSION</type></link> the module was compiled against.
128
125
</simpara></listitem>
129
126
</varlistentry>
130
127
<varlistentry>
131
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>purpose</structfield>;</term>
 
128
<term><link linkend="gchar">gchar</link>&#160;*<structfield>purpose</structfield>;</term>
132
129
<listitem><simpara>    The module's general purpose.
133
130
</simpara></listitem>
134
131
</varlistentry>
135
132
<varlistentry>
136
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>author</structfield>;</term>
 
133
<term><link linkend="gchar">gchar</link>&#160;*<structfield>author</structfield>;</term>
137
134
<listitem><simpara>     The module's author.
138
135
</simpara></listitem>
139
136
</varlistentry>
140
137
<varlistentry>
141
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>version</structfield>;</term>
 
138
<term><link linkend="gchar">gchar</link>&#160;*<structfield>version</structfield>;</term>
142
139
<listitem><simpara>    The module's version.
143
140
</simpara></listitem>
144
141
</varlistentry>
145
142
<varlistentry>
146
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>copyright</structfield>;</term>
 
143
<term><link linkend="gchar">gchar</link>&#160;*<structfield>copyright</structfield>;</term>
147
144
<listitem><simpara>  The module's copyright.
148
145
</simpara></listitem>
149
146
</varlistentry>
150
147
<varlistentry>
151
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>date</structfield>;</term>
 
148
<term><link linkend="gchar">gchar</link>&#160;*<structfield>date</structfield>;</term>
152
149
<listitem><simpara>       The module's release date.
153
 
 
154
150
</simpara></listitem>
155
151
</varlistentry>
156
152
</variablelist></refsect2>
157
153
<refsect2 id="GimpModuleState" role="enum">
158
154
<title>enum GimpModuleState</title>
159
 
<indexterm zone="GimpModuleState"><primary>GimpModuleState</primary></indexterm><programlisting>typedef enum
 
155
<indexterm zone="GimpModuleState"><primary sortas="GimpModuleState">GimpModuleState</primary></indexterm><programlisting>typedef enum
160
156
{
161
157
  GIMP_MODULE_STATE_ERROR,       /* missing gimp_module_register function
162
158
                                  * or other error
174
170
<para>
175
171
The possible states a <link linkend="GimpModule"><type>GimpModule</type></link> can be in.
176
172
</para><variablelist role="enum">
177
 
<varlistentry id="GIMP-MODULE-STATE-ERROR:CAPS" role="constant">
 
173
<varlistentry id="GIMP-MODULE-STATE-ERROR--CAPS" role="constant">
178
174
<term><literal>GIMP_MODULE_STATE_ERROR</literal></term>
179
175
<listitem><simpara>      Missing <link linkend="gimp-module-register"><function>gimp_module_register()</function></link> function
180
176
                                or other error.
181
177
</simpara></listitem>
182
178
</varlistentry>
183
 
<varlistentry id="GIMP-MODULE-STATE-LOADED:CAPS" role="constant">
 
179
<varlistentry id="GIMP-MODULE-STATE-LOADED--CAPS" role="constant">
184
180
<term><literal>GIMP_MODULE_STATE_LOADED</literal></term>
185
181
<listitem><simpara>     An instance of a type implemented by
186
182
                                this module is allocated.
187
183
</simpara></listitem>
188
184
</varlistentry>
189
 
<varlistentry id="GIMP-MODULE-STATE-LOAD-FAILED:CAPS" role="constant">
 
185
<varlistentry id="GIMP-MODULE-STATE-LOAD-FAILED--CAPS" role="constant">
190
186
<term><literal>GIMP_MODULE_STATE_LOAD_FAILED</literal></term>
191
 
<listitem><simpara><link linkend="gimp-module-register"><function>gimp_module_register()</function></link> returned <link linkend="FALSE:CAPS"><type>FALSE</type></link>.
 
187
<listitem><simpara><link linkend="gimp-module-register"><function>gimp_module_register()</function></link> returned <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
192
188
</simpara></listitem>
193
189
</varlistentry>
194
 
<varlistentry id="GIMP-MODULE-STATE-NOT-LOADED:CAPS" role="constant">
 
190
<varlistentry id="GIMP-MODULE-STATE-NOT-LOADED--CAPS" role="constant">
195
191
<term><literal>GIMP_MODULE_STATE_NOT_LOADED</literal></term>
196
192
<listitem><simpara> There are no instances allocated of
197
193
                                types implemented by this module.
198
 
 
199
194
</simpara></listitem>
200
195
</varlistentry>
201
196
</variablelist></refsect2>
202
197
<refsect2 id="GimpModuleQueryFunc" role="function">
203
198
<title>GimpModuleQueryFunc ()</title>
204
 
<indexterm zone="GimpModuleQueryFunc"><primary>GimpModuleQueryFunc</primary></indexterm><programlisting>const <link linkend="GimpModuleInfo">GimpModuleInfo</link>* (*GimpModuleQueryFunc)            (<link linkend="GTypeModule">GTypeModule</link> *module);</programlisting>
 
199
<indexterm zone="GimpModuleQueryFunc"><primary sortas="GimpModuleQueryFunc">GimpModuleQueryFunc</primary></indexterm><programlisting>const <link linkend="GimpModuleInfo">GimpModuleInfo</link> * (*GimpModuleQueryFunc)           (<link linkend="GTypeModule">GTypeModule</link> *module);</programlisting>
205
200
<para>
206
201
The signature of the query function a loadable GIMP module must
207
202
implement.  In the module, the function must be called
208
203
<link linkend="gimp-module-query"><function>gimp_module_query()</function></link>.
209
204
</para>
210
 
 
211
205
<para>
212
206
<link linkend="GimpModule"><type>GimpModule</type></link> will copy the returned <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct, so the
213
207
module doesn't need to keep these values around (however in most cases
214
208
the module will just return a pointer to a constant structure).
215
209
</para><variablelist role="params">
216
 
<varlistentry><term><parameter>module</parameter>&nbsp;:</term>
 
210
<varlistentry><term><parameter>module</parameter>&#160;:</term>
217
211
<listitem><simpara> The <link linkend="GimpModule"><type>GimpModule</type></link> responsible for this loadable module.
218
212
</simpara></listitem></varlistentry>
219
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>The <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct describing the module.
220
 
 
221
 
 
 
213
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct describing the module.
222
214
</simpara></listitem></varlistentry>
223
215
</variablelist></refsect2>
224
216
<refsect2 id="GimpModuleRegisterFunc" role="function">
225
217
<title>GimpModuleRegisterFunc ()</title>
226
 
<indexterm zone="GimpModuleRegisterFunc"><primary>GimpModuleRegisterFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*GimpModuleRegisterFunc)           (<link linkend="GTypeModule">GTypeModule</link> *module);</programlisting>
 
218
<indexterm zone="GimpModuleRegisterFunc"><primary sortas="GimpModuleRegisterFunc">GimpModuleRegisterFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*GimpModuleRegisterFunc)           (<link linkend="GTypeModule">GTypeModule</link> *module);</programlisting>
227
219
<para>
228
220
The signature of the register function a loadable GIMP module must
229
221
implement.  In the module, the function must be called
230
222
<link linkend="gimp-module-register"><function>gimp_module_register()</function></link>.
231
223
</para>
232
 
 
233
224
<para>
234
225
When this function is called, the module should register all the types
235
226
it implements with the passed <parameter>module</parameter>.
236
227
</para><variablelist role="params">
237
 
<varlistentry><term><parameter>module</parameter>&nbsp;:</term>
 
228
<varlistentry><term><parameter>module</parameter>&#160;:</term>
238
229
<listitem><simpara> The <link linkend="GimpModule"><type>GimpModule</type></link> responsible for this loadable module.
239
230
</simpara></listitem></varlistentry>
240
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><link linkend="TRUE:CAPS"><type>TRUE</type></link> on success, <link linkend="FALSE:CAPS"><type>FALSE</type></link> otherwise.
241
 
 
242
 
 
 
231
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>#TRUE on success, <link linkend="FALSE--CAPS"><type>FALSE</type></link> otherwise.
243
232
</simpara></listitem></varlistentry>
244
233
</variablelist></refsect2>
245
 
<refsect2 id="GIMP-MODULE-ABI-VERSION:CAPS" role="macro">
 
234
<refsect2 id="GIMP-MODULE-ABI-VERSION--CAPS" role="macro">
246
235
<title>GIMP_MODULE_ABI_VERSION</title>
247
 
<indexterm zone="GIMP-MODULE-ABI-VERSION:CAPS"><primary>GIMP_MODULE_ABI_VERSION</primary></indexterm><programlisting>#define GIMP_MODULE_ABI_VERSION 0x0004
 
236
<indexterm zone="GIMP-MODULE-ABI-VERSION--CAPS"><primary sortas="GIMP_MODULE_ABI_VERSION">GIMP_MODULE_ABI_VERSION</primary></indexterm><programlisting>#define GIMP_MODULE_ABI_VERSION 0x0004
248
237
</programlisting>
249
238
<para>
250
239
The version of the module system's ABI. Modules put this value into
252
241
can check if it was compiled against the same module ABI the modules
253
242
are compiled against.
254
243
</para></refsect2>
255
 
<refsect2 id="GIMP-MODULE-PARAM-SERIALIZE:CAPS" role="macro" condition="deprecated:">
 
244
<refsect2 id="GIMP-MODULE-PARAM-SERIALIZE--CAPS" role="macro" condition="deprecated:">
256
245
<title>GIMP_MODULE_PARAM_SERIALIZE</title>
257
 
<indexterm zone="GIMP-MODULE-PARAM-SERIALIZE:CAPS" role="deprecated"><primary>GIMP_MODULE_PARAM_SERIALIZE</primary></indexterm><programlisting>#define GIMP_MODULE_PARAM_SERIALIZE (1 &lt;&lt; (0 + G_PARAM_USER_SHIFT))
 
246
<indexterm zone="GIMP-MODULE-PARAM-SERIALIZE--CAPS" role="deprecated"><primary sortas="GIMP_MODULE_PARAM_SERIALIZE">GIMP_MODULE_PARAM_SERIALIZE</primary></indexterm><programlisting>#define GIMP_MODULE_PARAM_SERIALIZE (1 &lt;&lt; (0 + G_PARAM_USER_SHIFT))
258
247
</programlisting>
259
248
<warning><para><literal>GIMP_MODULE_PARAM_SERIALIZE</literal> is deprecated and should not be used in newly-written code.</para></warning>
260
249
<para>
261
 
 
262
250
</para></refsect2>
263
251
<refsect2 id="gimp-module-new" role="function">
264
252
<title>gimp_module_new ()</title>
265
 
<indexterm zone="gimp-module-new"><primary>gimp_module_new</primary></indexterm><programlisting><link linkend="GimpModule">GimpModule</link>*         gimp_module_new                     (const <link linkend="gchar">gchar</link> *filename,
 
253
<indexterm zone="gimp-module-new"><primary sortas="gimp_module_new">gimp_module_new</primary></indexterm><programlisting><link linkend="GimpModule">GimpModule</link> *        gimp_module_new                     (const <link linkend="gchar">gchar</link> *filename,
266
254
                                                         <link linkend="gboolean">gboolean</link> load_inhibit,
267
255
                                                         <link linkend="gboolean">gboolean</link> verbose);</programlisting>
268
256
<para>
269
257
Creates a new <link linkend="GimpModule"><type>GimpModule</type></link> instance.</para>
270
258
<para>
271
 
 
272
259
</para><variablelist role="params">
273
 
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
 
260
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
274
261
<listitem><simpara>     The filename of a loadable module.
275
262
</simpara></listitem></varlistentry>
276
 
<varlistentry><term><parameter>load_inhibit</parameter>&nbsp;:</term>
277
 
<listitem><simpara> Pass <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to exclude this module from auto-loading.
278
 
</simpara></listitem></varlistentry>
279
 
<varlistentry><term><parameter>verbose</parameter>&nbsp;:</term>
280
 
<listitem><simpara>      Pass <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to enable debugging output.
281
 
</simpara></listitem></varlistentry>
282
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new <link linkend="GimpModule"><type>GimpModule</type></link> object.
 
263
<varlistentry><term><parameter>load_inhibit</parameter>&#160;:</term>
 
264
<listitem><simpara> Pass <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to exclude this module from auto-loading.
 
265
</simpara></listitem></varlistentry>
 
266
<varlistentry><term><parameter>verbose</parameter>&#160;:</term>
 
267
<listitem><simpara>      Pass <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to enable debugging output.
 
268
</simpara></listitem></varlistentry>
 
269
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The new <link linkend="GimpModule"><type>GimpModule</type></link> object.
283
270
</simpara></listitem></varlistentry>
284
271
</variablelist></refsect2>
285
272
<refsect2 id="gimp-module-modified" role="function">
286
273
<title>gimp_module_modified ()</title>
287
 
<indexterm zone="gimp-module-modified"><primary>gimp_module_modified</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_modified                (<link linkend="GimpModule">GimpModule</link> *module);</programlisting>
 
274
<indexterm zone="gimp-module-modified"><primary sortas="gimp_module_modified">gimp_module_modified</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_modified                (<link linkend="GimpModule">GimpModule</link> *module);</programlisting>
288
275
<para>
289
276
Emits the "modified" signal. Call it whenever you have modified the module
290
277
manually (which you shouldn't do).</para>
291
278
<para>
292
 
 
293
279
</para><variablelist role="params">
294
 
<varlistentry><term><parameter>module</parameter>&nbsp;:</term>
 
280
<varlistentry><term><parameter>module</parameter>&#160;:</term>
295
281
<listitem><simpara> A <link linkend="GimpModule"><type>GimpModule</type></link>.
296
282
</simpara></listitem></varlistentry>
297
283
</variablelist></refsect2>
298
284
<refsect2 id="gimp-module-query-module" role="function">
299
285
<title>gimp_module_query_module ()</title>
300
 
<indexterm zone="gimp-module-query-module"><primary>gimp_module_query_module</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_module_query_module            (<link linkend="GimpModule">GimpModule</link> *module);</programlisting>
 
286
<indexterm zone="gimp-module-query-module"><primary sortas="gimp_module_query_module">gimp_module_query_module</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_module_query_module            (<link linkend="GimpModule">GimpModule</link> *module);</programlisting>
301
287
<para>
302
288
Queries the module without actually registering any of the types it
303
289
may implement. After successful query, the <parameter>info</parameter> field of the
304
290
<link linkend="GimpModule"><type>GimpModule</type></link> struct will be available for further inspection.</para>
305
291
<para>
306
 
 
307
292
</para><variablelist role="params">
308
 
<varlistentry><term><parameter>module</parameter>&nbsp;:</term>
 
293
<varlistentry><term><parameter>module</parameter>&#160;:</term>
309
294
<listitem><simpara> A <link linkend="GimpModule"><type>GimpModule</type></link>.
310
295
</simpara></listitem></varlistentry>
311
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success.
 
296
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success.
312
297
</simpara></listitem></varlistentry>
313
298
</variablelist></refsect2>
314
299
<refsect2 id="gimp-module-set-load-inhibit" role="function">
315
300
<title>gimp_module_set_load_inhibit ()</title>
316
 
<indexterm zone="gimp-module-set-load-inhibit"><primary>gimp_module_set_load_inhibit</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_set_load_inhibit        (<link linkend="GimpModule">GimpModule</link> *module,
 
301
<indexterm zone="gimp-module-set-load-inhibit"><primary sortas="gimp_module_set_load_inhibit">gimp_module_set_load_inhibit</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_set_load_inhibit        (<link linkend="GimpModule">GimpModule</link> *module,
317
302
                                                         <link linkend="gboolean">gboolean</link> load_inhibit);</programlisting>
318
303
<para>
319
304
Sets the <parameter>load_inhibit</parameter> property if the module. Emits "modified".</para>
320
305
<para>
321
 
 
322
306
</para><variablelist role="params">
323
 
<varlistentry><term><parameter>module</parameter>&nbsp;:</term>
 
307
<varlistentry><term><parameter>module</parameter>&#160;:</term>
324
308
<listitem><simpara>       A <link linkend="GimpModule"><type>GimpModule</type></link>.
325
309
</simpara></listitem></varlistentry>
326
 
<varlistentry><term><parameter>load_inhibit</parameter>&nbsp;:</term>
327
 
<listitem><simpara> Pass <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to exclude this module from auto-loading.
 
310
<varlistentry><term><parameter>load_inhibit</parameter>&#160;:</term>
 
311
<listitem><simpara> Pass <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to exclude this module from auto-loading.
328
312
</simpara></listitem></varlistentry>
329
313
</variablelist></refsect2>
330
314
<refsect2 id="gimp-module-state-name" role="function">
331
315
<title>gimp_module_state_name ()</title>
332
 
<indexterm zone="gimp-module-state-name"><primary>gimp_module_state_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_module_state_name              (<link linkend="GimpModuleState">GimpModuleState</link> state);</programlisting>
 
316
<indexterm zone="gimp-module-state-name"><primary sortas="gimp_module_state_name">gimp_module_state_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_module_state_name              (<link linkend="GimpModuleState">GimpModuleState</link> state);</programlisting>
333
317
<para>
334
318
Returns the translated textual representation of a <link linkend="GimpModuleState"><type>GimpModuleState</type></link>.
335
319
The returned string must not be freed.</para>
336
320
<para>
337
 
 
338
321
</para><variablelist role="params">
339
 
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
 
322
<varlistentry><term><parameter>state</parameter>&#160;:</term>
340
323
<listitem><simpara> A <link linkend="GimpModuleState"><type>GimpModuleState</type></link>.
341
324
</simpara></listitem></varlistentry>
342
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The <parameter>state</parameter>'s name.
 
325
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The <parameter>state</parameter>'s name.
343
326
</simpara></listitem></varlistentry>
344
327
</variablelist></refsect2>
345
328
<refsect2 id="gimp-module-register-enum" role="function" condition="deprecated:">
346
329
<title>gimp_module_register_enum ()</title>
347
 
<indexterm zone="gimp-module-register-enum" role="deprecated"><primary>gimp_module_register_enum</primary></indexterm><programlisting><link linkend="GType">GType</link>               gimp_module_register_enum           (<link linkend="GTypeModule">GTypeModule</link> *module,
 
330
<indexterm zone="gimp-module-register-enum" role="deprecated"><primary sortas="gimp_module_register_enum">gimp_module_register_enum</primary></indexterm><programlisting><link linkend="GType">GType</link>               gimp_module_register_enum           (<link linkend="GTypeModule">GTypeModule</link> *module,
348
331
                                                         const <link linkend="gchar">gchar</link> *name,
349
332
                                                         const <link linkend="GEnumValue">GEnumValue</link> *const_static_values);</programlisting>
350
333
<warning><para><literal>gimp_module_register_enum</literal> is deprecated and should not be used in newly-written code.</para></warning>
351
334
<para>
352
335
This function is deprecated! Use <link linkend="g-type-module-register-enum"><function>g_type_module_register_enum()</function></link> instead.</para>
353
336
<para>
354
 
 
355
337
</para><variablelist role="params">
356
 
<varlistentry><term><parameter>module</parameter>&nbsp;:</term>
357
 
<listitem><simpara>
358
 
</simpara></listitem></varlistentry>
359
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
360
 
<listitem><simpara>
361
 
</simpara></listitem></varlistentry>
362
 
<varlistentry><term><parameter>const_static_values</parameter>&nbsp;:</term>
363
 
<listitem><simpara>
364
 
</simpara></listitem></varlistentry>
365
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new enum <link linkend="GType"><type>GType</type></link>
 
338
<varlistentry><term><parameter>module</parameter>&#160;:</term>
 
339
<listitem><simpara>
 
340
</simpara></listitem></varlistentry>
 
341
<varlistentry><term><parameter>name</parameter>&#160;:</term>
 
342
<listitem><simpara>
 
343
</simpara></listitem></varlistentry>
 
344
<varlistentry><term><parameter>const_static_values</parameter>&#160;:</term>
 
345
<listitem><simpara>
 
346
</simpara></listitem></varlistentry>
 
347
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new enum <link linkend="GType"><type>GType</type></link>
366
348
</simpara></listitem></varlistentry>
367
349
</variablelist></refsect2>
368
350
<refsect2 id="gimp-module-info-new" role="function">
369
351
<title>gimp_module_info_new ()</title>
370
 
<indexterm zone="gimp-module-info-new"><primary>gimp_module_info_new</primary></indexterm><programlisting><link linkend="GimpModuleInfo">GimpModuleInfo</link>*     gimp_module_info_new                (<link linkend="guint32">guint32</link> abi_version,
 
352
<indexterm zone="gimp-module-info-new"><primary sortas="gimp_module_info_new">gimp_module_info_new</primary></indexterm><programlisting><link linkend="GimpModuleInfo">GimpModuleInfo</link> *    gimp_module_info_new                (<link linkend="guint32">guint32</link> abi_version,
371
353
                                                         const <link linkend="gchar">gchar</link> *purpose,
372
354
                                                         const <link linkend="gchar">gchar</link> *author,
373
355
                                                         const <link linkend="gchar">gchar</link> *version,
376
358
<para>
377
359
Creates a newly allocated <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct.</para>
378
360
<para>
379
 
 
380
361
</para><variablelist role="params">
381
 
<varlistentry><term><parameter>abi_version</parameter>&nbsp;:</term>
382
 
<listitem><simpara> The <link linkend="GIMP-MODULE-ABI-VERSION:CAPS"><type>GIMP_MODULE_ABI_VERSION</type></link> the module was compiled against.
 
362
<varlistentry><term><parameter>abi_version</parameter>&#160;:</term>
 
363
<listitem><simpara> The <link linkend="GIMP-MODULE-ABI-VERSION--CAPS"><type>GIMP_MODULE_ABI_VERSION</type></link> the module was compiled against.
383
364
</simpara></listitem></varlistentry>
384
 
<varlistentry><term><parameter>purpose</parameter>&nbsp;:</term>
 
365
<varlistentry><term><parameter>purpose</parameter>&#160;:</term>
385
366
<listitem><simpara>     The module's general purpose.
386
367
</simpara></listitem></varlistentry>
387
 
<varlistentry><term><parameter>author</parameter>&nbsp;:</term>
 
368
<varlistentry><term><parameter>author</parameter>&#160;:</term>
388
369
<listitem><simpara>      The module's author.
389
370
</simpara></listitem></varlistentry>
390
 
<varlistentry><term><parameter>version</parameter>&nbsp;:</term>
 
371
<varlistentry><term><parameter>version</parameter>&#160;:</term>
391
372
<listitem><simpara>     The module's version.
392
373
</simpara></listitem></varlistentry>
393
 
<varlistentry><term><parameter>copyright</parameter>&nbsp;:</term>
 
374
<varlistentry><term><parameter>copyright</parameter>&#160;:</term>
394
375
<listitem><simpara>   The module's copyright.
395
376
</simpara></listitem></varlistentry>
396
 
<varlistentry><term><parameter>date</parameter>&nbsp;:</term>
 
377
<varlistentry><term><parameter>date</parameter>&#160;:</term>
397
378
<listitem><simpara>        The module's release date.
398
379
</simpara></listitem></varlistentry>
399
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct.
 
380
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The new <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct.
400
381
</simpara></listitem></varlistentry>
401
382
</variablelist></refsect2>
402
383
<refsect2 id="gimp-module-info-copy" role="function">
403
384
<title>gimp_module_info_copy ()</title>
404
 
<indexterm zone="gimp-module-info-copy"><primary>gimp_module_info_copy</primary></indexterm><programlisting><link linkend="GimpModuleInfo">GimpModuleInfo</link>*     gimp_module_info_copy               (const <link linkend="GimpModuleInfo">GimpModuleInfo</link> *info);</programlisting>
 
385
<indexterm zone="gimp-module-info-copy"><primary sortas="gimp_module_info_copy">gimp_module_info_copy</primary></indexterm><programlisting><link linkend="GimpModuleInfo">GimpModuleInfo</link> *    gimp_module_info_copy               (const <link linkend="GimpModuleInfo">GimpModuleInfo</link> *info);</programlisting>
405
386
<para>
406
387
Copies a <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct.</para>
407
388
<para>
408
 
 
409
389
</para><variablelist role="params">
410
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
390
<varlistentry><term><parameter>info</parameter>&#160;:</term>
411
391
<listitem><simpara> The <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct to copy.
412
392
</simpara></listitem></varlistentry>
413
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new copy.
 
393
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The new copy.
414
394
</simpara></listitem></varlistentry>
415
395
</variablelist></refsect2>
416
396
<refsect2 id="gimp-module-info-free" role="function">
417
397
<title>gimp_module_info_free ()</title>
418
 
<indexterm zone="gimp-module-info-free"><primary>gimp_module_info_free</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_info_free               (<link linkend="GimpModuleInfo">GimpModuleInfo</link> *info);</programlisting>
 
398
<indexterm zone="gimp-module-info-free"><primary sortas="gimp_module_info_free">gimp_module_info_free</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_info_free               (<link linkend="GimpModuleInfo">GimpModuleInfo</link> *info);</programlisting>
419
399
<para>
420
400
Frees the passed <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link>.</para>
421
401
<para>
422
 
 
423
402
</para><variablelist role="params">
424
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
403
<varlistentry><term><parameter>info</parameter>&#160;:</term>
425
404
<listitem><simpara> The <link linkend="GimpModuleInfo"><type>GimpModuleInfo</type></link> struct to free
426
405
</simpara></listitem></varlistentry>
427
406
</variablelist></refsect2>
430
409
 
431
410
<refsect1 id="GimpModule.signal-details" role="signals">
432
411
<title role="signals.title">Signal Details</title>
433
 
<refsect2 id="GimpModule-modified"><title>The <literal>&quot;modified&quot;</literal> signal</title>
434
 
<indexterm zone="GimpModule-modified"><primary>GimpModule::modified</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpModule">GimpModule</link> *gimpmodule,
 
412
<refsect2 id="GimpModule-modified" role="signal"><title>The <literal>&quot;modified&quot;</literal> signal</title>
 
413
<indexterm zone="GimpModule-modified"><primary sortas="GimpModule::modified">GimpModule::modified</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpModule">GimpModule</link> *gimpmodule,
435
414
                                                        <link linkend="gpointer">gpointer</link>    user_data)       : Run First</programlisting>
436
415
<para>
437
 
 
438
416
</para><variablelist role="params">
439
 
<varlistentry><term><parameter>gimpmodule</parameter>&nbsp;:</term>
 
417
<varlistentry><term><parameter>gimpmodule</parameter>&#160;:</term>
440
418
<listitem><simpara>the object which received the signal.
441
 
 
442
419
</simpara></listitem></varlistentry>
443
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
420
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
444
421
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
445
422
</variablelist></refsect2>
446
423
</refsect1>