Gimp.LoadProcedure¶

Subclasses:: Gimp.VectorLoadProcedure

Methods¶

Inherited:: Gimp.FileProcedure (14), Gimp.Procedure (145), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (plug_in, name, proc_type, run_func, *run_data)
	`get_handles_raw` ()
	`get_thumbnail_loader` ()
	`set_handles_raw` (handles_raw)
	`set_thumbnail_loader` (thumbnail_proc)

Virtual Methods¶

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

Properties¶

Inherited:: Gimp.Procedure (3)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gimp.FileProcedure`	r

Class Details¶

class Gimp.LoadProcedure(**kwargs)¶

Bases:: Gimp.FileProcedure
Abstract:: No
Structure:: Gimp.LoadProcedureClass

A [class`Procedure`] subclass that makes it easier to write file load procedures.

It automatically adds the standard

( [enum`RunMode`], [iface`Gio`.File] )

arguments and the standard

( [class`Image`] )

return value of a load 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, *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.RunLoadFunc) – 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 load procedure named name which will call run_func when invoked.

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

New in version 3.0.

get_handles_raw()¶

Returns:: The procedure’s ‘handles raw’ flag.
Return type:: bool

Returns the procedure’s ‘handles raw’ flag as set with [method`GimpLoadProcedure`.set_handles_raw].

New in version 3.0.

get_thumbnail_loader()¶

Returns:: The procedure’s thumbnail loader procedure
Return type:: str

Returns the procedure’s thumbnail loader procedure as set with [method`GimpLoadProcedure`.set_thumbnail_loader].

New in version 3.0.

set_handles_raw(handles_raw)¶

Parameters:: handles_raw (bool) – The procedure’s handles raw flag.

Registers a load procedure as capable of handling raw digital camera loads.

Note that you cannot call this function on [class`VectorLoadProcedure`] subclass objects.

New in version 3.0.

set_thumbnail_loader(thumbnail_proc)¶

Parameters:: thumbnail_proc (str) – The name of the thumbnail load procedure.

Associates a thumbnail loader with a file load procedure.

Some file formats allow for embedded thumbnails, other file formats contain a scalable image or provide the image data in different resolutions. A file plug-in for such a format may register a special procedure that allows GIMP to load a thumbnail preview of the image. This procedure is then associated with the standard load procedure using this function.

New in version 3.0.