Constructor
GimpBatchProcedurenew
since: 3.0
Declaration [src]
GimpProcedure*
gimp_batch_procedure_new (
GimpPlugIn* plug_in,
const gchar* name,
const gchar* interpreter_name,
GimpPDBProcType proc_type,
GimpBatchFunc run_func,
gpointer run_data,
GDestroyNotify run_data_destroy
)
Description [src]
Creates a new batch interpreter procedure named name which will call
run_func when invoked.
See gimp_procedure_new() for information about proc_type.
GimpBatchProcedure is a GimpProcedure subclass that makes it easier
to write batch interpreter procedures.
It automatically adds the standard
(GimpRunMode, #gchar)
arguments of a batch procedure. It is possible to add additional arguments.
When invoked via gimp_procedure_run(), it unpacks these standard
arguments and calls run_func which is a GimpBatchFunc. The “args”
GimpValueArray of GimpRunSaveFunc only contains additionally added arguments.
Available since: 3.0
Parameters
plug_in-
Type:
GimpPlugInA
GimpPlugIn.The data is owned by the caller of the function. name-
Type:
const gchar*The new procedure’s name.
The data is owned by the caller of the function. The value is a NUL terminated UTF-8 string. interpreter_name-
Type:
const gchar*The public-facing name, e.g. “Python 3”.
The data is owned by the caller of the function. The value is a NUL terminated UTF-8 string. proc_type-
Type:
GimpPDBProcTypeThe new procedure’s
GimpPDBProcType. run_func-
Type:
GimpBatchFuncThe run function for the new procedure.
run_data-
Type:
gpointerUser data passed to
run_func.The argument can be NULL.The data is owned by the caller of the function. run_data_destroy-
Type:
GDestroyNotifyFree function for
run_data, orNULL.The argument can be NULL.
Return value
Type: GimpProcedure
A new GimpProcedure.
| The caller of the function takes ownership of the data, and is responsible for freeing it. |