Class
PeasEngine
Description [src]
final class Peas.Engine : GObject.Object {
/* No available fields */
}
The PeasEngine
is the object which manages the plugins.
Its role is twofold:
- it will fetch all the information about the available plugins from all the registered plugin directories;
- it will provide you an API to load, control and unload your plugins and their extensions from within your application.
Constructors
peas_engine_new
Return a new instance of PeasEngine
.
peas_engine_new_with_nonglobal_loaders
Return a new instance of PeasEngine
which will use non-global
plugin loaders instead of the default global ones.
Instance methods
peas_engine_add_search_path
Appends a search path to the list of paths where to look for plugins.
peas_engine_create_extension
If the plugin identified by info
implements the extension_type
,
then this function will return a new instance of this implementation.
peas_engine_create_extension_valist
If the plugin identified by info
implements the extension_type
,
then this function will return a new instance of this implementation.
peas_engine_create_extension_with_properties
If the plugin identified by info
implements the extension_type
,
then this function will return a new instance of this implementation.
peas_engine_dup_loaded_plugins
Returns the list of the names of all the loaded plugins.
peas_engine_enable_loader
Enable a loader, enables a loader for plugins.
peas_engine_garbage_collect
Triggers garbage collection on all the loaders currently owned by the
PeasEngine
.
peas_engine_get_plugin_info
Gets the PeasPluginInfo
corresponding with plugin_name
,
or NULL
if plugin_name
was not found.
peas_engine_load_plugin
Loads the plugin corresponding to info
if it’s not currently loaded.
peas_engine_provides_extension
Returns if info
provides an extension for extension_type
.
peas_engine_rescan_plugins
Rescan all the registered directories to find new or updated plugins.
peas_engine_set_loaded_plugins
Sets the list of loaded plugins for engine
.
peas_engine_unload_plugin
Unloads the plugin corresponding to info
.
Properties
Peas.Engine:loaded-plugins
The list of loaded plugins.
Peas.Engine:nonglobal-loaders
If non-global plugin loaders should be used.
Signals
Peas.Engine::load-plugin
The load-plugin signal is emitted when a plugin is being loaded.
Peas.Engine::unload-plugin
The unload-plugin signal is emitted when a plugin is being unloaded.
Class structure
struct PeasEngineClass {
GObjectClass parent_class;
}
Class members
parent_class |
|
No description available. |
Functions
peas_engine_get_default
Return the existing instance of PeasEngine
or a subclass of it.