216 lines
21 KiB
HTML
216 lines
21 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpproceduraldb</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Library Reference Manual"><link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images"><link rel="prev" href="libgimp-gimpplugin.html" title="gimpplugin"><link rel="next" href="libgimp-gimpprogress.html" title="gimpprogress"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants"><link rel="part" href="libgimp.html" title="Part II. GIMP Library"><link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images"><link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="chapter" href="libgimp-data.html" title="Data Objects"><link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs"><link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></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="libgimp-gimpplugin.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimp-general.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 Library Reference Manual</th><td><a accesskey="n" href="libgimp-gimpprogress.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimp-gimpproceduraldb"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpproceduraldb</span></h2><p>gimpproceduraldb — Functions for querying and changing procedural database (PDB) entries.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||
|
||
|
||
|
||
gchar* <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-temp-name">gimp_procedural_db_temp_name</a> (void);
|
||
gboolean <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-proc-info">gimp_procedural_db_proc_info</a> (const gchar *procedure,
|
||
gchar **blurb,
|
||
gchar **help,
|
||
gchar **author,
|
||
gchar **copyright,
|
||
gchar **date,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBProcType"
|
||
>GimpPDBProcType</a> *proc_type,
|
||
gint *num_args,
|
||
gint *num_values,
|
||
<a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> **args,
|
||
<a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> **return_vals);
|
||
gboolean <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-get-data">gimp_procedural_db_get_data</a> (const gchar *identifier,
|
||
gpointer data);
|
||
gboolean <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-set-data">gimp_procedural_db_set_data</a> (const gchar *identifier,
|
||
gpointer data,
|
||
guint32 bytes);
|
||
gboolean <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-dump">gimp_procedural_db_dump</a> (const gchar *filename);
|
||
gboolean <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-query">gimp_procedural_db_query</a> (const gchar *name,
|
||
const gchar *blurb,
|
||
const gchar *help,
|
||
const gchar *author,
|
||
const gchar *copyright,
|
||
const gchar *date,
|
||
const gchar *proc_type,
|
||
gint *num_matches,
|
||
gchar ***procedure_names);
|
||
gboolean <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-proc-arg">gimp_procedural_db_proc_arg</a> (const gchar *procedure,
|
||
gint arg_num,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBArgType"
|
||
>GimpPDBArgType</a> *arg_type,
|
||
gchar **arg_name,
|
||
gchar **arg_desc);
|
||
gboolean <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-proc-val">gimp_procedural_db_proc_val</a> (const gchar *procedure,
|
||
gint val_num,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBArgType"
|
||
>GimpPDBArgType</a> *val_type,
|
||
gchar **val_name,
|
||
gchar **val_desc);
|
||
gint <a href="libgimp-gimpproceduraldb.html#gimp-procedural-db-get-data-size">gimp_procedural_db_get_data_size</a>
|
||
(const gchar *identifier);
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2467194"></a><h2>Description</h2><p>
|
||
Functions for querying and changing procedural database (PDB) entries.
|
||
|
||
</p></div><div class="refsect1" lang="en"><a name="id2467204"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2467210"></a><h3><a name="gimp-procedural-db-temp-name"></a>gimp_procedural_db_temp_name ()</h3><a class="indexterm" name="id2467221"></a><pre class="programlisting">gchar* gimp_procedural_db_temp_name (void);</pre><p>
|
||
Generates a unique temporary PDB name.
|
||
</p><p>
|
||
This procedure generates a temporary PDB entry name that is
|
||
guaranteed to be unique. It is many used by the interactive popup
|
||
dialogs to generate a PDB entry name.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A unique temporary name for a temporary PDB entry.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2467260"></a><h3><a name="gimp-procedural-db-proc-info"></a>gimp_procedural_db_proc_info ()</h3><a class="indexterm" name="id2467271"></a><pre class="programlisting">gboolean gimp_procedural_db_proc_info (const gchar *procedure,
|
||
gchar **blurb,
|
||
gchar **help,
|
||
gchar **author,
|
||
gchar **copyright,
|
||
gchar **date,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBProcType"
|
||
>GimpPDBProcType</a> *proc_type,
|
||
gint *num_args,
|
||
gint *num_values,
|
||
<a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> **args,
|
||
<a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> **return_vals);</pre><p>
|
||
Queries the procedural database for information on the specified
|
||
procedure.
|
||
</p><p>
|
||
This procedure returns information on the specified procedure. A
|
||
short blurb, detailed help, author(s), copyright information,
|
||
procedure type, number of input, and number of return values are
|
||
returned. Additionally this function returns specific information
|
||
about each input argument and return value.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure</tt></i> :</span></td><td> The procedure name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>blurb</tt></i> :</span></td><td> A short blurb.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help</tt></i> :</span></td><td> Detailed procedure help.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>author</tt></i> :</span></td><td> Author(s) of the procedure.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>copyright</tt></i> :</span></td><td> The copyright.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>date</tt></i> :</span></td><td> Copyright date.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_type</tt></i> :</span></td><td> The procedure type.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_args</tt></i> :</span></td><td> The number of input arguments.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_values</tt></i> :</span></td><td> The number of return values.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>args</tt></i> :</span></td><td> The input arguments.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>return_vals</tt></i> :</span></td><td> The return values.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2551948"></a><h3><a name="gimp-procedural-db-get-data"></a>gimp_procedural_db_get_data ()</h3><a class="indexterm" name="id2551957"></a><pre class="programlisting">gboolean gimp_procedural_db_get_data (const gchar *identifier,
|
||
gpointer data);</pre><p>
|
||
Returns data associated with the specified identifier.
|
||
</p><p>
|
||
This procedure returns any data which may have been associated with
|
||
the specified identifier. The data is copied into the given memory
|
||
location.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>identifier</tt></i> :</span></td><td> The identifier associated with data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td> A byte array containing data.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success, FALSE if no data has been associated with
|
||
the identifier
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2552030"></a><h3><a name="gimp-procedural-db-set-data"></a>gimp_procedural_db_set_data ()</h3><a class="indexterm" name="id2552039"></a><pre class="programlisting">gboolean gimp_procedural_db_set_data (const gchar *identifier,
|
||
gpointer data,
|
||
guint32 bytes);</pre><p>
|
||
Associates the specified identifier with the supplied data.
|
||
</p><p>
|
||
This procedure associates the supplied data with the provided
|
||
identifier. The data may be subsequently retrieved by a call to
|
||
'procedural-db-get-data'.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>identifier</tt></i> :</span></td><td> The identifier associated with data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td> A byte array containing data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>bytes</tt></i> :</span></td><td> The number of bytes in the data
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2552128"></a><h3><a name="gimp-procedural-db-dump"></a>gimp_procedural_db_dump ()</h3><a class="indexterm" name="id2552137"></a><pre class="programlisting">gboolean gimp_procedural_db_dump (const gchar *filename);</pre><p>
|
||
Dumps the current contents of the procedural database
|
||
</p><p>
|
||
This procedure dumps the contents of the procedural database to the
|
||
specified file. The file will contain all of the information
|
||
provided for each registered procedure. This file is in a format
|
||
appropriate for use with the supplied \"pdb_self_doc.el\" Elisp
|
||
script, which generates a texinfo document.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> The dump filename.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2592489"></a><h3><a name="gimp-procedural-db-query"></a>gimp_procedural_db_query ()</h3><a class="indexterm" name="id2592498"></a><pre class="programlisting">gboolean gimp_procedural_db_query (const gchar *name,
|
||
const gchar *blurb,
|
||
const gchar *help,
|
||
const gchar *author,
|
||
const gchar *copyright,
|
||
const gchar *date,
|
||
const gchar *proc_type,
|
||
gint *num_matches,
|
||
gchar ***procedure_names);</pre><p>
|
||
Queries the procedural database for its contents using regular
|
||
expression matching.
|
||
</p><p>
|
||
This procedure queries the contents of the procedural database. It
|
||
is supplied with seven arguments matching procedures on { name,
|
||
blurb, help, author, copyright, date, procedure type}. This is
|
||
accomplished using regular expression matching. For instance, to
|
||
find all procedures with \"jpeg\" listed in the blurb, all seven
|
||
arguments can be supplied as \".*\", except for the second, which
|
||
can be supplied as \".*jpeg.*\". There are two return arguments for
|
||
this procedure. The first is the number of procedures matching the
|
||
query. The second is a concatenated list of procedure names
|
||
corresponding to those matching the query. If no matching entries
|
||
are found, then the returned string is NULL and the number of
|
||
entries is 0.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The regex for procedure name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>blurb</tt></i> :</span></td><td> The regex for procedure blurb.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help</tt></i> :</span></td><td> The regex for procedure help.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>author</tt></i> :</span></td><td> The regex for procedure author.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>copyright</tt></i> :</span></td><td> The regex for procedure copyright.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>date</tt></i> :</span></td><td> The regex for procedure date.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_type</tt></i> :</span></td><td> The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-in', 'GIMP Extension' }.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_matches</tt></i> :</span></td><td> The number of matching procedures.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>procedure_names</tt></i> :</span></td><td> The list of procedure names.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2592655"></a><h3><a name="gimp-procedural-db-proc-arg"></a>gimp_procedural_db_proc_arg ()</h3><a class="indexterm" name="id2592662"></a><pre class="programlisting">gboolean gimp_procedural_db_proc_arg (const gchar *procedure,
|
||
gint arg_num,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBArgType"
|
||
>GimpPDBArgType</a> *arg_type,
|
||
gchar **arg_name,
|
||
gchar **arg_desc);</pre><p>
|
||
Queries the procedural database for information on the specified
|
||
procedure's argument.
|
||
</p><p>
|
||
This procedure returns information on the specified procedure's
|
||
argument. The argument type, name, and a description are retrieved.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure</tt></i> :</span></td><td> The procedure name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg_num</tt></i> :</span></td><td> The argument number.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg_type</tt></i> :</span></td><td> The type of argument.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg_name</tt></i> :</span></td><td> The name of the argument.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg_desc</tt></i> :</span></td><td> A description of the argument.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2592777"></a><h3><a name="gimp-procedural-db-proc-val"></a>gimp_procedural_db_proc_val ()</h3><a class="indexterm" name="id2592785"></a><pre class="programlisting">gboolean gimp_procedural_db_proc_val (const gchar *procedure,
|
||
gint val_num,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBArgType"
|
||
>GimpPDBArgType</a> *val_type,
|
||
gchar **val_name,
|
||
gchar **val_desc);</pre><p>
|
||
Queries the procedural database for information on the specified
|
||
procedure's return value.
|
||
</p><p>
|
||
This procedure returns information on the specified procedure's
|
||
return value. The return value type, name, and a description are
|
||
retrieved.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure</tt></i> :</span></td><td> The procedure name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>val_num</tt></i> :</span></td><td> The return value number.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>val_type</tt></i> :</span></td><td> The type of return value.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>val_name</tt></i> :</span></td><td> The name of the return value.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>val_desc</tt></i> :</span></td><td> A description of the return value.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2592900"></a><h3><a name="gimp-procedural-db-get-data-size"></a>gimp_procedural_db_get_data_size ()</h3><a class="indexterm" name="id2592908"></a><pre class="programlisting">gint gimp_procedural_db_get_data_size
|
||
(const gchar *identifier);</pre><p>
|
||
Returns size of data associated with the specified identifier.
|
||
</p><p>
|
||
This procedure returns the size of any data which may have been
|
||
associated with the specified identifier. If no data has been
|
||
associated with the identifier, an error is returned.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>identifier</tt></i> :</span></td><td> The identifier associated with data.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The number of bytes in the data.
|
||
</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="libgimp-gimpplugin.html"><b><< gimpplugin</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpprogress.html"><b>gimpprogress >></b></a></td></tr></table></body></html>
|