See also: Main Index; Alphabetic; Misc; By Author; By Module; By Menu External Links: The Gimp; Gimp User Manual

The Gimp procedural_db functions

gimp_procedural_db_dump	Dumps the current contents of the procedural database
gimp_procedural_db_get_data	Returns data associated with the specified identifier.
gimp_procedural_db_get_data_size	Returns size of data associated with the specified identifier.
gimp_procedural_db_proc_arg	Queries the procedural database for information on the specified procedure's argument.
gimp_procedural_db_proc_info	Queries the procedural database for information on the specified procedure.
gimp_procedural_db_proc_val	Queries the procedural database for information on the specified procedure's return value.
gimp_procedural_db_query	Queries the procedural database for its contents using regular expression matching.
gimp_procedural_db_set_data	Associates the specified identifier with the supplied data.
gimp_procedural_db_temp_name	Generates a unique temporary PDB name.

gimp_procedural_db_dump

Input:

STRING

filename

The dump filename

Returns: nothing
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.
Spencer Kimball & Josh MacDonald & Peter Mattis; 1995-1996

gimp_procedural_db_get_data

Input:

STRING

identifier

The identifier associated with data

Returns:

INT32	bytes	The number of bytes in the data
INT8ARRAY	data	A byte array containing data

This procedure returns any data which may have been associated with the specified identifier. The data is a variable length array of bytes. If no data has been associated with the identifier, an error is returned.
Spencer Kimball & Peter Mattis; 1997

gimp_procedural_db_get_data_size

Input:

STRING

identifier

The identifier associated with data

Returns:

INT32

bytes

The number of bytes in the data

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.
Nick Lamb; 1998

gimp_procedural_db_proc_arg

Input:

STRING	procedure	The procedure name
INT32	arg_num	The argument number

Returns:

INT32	arg_type	The type of argument { GIMP_PDB_INT32 (0), GIMP_PDB_INT16 (1), GIMP_PDB_INT8 (2), GIMP_PDB_FLOAT (3), GIMP_PDB_STRING (4), GIMP_PDB_INT32ARRAY (5), GIMP_PDB_INT16ARRAY (6), GIMP_PDB_INT8ARRAY (7), GIMP_PDB_FLOATARRAY (8), GIMP_PDB_STRINGARRAY (9), GIMP_PDB_COLOR (10), GIMP_PDB_REGION (11), GIMP_PDB_DISPLAY (12), GIMP_PDB_IMAGE (13), GIMP_PDB_LAYER (14), GIMP_PDB_CHANNEL (15), GIMP_PDB_DRAWABLE (16), GIMP_PDB_SELECTION (17), GIMP_PDB_BOUNDARY (18), GIMP_PDB_PATH (19), GIMP_PDB_PARASITE (20), GIMP_PDB_STATUS (21) }
STRING	arg_name	The name of the argument
STRING	arg_desc	A description of the argument

This procedure returns information on the specified procedure's argument. The argument type, name, and a description are retrieved.
Spencer Kimball & Peter Mattis; 1997

gimp_procedural_db_proc_info

Input:

STRING

procedure

The procedure name

Returns:

STRING	blurb	A short blurb
STRING	help	Detailed procedure help
STRING	author	Author(s) of the procedure
STRING	copyright	The copyright
STRING	date	Copyright date
INT32	proc_type	The procedure type: { GIMP_INTERNAL (0), GIMP_PLUGIN (1), GIMP_EXTENSION (2), GIMP_TEMPORARY (3) }
INT32	num_args	The number of input arguments
INT32	num_values	The number of return values

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. For specific information on each input argument and return value, use the 'gimp_procedural_db_proc_arg' and 'gimp_procedural_db_proc_val' procedures.
Spencer Kimball & Peter Mattis; 1997

gimp_procedural_db_proc_val

Input:

STRING	procedure	The procedure name
INT32	val_num	The return value number

Returns:

INT32	val_type	The type of return value { GIMP_PDB_INT32 (0), GIMP_PDB_INT16 (1), GIMP_PDB_INT8 (2), GIMP_PDB_FLOAT (3), GIMP_PDB_STRING (4), GIMP_PDB_INT32ARRAY (5), GIMP_PDB_INT16ARRAY (6), GIMP_PDB_INT8ARRAY (7), GIMP_PDB_FLOATARRAY (8), GIMP_PDB_STRINGARRAY (9), GIMP_PDB_COLOR (10), GIMP_PDB_REGION (11), GIMP_PDB_DISPLAY (12), GIMP_PDB_IMAGE (13), GIMP_PDB_LAYER (14), GIMP_PDB_CHANNEL (15), GIMP_PDB_DRAWABLE (16), GIMP_PDB_SELECTION (17), GIMP_PDB_BOUNDARY (18), GIMP_PDB_PATH (19), GIMP_PDB_PARASITE (20), GIMP_PDB_STATUS (21) }
STRING	val_name	The name of the return value
STRING	val_desc	A description of the return value

This procedure returns information on the specified procedure's return value. The return value type, name, and a description are retrieved.
Spencer Kimball & Peter Mattis; 1997

gimp_procedural_db_query

Input:

STRING	name	The regex for procedure name
STRING	blurb	The regex for procedure blurb
STRING	help	The regex for procedure help
STRING	author	The regex for procedure author
STRING	copyright	The regex for procedure copyright
STRING	date	The regex for procedure date
STRING	proc_type	The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-In', 'GIMP Extension', 'Temporary Procedure' }

Returns:

INT32	num_matches	The number of matching procedures
STRINGARRAY	procedure_names	The list of procedure names

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.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_procedural_db_set_data

Input:

STRING	identifier	The identifier associated with data
INT32	bytes	The number of bytes in the data
INT8ARRAY	data	A byte array containing data

Returns: nothing
This procedure associates the supplied data with the provided identifier. The data may be subsequently retrieved by a call to 'procedural-db-get-data'.
Spencer Kimball & Peter Mattis; 1997

gimp_procedural_db_temp_name

Input: none
Returns:

STRING

temp_name

A unique temporary name for a temporary PDB entry

This procedure generates a temporary PDB entry name that is guaranteed to be unique. It is mainly used by the interactive popup dialogs to generate a PDB entry name.
Andy Thomas; 1998

The Gimp 2.3.2 (win32)	Documentation fresh from PDB	22:53:14 Fr 22.07.2005
Generated by pdb2doc.py* written by Hans Breuer <Hans@Breuer.org>*