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