1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpModuleDB">
<refmeta>
<refentrytitle>GimpModuleDB</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPMODULE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpModuleDB</refname><refpurpose>Keeps a list of <link linkend="GimpModule"><type>GimpModule</type></link>'s found in a given searchpath.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="GimpModuleDB-struct">GimpModuleDB</link>;
<link linkend="GimpModuleDB">GimpModuleDB</link>* <link linkend="gimp-module-db-new">gimp_module_db_new</link> (<link linkend="gboolean">gboolean</link> verbose);
<link linkend="void">void</link> <link linkend="gimp-module-db-set-load-inhibit">gimp_module_db_set_load_inhibit</link> (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
const <link linkend="gchar">gchar</link> *load_inhibit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-module-db-get-load-inhibit">gimp_module_db_get_load_inhibit</link>
(<link linkend="GimpModuleDB">GimpModuleDB</link> *db);
<link linkend="void">void</link> <link linkend="gimp-module-db-load">gimp_module_db_load</link> (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
const <link linkend="gchar">gchar</link> *module_path);
<link linkend="void">void</link> <link linkend="gimp-module-db-refresh">gimp_module_db_refresh</link> (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
const <link linkend="gchar">gchar</link> *module_path);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GimpModuleDB
</synopsis>
</refsect1>
<refsect1>
<title>Signal Prototypes</title>
<synopsis>
"<link linkend="GimpModuleDB-add">add</link>" <link linkend="void">void</link> user_function (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
<link linkend="GimpModule">GimpModule</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="GimpModuleDB-module-modified">module-modified</link>"
<link linkend="void">void</link> user_function (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
<link linkend="GimpModule">GimpModule</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="GimpModuleDB-remove">remove</link>" <link linkend="void">void</link> user_function (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
<link linkend="GimpModule">GimpModule</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Keeps a list of <link linkend="GimpModule"><type>GimpModule</type></link>'s found in a given searchpath.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpModuleDB-struct"/>GimpModuleDB</title>
<indexterm><primary>GimpModuleDB</primary></indexterm><programlisting>typedef struct _GimpModuleDB GimpModuleDB;</programlisting>
<para>
The <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link> struct contains no public members.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-module-db-new"/>gimp_module_db_new ()</title>
<indexterm><primary>gimp_module_db_new</primary></indexterm><programlisting><link linkend="GimpModuleDB">GimpModuleDB</link>* gimp_module_db_new (<link linkend="gboolean">gboolean</link> verbose);</programlisting>
<para>
Creates a new <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link> instance. The <parameter>verbose</parameter> parameter will be
passed to the created <link linkend="GimpModule"><type>GimpModule</type></link> instances using <link linkend="gimp-module-new"><function>gimp_module_new()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>verbose</parameter> :</term>
<listitem><simpara> Pass <literal>TRUE</literal> to enable debugging output.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link> instance.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-module-db-set-load-inhibit"/>gimp_module_db_set_load_inhibit ()</title>
<indexterm><primary>gimp_module_db_set_load_inhibit</primary></indexterm><programlisting><link linkend="void">void</link> gimp_module_db_set_load_inhibit (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
const <link linkend="gchar">gchar</link> *load_inhibit);</programlisting>
<para>
Sets the <parameter>load_inhibit</parameter> flag for all <link linkend="GimpModule"><type>GimpModule</type></link>'s which are kept
by <parameter>db</parameter> (using <link linkend="gimp-module-set-load-inhibit"><function>gimp_module_set_load_inhibit()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>db</parameter> :</term>
<listitem><simpara> A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>load_inhibit</parameter> :</term>
<listitem><simpara> A <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> delimited list of module
filenames to exclude from auto-loading.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-module-db-get-load-inhibit"/>gimp_module_db_get_load_inhibit ()</title>
<indexterm><primary>gimp_module_db_get_load_inhibit</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_module_db_get_load_inhibit
(<link linkend="GimpModuleDB">GimpModuleDB</link> *db);</programlisting>
<para>
Return the <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> selimited list of module filenames
which are excluded from auto-loading.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>db</parameter> :</term>
<listitem><simpara> A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <parameter>db</parameter>'s <parameter>load_inhibit</parameter> string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-module-db-load"/>gimp_module_db_load ()</title>
<indexterm><primary>gimp_module_db_load</primary></indexterm><programlisting><link linkend="void">void</link> gimp_module_db_load (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
const <link linkend="gchar">gchar</link> *module_path);</programlisting>
<para>
Scans the directories contained in <parameter>module_path</parameter> using
<link linkend="gimp-datafiles-read-directories"><function>gimp_datafiles_read_directories()</function></link> and creates a <link linkend="GimpModule"><type>GimpModule</type></link>
instance for every loadable module contained in the directories.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>db</parameter> :</term>
<listitem><simpara> A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>module_path</parameter> :</term>
<listitem><simpara> A <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> delimited list of directories
to load modules from.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-module-db-refresh"/>gimp_module_db_refresh ()</title>
<indexterm><primary>gimp_module_db_refresh</primary></indexterm><programlisting><link linkend="void">void</link> gimp_module_db_refresh (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
const <link linkend="gchar">gchar</link> *module_path);</programlisting>
<para>
Does the same as <link linkend="gimp-module-db-load"><function>gimp_module_db_load()</function></link>, plus removes all <link linkend="GimpModule"><type>GimpModule</type></link>
instances whose modules have been deleted from disk.
</para>
<para>
Note that the <link linkend="GimpModule"><type>GimpModule</type></link>'s will just be removed from the internal
list and not freed as this is not possible with <link linkend="GTypeModule"><type>GTypeModule</type></link>
instances which actually implement types.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>db</parameter> :</term>
<listitem><simpara> A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>module_path</parameter> :</term>
<listitem><simpara> A <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> delimited list of directories
to load modules from.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2><title><anchor id="GimpModuleDB-add"/>The "add" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
<link linkend="GimpModule">GimpModule</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpmoduledb</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GimpModuleDB-module-modified"/>The "module-modified" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
<link linkend="GimpModule">GimpModule</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpmoduledb</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GimpModuleDB-remove"/>The "remove" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
<link linkend="GimpModule">GimpModule</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpmoduledb</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
