File: GimpModuleDB.html

package info (click to toggle)
gimp 2.2.6-1sarge4
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 97,088 kB
  • ctags: 43,756
  • sloc: ansic: 525,782; xml: 36,543; lisp: 9,851; sh: 9,007; makefile: 7,974; python: 2,622; perl: 2,589; yacc: 520; lex: 334
file content (129 lines) | stat: -rw-r--r-- 15,008 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpModuleDB</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Module Library Reference Manual"><link rel="up" href="libgimpmodule.html" title="PartI.GIMP Module Library"><link rel="prev" href="GimpModule.html" title="GimpModule"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
        .synopsis, .classsynopsis {
            background: #eeeeee;
            border: solid 1px #aaaaaa;
            padding: 0.5em;
        }
        .programlisting {
            background: #eeeeff;
            border: solid 1px #aaaaff;
            padding: 0.5em;
        }
        .variablelist {
            padding: 4px;
            margin-left: 3em;
        }
        .navigation {
            background: #ffeeee;
            border: solid 1px #ffaaaa;
            margin-top: 0.5em;
            margin-bottom: 0.5em;
        }
        .navigation a {
            color: #770000;
        }
        .navigation a:visited {
            color: #550000;
        }
        .navigation .title {
            font-size: 200%;
        }
      </style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" 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></tr></table><div class="refentry" lang="en"><a name="GimpModuleDB"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">GimpModuleDB</span></h2><p>GimpModuleDB &#8212; 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="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">



struct      <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>            (gboolean 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 gchar *load_inhibit);
const gchar* <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 gchar *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 gchar *module_path);

</pre></div><div class="refsect1" lang="en"><a name="id2467447"></a><h2>Object Hierarchy</h2><pre class="synopsis">

  GObject
   +----GimpModuleDB
</pre></div><div class="refsect1" lang="en"><a name="id2467461"></a><h2>Signal Prototypes</h2><pre class="synopsis">

"<a href="GimpModuleDB.html#GimpModuleDB-add">add</a>"       void        user_function      (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
                                            <a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
                                            gpointer user_data);
"<a href="GimpModuleDB.html#GimpModuleDB-module-modified">module-modified</a>"
            void        user_function      (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
                                            <a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
                                            gpointer user_data);
"<a href="GimpModuleDB.html#GimpModuleDB-remove">remove</a>"    void        user_function      (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
                                            <a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
                                            gpointer user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2549979"></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="id2549995"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2550001"></a><h3><a name="GimpModuleDB-struct"></a>struct GimpModuleDB</h3><a class="indexterm" name="id2550009"></a><pre class="programlisting">struct 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="id2550025"></a><h3><a name="gimp-module-db-new"></a>gimp_module_db_new ()</h3><a class="indexterm" name="id2550033"></a><pre class="programlisting"><a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a>* gimp_module_db_new            (gboolean verbose);</pre><p>
Creates a new <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a> instance. The <i class="parameter"><tt>verbose</tt></i> 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"><tt class="function">gimp_module_new()</tt></a>.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>verbose</tt></i>:</span></td><td> Pass <tt class="literal">TRUE</tt> 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="id2494579"></a><h3><a name="gimp-module-db-set-load-inhibit"></a>gimp_module_db_set_load_inhibit ()</h3><a class="indexterm" name="id2494590"></a><pre class="programlisting">void        gimp_module_db_set_load_inhibit (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
                                             const gchar *load_inhibit);</pre><p>
Sets the <i class="parameter"><tt>load_inhibit</tt></i> flag for all <a href="GimpModule.html" title="GimpModule"><span class="type">GimpModule</span></a>'s which are kept
by <i class="parameter"><tt>db</tt></i> (using <a href="GimpModule.html#gimp-module-set-load-inhibit"><tt class="function">gimp_module_set_load_inhibit()</tt></a>).</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>db</tt></i>:</span></td><td>           A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>load_inhibit</tt></i>:</span></td><td> A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of module
               filenames to exclude from auto-loading.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2494679"></a><h3><a name="gimp-module-db-get-load-inhibit"></a>gimp_module_db_get_load_inhibit ()</h3><a class="indexterm" name="id2494690"></a><pre class="programlisting">const gchar* gimp_module_db_get_load_inhibit
                                            (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db);</pre><p>
Return the <span class="type">G_SEARCHPATH_SEPARATOR</span> 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"><i class="parameter"><tt>db</tt></i>:</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 <i class="parameter"><tt>db</tt></i>'s <i class="parameter"><tt>load_inhibit</tt></i> string.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2494760"></a><h3><a name="gimp-module-db-load"></a>gimp_module_db_load ()</h3><a class="indexterm" name="id2494769"></a><pre class="programlisting">void        gimp_module_db_load             (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
                                             const gchar *module_path);</pre><p>
Scans the directories contained in <i class="parameter"><tt>module_path</tt></i> using
<tt class="function">gimp_datafiles_read_directories()</tt> 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"><i class="parameter"><tt>db</tt></i>:</span></td><td>          A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>module_path</tt></i>:</span></td><td> A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of directories
              to load modules from.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2468555"></a><h3><a name="gimp-module-db-refresh"></a>gimp_module_db_refresh ()</h3><a class="indexterm" name="id2468564"></a><pre class="programlisting">void        gimp_module_db_refresh          (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *db,
                                             const gchar *module_path);</pre><p>
Does the same as <a href="GimpModuleDB.html#gimp-module-db-load"><tt class="function">gimp_module_db_load()</tt></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 <span class="type">GTypeModule</span>
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"><i class="parameter"><tt>db</tt></i>:</span></td><td>          A <a href="GimpModuleDB.html" title="GimpModuleDB"><span class="type">GimpModuleDB</span></a>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>module_path</tt></i>:</span></td><td> A <span class="type">G_SEARCHPATH_SEPARATOR</span> delimited list of directories
              to load modules from.
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2468665"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2468670"></a><h3><a name="GimpModuleDB-add"></a>The "add" signal</h3><pre class="programlisting">void        user_function                  (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
                                            <a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
                                            gpointer user_data);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>gimpmoduledb</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</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="id2468744"></a><h3><a name="GimpModuleDB-module-modified"></a>The "module-modified" signal</h3><pre class="programlisting">void        user_function                  (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
                                            <a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
                                            gpointer user_data);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>gimpmoduledb</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</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="id2582289"></a><h3><a name="GimpModuleDB-remove"></a>The "remove" signal</h3><pre class="programlisting">void        user_function                  (<a href="GimpModuleDB.html" title="GimpModuleDB">GimpModuleDB</a> *gimpmoduledb,
                                            <a href="GimpModule.html" title="GimpModule">GimpModule</a> *arg1,
                                            gpointer user_data);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>gimpmoduledb</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="GimpModule.html"><b>&lt;&lt;GimpModule</b></a></td><td align="right"></td></tr></table></body></html>