Top | ![]() |
![]() |
![]() |
![]() |
GimpModuleGimpModule — A GTypeModule subclass which implements module loading using GModule. |
const GimpModuleInfo * | (*GimpModuleQueryFunc) () |
gboolean | (*GimpModuleRegisterFunc) () |
GimpModule * | gimp_module_new () |
gboolean | gimp_module_query_module () |
GFile * | gimp_module_get_file () |
gboolean | gimp_module_get_auto_load () |
void | gimp_module_set_auto_load () |
gboolean | gimp_module_is_loaded () |
gboolean | gimp_module_is_on_disk () |
const GimpModuleInfo * | gimp_module_get_info () |
const gchar * | gimp_module_get_last_error () |
GimpModuleState | gimp_module_get_state () |
GQuark | gimp_module_error_quark () |
GimpModuleInfo | |
enum | GimpModuleState |
#define | GIMP_MODULE_ERROR |
enum | GimpModuleError |
#define | GIMP_MODULE_ABI_VERSION |
GimpModule is a generic mechanism to dynamically load modules into GIMP. It is a GTypeModule subclass, implementing module loading using GModule. GimpModule does not know which functionality is implemented by the modules, it just provides a framework to get arbitrary GType implementations loaded from disk.
const GimpModuleInfo *
(*GimpModuleQueryFunc) (GTypeModule *module
);
The signature of the query function a loadable GIMP module must
implement. In the module, the function must be called
gimp_module_query()
.
GimpModule will copy the returned GimpModuleInfo struct, so the module doesn't need to keep these values around (however in most cases the module will just return a pointer to a constant structure).
gboolean
(*GimpModuleRegisterFunc) (GTypeModule *module
);
The signature of the register function a loadable GIMP module must
implement. In the module, the function must be called
gimp_module_register()
.
When this function is called, the module should register all the types
it implements with the passed module
.
GimpModule * gimp_module_new (GFile *file
,gboolean auto_load
,gboolean verbose
);
Creates a new GimpModule instance.
gboolean
gimp_module_query_module (GimpModule *module
);
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.
GFile *
gimp_module_get_file (GimpModule *module
);
Returns GFile of the module
,
Since: 3.0
gboolean
gimp_module_get_auto_load (GimpModule *module
);
Returns whether this module
in automatically loaded at startup.
Since: 3.0
void gimp_module_set_auto_load (GimpModule *module
,gboolean auto_load
);
Sets the auto_load
property if the module. Emits "modified".
Since: 3.0
const GimpModuleInfo *
gimp_module_get_info (GimpModule *module
);
Since: 3.0
const gchar *
gimp_module_get_last_error (GimpModule *module
);
Since: 3.0
GQuark
gimp_module_error_quark (void
);
This function is never called directly. Use GIMP_MODULE_ERROR()
instead.
Since: 2.8
typedef struct { guint32 abi_version; gchar *purpose; gchar *author; gchar *version; gchar *copyright; gchar *date; } GimpModuleInfo;
This structure contains information about a loadable module.
The possible states a GimpModule can be in.
Missing |
||
An instance of a type implemented by this module is allocated. |
||
gimp_module_register() returned |
||
There are no instances allocated of types implemented by this module. |
#define GIMP_MODULE_ABI_VERSION 0x0005
The version of the module system's ABI. Modules put this value into
GimpModuleInfo's abi_version
field so the code loading the modules
can check if it was compiled against the same module ABI the modules
are compiled against.
GIMP_MODULE_ABI_VERSION is incremented each time one of the following changes:
the libgimpmodule implementation (if the change affects modules).
one of the classes implemented by modules (currently GimpColorDisplay, GimpColorSelector and GimpController).
“modified”
signalvoid user_function (GimpModule *gimpmodule, gpointer user_data)
Flags: Run First