Gimp.ImageProcedure

Subclasses:

None

Methods

Inherited:

Gimp.Procedure (145), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new (plug_in, name, proc_type, run_func)

Virtual Methods

Inherited:

Gimp.Procedure (4), GObject.Object (7)

Properties

Inherited:

Gimp.Procedure (3)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Gimp.ImageProcedure(**kwargs)

Bases:

Gimp.Procedure

Abstract:

No

Structure:

Gimp.ImageProcedureClass

A [class`Procedure`] subclass that makes it easier to write standard plug-in procedures that operate on drawables.

It automatically adds the standard

( [enum`RunMode`], [class`Image`], [class`Drawable`] )

arguments of an image procedure. It is possible to add additional arguments.

When invoked via [method`Procedure`.run], it unpacks these standard arguments and calls run_func which is a [callback`RunImageFunc`]. The “args” [struct`ValueArray`] of [callback`RunImageFunc`] only contains additionally added arguments.

classmethod new(plug_in, name, proc_type, run_func)

Parameters:

• plug_in (Gimp.PlugIn) – a Gimp.PlugIn.

• name (str) – the new procedure’s name.

• proc_type (Gimp.PDBProcType) – the new procedure’s Gimp.PDBProcType.

• run_func (Gimp.RunImageFunc) – the run function for the new procedure.

Returns:

a new Gimp.Procedure.

Return type:

Gimp.Procedure

Creates a new image procedure named name which will call run_func when invoked.

See [ctor`Procedure`.new] for information about proc_type.

New in version 3.0.