← Back to branch summary

~ubuntu-branches/ubuntu/vivid/gimp/vivid

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Jordi Mallach
  • Date: 2012-05-08 18:50:03 UTC
  • mto: (1.1.26) (0.5.1 experimental)
  • mto: This revision was merged to the branch mainline in revision 71.
  • Revision ID: package-import@ubuntu.com-20120508185003-tltkvbaysf8d2426
Import upstream version 2.8.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpmodule/html/GimpModule.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GimpModule</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="GIMP Module Library Reference Manual">
 
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
<link rel="next" href="GimpModuleDB.html" title="GimpModuleDB">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="libgimpmodule.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="libgimpmodule.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">GIMP Module Library Reference Manual</th>
 
21
<td><a accesskey="n" href="GimpModuleDB.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#GimpModule.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#GimpModule.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#GimpModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#GimpModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#GimpModule.signals" class="shortcut">Signals</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="GimpModule"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="GimpModule.top_of_page"></a>GimpModule</span></h2>
 
40
<p>GimpModule — A <span class="type">GTypeModule</span> subclass which implements module
 
41
                    loading using <span class="type">GModule</span>.</p>
 
42
</td>
 
43
<td valign="top" align="right"></td>
 
44
</tr></table></div>
 
45
<div class="refsynopsisdiv">
 
46
<a name="GimpModule.synopsis"></a><h2>Synopsis</h2>
 
47
<pre class="synopsis">                    <a class="link" href="GimpModule.html#GimpModule-struct" title="GimpModule">GimpModule</a>;
 
48
                    <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>;
 
49
enum                <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a>;
 
50
const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> * (<a class="link" href="GimpModule.html#GimpModuleQueryFunc" title="GimpModuleQueryFunc ()">*GimpModuleQueryFunc</a>)           (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>);
 
51
<span class="returnvalue">gboolean</span>            (<a class="link" href="GimpModule.html#GimpModuleRegisterFunc" title="GimpModuleRegisterFunc ()">*GimpModuleRegisterFunc</a>)           (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>);
 
52
#define             <a class="link" href="GimpModule.html#GIMP-MODULE-ERROR:CAPS" title="GIMP_MODULE_ERROR">GIMP_MODULE_ERROR</a>
 
53
enum                <a class="link" href="GimpModule.html#GimpModuleError" title="enum GimpModuleError">GimpModuleError</a>;
 
54
#define             <a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS" title="GIMP_MODULE_ABI_VERSION">GIMP_MODULE_ABI_VERSION</a>
 
55
#define             <a class="link" href="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE:CAPS" title="GIMP_MODULE_PARAM_SERIALIZE">GIMP_MODULE_PARAM_SERIALIZE</a>
 
56
<a class="link" href="GimpModule.html" title="GimpModule"><span class="returnvalue">GimpModule</span></a> *        <a class="link" href="GimpModule.html#gimp-module-new" title="gimp_module_new ()">gimp_module_new</a>                     (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">gboolean</span> load_inhibit</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">gboolean</span> verbose</code></em>);
 
59
<span class="returnvalue">void</span>                <a class="link" href="GimpModule.html#gimp-module-modified" title="gimp_module_modified ()">gimp_module_modified</a>                (<em class="parameter"><code><a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *module</code></em>);
 
60
<span class="returnvalue">gboolean</span>            <a class="link" href="GimpModule.html#gimp-module-query-module" title="gimp_module_query_module ()">gimp_module_query_module</a>            (<em class="parameter"><code><a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *module</code></em>);
 
61
<span class="returnvalue">void</span>                <a class="link" href="GimpModule.html#gimp-module-set-load-inhibit" title="gimp_module_set_load_inhibit ()">gimp_module_set_load_inhibit</a>        (<em class="parameter"><code><a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *module</code></em>,
 
62
                                                         <em class="parameter"><code><span class="type">gboolean</span> load_inhibit</code></em>);
 
63
const <span class="returnvalue">gchar</span> *       <a class="link" href="GimpModule.html#gimp-module-state-name" title="gimp_module_state_name ()">gimp_module_state_name</a>              (<em class="parameter"><code><a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a> state</code></em>);
 
64
<span class="returnvalue">GType</span>               <a class="link" href="GimpModule.html#gimp-module-register-enum" title="gimp_module_register_enum ()">gimp_module_register_enum</a>           (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>,
 
65
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
66
                                                         <em class="parameter"><code>const <span class="type">GEnumValue</span> *const_static_values</code></em>);
 
67
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> *    <a class="link" href="GimpModule.html#gimp-module-info-new" title="gimp_module_info_new ()">gimp_module_info_new</a>                (<em class="parameter"><code><span class="type">guint32</span> abi_version</code></em>,
 
68
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *purpose</code></em>,
 
69
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *author</code></em>,
 
70
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *version</code></em>,
 
71
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *copyright</code></em>,
 
72
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *date</code></em>);
 
73
<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> *    <a class="link" href="GimpModule.html#gimp-module-info-copy" title="gimp_module_info_copy ()">gimp_module_info_copy</a>               (<em class="parameter"><code>const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> *info</code></em>);
 
74
<span class="returnvalue">void</span>                <a class="link" href="GimpModule.html#gimp-module-info-free" title="gimp_module_info_free ()">gimp_module_info_free</a>               (<em class="parameter"><code><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> *info</code></em>);
 
75
<span class="returnvalue">GQuark</span>              <a class="link" href="GimpModule.html#gimp-module-error-quark" title="gimp_module_error_quark ()">gimp_module_error_quark</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
76
</pre>
 
77
</div>
 
78
<div class="refsect1">
 
79
<a name="GimpModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
80
<pre class="synopsis">
 
81
  GObject
 
82
   +----GTypeModule
 
83
         +----GimpModule
 
84
</pre>
 
85
</div>
 
86
<div class="refsect1">
 
87
<a name="GimpModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
88
<p>
 
89
GimpModule implements
 
90
 GTypePlugin.</p>
 
91
</div>
 
92
<div class="refsect1">
 
93
<a name="GimpModule.signals"></a><h2>Signals</h2>
 
94
<pre class="synopsis">
 
95
  "<a class="link" href="GimpModule.html#GimpModule-modified" title='The "modified" signal'>modified</a>"                                       : <code class="literal">Run First</code>
 
96
</pre>
 
97
</div>
 
98
<div class="refsect1">
 
99
<a name="GimpModule.description"></a><h2>Description</h2>
 
100
<p>
 
101
A <span class="type">GTypeModule</span> subclass which implements module loading using <span class="type">GModule</span>.
 
102
</p>
 
103
</div>
 
104
<div class="refsect1">
 
105
<a name="GimpModule.details"></a><h2>Details</h2>
 
106
<div class="refsect2">
 
107
<a name="GimpModule-struct"></a><h3>GimpModule</h3>
 
108
<pre class="programlisting">typedef struct {
 
109
  gchar           *filename;     /* path to the module                       */
 
110
  gboolean         verbose;      /* verbose error reporting                  */
 
111
  GimpModuleState  state;        /* what's happened to the module            */
 
112
  gboolean         on_disk;      /* TRUE if file still exists                */
 
113
  gboolean         load_inhibit; /* user requests not to load at boot time   */
 
114
 
 
115
  /* stuff from now on may be NULL depending on the state the module is in   */
 
116
  GimpModuleInfo  *info;         /* returned values from module_query        */
 
117
  gchar           *last_module_error;
 
118
} GimpModule;
 
119
</pre>
 
120
<p>
 
121
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> is a generic mechanism to dynamically load modules into
 
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
 
124
implemented by the modules, it just provides a framework to get
 
125
arbitrary <span class="type">GType</span> implementations loaded from disk.
 
126
</p>
 
127
</div>
 
128
<hr>
 
129
<div class="refsect2">
 
130
<a name="GimpModuleInfo"></a><h3>GimpModuleInfo</h3>
 
131
<pre class="programlisting">typedef struct {
 
132
  guint32  abi_version;
 
133
  gchar   *purpose;
 
134
  gchar   *author;
 
135
  gchar   *version;
 
136
  gchar   *copyright;
 
137
  gchar   *date;
 
138
} GimpModuleInfo;
 
139
</pre>
 
140
<p>
 
141
This structure contains information about a loadable module.
 
142
</p>
 
143
<div class="variablelist"><table border="0">
 
144
<col align="left" valign="top">
 
145
<tbody>
 
146
<tr>
 
147
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GimpModuleInfo.abi-version"></a>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.</td>
 
149
</tr>
 
150
<tr>
 
151
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.purpose"></a>purpose</code></em>;</span></p></td>
 
152
<td>The module's general purpose.</td>
 
153
</tr>
 
154
<tr>
 
155
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.author"></a>author</code></em>;</span></p></td>
 
156
<td>The module's author.</td>
 
157
</tr>
 
158
<tr>
 
159
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.version"></a>version</code></em>;</span></p></td>
 
160
<td>The module's version.</td>
 
161
</tr>
 
162
<tr>
 
163
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.copyright"></a>copyright</code></em>;</span></p></td>
 
164
<td>The module's copyright.</td>
 
165
</tr>
 
166
<tr>
 
167
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.date"></a>date</code></em>;</span></p></td>
 
168
<td>The module's release date.</td>
 
169
</tr>
 
170
</tbody>
 
171
</table></div>
 
172
</div>
 
173
<hr>
 
174
<div class="refsect2">
 
175
<a name="GimpModuleState"></a><h3>enum GimpModuleState</h3>
 
176
<pre class="programlisting">typedef enum {
 
177
  GIMP_MODULE_STATE_ERROR,
 
178
  GIMP_MODULE_STATE_LOADED,
 
179
  GIMP_MODULE_STATE_LOAD_FAILED,
 
180
  GIMP_MODULE_STATE_NOT_LOADED
 
181
} GimpModuleState;
 
182
</pre>
 
183
<p>
 
184
The possible states a <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> can be in.
 
185
</p>
 
186
<div class="variablelist"><table border="0">
 
187
<col align="left" valign="top">
 
188
<tbody>
 
189
<tr>
 
190
<td><p><a name="GIMP-MODULE-STATE-ERROR:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_ERROR</code></span></p></td>
 
191
<td>Missing <code class="function">gimp_module_register()</code> function
 
192
                                or other error.
 
193
</td>
 
194
</tr>
 
195
<tr>
 
196
<td><p><a name="GIMP-MODULE-STATE-LOADED:CAPS"></a><span class="term"><code class="literal">GIMP_MODULE_STATE_LOADED</code></span></p></td>
 
197
<td>An instance of a type implemented by
 
198
                                this module is allocated.
 
199
</td>
 
200
</tr>
 
201
<tr>
 
202
<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>
 
203
<td>gimp_module_register() returned <code class="literal">FALSE</code>.
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<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>
 
208
<td>There are no instances allocated of
 
209
                                types implemented by this module.
 
210
</td>
 
211
</tr>
 
212
</tbody>
 
213
</table></div>
 
214
</div>
 
215
<hr>
 
216
<div class="refsect2">
 
217
<a name="GimpModuleQueryFunc"></a><h3>GimpModuleQueryFunc ()</h3>
 
218
<pre class="programlisting">const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> * (*GimpModuleQueryFunc)           (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>);</pre>
 
219
<p>
 
220
The signature of the query function a loadable GIMP module must
 
221
implement.  In the module, the function must be called
 
222
<code class="function">gimp_module_query()</code>.
 
223
</p>
 
224
<p>
 
225
<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
 
226
module doesn't need to keep these values around (however in most
 
227
cases the module will just return a pointer to a constant
 
228
structure).
 
229
</p>
 
230
<div class="variablelist"><table border="0">
 
231
<col align="left" valign="top">
 
232
<tbody>
 
233
<tr>
 
234
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
 
235
<td>The <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> responsible for this loadable module.</td>
 
236
</tr>
 
237
<tr>
 
238
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
239
<td>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct describing the module.</td>
 
240
</tr>
 
241
</tbody>
 
242
</table></div>
 
243
</div>
 
244
<hr>
 
245
<div class="refsect2">
 
246
<a name="GimpModuleRegisterFunc"></a><h3>GimpModuleRegisterFunc ()</h3>
 
247
<pre class="programlisting"><span class="returnvalue">gboolean</span>            (*GimpModuleRegisterFunc)           (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>);</pre>
 
248
<p>
 
249
The signature of the register function a loadable GIMP module must
 
250
implement.  In the module, the function must be called
 
251
<code class="function">gimp_module_register()</code>.
 
252
</p>
 
253
<p>
 
254
When this function is called, the module should register all the types
 
255
it implements with the passed <em class="parameter"><code>module</code></em>.
 
256
</p>
 
257
<div class="variablelist"><table border="0">
 
258
<col align="left" valign="top">
 
259
<tbody>
 
260
<tr>
 
261
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
 
262
<td>The <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> responsible for this loadable module.</td>
 
263
</tr>
 
264
<tr>
 
265
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
266
<td>
 
267
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.</td>
 
268
</tr>
 
269
</tbody>
 
270
</table></div>
 
271
</div>
 
272
<hr>
 
273
<div class="refsect2">
 
274
<a name="GIMP-MODULE-ERROR:CAPS"></a><h3>GIMP_MODULE_ERROR</h3>
 
275
<pre class="programlisting">#define GIMP_MODULE_ERROR (gimp_module_error_quark ())
 
276
</pre>
 
277
<p>
 
278
</p>
 
279
</div>
 
280
<hr>
 
281
<div class="refsect2">
 
282
<a name="GimpModuleError"></a><h3>enum GimpModuleError</h3>
 
283
<pre class="programlisting">typedef enum {
 
284
  GIMP_MODULE_FAILED             /* generic error condition */
 
285
} GimpModuleError;
 
286
</pre>
 
287
<p>
 
288
</p>
 
289
</div>
 
290
<hr>
 
291
<div class="refsect2">
 
292
<a name="GIMP-MODULE-ABI-VERSION:CAPS"></a><h3>GIMP_MODULE_ABI_VERSION</h3>
 
293
<pre class="programlisting">#define GIMP_MODULE_ABI_VERSION 0x0004
 
294
</pre>
 
295
<p>
 
296
The version of the module system's ABI. Modules put this value into
 
297
<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
 
298
can check if it was compiled against the same module ABI the modules
 
299
are compiled against.
 
300
</p>
 
301
<p>
 
302
 GIMP_MODULE_ABI_VERSION is incremented each time one of the
 
303
 following changes:
 
304
</p>
 
305
<p>
 
306
 - the libgimpmodule implementation (if the change affects modules).
 
307
</p>
 
308
<p>
 
309
 - one of the classes implemented by modules (currently <a href="/local/head/share/gtk-doc/html/libgimpwidgets/GimpColorDisplay.html"><span class="type">GimpColorDisplay</span></a>,
 
310
   <a href="/local/head/share/gtk-doc/html/libgimpwidgets/GimpColorSelector.html"><span class="type">GimpColorSelector</span></a> and <a href="/local/head/share/gtk-doc/html/libgimpwidgets/GimpController.html"><span class="type">GimpController</span></a>).
 
311
</p>
 
312
</div>
 
313
<hr>
 
314
<div class="refsect2">
 
315
<a name="GIMP-MODULE-PARAM-SERIALIZE:CAPS"></a><h3>GIMP_MODULE_PARAM_SERIALIZE</h3>
 
316
<pre class="programlisting">#define GIMP_MODULE_PARAM_SERIALIZE (1 &lt;&lt; (0 + G_PARAM_USER_SHIFT))
 
317
</pre>
 
318
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
319
<h3 class="title">Warning</h3>
 
320
<p><code class="literal">GIMP_MODULE_PARAM_SERIALIZE</code> is deprecated and should not be used in newly-written code.</p>
 
321
</div>
 
322
<p>
 
323
</p>
 
324
</div>
 
325
<hr>
 
326
<div class="refsect2">
 
327
<a name="gimp-module-new"></a><h3>gimp_module_new ()</h3>
 
328
<pre class="programlisting"><a class="link" href="GimpModule.html" title="GimpModule"><span class="returnvalue">GimpModule</span></a> *        gimp_module_new                     (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
 
329
                                                         <em class="parameter"><code><span class="type">gboolean</span> load_inhibit</code></em>,
 
330
                                                         <em class="parameter"><code><span class="type">gboolean</span> verbose</code></em>);</pre>
 
331
<p>
 
332
Creates a new <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instance.
 
333
</p>
 
334
<div class="variablelist"><table border="0">
 
335
<col align="left" valign="top">
 
336
<tbody>
 
337
<tr>
 
338
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 
339
<td>The filename of a loadable module.</td>
 
340
</tr>
 
341
<tr>
 
342
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></p></td>
 
343
<td>Pass <code class="literal">TRUE</code> to exclude this module from auto-loading.</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.</td>
 
348
</tr>
 
349
<tr>
 
350
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
351
<td>The new <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> object.</td>
 
352
</tr>
 
353
</tbody>
 
354
</table></div>
 
355
</div>
 
356
<hr>
 
357
<div class="refsect2">
 
358
<a name="gimp-module-modified"></a><h3>gimp_module_modified ()</h3>
 
359
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_module_modified                (<em class="parameter"><code><a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *module</code></em>);</pre>
 
360
<p>
 
361
Emits the "modified" signal. Call it whenever you have modified the module
 
362
manually (which you shouldn't do).
 
363
</p>
 
364
<div class="variablelist"><table border="0">
 
365
<col align="left" valign="top">
 
366
<tbody><tr>
 
367
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
 
368
<td>A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.</td>
 
369
</tr></tbody>
 
370
</table></div>
 
371
</div>
 
372
<hr>
 
373
<div class="refsect2">
 
374
<a name="gimp-module-query-module"></a><h3>gimp_module_query_module ()</h3>
 
375
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_module_query_module            (<em class="parameter"><code><a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *module</code></em>);</pre>
 
376
<p>
 
377
Queries the module without actually registering any of the types it
 
378
may implement. After successful query, the <em class="parameter"><code>info</code></em> field of the
 
379
<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> struct will be available for further inspection.
 
380
</p>
 
381
<div class="variablelist"><table border="0">
 
382
<col align="left" valign="top">
 
383
<tbody>
 
384
<tr>
 
385
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
 
386
<td>A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.</td>
 
387
</tr>
 
388
<tr>
 
389
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
390
<td>
 
391
<code class="literal">TRUE</code> on success.</td>
 
392
</tr>
 
393
</tbody>
 
394
</table></div>
 
395
</div>
 
396
<hr>
 
397
<div class="refsect2">
 
398
<a name="gimp-module-set-load-inhibit"></a><h3>gimp_module_set_load_inhibit ()</h3>
 
399
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_module_set_load_inhibit        (<em class="parameter"><code><a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *module</code></em>,
 
400
                                                         <em class="parameter"><code><span class="type">gboolean</span> load_inhibit</code></em>);</pre>
 
401
<p>
 
402
Sets the <em class="parameter"><code>load_inhibit</code></em> property if the module. Emits "modified".
 
403
</p>
 
404
<div class="variablelist"><table border="0">
 
405
<col align="left" valign="top">
 
406
<tbody>
 
407
<tr>
 
408
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
 
409
<td>A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.</td>
 
410
</tr>
 
411
<tr>
 
412
<td><p><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></p></td>
 
413
<td>Pass <code class="literal">TRUE</code> to exclude this module from auto-loading.</td>
 
414
</tr>
 
415
</tbody>
 
416
</table></div>
 
417
</div>
 
418
<hr>
 
419
<div class="refsect2">
 
420
<a name="gimp-module-state-name"></a><h3>gimp_module_state_name ()</h3>
 
421
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       gimp_module_state_name              (<em class="parameter"><code><a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a> state</code></em>);</pre>
 
422
<p>
 
423
Returns the translated textual representation of a <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a>.
 
424
The returned string must not be freed.
 
425
</p>
 
426
<div class="variablelist"><table border="0">
 
427
<col align="left" valign="top">
 
428
<tbody>
 
429
<tr>
 
430
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 
431
<td>A <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a>.</td>
 
432
</tr>
 
433
<tr>
 
434
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
435
<td>The <em class="parameter"><code>state</code></em>'s name.</td>
 
436
</tr>
 
437
</tbody>
 
438
</table></div>
 
439
</div>
 
440
<hr>
 
441
<div class="refsect2">
 
442
<a name="gimp-module-register-enum"></a><h3>gimp_module_register_enum ()</h3>
 
443
<pre class="programlisting"><span class="returnvalue">GType</span>               gimp_module_register_enum           (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>,
 
444
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
445
                                                         <em class="parameter"><code>const <span class="type">GEnumValue</span> *const_static_values</code></em>);</pre>
 
446
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
447
<h3 class="title">Warning</h3>
 
448
<p><code class="literal">gimp_module_register_enum</code> is deprecated and should not be used in newly-written code.</p>
 
449
</div>
 
450
<p>
 
451
This function is deprecated! Use <code class="function">g_type_module_register_enum()</code> instead.
 
452
</p>
 
453
<div class="variablelist"><table border="0">
 
454
<col align="left" valign="top">
 
455
<tbody>
 
456
<tr>
 
457
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
 
458
<td>a module</td>
 
459
</tr>
 
460
<tr>
 
461
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
462
<td>the name of the new enum type</td>
 
463
</tr>
 
464
<tr>
 
465
<td><p><span class="term"><em class="parameter"><code>const_static_values</code></em> :</span></p></td>
 
466
<td>the enum values</td>
 
467
</tr>
 
468
<tr>
 
469
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
470
<td>a new enum <span class="type">GType</span>
 
471
</td>
 
472
</tr>
 
473
</tbody>
 
474
</table></div>
 
475
</div>
 
476
<hr>
 
477
<div class="refsect2">
 
478
<a name="gimp-module-info-new"></a><h3>gimp_module_info_new ()</h3>
 
479
<pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> *    gimp_module_info_new                (<em class="parameter"><code><span class="type">guint32</span> abi_version</code></em>,
 
480
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *purpose</code></em>,
 
481
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *author</code></em>,
 
482
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *version</code></em>,
 
483
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *copyright</code></em>,
 
484
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *date</code></em>);</pre>
 
485
<p>
 
486
Creates a newly allocated <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.
 
487
</p>
 
488
<div class="variablelist"><table border="0">
 
489
<col align="left" valign="top">
 
490
<tbody>
 
491
<tr>
 
492
<td><p><span class="term"><em class="parameter"><code>abi_version</code></em> :</span></p></td>
 
493
<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.</td>
 
494
</tr>
 
495
<tr>
 
496
<td><p><span class="term"><em class="parameter"><code>purpose</code></em> :</span></p></td>
 
497
<td>The module's general purpose.</td>
 
498
</tr>
 
499
<tr>
 
500
<td><p><span class="term"><em class="parameter"><code>author</code></em> :</span></p></td>
 
501
<td>The module's author.</td>
 
502
</tr>
 
503
<tr>
 
504
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
 
505
<td>The module's version.</td>
 
506
</tr>
 
507
<tr>
 
508
<td><p><span class="term"><em class="parameter"><code>copyright</code></em> :</span></p></td>
 
509
<td>The module's copyright.</td>
 
510
</tr>
 
511
<tr>
 
512
<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
 
513
<td>The module's release date.</td>
 
514
</tr>
 
515
<tr>
 
516
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
517
<td>The new <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</td>
 
518
</tr>
 
519
</tbody>
 
520
</table></div>
 
521
</div>
 
522
<hr>
 
523
<div class="refsect2">
 
524
<a name="gimp-module-info-copy"></a><h3>gimp_module_info_copy ()</h3>
 
525
<pre class="programlisting"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> *    gimp_module_info_copy               (<em class="parameter"><code>const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> *info</code></em>);</pre>
 
526
<p>
 
527
Copies a <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.
 
528
</p>
 
529
<div class="variablelist"><table border="0">
 
530
<col align="left" valign="top">
 
531
<tbody>
 
532
<tr>
 
533
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
534
<td>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to copy.</td>
 
535
</tr>
 
536
<tr>
 
537
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
538
<td>The new copy.</td>
 
539
</tr>
 
540
</tbody>
 
541
</table></div>
 
542
</div>
 
543
<hr>
 
544
<div class="refsect2">
 
545
<a name="gimp-module-info-free"></a><h3>gimp_module_info_free ()</h3>
 
546
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_module_info_free               (<em class="parameter"><code><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> *info</code></em>);</pre>
 
547
<p>
 
548
Frees the passed <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a>.
 
549
</p>
 
550
<div class="variablelist"><table border="0">
 
551
<col align="left" valign="top">
 
552
<tbody><tr>
 
553
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
554
<td>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to free</td>
 
555
</tr></tbody>
 
556
</table></div>
 
557
</div>
 
558
<hr>
 
559
<div class="refsect2">
 
560
<a name="gimp-module-error-quark"></a><h3>gimp_module_error_quark ()</h3>
 
561
<pre class="programlisting"><span class="returnvalue">GQuark</span>              gimp_module_error_quark             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
562
<p>
 
563
This function is never called directly. Use <a class="link" href="GimpModule.html#GIMP-MODULE-ERROR:CAPS" title="GIMP_MODULE_ERROR"><code class="function">GIMP_MODULE_ERROR()</code></a> instead.
 
564
</p>
 
565
<div class="variablelist"><table border="0">
 
566
<col align="left" valign="top">
 
567
<tbody><tr>
 
568
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
569
<td>the <span class="type">GQuark</span> that defines the GIMP module error domain.</td>
 
570
</tr></tbody>
 
571
</table></div>
 
572
<p class="since">Since GIMP 2.8</p>
 
573
</div>
 
574
</div>
 
575
<div class="refsect1">
 
576
<a name="GimpModule.signal-details"></a><h2>Signal Details</h2>
 
577
<div class="refsect2">
 
578
<a name="GimpModule-modified"></a><h3>The <code class="literal">"modified"</code> signal</h3>
 
579
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *gimpmodule,
 
580
                                                        <span class="type">gpointer</span>    user_data)       : <code class="literal">Run First</code></pre>
 
581
<p>
 
582
</p>
 
583
<div class="variablelist"><table border="0">
 
584
<col align="left" valign="top">
 
585
<tbody>
 
586
<tr>
 
587
<td><p><span class="term"><em class="parameter"><code>gimpmodule</code></em> :</span></p></td>
 
588
<td>the object which received the signal.</td>
 
589
</tr>
 
590
<tr>
 
591
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
592
<td>user data set when the signal handler was connected.</td>
 
593
</tr>
 
594
</tbody>
 
595
</table></div>
 
596
</div>
 
597
</div>
 
598
<div class="refsect1">
 
599
<a name="GimpModule.see-also"></a><h2>See Also</h2>
 
600
<span class="type">GModule</span>, <span class="type">GTypeModule</span>
 
601
</div>
 
602
</div>
 
603
<div class="footer">
 
604
<hr>
 
605
          Generated by GTK-Doc V1.18</div>
 
606
</body>
 
607
</html>
 
 
b'\\ No newline at end of file'