← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpmodule/xml/gimpmoduledb.xml

  • Committer: Package Import Robot
  • Author(s): Ari Pollak
  • Date: 2010-07-08 21:31:29 UTC
  • mto: (0.4.6 sid) (1.1.23)
  • mto: This revision was merged to the branch mainline in revision 53.
  • Revision ID: package-import@ubuntu.com-20100708213129-eq09128jclwhu07x
Import upstream version 2.6.10

Show diffs side-by-side

added added

removed removed

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