diff options
Diffstat (limited to 'devel-docs/libgimpmodule/html')
| -rw-r--r-- | devel-docs/libgimpmodule/html/GimpModule.html | 787 | ||||
| -rw-r--r-- | devel-docs/libgimpmodule/html/GimpModuleDB.html | 339 | ||||
| -rw-r--r-- | devel-docs/libgimpmodule/html/api-index-full.html | 146 | ||||
| -rw-r--r-- | devel-docs/libgimpmodule/html/home.png | bin | 0 -> 256 bytes | |||
| -rw-r--r-- | devel-docs/libgimpmodule/html/index.html | 42 | ||||
| -rw-r--r-- | devel-docs/libgimpmodule/html/left-insensitive.png | bin | 0 -> 395 bytes | |||
| -rw-r--r-- | devel-docs/libgimpmodule/html/left.png | bin | 0 -> 262 bytes | |||
| -rw-r--r-- | devel-docs/libgimpmodule/html/libgimpmodule.devhelp2 | 55 | ||||
| -rw-r--r-- | devel-docs/libgimpmodule/html/pt01.html | 42 | ||||
| -rw-r--r-- | devel-docs/libgimpmodule/html/right-insensitive.png | bin | 0 -> 373 bytes | |||
| -rw-r--r-- | devel-docs/libgimpmodule/html/right.png | bin | 0 -> 261 bytes | |||
| -rw-r--r-- | devel-docs/libgimpmodule/html/style.css | 533 | ||||
| -rw-r--r-- | devel-docs/libgimpmodule/html/up-insensitive.png | bin | 0 -> 374 bytes | |||
| -rw-r--r-- | devel-docs/libgimpmodule/html/up.png | bin | 0 -> 260 bytes |
14 files changed, 1944 insertions, 0 deletions
diff --git a/devel-docs/libgimpmodule/html/GimpModule.html b/devel-docs/libgimpmodule/html/GimpModule.html new file mode 100644 index 0000000..e1fc69c --- /dev/null +++ b/devel-docs/libgimpmodule/html/GimpModule.html @@ -0,0 +1,787 @@ +<!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: GIMP Module Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="up" href="pt01.html" title="Part I. GIMP Module Library"> +<link rel="prev" href="pt01.html" title="Part I. GIMP Module Library"> +<link rel="next" href="GimpModuleDB.html" title="GimpModuleDB"> +<meta name="generator" content="GTK-Doc V1.32 (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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#GimpModule.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GimpModule.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#GimpModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#GimpModule.signals" class="shortcut">Signals</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="pt01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GimpModuleDB.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GimpModule"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="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 class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GimpModule.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type">const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> * +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="GimpModule.html#GimpModuleQueryFunc" title="GimpModuleQueryFunc ()">*GimpModuleQueryFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="GimpModule.html#GimpModuleRegisterFunc" title="GimpModuleRegisterFunc ()">*GimpModuleRegisterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GimpModule.html" title="GimpModule"><span class="returnvalue">GimpModule</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-new" title="gimp_module_new ()">gimp_module_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-modified" title="gimp_module_modified ()">gimp_module_modified</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-query-module" title="gimp_module_query_module ()">gimp_module_query_module</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-set-load-inhibit" title="gimp_module_set_load_inhibit ()">gimp_module_set_load_inhibit</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-state-name" title="gimp_module_state_name ()">gimp_module_state_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GType</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-register-enum" title="gimp_module_register_enum ()">gimp_module_register_enum</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-info-new" title="gimp_module_info_new ()">gimp_module_info_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-info-copy" title="gimp_module_info_copy ()">gimp_module_info_copy</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-info-free" title="gimp_module_info_free ()">gimp_module_info_free</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GQuark</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModule.html#gimp-module-error-quark" title="gimp_module_error_quark ()">gimp_module_error_quark</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpModule.signals"></a><h2>Signals</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="signal_proto_type"> +<col width="300px" class="signal_proto_name"> +<col width="200px" class="signal_proto_flags"> +</colgroup> +<tbody><tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GimpModule.html#GimpModule-modified" title="The “modified” signal">modified</a></td> +<td class="signal_flags">Run First</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpModule.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GimpModule.html#GimpModule-struct" title="GimpModule">GimpModule</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="GimpModule.html#GIMP-MODULE-ERROR:CAPS" title="GIMP_MODULE_ERROR">GIMP_MODULE_ERROR</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="GimpModule.html#GimpModuleError" title="enum GimpModuleError">GimpModuleError</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS" title="GIMP_MODULE_ABI_VERSION">GIMP_MODULE_ABI_VERSION</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE:CAPS" title="GIMP_MODULE_PARAM_SERIALIZE">GIMP_MODULE_PARAM_SERIALIZE</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpModule.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> GTypeModule + <span class="lineart">╰──</span> GimpModule +</pre> +</div> +<div class="refsect1"> +<a name="GimpModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GimpModule implements + GTypePlugin.</p> +</div> +<div class="refsect1"> +<a name="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="GimpModule.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="GimpModuleQueryFunc"></a><h3>GimpModuleQueryFunc ()</h3> +<pre class="programlisting">const <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="returnvalue">GimpModuleInfo</span></a> * +<span class="c_punctuation">(</span>*GimpModuleQueryFunc<span class="c_punctuation">)</span> (<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="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 +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="refsect3"> +<a name="GimpModuleQueryFunc.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>module</p></td> +<td class="parameter_description"><p>The <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> responsible for this loadable module.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="GimpModuleQueryFunc.returns"></a><h4>Returns</h4> +<p>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct describing the module.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpModuleRegisterFunc"></a><h3>GimpModuleRegisterFunc ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +<span class="c_punctuation">(</span>*GimpModuleRegisterFunc<span class="c_punctuation">)</span> (<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="refsect3"> +<a name="GimpModuleRegisterFunc.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>module</p></td> +<td class="parameter_description"><p>The <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> responsible for this loadable module.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="GimpModuleRegisterFunc.returns"></a><h4>Returns</h4> +<p><code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-module-new"></a><h3>gimp_module_new ()</h3> +<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>, + <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="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instance.</p> +<div class="refsect3"> +<a name="gimp-module-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>The filename of a loadable module.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>load_inhibit</p></td> +<td class="parameter_description"><p>Pass <code class="literal">TRUE</code> to exclude this module from auto-loading.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>verbose</p></td> +<td class="parameter_description"><p>Pass <code class="literal">TRUE</code> to enable debugging output.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-new.returns"></a><h4>Returns</h4> +<p> The new <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> object.</p> +</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="GimpModule.html" title="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="refsect3"> +<a name="gimp-module-modified.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>module</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</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="GimpModule.html" title="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="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> struct will be available for further inspection.</p> +<div class="refsect3"> +<a name="gimp-module-query-module.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>module</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-query-module.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> on success.</p> +</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="GimpModule.html" title="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="refsect3"> +<a name="gimp-module-set-load-inhibit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>module</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>load_inhibit</p></td> +<td class="parameter_description"><p>Pass <code class="literal">TRUE</code> to exclude this module from auto-loading.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</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="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="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a>. +The returned string must not be freed.</p> +<div class="refsect3"> +<a name="gimp-module-state-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>state</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState"><span class="type">GimpModuleState</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-state-name.returns"></a><h4>Returns</h4> +<p> The <em class="parameter"><code>state</code></em> +'s name.</p> +</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"><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="refsect3"> +<a name="gimp-module-register-enum.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>module</p></td> +<td class="parameter_description"><p>a module</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>the name of the new enum type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>const_static_values</p></td> +<td class="parameter_description"><p>the enum values</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-register-enum.returns"></a><h4>Returns</h4> +<p> a new enum <span class="type">GType</span></p> +</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="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="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p> +<div class="refsect3"> +<a name="gimp-module-info-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>abi_version</p></td> +<td class="parameter_description"><p>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.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>purpose</p></td> +<td class="parameter_description"><p>The module's general purpose.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>author</p></td> +<td class="parameter_description"><p>The module's author.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>version</p></td> +<td class="parameter_description"><p>The module's version.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>copyright</p></td> +<td class="parameter_description"><p>The module's copyright.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>date</p></td> +<td class="parameter_description"><p>The module's release date.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-info-new.returns"></a><h4>Returns</h4> +<p> The new <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p> +</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="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> +<p>Copies a <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct.</p> +<div class="refsect3"> +<a name="gimp-module-info-copy.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>info</p></td> +<td class="parameter_description"><p>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to copy.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-info-copy.returns"></a><h4>Returns</h4> +<p> The new copy.</p> +</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="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> *info</code></em>);</pre> +<p>Frees the passed <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a>.</p> +<div class="refsect3"> +<a name="gimp-module-info-free.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>info</p></td> +<td class="parameter_description"><p>The <a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo"><span class="type">GimpModuleInfo</span></a> struct to free</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-module-error-quark"></a><h3>gimp_module_error_quark ()</h3> +<pre class="programlisting"><span class="returnvalue">GQuark</span> +gimp_module_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-module-error-quark.returns"></a><h4>Returns</h4> +<p> the <span class="type">GQuark</span> that defines the GIMP module error domain.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +</div> +<div class="refsect1"> +<a name="GimpModule.other_details"></a><h2>Types and Values</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="GimpModule.html" title="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="GimpModule.html" title="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="refsect3"> +<a name="GimpModuleInfo.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GimpModuleInfo.abi-version"></a>abi_version</code></em>;</p></td> +<td class="struct_member_description"><p>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.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.purpose"></a>purpose</code></em>;</p></td> +<td class="struct_member_description"><p>The module's general purpose.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.author"></a>author</code></em>;</p></td> +<td class="struct_member_description"><p>The module's author.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.version"></a>version</code></em>;</p></td> +<td class="struct_member_description"><p>The module's version.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.copyright"></a>copyright</code></em>;</p></td> +<td class="struct_member_description"><p>The module's copyright.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpModuleInfo.date"></a>date</code></em>;</p></td> +<td class="struct_member_description"><p>The module's release date.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpModuleState"></a><h3>enum GimpModuleState</h3> +<p>The possible states a <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> can be in.</p> +<div class="refsect3"> +<a name="GimpModuleState.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="GIMP-MODULE-STATE-ERROR:CAPS"></a>GIMP_MODULE_STATE_ERROR</p></td> +<td class="enum_member_description"> +<p>Missing <code class="function">gimp_module_register()</code> function +or other error.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-MODULE-STATE-LOADED:CAPS"></a>GIMP_MODULE_STATE_LOADED</p></td> +<td class="enum_member_description"> +<p>An instance of a type implemented by +this module is allocated.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-MODULE-STATE-LOAD-FAILED:CAPS"></a>GIMP_MODULE_STATE_LOAD_FAILED</p></td> +<td class="enum_member_description"> +<p>gimp_module_register() returned <code class="literal">FALSE</code>.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-MODULE-STATE-NOT-LOADED:CAPS"></a>GIMP_MODULE_STATE_NOT_LOADED</p></td> +<td class="enum_member_description"> +<p>There are no instances allocated of +types implemented by this module.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GIMP-MODULE-ERROR:CAPS"></a><h3>GIMP_MODULE_ERROR</h3> +<pre class="programlisting">#define GIMP_MODULE_ERROR (gimp_module_error_quark ()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GimpModuleError"></a><h3>enum GimpModuleError</h3> +<p>Types of errors returned by modules</p> +<div class="refsect3"> +<a name="GimpModuleError.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody><tr> +<td class="enum_member_name"><p><a name="GIMP-MODULE-FAILED:CAPS"></a>GIMP_MODULE_FAILED</p></td> +<td class="enum_member_description"> +<p>Generic error condition</p> +</td> +<td class="enum_member_annotations"> </td> +</tr></tbody> +</table></div> +</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="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> +<p> GIMP_MODULE_ABI_VERSION is incremented each time one of the + following changes:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>the libgimpmodule implementation (if the change affects modules).</p></li> +<li class="listitem"><p>one of the classes implemented by modules (currently <a href="/local/head/share/gtk-doc/html/libgimpwidgets3/GimpColorDisplay.html#GimpColorDisplay-struct"><span class="type">GimpColorDisplay</span></a>, +<a href="/local/head/share/gtk-doc/html/libgimpwidgets3/GimpColorSelector.html#GimpColorSelector-struct"><span class="type">GimpColorSelector</span></a> and <a href="/local/head/share/gtk-doc/html/libgimpwidgets3/GimpController.html#GimpController-struct"><span class="type">GimpController</span></a>).</p></li> +</ul></div> +</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"><p><code class="literal">GIMP_MODULE_PARAM_SERIALIZE</code> is deprecated and should not be used in newly-written code.</p></div> +</div> +</div> +<div class="refsect1"> +<a name="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="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *gimpmodule, + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run First</p> +</div> +</div> +<div class="refsect1"> +<a name="GimpModule.see-also"></a><h2>See Also</h2> +<p><span class="type">GModule</span>, <span class="type">GTypeModule</span></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file diff --git a/devel-docs/libgimpmodule/html/GimpModuleDB.html b/devel-docs/libgimpmodule/html/GimpModuleDB.html new file mode 100644 index 0000000..0e0e2b6 --- /dev/null +++ b/devel-docs/libgimpmodule/html/GimpModuleDB.html @@ -0,0 +1,339 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpModuleDB: GIMP Module Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="up" href="pt01.html" title="Part I. GIMP Module Library"> +<link rel="prev" href="GimpModule.html" title="GimpModule"> +<link rel="next" href="api-index-full.html" title="Index"> +<meta name="generator" content="GTK-Doc V1.32 (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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#GimpModuleDB.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GimpModuleDB.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#GimpModuleDB.signals" class="shortcut">Signals</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GimpModule.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GimpModuleDB"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GimpModuleDB.top_of_page"></a>GimpModuleDB</span></h2> +<p>GimpModuleDB — Keeps a list of <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given +searchpath.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GimpModuleDB.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="returnvalue">GimpModuleDB</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GimpModuleDB.html#gimp-module-db-new" title="gimp_module_db_new ()">gimp_module_db_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModuleDB.html#gimp-module-db-set-load-inhibit" title="gimp_module_db_set_load_inhibit ()">gimp_module_db_set_load_inhibit</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpModuleDB.html#gimp-module-db-get-load-inhibit" title="gimp_module_db_get_load_inhibit ()">gimp_module_db_get_load_inhibit</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModuleDB.html#gimp-module-db-load" title="gimp_module_db_load ()">gimp_module_db_load</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpModuleDB.html#gimp-module-db-refresh" title="gimp_module_db_refresh ()">gimp_module_db_refresh</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpModuleDB.signals"></a><h2>Signals</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="signal_proto_type"> +<col width="300px" class="signal_proto_name"> +<col width="200px" class="signal_proto_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-add" title="The “add” signal">add</a></td> +<td class="signal_flags">Run First</td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-module-modified" title="The “module-modified” signal">module-modified</a></td> +<td class="signal_flags">Run First</td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-remove" title="The “remove” signal">remove</a></td> +<td class="signal_flags">Run First</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpModuleDB.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GimpModuleDB.html#GimpModuleDB-struct" title="GimpModuleDB">GimpModuleDB</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpModuleDB.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> GimpModuleDB +</pre> +</div> +<div class="refsect1"> +<a name="GimpModuleDB.description"></a><h2>Description</h2> +<p>Keeps a list of <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.</p> +</div> +<div class="refsect1"> +<a name="GimpModuleDB.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-module-db-new"></a><h3>gimp_module_db_new ()</h3> +<pre class="programlisting"><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="returnvalue">GimpModuleDB</span></a> * +gimp_module_db_new (<em class="parameter"><code><span class="type">gboolean</span> verbose</code></em>);</pre> +<p>Creates a new <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> instance. The <em class="parameter"><code>verbose</code></em> + parameter will be +passed to the created <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instances using <a class="link" href="GimpModule.html#gimp-module-new" title="gimp_module_new ()"><code class="function">gimp_module_new()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-module-db-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>verbose</p></td> +<td class="parameter_description"><p>Pass <code class="literal">TRUE</code> to enable debugging output.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-db-new.returns"></a><h4>Returns</h4> +<p> The new <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> instance.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-module-db-set-load-inhibit"></a><h3>gimp_module_db_set_load_inhibit ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_module_db_set_load_inhibit (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *load_inhibit</code></em>);</pre> +<p>Sets the <em class="parameter"><code>load_inhibit</code></em> + flag for all <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s which are kept +by <em class="parameter"><code>db</code></em> + (using <a class="link" href="GimpModule.html#gimp-module-set-load-inhibit" title="gimp_module_set_load_inhibit ()"><code class="function">gimp_module_set_load_inhibit()</code></a>).</p> +<div class="refsect3"> +<a name="gimp-module-db-set-load-inhibit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>db</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>load_inhibit</p></td> +<td class="parameter_description"><p>A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of module +filenames to exclude from auto-loading.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-module-db-get-load-inhibit"></a><h3>gimp_module_db_get_load_inhibit ()</h3> +<pre class="programlisting">const <span class="returnvalue">gchar</span> * +gimp_module_db_get_load_inhibit (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>);</pre> +<p>Return the <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of module filenames +which are excluded from auto-loading.</p> +<div class="refsect3"> +<a name="gimp-module-db-get-load-inhibit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>db</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-module-db-get-load-inhibit.returns"></a><h4>Returns</h4> +<p> the <em class="parameter"><code>db</code></em> +'s <em class="parameter"><code>load_inhibit</code></em> +string.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-module-db-load"></a><h3>gimp_module_db_load ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_module_db_load (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *module_path</code></em>);</pre> +<p>Scans the directories contained in <em class="parameter"><code>module_path</code></em> + and creates a +<a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instance for every loadable module contained in the +directories.</p> +<div class="refsect3"> +<a name="gimp-module-db-load.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>db</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>module_path</p></td> +<td class="parameter_description"><p>A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of directories +to load modules from.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-module-db-refresh"></a><h3>gimp_module_db_refresh ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_module_db_refresh (<em class="parameter"><code><a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *db</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *module_path</code></em>);</pre> +<p>Does the same as <a class="link" href="GimpModuleDB.html#gimp-module-db-load" title="gimp_module_db_load ()"><code class="function">gimp_module_db_load()</code></a>, plus removes all <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> +instances whose modules have been deleted from disk.</p> +<p>Note that the <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s will just be removed from the internal +list and not freed as this is not possible with <span class="type">GTypeModule</span> +instances which actually implement types.</p> +<div class="refsect3"> +<a name="gimp-module-db-refresh.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>db</p></td> +<td class="parameter_description"><p>A <a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>module_path</p></td> +<td class="parameter_description"><p>A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of directories +to load modules from.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GimpModuleDB.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpModuleDB-struct"></a><h3>GimpModuleDB</h3> +<pre class="programlisting">typedef struct _GimpModuleDB GimpModuleDB;</pre> +</div> +</div> +<div class="refsect1"> +<a name="GimpModuleDB.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="GimpModuleDB-add"></a><h3>The <code class="literal">“add”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *gimpmoduledb, + <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *arg1, + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run First</p> +</div> +<hr> +<div class="refsect2"> +<a name="GimpModuleDB-module-modified"></a><h3>The <code class="literal">“module-modified”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *gimpmoduledb, + <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *arg1, + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run First</p> +</div> +<hr> +<div class="refsect2"> +<a name="GimpModuleDB-remove"></a><h3>The <code class="literal">“remove”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> *gimpmoduledb, + <a class="link" href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> *arg1, + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run First</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file diff --git a/devel-docs/libgimpmodule/html/api-index-full.html b/devel-docs/libgimpmodule/html/api-index-full.html new file mode 100644 index 0000000..74abdc3 --- /dev/null +++ b/devel-docs/libgimpmodule/html/api-index-full.html @@ -0,0 +1,146 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Index: GIMP Module Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="up" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="prev" href="GimpModuleDB.html" title="GimpModuleDB"> +<link rel="next" href="api-index-2-8.html" title="Index of new symbols in GIMP 2.8"> +<meta name="generator" content="GTK-Doc V1.32 (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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"><span id="nav_index"><a class="shortcut" href="#idxM">M</a></span></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="GimpModuleDB.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="api-index-2-8.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="api-index-full"></a>Index</h1></div></div></div> +<a name="idx"></a><a name="idxM"></a><h3 class="title">M</h3> +<dt> +<a class="link" href="GimpModule.html#GimpModule-struct" title="GimpModule">GimpModule</a>, struct in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GimpModule-modified" title="The “modified” signal">GimpModule::modified</a>, object signal in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#GimpModuleDB-struct" title="GimpModuleDB">GimpModuleDB</a>, struct in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#GimpModuleDB-add" title="The “add” signal">GimpModuleDB::add</a>, object signal in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#GimpModuleDB-module-modified" title="The “module-modified” signal">GimpModuleDB::module-modified</a>, object signal in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#GimpModuleDB-remove" title="The “remove” signal">GimpModuleDB::remove</a>, object signal in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GimpModuleError" title="enum GimpModuleError">GimpModuleError</a>, enum in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GimpModuleInfo" title="GimpModuleInfo">GimpModuleInfo</a>, struct in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GimpModuleQueryFunc" title="GimpModuleQueryFunc ()">GimpModuleQueryFunc</a>, user_function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GimpModuleRegisterFunc" title="GimpModuleRegisterFunc ()">GimpModuleRegisterFunc</a>, user_function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GimpModuleState" title="enum GimpModuleState">GimpModuleState</a>, enum in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS" title="GIMP_MODULE_ABI_VERSION">GIMP_MODULE_ABI_VERSION</a>, macro in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#gimp-module-db-get-load-inhibit" title="gimp_module_db_get_load_inhibit ()">gimp_module_db_get_load_inhibit</a>, function in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#gimp-module-db-load" title="gimp_module_db_load ()">gimp_module_db_load</a>, function in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#gimp-module-db-new" title="gimp_module_db_new ()">gimp_module_db_new</a>, function in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#gimp-module-db-refresh" title="gimp_module_db_refresh ()">gimp_module_db_refresh</a>, function in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModuleDB.html#gimp-module-db-set-load-inhibit" title="gimp_module_db_set_load_inhibit ()">gimp_module_db_set_load_inhibit</a>, function in <a class="link" href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GIMP-MODULE-ERROR:CAPS" title="GIMP_MODULE_ERROR">GIMP_MODULE_ERROR</a>, macro in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-error-quark" title="gimp_module_error_quark ()">gimp_module_error_quark</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-info-copy" title="gimp_module_info_copy ()">gimp_module_info_copy</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-info-free" title="gimp_module_info_free ()">gimp_module_info_free</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-info-new" title="gimp_module_info_new ()">gimp_module_info_new</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-modified" title="gimp_module_modified ()">gimp_module_modified</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-new" title="gimp_module_new ()">gimp_module_new</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE:CAPS" title="GIMP_MODULE_PARAM_SERIALIZE">GIMP_MODULE_PARAM_SERIALIZE</a>, macro in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-query-module" title="gimp_module_query_module ()">gimp_module_query_module</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-register-enum" title="gimp_module_register_enum ()">gimp_module_register_enum</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-set-load-inhibit" title="gimp_module_set_load_inhibit ()">gimp_module_set_load_inhibit</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="GimpModule.html#gimp-module-state-name" title="gimp_module_state_name ()">gimp_module_state_name</a>, function in <a class="link" href="GimpModule.html" title="GimpModule">GimpModule</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file diff --git a/devel-docs/libgimpmodule/html/home.png b/devel-docs/libgimpmodule/html/home.png Binary files differnew file mode 100644 index 0000000..bf327ac --- /dev/null +++ b/devel-docs/libgimpmodule/html/home.png diff --git a/devel-docs/libgimpmodule/html/index.html b/devel-docs/libgimpmodule/html/index.html new file mode 100644 index 0000000..407b5c2 --- /dev/null +++ b/devel-docs/libgimpmodule/html/index.html @@ -0,0 +1,42 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GIMP Module Library Reference Manual: GIMP Module Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="next" href="pt01.html" title="Part I. GIMP Module Library"> +<meta name="generator" content="GTK-Doc V1.32 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div lang="en" class="book"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GIMP Module Library Reference Manual</p></th></tr></table></div> +<div><p class="releaseinfo"> + for GIMP 2.10.22 + + </p></div> +</div> +<hr> +</div> +<div class="toc"><dl class="toc"> +<dt><span class="part"><a href="pt01.html">I. GIMP Module Library</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GimpModule.html">GimpModule</a></span><span class="refpurpose"> — A <span class="type">GTypeModule</span> subclass which implements module +loading using <span class="type">GModule</span>.</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GimpModuleDB.html">GimpModuleDB</a></span><span class="refpurpose"> — Keeps a list of <span class="type">GimpModule</span>'s found in a given +searchpath.</span> +</dt> +</dl></dd> +<dt><span class="index"><a href="api-index-full.html">Index</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file diff --git a/devel-docs/libgimpmodule/html/left-insensitive.png b/devel-docs/libgimpmodule/html/left-insensitive.png Binary files differnew file mode 100644 index 0000000..a214ac6 --- /dev/null +++ b/devel-docs/libgimpmodule/html/left-insensitive.png diff --git a/devel-docs/libgimpmodule/html/left.png b/devel-docs/libgimpmodule/html/left.png Binary files differnew file mode 100644 index 0000000..c11c1d0 --- /dev/null +++ b/devel-docs/libgimpmodule/html/left.png diff --git a/devel-docs/libgimpmodule/html/libgimpmodule.devhelp2 b/devel-docs/libgimpmodule/html/libgimpmodule.devhelp2 new file mode 100644 index 0000000..1263000 --- /dev/null +++ b/devel-docs/libgimpmodule/html/libgimpmodule.devhelp2 @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<book xmlns="http://www.devhelp.net/book" title="GIMP Module Library Reference Manual" link="index.html" author="" name="libgimpmodule" version="2" language="c"> + <chapters> + <sub name="GIMP Module Library" link="pt01.html"> + <sub name="GimpModule" link="GimpModule.html"/> + <sub name="GimpModuleDB" link="GimpModuleDB.html"/> + </sub> + <sub name="Index" link="api-index-full.html"/> + <sub name="Index of new symbols in GIMP 2.8" link="api-index-2-8.html"/> + <sub name="Index of new symbols in GIMP 2.10" link="api-index-2-10.html"/> + <sub name="Index of deprecated symbols" link="api-index-deprecated.html"/> + </chapters> + <functions> + <keyword type="function" name="GimpModuleQueryFunc ()" link="GimpModule.html#GimpModuleQueryFunc"/> + <keyword type="function" name="GimpModuleRegisterFunc ()" link="GimpModule.html#GimpModuleRegisterFunc"/> + <keyword type="function" name="gimp_module_new ()" link="GimpModule.html#gimp-module-new"/> + <keyword type="function" name="gimp_module_modified ()" link="GimpModule.html#gimp-module-modified"/> + <keyword type="function" name="gimp_module_query_module ()" link="GimpModule.html#gimp-module-query-module"/> + <keyword type="function" name="gimp_module_set_load_inhibit ()" link="GimpModule.html#gimp-module-set-load-inhibit"/> + <keyword type="function" name="gimp_module_state_name ()" link="GimpModule.html#gimp-module-state-name"/> + <keyword type="function" name="gimp_module_register_enum ()" link="GimpModule.html#gimp-module-register-enum" deprecated=""/> + <keyword type="function" name="gimp_module_info_new ()" link="GimpModule.html#gimp-module-info-new"/> + <keyword type="function" name="gimp_module_info_copy ()" link="GimpModule.html#gimp-module-info-copy"/> + <keyword type="function" name="gimp_module_info_free ()" link="GimpModule.html#gimp-module-info-free"/> + <keyword type="function" name="gimp_module_error_quark ()" link="GimpModule.html#gimp-module-error-quark" since="2.8"/> + <keyword type="struct" name="GimpModule" link="GimpModule.html#GimpModule-struct"/> + <keyword type="struct" name="GimpModuleInfo" link="GimpModule.html#GimpModuleInfo"/> + <keyword type="enum" name="enum GimpModuleState" link="GimpModule.html#GimpModuleState"/> + <keyword type="macro" name="GIMP_MODULE_ERROR" link="GimpModule.html#GIMP-MODULE-ERROR:CAPS"/> + <keyword type="enum" name="enum GimpModuleError" link="GimpModule.html#GimpModuleError"/> + <keyword type="macro" name="GIMP_MODULE_ABI_VERSION" link="GimpModule.html#GIMP-MODULE-ABI-VERSION:CAPS"/> + <keyword type="macro" name="GIMP_MODULE_PARAM_SERIALIZE" link="GimpModule.html#GIMP-MODULE-PARAM-SERIALIZE:CAPS" deprecated=""/> + <keyword type="signal" name="The “modified” signal" link="GimpModule.html#GimpModule-modified"/> + <keyword type="function" name="gimp_module_db_new ()" link="GimpModuleDB.html#gimp-module-db-new"/> + <keyword type="function" name="gimp_module_db_set_load_inhibit ()" link="GimpModuleDB.html#gimp-module-db-set-load-inhibit"/> + <keyword type="function" name="gimp_module_db_get_load_inhibit ()" link="GimpModuleDB.html#gimp-module-db-get-load-inhibit"/> + <keyword type="function" name="gimp_module_db_load ()" link="GimpModuleDB.html#gimp-module-db-load"/> + <keyword type="function" name="gimp_module_db_refresh ()" link="GimpModuleDB.html#gimp-module-db-refresh"/> + <keyword type="struct" name="GimpModuleDB" link="GimpModuleDB.html#GimpModuleDB-struct"/> + <keyword type="signal" name="The “add” signal" link="GimpModuleDB.html#GimpModuleDB-add"/> + <keyword type="signal" name="The “module-modified” signal" link="GimpModuleDB.html#GimpModuleDB-module-modified"/> + <keyword type="signal" name="The “remove” signal" link="GimpModuleDB.html#GimpModuleDB-remove"/> + <keyword type="constant" name="GIMP_MODULE_STATE_ERROR" link="GimpModule.html#GIMP-MODULE-STATE-ERROR:CAPS"/> + <keyword type="constant" name="GIMP_MODULE_STATE_LOADED" link="GimpModule.html#GIMP-MODULE-STATE-LOADED:CAPS"/> + <keyword type="constant" name="GIMP_MODULE_STATE_LOAD_FAILED" link="GimpModule.html#GIMP-MODULE-STATE-LOAD-FAILED:CAPS"/> + <keyword type="constant" name="GIMP_MODULE_STATE_NOT_LOADED" link="GimpModule.html#GIMP-MODULE-STATE-NOT-LOADED:CAPS"/> + <keyword type="constant" name="GIMP_MODULE_FAILED" link="GimpModule.html#GIMP-MODULE-FAILED:CAPS"/> + <keyword type="member" name="GimpModuleInfo.abi-version" link="GimpModule.html#GimpModuleInfo.abi-version"/> + <keyword type="member" name="GimpModuleInfo.purpose" link="GimpModule.html#GimpModuleInfo.purpose"/> + <keyword type="member" name="GimpModuleInfo.author" link="GimpModule.html#GimpModuleInfo.author"/> + <keyword type="member" name="GimpModuleInfo.version" link="GimpModule.html#GimpModuleInfo.version"/> + <keyword type="member" name="GimpModuleInfo.copyright" link="GimpModule.html#GimpModuleInfo.copyright"/> + <keyword type="member" name="GimpModuleInfo.date" link="GimpModule.html#GimpModuleInfo.date"/> + </functions> +</book> diff --git a/devel-docs/libgimpmodule/html/pt01.html b/devel-docs/libgimpmodule/html/pt01.html new file mode 100644 index 0000000..bf80f11 --- /dev/null +++ b/devel-docs/libgimpmodule/html/pt01.html @@ -0,0 +1,42 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part I. GIMP Module Library: GIMP Module Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="up" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="prev" href="index.html" title="GIMP Module Library Reference Manual"> +<link rel="next" href="GimpModule.html" title="GimpModule"> +<meta name="generator" content="GTK-Doc V1.32 (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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GimpModule.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="id-1.2"></a>Part I. GIMP Module Library</h1></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl class="toc"> +<dt> +<span class="refentrytitle"><a href="GimpModule.html">GimpModule</a></span><span class="refpurpose"> — A <span class="type">GTypeModule</span> subclass which implements module +loading using <span class="type">GModule</span>.</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GimpModuleDB.html">GimpModuleDB</a></span><span class="refpurpose"> — Keeps a list of <span class="type">GimpModule</span>'s found in a given +searchpath.</span> +</dt> +</dl> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file diff --git a/devel-docs/libgimpmodule/html/right-insensitive.png b/devel-docs/libgimpmodule/html/right-insensitive.png Binary files differnew file mode 100644 index 0000000..e4a5684 --- /dev/null +++ b/devel-docs/libgimpmodule/html/right-insensitive.png diff --git a/devel-docs/libgimpmodule/html/right.png b/devel-docs/libgimpmodule/html/right.png Binary files differnew file mode 100644 index 0000000..2a405d3 --- /dev/null +++ b/devel-docs/libgimpmodule/html/right.png diff --git a/devel-docs/libgimpmodule/html/style.css b/devel-docs/libgimpmodule/html/style.css new file mode 100644 index 0000000..b4a1493 --- /dev/null +++ b/devel-docs/libgimpmodule/html/style.css @@ -0,0 +1,533 @@ +body +{ + font-family: cantarell, sans-serif; +} +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ + background: #e6f3ff; + border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +span.nowrap { + white-space: nowrap; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.informaltable table +{ + border-collapse: separate; + border-spacing: 1em 0.3em; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +td p +{ + margin: 0.25em; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +h4 +{ + color: #555753; + margin-top: 1em; + margin-bottom: 1em; +} + +hr +{ + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; + border: none 0px; + height: 1px; + clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; + font-weight: bold; +} + +dl.toc > dl +{ + padding-bottom: 0.5em; +} + +.parameter +{ + font-style: normal; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + background: rgba(252, 175, 62, 0.1); + border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); + border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); +} +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; + margin: 2em; +} +.note p, .warning p +{ + margin: 0; +} + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-weight: normal; +} + +.structfield +{ + font-style: normal; + font-weight: normal; +} + +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; + background: none; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + +@media screen { + /* these have a <sup> as a first child, but since there are no parent selectors + * we can't use that. */ + a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 2.5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + border-spacing: 5px; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + z-index: 10; + } + table.navigation#top td + { + padding-left: 6px; + padding-right: 6px; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } + .navigation .title + { + font-size: 80%; + max-width: none; + margin: 0px; + font-weight: normal; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } + .listing_lines { display: none; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.hll { background-color: #ffffcc } +.c { color: #408080; font-style: italic } /* Comment */ +.err { border: 1px solid #FF0000 } /* Error */ +.k { color: #008000; font-weight: bold } /* Keyword */ +.o { color: #666666 } /* Operator */ +.ch { color: #408080; font-style: italic } /* Comment.Hashbang */ +.cm { color: #408080; font-style: italic } /* Comment.Multiline */ +.cp { color: #BC7A00 } /* Comment.Preproc */ +.cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ +.c1 { color: #408080; font-style: italic } /* Comment.Single */ +.cs { color: #408080; font-style: italic } /* Comment.Special */ +.gd { color: #A00000 } /* Generic.Deleted */ +.ge { font-style: italic } /* Generic.Emph */ +.gr { color: #FF0000 } /* Generic.Error */ +.gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.gi { color: #00A000 } /* Generic.Inserted */ +.go { color: #888888 } /* Generic.Output */ +.gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.gs { font-weight: bold } /* Generic.Strong */ +.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.gt { color: #0044DD } /* Generic.Traceback */ +.kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.kp { color: #008000 } /* Keyword.Pseudo */ +.kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.kt { color: #B00040 } /* Keyword.Type */ +.m { color: #666666 } /* Literal.Number */ +.s { color: #BA2121 } /* Literal.String */ +.na { color: #7D9029 } /* Name.Attribute */ +.nb { color: #008000 } /* Name.Builtin */ +.nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.no { color: #880000 } /* Name.Constant */ +.nd { color: #AA22FF } /* Name.Decorator */ +.ni { color: #999999; font-weight: bold } /* Name.Entity */ +.ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +.nf { color: #0000FF } /* Name.Function */ +.nl { color: #A0A000 } /* Name.Label */ +.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.nt { color: #008000; font-weight: bold } /* Name.Tag */ +.nv { color: #19177C } /* Name.Variable */ +.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.w { color: #bbbbbb } /* Text.Whitespace */ +.mb { color: #666666 } /* Literal.Number.Bin */ +.mf { color: #666666 } /* Literal.Number.Float */ +.mh { color: #666666 } /* Literal.Number.Hex */ +.mi { color: #666666 } /* Literal.Number.Integer */ +.mo { color: #666666 } /* Literal.Number.Oct */ +.sa { color: #BA2121 } /* Literal.String.Affix */ +.sb { color: #BA2121 } /* Literal.String.Backtick */ +.sc { color: #BA2121 } /* Literal.String.Char */ +.dl { color: #BA2121 } /* Literal.String.Delimiter */ +.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.s2 { color: #BA2121 } /* Literal.String.Double */ +.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +.sh { color: #BA2121 } /* Literal.String.Heredoc */ +.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +.sx { color: #008000 } /* Literal.String.Other */ +.sr { color: #BB6688 } /* Literal.String.Regex */ +.s1 { color: #BA2121 } /* Literal.String.Single */ +.ss { color: #19177C } /* Literal.String.Symbol */ +.bp { color: #008000 } /* Name.Builtin.Pseudo */ +.fm { color: #0000FF } /* Name.Function.Magic */ +.vc { color: #19177C } /* Name.Variable.Class */ +.vg { color: #19177C } /* Name.Variable.Global */ +.vi { color: #19177C } /* Name.Variable.Instance */ +.vm { color: #19177C } /* Name.Variable.Magic */ +.il { color: #666666 } /* Literal.Number.Integer.Long */
\ No newline at end of file diff --git a/devel-docs/libgimpmodule/html/up-insensitive.png b/devel-docs/libgimpmodule/html/up-insensitive.png Binary files differnew file mode 100644 index 0000000..b159d01 --- /dev/null +++ b/devel-docs/libgimpmodule/html/up-insensitive.png diff --git a/devel-docs/libgimpmodule/html/up.png b/devel-docs/libgimpmodule/html/up.png Binary files differnew file mode 100644 index 0000000..8fad884 --- /dev/null +++ b/devel-docs/libgimpmodule/html/up.png |
