← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-31 10:24:10 UTC
  • mfrom: (1.1.21 upstream) (0.1.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090831102410-eqawgw6fhdyi91ee
Tags: 2.6.7-1ubuntu1
https://launchpad.net/bugs/419593
* Merge with Debian unstable (LP: #419593), remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + updated some strings for ubuntu
  - debian/rules:
    + updated translation templates
  - debian/control:
    + Drop webkit build dependency. gimp is the only thing pulling in webkit
      for the desktop CDs, and makes them explode. Without the webkit help
      browser plugin, help will just be displayed in the default browser.
* debian/patches/01_debian-gimprc.patch:
  - Updated
* debian/control:
  - Added a BZR link

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpmodule/xml/gimpmoduledb.xml
12
12
<refnamediv>
13
13
<refname>GimpModuleDB</refname>
14
14
<refpurpose>Keeps a list of <link linkend="GimpModule"><type>GimpModule</type></link>'s found in a given searchpath.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpModuleDB.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpModuleDB-struct">GimpModuleDB</link>;
23
 
<link linkend="GimpModuleDB">GimpModuleDB</link>*       <link linkend="gimp-module-db-new">gimp_module_db_new</link>                  (<link linkend="gboolean">gboolean</link> verbose);
 
22
<link linkend="GimpModuleDB">GimpModuleDB</link> *      <link linkend="gimp-module-db-new">gimp_module_db_new</link>                  (<link linkend="gboolean">gboolean</link> verbose);
24
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,
25
24
                                                         const <link linkend="gchar">gchar</link> *load_inhibit);
26
 
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);
 
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);
27
26
<link linkend="void">void</link>                <link linkend="gimp-module-db-load">gimp_module_db_load</link>                 (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
28
27
                                                         const <link linkend="gchar">gchar</link> *module_path);
29
28
<link linkend="void">void</link>                <link linkend="gimp-module-db-refresh">gimp_module_db_refresh</link>              (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
37
36
  <link linkend="GObject">GObject</link>
38
37
   +----GimpModuleDB
39
38
</synopsis>
40
 
 
41
39
</refsect1>
42
40
 
43
41
 
66
64
<title role="details.title">Details</title>
67
65
<refsect2 id="GimpModuleDB-struct" role="struct">
68
66
<title>GimpModuleDB</title>
69
 
<indexterm zone="GimpModuleDB-struct"><primary>GimpModuleDB</primary></indexterm><programlisting>typedef struct _GimpModuleDB GimpModuleDB;</programlisting>
 
67
<indexterm zone="GimpModuleDB-struct"><primary sortas="GimpModuleDB">GimpModuleDB</primary></indexterm><programlisting>typedef struct _GimpModuleDB GimpModuleDB;</programlisting>
70
68
<para>
71
69
The <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link> struct contains no public members.
72
70
</para></refsect2>
73
71
<refsect2 id="gimp-module-db-new" role="function">
74
72
<title>gimp_module_db_new ()</title>
75
 
<indexterm zone="gimp-module-db-new"><primary>gimp_module_db_new</primary></indexterm><programlisting><link linkend="GimpModuleDB">GimpModuleDB</link>*       gimp_module_db_new                  (<link linkend="gboolean">gboolean</link> verbose);</programlisting>
 
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>
76
74
<para>
77
75
Creates a new <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link> instance. The <parameter>verbose</parameter> parameter will be
78
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>
79
77
<para>
80
 
 
81
78
</para><variablelist role="params">
82
 
<varlistentry><term><parameter>verbose</parameter>&nbsp;:</term>
83
 
<listitem><simpara> Pass <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to enable debugging output.
 
79
<varlistentry><term><parameter>verbose</parameter>&#160;:</term>
 
80
<listitem><simpara> Pass <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to enable debugging output.
84
81
</simpara></listitem></varlistentry>
85
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link> instance.
 
82
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The new <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link> instance.
86
83
</simpara></listitem></varlistentry>
87
84
</variablelist></refsect2>
88
85
<refsect2 id="gimp-module-db-set-load-inhibit" role="function">
89
86
<title>gimp_module_db_set_load_inhibit ()</title>
90
 
<indexterm zone="gimp-module-db-set-load-inhibit"><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,
 
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,
91
88
                                                         const <link linkend="gchar">gchar</link> *load_inhibit);</programlisting>
92
89
<para>
93
90
Sets the <parameter>load_inhibit</parameter> flag for all <link linkend="GimpModule"><type>GimpModule</type></link>'s which are kept
94
91
by <parameter>db</parameter> (using <link linkend="gimp-module-set-load-inhibit"><function>gimp_module_set_load_inhibit()</function></link>).</para>
95
92
<para>
96
 
 
97
93
</para><variablelist role="params">
98
 
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
94
<varlistentry><term><parameter>db</parameter>&#160;:</term>
99
95
<listitem><simpara>           A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
100
96
</simpara></listitem></varlistentry>
101
 
<varlistentry><term><parameter>load_inhibit</parameter>&nbsp;:</term>
102
 
<listitem><simpara> A <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> delimited list of module
 
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
103
99
               filenames to exclude from auto-loading.
104
100
</simpara></listitem></varlistentry>
105
101
</variablelist></refsect2>
106
102
<refsect2 id="gimp-module-db-get-load-inhibit" role="function">
107
103
<title>gimp_module_db_get_load_inhibit ()</title>
108
 
<indexterm zone="gimp-module-db-get-load-inhibit"><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>
 
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>
109
105
<para>
110
 
Return the <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> selimited list of module filenames
 
106
Return the <link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> selimited list of module filenames
111
107
which are excluded from auto-loading.</para>
112
108
<para>
113
 
 
114
109
</para><variablelist role="params">
115
 
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
110
<varlistentry><term><parameter>db</parameter>&#160;:</term>
116
111
<listitem><simpara> A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
117
112
</simpara></listitem></varlistentry>
118
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <parameter>db</parameter>'s <parameter>load_inhibit</parameter> string.
 
113
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <parameter>db</parameter>'s <parameter>load_inhibit</parameter> string.
119
114
</simpara></listitem></varlistentry>
120
115
</variablelist></refsect2>
121
116
<refsect2 id="gimp-module-db-load" role="function">
122
117
<title>gimp_module_db_load ()</title>
123
 
<indexterm zone="gimp-module-db-load"><primary>gimp_module_db_load</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_db_load                 (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
 
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,
124
119
                                                         const <link linkend="gchar">gchar</link> *module_path);</programlisting>
125
120
<para>
126
121
Scans the directories contained in <parameter>module_path</parameter> using
127
122
<link linkend="gimp-datafiles-read-directories"><function>gimp_datafiles_read_directories()</function></link> and creates a <link linkend="GimpModule"><type>GimpModule</type></link>
128
123
instance for every loadable module contained in the directories.</para>
129
124
<para>
130
 
 
131
125
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
126
<varlistentry><term><parameter>db</parameter>&#160;:</term>
133
127
<listitem><simpara>          A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
134
128
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>module_path</parameter>&nbsp;:</term>
136
 
<listitem><simpara> A <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> delimited list of directories
 
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
137
131
              to load modules from.
138
132
</simpara></listitem></varlistentry>
139
133
</variablelist></refsect2>
140
134
<refsect2 id="gimp-module-db-refresh" role="function">
141
135
<title>gimp_module_db_refresh ()</title>
142
 
<indexterm zone="gimp-module-db-refresh"><primary>gimp_module_db_refresh</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_module_db_refresh              (<link linkend="GimpModuleDB">GimpModuleDB</link> *db,
 
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,
143
137
                                                         const <link linkend="gchar">gchar</link> *module_path);</programlisting>
144
138
<para>
145
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>
150
144
list and not freed as this is not possible with <link linkend="GTypeModule"><type>GTypeModule</type></link>
151
145
instances which actually implement types.</para>
152
146
<para>
153
 
 
154
147
</para><variablelist role="params">
155
 
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
148
<varlistentry><term><parameter>db</parameter>&#160;:</term>
156
149
<listitem><simpara>          A <link linkend="GimpModuleDB"><type>GimpModuleDB</type></link>.
157
150
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><parameter>module_path</parameter>&nbsp;:</term>
159
 
<listitem><simpara> A <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> delimited list of directories
 
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
160
153
              to load modules from.
161
154
</simpara></listitem></varlistentry>
162
155
</variablelist></refsect2>
165
158
 
166
159
<refsect1 id="GimpModuleDB.signal-details" role="signals">
167
160
<title role="signals.title">Signal Details</title>
168
 
<refsect2 id="GimpModuleDB-add"><title>The <literal>&quot;add&quot;</literal> signal</title>
169
 
<indexterm zone="GimpModuleDB-add"><primary>GimpModuleDB::add</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
170
 
                                                        <link linkend="GimpModule">GimpModule</link>   *arg1,
171
 
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run First</programlisting>
172
 
<para>
173
 
 
174
 
</para><variablelist role="params">
175
 
<varlistentry><term><parameter>gimpmoduledb</parameter>&nbsp;:</term>
176
 
<listitem><simpara>the object which received the signal.
177
 
</simpara></listitem></varlistentry>
178
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
179
 
<listitem><simpara>
180
 
 
181
 
</simpara></listitem></varlistentry>
182
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
183
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
184
 
</variablelist></refsect2><refsect2 id="GimpModuleDB-module-modified"><title>The <literal>&quot;module-modified&quot;</literal> signal</title>
185
 
<indexterm zone="GimpModuleDB-module-modified"><primary>GimpModuleDB::module-modified</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
186
 
                                                        <link linkend="GimpModule">GimpModule</link>   *arg1,
187
 
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run First</programlisting>
188
 
<para>
189
 
 
190
 
</para><variablelist role="params">
191
 
<varlistentry><term><parameter>gimpmoduledb</parameter>&nbsp;:</term>
192
 
<listitem><simpara>the object which received the signal.
193
 
</simpara></listitem></varlistentry>
194
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
195
 
<listitem><simpara>
196
 
 
197
 
</simpara></listitem></varlistentry>
198
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
199
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
200
 
</variablelist></refsect2><refsect2 id="GimpModuleDB-remove"><title>The <literal>&quot;remove&quot;</literal> signal</title>
201
 
<indexterm zone="GimpModuleDB-remove"><primary>GimpModuleDB::remove</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpModuleDB">GimpModuleDB</link> *gimpmoduledb,
202
 
                                                        <link linkend="GimpModule">GimpModule</link>   *arg1,
203
 
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run First</programlisting>
204
 
<para>
205
 
 
206
 
</para><variablelist role="params">
207
 
<varlistentry><term><parameter>gimpmoduledb</parameter>&nbsp;:</term>
208
 
<listitem><simpara>the object which received the signal.
209
 
</simpara></listitem></varlistentry>
210
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
211
 
<listitem><simpara>
212
 
 
213
 
</simpara></listitem></varlistentry>
214
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
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>
215
202
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
216
203
</variablelist></refsect2>
217
204
</refsect1>