386 lines
16 KiB
HTML
386 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>GimpModuleDB</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
|
|
<link rel="start" 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="GimpModule.html" title="GimpModule">
|
|
<link rel="next" href="libgimpmodule-index.html" title="Index">
|
|
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimpmodule.html" title="Part I. GIMP Module Library">
|
|
<link rel="index" href="libgimpmodule-index.html" title="Index">
|
|
<link rel="index" href="libgimpmodule-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimpmodule-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimpmodule-index-deprecated.html" title="Index of deprecated symbols">
|
|
</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="GimpModule.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-index.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
|
</tr>
|
|
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2597010" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2594177" class="shortcut">Description</a>
|
|
 | 
|
|
<a href="#id2594114" class="shortcut">Object Hierarchy</a>
|
|
 | 
|
|
<a href="#id2594138" class="shortcut">Signals</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="GimpModuleDB"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2597010"></a><span class="refentrytitle">GimpModuleDB</span>
|
|
</h2>
|
|
<p>GimpModuleDB — Keeps a list of <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a href="GimpModuleDB.html#GimpModuleDB-struct">GimpModuleDB</a>;
|
|
<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* <a href="GimpModuleDB.html#gimp-module-db-new">gimp_module_db_new</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> verbose);
|
|
void <a href="GimpModuleDB.html#gimp-module-db-set-load-inhibit">gimp_module_db_set_load_inhibit</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *load_inhibit);
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* <a href="GimpModuleDB.html#gimp-module-db-get-load-inhibit">gimp_module_db_get_load_inhibit</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);
|
|
void <a href="GimpModuleDB.html#gimp-module-db-load">gimp_module_db_load</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *module_path);
|
|
void <a href="GimpModuleDB.html#gimp-module-db-refresh">gimp_module_db_refresh</a> (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *module_path);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2594114"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
<a
|
|
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
|
|
>GObject</a>
|
|
+----GimpModuleDB
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2594138"></a><h2>Signals</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a href="GimpModuleDB.html#GimpModuleDB-add">add</a>" : Run First
|
|
"<a href="GimpModuleDB.html#GimpModuleDB-module-modified">module-modified</a>" : Run First
|
|
"<a href="GimpModuleDB.html#GimpModuleDB-remove">remove</a>" : Run First
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2594177"></a><h2>Description</h2>
|
|
<p>
|
|
Keeps a list of <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s found in a given searchpath.
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2594200"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2594211"></a><h3>
|
|
<a name="GimpModuleDB-struct"></a>GimpModuleDB</h3>
|
|
<a class="indexterm" name="id2594223"></a><pre class="programlisting">typedef struct _GimpModuleDB GimpModuleDB;</pre>
|
|
<p>
|
|
The <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> struct contains no public members.
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2566754"></a><h3>
|
|
<a name="gimp-module-db-new"></a>gimp_module_db_new ()</h3>
|
|
<a class="indexterm" name="id2566767"></a><pre class="programlisting"><a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* gimp_module_db_new (<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> verbose);</pre>
|
|
<p>
|
|
Creates a new <a 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 href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a> instances using <a href="GimpModule.html#gimp-module-new"><code class="function">gimp_module_new()</code></a>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>verbose</code></em> :</span></td>
|
|
<td> Pass <a
|
|
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
|
|
><code class="literal">TRUE</code></a> to enable debugging output.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The new <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> instance.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2566874"></a><h3>
|
|
<a name="gimp-module-db-set-load-inhibit"></a>gimp_module_db_set_load_inhibit ()</h3>
|
|
<a class="indexterm" name="id2566885"></a><pre class="programlisting">void gimp_module_db_set_load_inhibit (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *load_inhibit);</pre>
|
|
<p>
|
|
Sets the <em class="parameter"><code>load_inhibit</code></em> flag for all <a 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 href="GimpModule.html#gimp-module-set-load-inhibit"><code class="function">gimp_module_set_load_inhibit()</code></a>).</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>db</code></em> :</span></td>
|
|
<td> A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>load_inhibit</code></em> :</span></td>
|
|
<td> A <a
|
|
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
|
|
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> delimited list of module
|
|
filenames to exclude from auto-loading.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2588773"></a><h3>
|
|
<a name="gimp-module-db-get-load-inhibit"></a>gimp_module_db_get_load_inhibit ()</h3>
|
|
<a class="indexterm" name="id2588786"></a><pre class="programlisting">const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* gimp_module_db_get_load_inhibit (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);</pre>
|
|
<p>
|
|
Return the <a
|
|
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
|
|
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> selimited list of module filenames
|
|
which are excluded from auto-loading.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>db</code></em> :</span></td>
|
|
<td> A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the <em class="parameter"><code>db</code></em>'s <em class="parameter"><code>load_inhibit</code></em> string.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2588876"></a><h3>
|
|
<a name="gimp-module-db-load"></a>gimp_module_db_load ()</h3>
|
|
<a class="indexterm" name="id2588888"></a><pre class="programlisting">void gimp_module_db_load (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *module_path);</pre>
|
|
<p>
|
|
Scans the directories contained in <em class="parameter"><code>module_path</code></em> using
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories"
|
|
><code class="function">gimp_datafiles_read_directories()</code></a> and creates a <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>
|
|
instance for every loadable module contained in the directories.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>db</code></em> :</span></td>
|
|
<td> A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>module_path</code></em> :</span></td>
|
|
<td> A <a
|
|
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
|
|
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> delimited list of directories
|
|
to load modules from.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2588044"></a><h3>
|
|
<a name="gimp-module-db-refresh"></a>gimp_module_db_refresh ()</h3>
|
|
<a class="indexterm" name="id2588055"></a><pre class="programlisting">void gimp_module_db_refresh (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *module_path);</pre>
|
|
<p>
|
|
Does the same as <a href="GimpModuleDB.html#gimp-module-db-load"><code class="function">gimp_module_db_load()</code></a>, plus removes all <a 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 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 <a
|
|
href="../gobject/GTypeModule.html"
|
|
><span class="type">GTypeModule</span></a>
|
|
instances which actually implement types.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>db</code></em> :</span></td>
|
|
<td> A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>module_path</code></em> :</span></td>
|
|
<td> A <a
|
|
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
|
|
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> delimited list of directories
|
|
to load modules from.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2588179"></a><h2>Signal Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2588190"></a><h3>
|
|
<a name="GimpModuleDB-add"></a>The "add" signal</h3>
|
|
<a class="indexterm" name="id2588199"></a><pre class="programlisting">void user_function (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
|
|
<a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gpointer"
|
|
>gpointer</a> user_data) : Run First</pre>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></td>
|
|
<td>the object which received the signal.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
|
|
<td>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
|
|
<td>user data set when the signal handler was connected.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2600365"></a><h3>
|
|
<a name="GimpModuleDB-module-modified"></a>The "module-modified" signal</h3>
|
|
<a class="indexterm" name="id2600374"></a><pre class="programlisting">void user_function (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
|
|
<a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gpointer"
|
|
>gpointer</a> user_data) : Run First</pre>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></td>
|
|
<td>the object which received the signal.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
|
|
<td>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
|
|
<td>user data set when the signal handler was connected.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2600456"></a><h3>
|
|
<a name="GimpModuleDB-remove"></a>The "remove" signal</h3>
|
|
<a class="indexterm" name="id2600463"></a><pre class="programlisting">void user_function (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
|
|
<a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gpointer"
|
|
>gpointer</a> user_data) : Run First</pre>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>gimpmoduledb</code></em> :</span></td>
|
|
<td>the object which received the signal.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
|
|
<td>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
|
|
<td>user data set when the signal handler was connected.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|