← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-security

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

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