GObject.Object
Peas.Engine
Import line: | Peas = imports.gi.Peas; |
GIR File: | Peas-1.0.gir |
C documentation: | PeasEngine |
Class : | Engine |
Extends: | GObject.Object |
Show / Hide Inherited methods, properties and signals |
Properties | Defined By | |
---|---|---|
app_name : String
The application name.
The application name. Filename extension and section header for PeasPluginInfo files are actually derived from this value. For instance, if app-name is "Gedit", then info files will have the .gedit-plugin extension, and the engine will look for a "Gedit Plugin" section in it to load the plugin data.
|
Peas.Engine | |
base_module_dir : String
The base application directory for binding modules lookup.
The base application directory for binding modules lookup. Each loader module will load its modules from a subdirectory of the base module directory. For instance, the python loader will look for python modules in "${base-module-dir}/python/".
|
Peas.Engine | |
parent : GObject.Object
read only
|
Peas.Engine | |
priv : Peas.EnginePrivate
read only
|
Peas.Engine | |
search_paths : none
The list of path where to look for plugins.
The list of path where to look for plugins. A so-called "search path" actually consists on a couple of both a module directory (where the shared libraries or language modules lie) and a data directory (where the plugin data is). The PeasPlugin will be able to use a correct data dir depending on where it is installed, hence allowing to keep the plugin agnostic installed both in the system path or in the user's home directory, without taking other special care than using egg_plugin_get_data_dir() when looking for its data files. Concretely, this property contains a NULL-terminated array of strings, whose even-indexed strings are module directories, and odd-indexed ones are the associated data directories. Here is an example of such an array: |[ gchar const * const search_paths[] = { // Plugins in ~/.config g_build_filename (g_get_user_config_dir (), "example/plugins", NULL), g_build_filename (g_get_user_config_dir (), "example/plugins", NULL), // System plugins EXAMPLE_PREFIX "/lib/example/plugins/", EXAMPLE_PREFIX "/share/example/plugins/", NULL }; ]|
|
Peas.Engine |
Method / Constructor | Defined By | |
---|---|---|
new Peas.Engine
(Object properties)
Create a new Peas.Engine
Create a new Peas.Engine
|
||
Create a new Peas.Engine
Create a new Peas.Engine
|
||
activate_plugin
(PluginInfo info)
:
Boolean
Activates the plugin corresponding to info on all the objects registered against engine, loading it if it's not already available.
Activates the plugin corresponding to info on all the objects registered against engine, loading it if it's not already available.
|
Peas.Engine | |
deactivate_plugin
(PluginInfo info)
:
Boolean
Deactivates the plugin corresponding to info on all the objects registered against engine, eventually unloading it when it has been completely deactivated.
Deactivates the plugin corresponding to info on all the objects registered against engine, eventually unloading it when it has been completely deactivated.
|
Peas.Engine | |
garbage_collect
()
:
none
This function triggers garbage collection on all the loaders currently owned by the PeasEngine.
This function triggers garbage collection on all the loaders currently owned by the PeasEngine. This can be used to force the loaders to destroy managed objects that still hold references to objects that are about to disappear.
|
Peas.Engine | |
get_active_plugins
()
:
Array
Returns the list of the names of all the active plugins, or NULL if there is no active plugin.
Returns the list of the names of all the active plugins, or NULL if there is no active plugin. Please note that the returned array is a newly
|
Peas.Engine | |
|
Peas.Engine | |
get_plugin_info
(String plugin_name)
:
Peas.PluginInfo
|
Peas.Engine | |
get_plugin_list
()
:
Array
Returns the list of PeasPluginInfo known to the engine.
Returns the list of PeasPluginInfo known to the engine. belongs to the engine and should not be freed.
|
Peas.Engine | |
|
Peas.Engine | |
rescan_plugins
()
:
none
Rescan all the registered directories to find new or updated plugins.
Rescan all the registered directories to find new or updated plugins. Calling this function will make the newly installed plugin infos to be loaded by the engine, so the new plugins can actually be used without restarting the application.
|
Peas.Engine | |
set_active_plugins
(Array plugin_names)
:
none
Sets the list of active plugins for engine.
Sets the list of active plugins for engine. When this function is called, the PeasEngine will activate all the plugins whose names are in
|
Peas.Engine |
Event | Defined By | |
---|---|---|
activate_plugin (Engine self, PluginInfo info)
:
none
The activate-plugin signal is emitted when a plugin is being activated.
The activate-plugin signal is emitted when a plugin is being activated.
|
Peas.Engine | |
deactivate_plugin (Engine self, PluginInfo info)
:
none
The activate-plugin signal is emitted when a plugin is being deactivated.
The activate-plugin signal is emitted when a plugin is being deactivated.
|
Peas.Engine |
Class / Namespace | Method / Signal / Properties |
---|---|
Peas.ExtensionSet
Method |
Create a new Peas.ExtensionSet
|
PeasUI.PluginManager
Property |
engine : Peas.Engine
|
PeasUI.PluginManager
Method |
Create a new PeasUI.PluginManager
|