← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpproceduraldb.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpproceduraldb.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-procedural-db-temp-name">gimp_procedural_db_temp_name</link>    (void);
26
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-procedural-db-proc-info">gimp_procedural_db_proc_info</link>    (const <link linkend="gchar">gchar</link> *procedure,
27
 
                                             <link linkend="gchar">gchar</link> **blurb,
28
 
                                             <link linkend="gchar">gchar</link> **help,
29
 
                                             <link linkend="gchar">gchar</link> **author,
30
 
                                             <link linkend="gchar">gchar</link> **copyright,
31
 
                                             <link linkend="gchar">gchar</link> **date,
32
 
                                             <link linkend="GimpPDBProcType">GimpPDBProcType</link> *proc_type,
33
 
                                             <link linkend="gint">gint</link> *num_args,
34
 
                                             <link linkend="gint">gint</link> *num_values,
35
 
                                             <link linkend="GimpParamDef">GimpParamDef</link> **args,
36
 
                                             <link linkend="GimpParamDef">GimpParamDef</link> **return_vals);
37
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-procedural-db-get-data">gimp_procedural_db_get_data</link>     (const <link linkend="gchar">gchar</link> *identifier,
38
 
                                             <link linkend="gpointer">gpointer</link> data);
39
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-procedural-db-set-data">gimp_procedural_db_set_data</link>     (const <link linkend="gchar">gchar</link> *identifier,
40
 
                                             <link linkend="gpointer">gpointer</link> data,
41
 
                                             <link linkend="guint32">guint32</link> bytes);
42
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-procedural-db-dump">gimp_procedural_db_dump</link>         (const <link linkend="gchar">gchar</link> *filename);
43
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-procedural-db-query">gimp_procedural_db_query</link>        (const <link linkend="gchar">gchar</link> *name,
44
 
                                             const <link linkend="gchar">gchar</link> *blurb,
45
 
                                             const <link linkend="gchar">gchar</link> *help,
46
 
                                             const <link linkend="gchar">gchar</link> *author,
47
 
                                             const <link linkend="gchar">gchar</link> *copyright,
48
 
                                             const <link linkend="gchar">gchar</link> *date,
49
 
                                             const <link linkend="gchar">gchar</link> *proc_type,
50
 
                                             <link linkend="gint">gint</link> *num_matches,
51
 
                                             <link linkend="gchar">gchar</link> ***procedure_names);
52
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-procedural-db-proc-arg">gimp_procedural_db_proc_arg</link>     (const <link linkend="gchar">gchar</link> *procedure,
53
 
                                             <link linkend="gint">gint</link> arg_num,
54
 
                                             <link linkend="GimpPDBArgType">GimpPDBArgType</link> *arg_type,
55
 
                                             <link linkend="gchar">gchar</link> **arg_name,
56
 
                                             <link linkend="gchar">gchar</link> **arg_desc);
57
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-procedural-db-proc-val">gimp_procedural_db_proc_val</link>     (const <link linkend="gchar">gchar</link> *procedure,
58
 
                                             <link linkend="gint">gint</link> val_num,
59
 
                                             <link linkend="GimpPDBArgType">GimpPDBArgType</link> *val_type,
60
 
                                             <link linkend="gchar">gchar</link> **val_name,
61
 
                                             <link linkend="gchar">gchar</link> **val_desc);
62
 
<link linkend="gint">gint</link>        <link linkend="gimp-procedural-db-get-data-size">gimp_procedural_db_get_data_size</link>
63
 
                                            (const <link linkend="gchar">gchar</link> *identifier);
 
25
<link linkend="gchar">gchar</link>*              <link linkend="gimp-procedural-db-temp-name">gimp_procedural_db_temp_name</link>        (void);
 
26
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-procedural-db-proc-info">gimp_procedural_db_proc_info</link>        (const <link linkend="gchar">gchar</link> *procedure,
 
27
                                                         <link linkend="gchar">gchar</link> **blurb,
 
28
                                                         <link linkend="gchar">gchar</link> **help,
 
29
                                                         <link linkend="gchar">gchar</link> **author,
 
30
                                                         <link linkend="gchar">gchar</link> **copyright,
 
31
                                                         <link linkend="gchar">gchar</link> **date,
 
32
                                                         <link linkend="GimpPDBProcType">GimpPDBProcType</link> *proc_type,
 
33
                                                         <link linkend="gint">gint</link> *num_args,
 
34
                                                         <link linkend="gint">gint</link> *num_values,
 
35
                                                         <link linkend="GimpParamDef">GimpParamDef</link> **args,
 
36
                                                         <link linkend="GimpParamDef">GimpParamDef</link> **return_vals);
 
37
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-procedural-db-get-data">gimp_procedural_db_get_data</link>         (const <link linkend="gchar">gchar</link> *identifier,
 
38
                                                         <link linkend="gpointer">gpointer</link> data);
 
39
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-procedural-db-set-data">gimp_procedural_db_set_data</link>         (const <link linkend="gchar">gchar</link> *identifier,
 
40
                                                         <link linkend="gconstpointer">gconstpointer</link> data,
 
41
                                                         <link linkend="guint32">guint32</link> bytes);
 
42
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-procedural-db-dump">gimp_procedural_db_dump</link>             (const <link linkend="gchar">gchar</link> *filename);
 
43
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-procedural-db-query">gimp_procedural_db_query</link>            (const <link linkend="gchar">gchar</link> *name,
 
44
                                                         const <link linkend="gchar">gchar</link> *blurb,
 
45
                                                         const <link linkend="gchar">gchar</link> *help,
 
46
                                                         const <link linkend="gchar">gchar</link> *author,
 
47
                                                         const <link linkend="gchar">gchar</link> *copyright,
 
48
                                                         const <link linkend="gchar">gchar</link> *date,
 
49
                                                         const <link linkend="gchar">gchar</link> *proc_type,
 
50
                                                         <link linkend="gint">gint</link> *num_matches,
 
51
                                                         <link linkend="gchar">gchar</link> ***procedure_names);
 
52
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-procedural-db-proc-arg">gimp_procedural_db_proc_arg</link>         (const <link linkend="gchar">gchar</link> *procedure_name,
 
53
                                                         <link linkend="gint">gint</link> arg_num,
 
54
                                                         <link linkend="GimpPDBArgType">GimpPDBArgType</link> *arg_type,
 
55
                                                         <link linkend="gchar">gchar</link> **arg_name,
 
56
                                                         <link linkend="gchar">gchar</link> **arg_desc);
 
57
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-procedural-db-proc-val">gimp_procedural_db_proc_val</link>         (const <link linkend="gchar">gchar</link> *procedure_name,
 
58
                                                         <link linkend="gint">gint</link> val_num,
 
59
                                                         <link linkend="GimpPDBArgType">GimpPDBArgType</link> *val_type,
 
60
                                                         <link linkend="gchar">gchar</link> **val_name,
 
61
                                                         <link linkend="gchar">gchar</link> **val_desc);
 
62
<link linkend="gint">gint</link>                <link linkend="gimp-procedural-db-get-data-size">gimp_procedural_db_get_data_size</link>    (const <link linkend="gchar">gchar</link> *identifier);
64
63
</synopsis>
65
64
</refsynopsisdiv>
66
65
 
84
83
<title role="details.title">Details</title>
85
84
<refsect2>
86
85
<title><anchor id="gimp-procedural-db-temp-name" role="function"/>gimp_procedural_db_temp_name ()</title>
87
 
<indexterm><primary>gimp_procedural_db_temp_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_procedural_db_temp_name    (void);</programlisting>
 
86
<indexterm><primary>gimp_procedural_db_temp_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_procedural_db_temp_name        (void);</programlisting>
88
87
<para>
89
88
Generates a unique temporary PDB name.
90
89
</para>
91
90
<para>
92
91
This procedure generates a temporary PDB entry name that is
93
 
guaranteed to be unique. It is many used by the interactive popup
94
 
dialogs to generate a PDB entry name.</para>
 
92
guaranteed to be unique.</para>
95
93
<para>
96
94
 
97
95
</para><variablelist role="params">
100
98
</variablelist></refsect2>
101
99
<refsect2>
102
100
<title><anchor id="gimp-procedural-db-proc-info" role="function"/>gimp_procedural_db_proc_info ()</title>
103
 
<indexterm><primary>gimp_procedural_db_proc_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_procedural_db_proc_info    (const <link linkend="gchar">gchar</link> *procedure,
104
 
                                             <link linkend="gchar">gchar</link> **blurb,
105
 
                                             <link linkend="gchar">gchar</link> **help,
106
 
                                             <link linkend="gchar">gchar</link> **author,
107
 
                                             <link linkend="gchar">gchar</link> **copyright,
108
 
                                             <link linkend="gchar">gchar</link> **date,
109
 
                                             <link linkend="GimpPDBProcType">GimpPDBProcType</link> *proc_type,
110
 
                                             <link linkend="gint">gint</link> *num_args,
111
 
                                             <link linkend="gint">gint</link> *num_values,
112
 
                                             <link linkend="GimpParamDef">GimpParamDef</link> **args,
113
 
                                             <link linkend="GimpParamDef">GimpParamDef</link> **return_vals);</programlisting>
 
101
<indexterm><primary>gimp_procedural_db_proc_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_procedural_db_proc_info        (const <link linkend="gchar">gchar</link> *procedure,
 
102
                                                         <link linkend="gchar">gchar</link> **blurb,
 
103
                                                         <link linkend="gchar">gchar</link> **help,
 
104
                                                         <link linkend="gchar">gchar</link> **author,
 
105
                                                         <link linkend="gchar">gchar</link> **copyright,
 
106
                                                         <link linkend="gchar">gchar</link> **date,
 
107
                                                         <link linkend="GimpPDBProcType">GimpPDBProcType</link> *proc_type,
 
108
                                                         <link linkend="gint">gint</link> *num_args,
 
109
                                                         <link linkend="gint">gint</link> *num_values,
 
110
                                                         <link linkend="GimpParamDef">GimpParamDef</link> **args,
 
111
                                                         <link linkend="GimpParamDef">GimpParamDef</link> **return_vals);</programlisting>
114
112
<para>
115
113
Queries the procedural database for information on the specified
116
114
procedure.
162
160
</variablelist></refsect2>
163
161
<refsect2>
164
162
<title><anchor id="gimp-procedural-db-get-data" role="function"/>gimp_procedural_db_get_data ()</title>
165
 
<indexterm><primary>gimp_procedural_db_get_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_procedural_db_get_data     (const <link linkend="gchar">gchar</link> *identifier,
166
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
 
163
<indexterm><primary>gimp_procedural_db_get_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_procedural_db_get_data         (const <link linkend="gchar">gchar</link> *identifier,
 
164
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
167
165
<para>
168
166
Returns data associated with the specified identifier.
169
167
</para>
186
184
</variablelist></refsect2>
187
185
<refsect2>
188
186
<title><anchor id="gimp-procedural-db-set-data" role="function"/>gimp_procedural_db_set_data ()</title>
189
 
<indexterm><primary>gimp_procedural_db_set_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_procedural_db_set_data     (const <link linkend="gchar">gchar</link> *identifier,
190
 
                                             <link linkend="gpointer">gpointer</link> data,
191
 
                                             <link linkend="guint32">guint32</link> bytes);</programlisting>
 
187
<indexterm><primary>gimp_procedural_db_set_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_procedural_db_set_data         (const <link linkend="gchar">gchar</link> *identifier,
 
188
                                                         <link linkend="gconstpointer">gconstpointer</link> data,
 
189
                                                         <link linkend="guint32">guint32</link> bytes);</programlisting>
192
190
<para>
193
191
Associates the specified identifier with the supplied data.
194
192
</para>
213
211
</variablelist></refsect2>
214
212
<refsect2>
215
213
<title><anchor id="gimp-procedural-db-dump" role="function"/>gimp_procedural_db_dump ()</title>
216
 
<indexterm><primary>gimp_procedural_db_dump</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_procedural_db_dump         (const <link linkend="gchar">gchar</link> *filename);</programlisting>
 
214
<indexterm><primary>gimp_procedural_db_dump</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_procedural_db_dump             (const <link linkend="gchar">gchar</link> *filename);</programlisting>
217
215
<para>
218
216
Dumps the current contents of the procedural database
219
217
</para>
234
232
</variablelist></refsect2>
235
233
<refsect2>
236
234
<title><anchor id="gimp-procedural-db-query" role="function"/>gimp_procedural_db_query ()</title>
237
 
<indexterm><primary>gimp_procedural_db_query</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_procedural_db_query        (const <link linkend="gchar">gchar</link> *name,
238
 
                                             const <link linkend="gchar">gchar</link> *blurb,
239
 
                                             const <link linkend="gchar">gchar</link> *help,
240
 
                                             const <link linkend="gchar">gchar</link> *author,
241
 
                                             const <link linkend="gchar">gchar</link> *copyright,
242
 
                                             const <link linkend="gchar">gchar</link> *date,
243
 
                                             const <link linkend="gchar">gchar</link> *proc_type,
244
 
                                             <link linkend="gint">gint</link> *num_matches,
245
 
                                             <link linkend="gchar">gchar</link> ***procedure_names);</programlisting>
 
235
<indexterm><primary>gimp_procedural_db_query</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_procedural_db_query            (const <link linkend="gchar">gchar</link> *name,
 
236
                                                         const <link linkend="gchar">gchar</link> *blurb,
 
237
                                                         const <link linkend="gchar">gchar</link> *help,
 
238
                                                         const <link linkend="gchar">gchar</link> *author,
 
239
                                                         const <link linkend="gchar">gchar</link> *copyright,
 
240
                                                         const <link linkend="gchar">gchar</link> *date,
 
241
                                                         const <link linkend="gchar">gchar</link> *proc_type,
 
242
                                                         <link linkend="gint">gint</link> *num_matches,
 
243
                                                         <link linkend="gchar">gchar</link> ***procedure_names);</programlisting>
246
244
<para>
247
245
Queries the procedural database for its contents using regular
248
246
expression matching.
282
280
<listitem><simpara> The regex for procedure date.
283
281
</simpara></listitem></varlistentry>
284
282
<varlistentry><term><parameter>proc_type</parameter>&nbsp;:</term>
285
 
<listitem><simpara> The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-in', 'GIMP Extension' }.
 
283
<listitem><simpara> The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-In', 'GIMP Extension', 'Temporary Procedure' }.
286
284
</simpara></listitem></varlistentry>
287
285
<varlistentry><term><parameter>num_matches</parameter>&nbsp;:</term>
288
286
<listitem><simpara> The number of matching procedures.
295
293
</variablelist></refsect2>
296
294
<refsect2>
297
295
<title><anchor id="gimp-procedural-db-proc-arg" role="function"/>gimp_procedural_db_proc_arg ()</title>
298
 
<indexterm><primary>gimp_procedural_db_proc_arg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_procedural_db_proc_arg     (const <link linkend="gchar">gchar</link> *procedure,
299
 
                                             <link linkend="gint">gint</link> arg_num,
300
 
                                             <link linkend="GimpPDBArgType">GimpPDBArgType</link> *arg_type,
301
 
                                             <link linkend="gchar">gchar</link> **arg_name,
302
 
                                             <link linkend="gchar">gchar</link> **arg_desc);</programlisting>
 
296
<indexterm><primary>gimp_procedural_db_proc_arg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_procedural_db_proc_arg         (const <link linkend="gchar">gchar</link> *procedure_name,
 
297
                                                         <link linkend="gint">gint</link> arg_num,
 
298
                                                         <link linkend="GimpPDBArgType">GimpPDBArgType</link> *arg_type,
 
299
                                                         <link linkend="gchar">gchar</link> **arg_name,
 
300
                                                         <link linkend="gchar">gchar</link> **arg_desc);</programlisting>
303
301
<para>
304
302
Queries the procedural database for information on the specified
305
303
procedure's argument.
310
308
<para>
311
309
 
312
310
</para><variablelist role="params">
313
 
<varlistentry><term><parameter>procedure</parameter>&nbsp;:</term>
 
311
<varlistentry><term><parameter>procedure_name</parameter>&nbsp;:</term>
314
312
<listitem><simpara> The procedure name.
315
313
</simpara></listitem></varlistentry>
316
314
<varlistentry><term><parameter>arg_num</parameter>&nbsp;:</term>
330
328
</variablelist></refsect2>
331
329
<refsect2>
332
330
<title><anchor id="gimp-procedural-db-proc-val" role="function"/>gimp_procedural_db_proc_val ()</title>
333
 
<indexterm><primary>gimp_procedural_db_proc_val</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_procedural_db_proc_val     (const <link linkend="gchar">gchar</link> *procedure,
334
 
                                             <link linkend="gint">gint</link> val_num,
335
 
                                             <link linkend="GimpPDBArgType">GimpPDBArgType</link> *val_type,
336
 
                                             <link linkend="gchar">gchar</link> **val_name,
337
 
                                             <link linkend="gchar">gchar</link> **val_desc);</programlisting>
 
331
<indexterm><primary>gimp_procedural_db_proc_val</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_procedural_db_proc_val         (const <link linkend="gchar">gchar</link> *procedure_name,
 
332
                                                         <link linkend="gint">gint</link> val_num,
 
333
                                                         <link linkend="GimpPDBArgType">GimpPDBArgType</link> *val_type,
 
334
                                                         <link linkend="gchar">gchar</link> **val_name,
 
335
                                                         <link linkend="gchar">gchar</link> **val_desc);</programlisting>
338
336
<para>
339
337
Queries the procedural database for information on the specified
340
338
procedure's return value.
346
344
<para>
347
345
 
348
346
</para><variablelist role="params">
349
 
<varlistentry><term><parameter>procedure</parameter>&nbsp;:</term>
 
347
<varlistentry><term><parameter>procedure_name</parameter>&nbsp;:</term>
350
348
<listitem><simpara> The procedure name.
351
349
</simpara></listitem></varlistentry>
352
350
<varlistentry><term><parameter>val_num</parameter>&nbsp;:</term>
366
364
</variablelist></refsect2>
367
365
<refsect2>
368
366
<title><anchor id="gimp-procedural-db-get-data-size" role="function"/>gimp_procedural_db_get_data_size ()</title>
369
 
<indexterm><primary>gimp_procedural_db_get_data_size</primary></indexterm><programlisting><link linkend="gint">gint</link>        gimp_procedural_db_get_data_size
370
 
                                            (const <link linkend="gchar">gchar</link> *identifier);</programlisting>
 
367
<indexterm><primary>gimp_procedural_db_get_data_size</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_procedural_db_get_data_size    (const <link linkend="gchar">gchar</link> *identifier);</programlisting>
371
368
<para>
372
369
Returns size of data associated with the specified identifier.
373
370
</para>