![]() |
![]() |
![]() |
Anjuta Developers Reference Manual | ![]() |
---|---|---|---|---|
#include <libanjuta/anjuta-plugin-manager.h> #define ANJUTA_PLUGIN_MANAGER_ERROR enum AnjutaPluginManagerError; AnjutaPluginManagerPriv; AnjutaPluginManager; GQuark anjuta_plugin_manager_error_quark (void); AnjutaPluginManager* anjuta_plugin_manager_new (GObject *shell, AnjutaStatus *status, GList *plugin_search_paths); GObject* anjuta_plugin_manager_get_plugin (AnjutaPluginManager *plugin_manager, const gchar *iface_name); GObject* anjuta_plugin_manager_get_plugin_by_id (AnjutaPluginManager *plugin_manager, const gchar *plugin_id); gboolean anjuta_plugin_manager_unload_plugin (AnjutaPluginManager *plugin_manager, GObject *plugin); gboolean anjuta_plugin_manager_unload_plugin_by_id (AnjutaPluginManager *plugin_manager, const gchar *plugin_id); GList* anjuta_plugin_manager_get_active_plugins (AnjutaPluginManager *plugin_manager); GList* anjuta_plugin_manager_get_active_plugin_objects (AnjutaPluginManager *plugin_manager); GtkWidget* anjuta_plugin_manager_get_plugins_page (AnjutaPluginManager *plugin_manager); GtkWidget* anjuta_plugin_manager_get_remembered_plugins_page (AnjutaPluginManager *plugin_manager); GList* anjuta_plugin_manager_query (AnjutaPluginManager *plugin_manager, const gchar *section_name, const gchar *attribute_name, const gchar *attribute_value, ...); AnjutaPluginDescription* anjuta_plugin_manager_select (AnjutaPluginManager *plugin_manager, gchar *title, gchar *description, GList *plugin_descriptions); GObject* anjuta_plugin_manager_select_and_activate (AnjutaPluginManager *plugin_manager, gchar *title, gchar *description, GList *plugin_descriptions); void anjuta_plugin_manager_activate_plugins (AnjutaPluginManager *plugin_manager, GList *plugin_descs); void anjuta_plugin_manager_unload_all_plugins (AnjutaPluginManager *plugin_manager); gchar* anjuta_plugin_manager_get_remembered_plugins (AnjutaPluginManager *plugin_manager); void anjuta_plugin_manager_set_remembered_plugins (AnjutaPluginManager *plugin_manager, const gchar *remembered_plugins); #define anjuta_plugin_manager_get_interface (plugin_manager, iface_type, error)
"activated-plugins" gpointer : Read "available-plugins" gpointer : Read "profiles" gpointer : Read "shell" GObject : Read / Write / Construct "status" AnjutaStatus : Read / Write / Construct
#define ANJUTA_PLUGIN_MANAGER_ERROR (anjuta_plugin_manager_error_quark())
typedef enum { ANJUTA_PLUGIN_MANAGER_MISSING_FACTORY, ANJUTA_PLUGIN_MANAGER_ERROR_UNKNOWN } AnjutaPluginManagerError;
AnjutaPluginManager* anjuta_plugin_manager_new (GObject *shell, AnjutaStatus *status, GList *plugin_search_paths);
shell : |
|
status : |
|
plugin_search_paths : |
|
Returns : |
GObject* anjuta_plugin_manager_get_plugin (AnjutaPluginManager *plugin_manager, const gchar *iface_name);
Searches the currently available plugins to find the one which implements the given interface as primary interface and returns it. If the plugin is not yet loaded, it will be loaded and activated. The returned object is garanteed to be an implementor of the interface (as exported by the plugin metafile). It only searches from the pool of plugin objects loaded in this shell and can only search by primary interface. If there are more objects implementing this primary interface, user might be prompted to select one from them (and might give the option to use it as default for future queries). A typical usage of this function is:
GObject *docman = anjuta_plugin_manager_get_plugin (plugin_manager, "IAnjutaDocumentManager", error);
Notice that this function takes the interface name string as string, unlike
anjuta_plugins_get_interface()
which takes the type directly.
plugin_manager : |
A AnjutaPluginManager object |
iface_name : |
The interface implemented by the object to be found |
Returns : | The plugin object (subclass of AnjutaPlugin) which implements the given interface. See AnjutaPlugin for more detail on interfaces implemented by plugins. |
GObject* anjuta_plugin_manager_get_plugin_by_id (AnjutaPluginManager *plugin_manager, const gchar *plugin_id);
plugin_manager : |
|
plugin_id : |
|
Returns : |
gboolean anjuta_plugin_manager_unload_plugin (AnjutaPluginManager *plugin_manager, GObject *plugin);
plugin_manager : |
|
plugin : |
|
Returns : |
gboolean anjuta_plugin_manager_unload_plugin_by_id (AnjutaPluginManager *plugin_manager, const gchar *plugin_id);
plugin_manager : |
|
plugin_id : |
|
Returns : |
GList* anjuta_plugin_manager_get_active_plugins (AnjutaPluginManager *plugin_manager);
plugin_manager : |
|
Returns : |
GList* anjuta_plugin_manager_get_active_plugin_objects (AnjutaPluginManager *plugin_manager);
plugin_manager : |
|
Returns : |
GtkWidget* anjuta_plugin_manager_get_plugins_page (AnjutaPluginManager *plugin_manager);
plugin_manager : |
|
Returns : |
GtkWidget* anjuta_plugin_manager_get_remembered_plugins_page (AnjutaPluginManager *plugin_manager);
plugin_manager : |
|
Returns : |
GList* anjuta_plugin_manager_query (AnjutaPluginManager *plugin_manager, const gchar *section_name, const gchar *attribute_name, const gchar *attribute_value, ...);
plugin_manager : |
|
section_name : |
|
attribute_name : |
|
attribute_value : |
|
... : |
|
Returns : |
AnjutaPluginDescription* anjuta_plugin_manager_select (AnjutaPluginManager *plugin_manager, gchar *title, gchar *description, GList *plugin_descriptions);
plugin_manager : |
|
title : |
|
description : |
|
plugin_descriptions : |
|
Returns : |
GObject* anjuta_plugin_manager_select_and_activate (AnjutaPluginManager *plugin_manager, gchar *title, gchar *description, GList *plugin_descriptions);
plugin_manager : |
|
title : |
|
description : |
|
plugin_descriptions : |
|
Returns : |
void anjuta_plugin_manager_activate_plugins (AnjutaPluginManager *plugin_manager, GList *plugin_descs);
plugin_manager : |
|
plugin_descs : |
void anjuta_plugin_manager_unload_all_plugins (AnjutaPluginManager *plugin_manager);
plugin_manager : |
gchar* anjuta_plugin_manager_get_remembered_plugins (AnjutaPluginManager *plugin_manager);
plugin_manager : |
|
Returns : |
void anjuta_plugin_manager_set_remembered_plugins (AnjutaPluginManager *plugin_manager, const gchar *remembered_plugins);
plugin_manager : |
|
remembered_plugins : |
#define anjuta_plugin_manager_get_interface(plugin_manager, iface_type, error)
Equivalent to anjuta_plugin_manager_get_object()
, but additionally
typecasts returned object to the interface type. It also takes
interface type directly. A usage of this function is:
IAnjutaDocumentManager *docman = anjuta_plugin_manager_get_interface (plugin_manager, IAnjutaDocumentManager, error);
plugin_manager : |
A AnjutaPluginManager object |
iface_type : |
The interface type implemented by the object to be found |
error : |
Error propagation object. |
available-plugins
" property"available-plugins" gpointer : Read
Currently available plugins found in plugin paths.
shell
" property"shell" GObject : Read / Write / Construct
Anjuta shell for which the plugins are.
status
" property"status" AnjutaStatus : Read / Write / Construct
Anjuta status to use in loading and unloading of plugins.
void user_function (AnjutaPluginManager *anjutapluginmanager, gpointer arg1, AnjutaPlugin *arg2, gpointer user_data) : Run First
anjutapluginmanager : |
the object which received the signal. |
arg1 : |
|
arg2 : |
|
user_data : |
user data set when the signal handler was connected. |
void user_function (AnjutaPluginManager *anjutapluginmanager, gpointer arg1, AnjutaPlugin *arg2, gpointer user_data) : Run First
anjutapluginmanager : |
the object which received the signal. |
arg1 : |
|
arg2 : |
|
user_data : |
user data set when the signal handler was connected. |