Gimp.Module¶

Subclasses:: None

Methods¶

Inherited:: GObject.TypeModule (7), GObject.Object (37), GObject.TypePlugin (4)
Structs:: GObject.ObjectClass (5)

class	`error_quark` ()
class	`new` (file, auto_load, verbose)
class	`query` (module)
class	`register` (module)
	`get_auto_load` ()
	`get_file` ()
	`get_info` ()
	`get_last_error` ()
	`get_state` ()
	`is_loaded` ()
	`is_on_disk` ()
	`query_module` ()
	`set_auto_load` (auto_load)

Virtual Methods¶

Inherited:: GObject.TypeModule (2), GObject.Object (7)

do_modified ()

Properties¶

Name	Type	Flags	Short Description
`auto-load`	`bool`	r/w	auto-load
`on-disk`	`bool`	r	on-disk

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.TypeModule`	r

Class Details¶

class Gimp.Module(**kwargs)¶

Bases:: GObject.TypeModule
Abstract:: No
Structure:: Gimp.ModuleClass

Gimp.Module is a generic mechanism to dynamically load modules into GIMP. It is a GObject.TypeModule subclass, implementing module loading using GModule.Module. Gimp.Module does not know which functionality is implemented by the modules, it just provides a framework to get arbitrary GObject.GType implementations loaded from disk.

classmethod error_quark()¶

Returns:: the #GQuark that defines the GIMP module error domain.
Return type:: int

This function is never called directly. Use GIMP_MODULE_ERROR() instead.

New in version 2.8.

classmethod new(file, auto_load, verbose)¶

Parameters:

file (Gio.File) – A Gio.File pointing to a loadable module.
auto_load (bool) – Pass True to exclude this module from auto-loading.
verbose (bool) – Pass True to enable debugging output.

Returns:

The new Gimp.Module object.

Return type:

Gimp.Module

Creates a new Gimp.Module instance.

classmethod query(module)¶

Parameters:: module (GObject.TypeModule) –
Return type:: Gimp.ModuleInfo

classmethod register(module)¶

Parameters:: module (GObject.TypeModule) –
Return type:: bool

get_auto_load()¶

Returns:: The self's ‘auto_load’ property.
Return type:: bool

Returns whether this self in automatically loaded at startup.

New in version 3.0.

get_file()¶

Returns:: The self's Gio.File.
Return type:: Gio.File

Returns Gio.File of the self,

New in version 3.0.

get_info()¶

Returns:: The self's Gimp.ModuleInfo as provided by the actual module, or None.
Return type:: Gimp.ModuleInfo

New in version 3.0.

get_last_error()¶

Returns:: The self's last error message.
Return type:: str

New in version 3.0.

get_state()¶

Returns:: The self's state.
Return type:: Gimp.ModuleState

New in version 3.0.

is_loaded()¶

Returns:: Whether the self is currently loaded.
Return type:: bool

New in version 3.0.

is_on_disk()¶

Returns:: Whether the self is present on diak.
Return type:: bool

New in version 3.0.

query_module()¶

Returns:: True on success.
Return type:: bool

Queries the module without actually registering any of the types it may implement. After successful query, Gimp.Module.get_info() can be used to get further about the module.

set_auto_load(auto_load)¶

Parameters:: auto_load (bool) – Pass False to exclude this module from auto-loading

Sets the auto_load property of the module

New in version 3.0.

do_modified() virtual¶

Property Details¶

Gimp.Module.props.auto_load¶

Name:: auto-load
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

auto-load

Gimp.Module.props.on_disk¶

Name:: on-disk
Type:: bool
Default Value:: False
Flags:: READABLE

on-disk