Gimp.ThumbnailProcedure

Subclasses:

None

Methods

Inherited:

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

Structs:

GObject.ObjectClass (5)

class

new (plug_in, name, proc_type, run_func, *run_data)

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.ThumbnailProcedure(**kwargs)

Bases:

Gimp.Procedure

Abstract:

No

Structure:

Gimp.ThumbnailProcedureClass

classmethod new(plug_in, name, proc_type, run_func, *run_data)

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.RunThumbnailFunc) – the run function for the new procedure.

• run_data (object or None) – user data passed to run_func.

Returns:

a new Gimp.Procedure.

Return type:

Gimp.Procedure

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

See Gimp.Procedure.new() for information about proc_type.

Gimp.ThumbnailProcedure is a Gimp.Procedure subclass that makes it easier to write file thumbnail procedures.

It automatically adds the standard

(Gio.File, size)

arguments and the standard

(Gimp.Image, image-width, image-height, Gimp.ImageType, num-layers)

return value of a thumbnail 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 Gimp.RunThumbnailFunc. The “args” Gimp.ValueArray of Gimp.RunThumbnailFunc only contains additionally added arguments.

Gimp.RunThumbnailFunc must Gimp.ValueArray.truncate() the returned Gimp.ValueArray to the number of return values it actually uses.

New in version 3.0.