e_plugin_construct ()

gint
e_plugin_construct (EPlugin *plugin,
                    xmlNodePtr root);

Helper to invoke the construct virtual method.

e_plugin_load_plugins ()

gint
e_plugin_load_plugins (void);

Scan the search path, looking for plugin definitions, and load them into memory.

e_plugin_list_plugins ()

GSList *
e_plugin_list_plugins (void);

e_plugin_get_symbol ()

gpointer
e_plugin_get_symbol (EPlugin *plugin,
                     const gchar *name);

Helper to fetch a symbol name from a plugin.

e_plugin_invoke ()

gpointer
e_plugin_invoke (EPlugin *plugin,
                 const gchar *name,
                 gpointer data);

Helper to invoke the invoke virtual method.

e_plugin_enable ()

void
e_plugin_enable (EPlugin *plugin,
                 gint state);

Set the enable state of a plugin.

THIS IS NOT FULLY IMPLEMENTED YET

e_plugin_get_configure_widget ()

GtkWidget *
e_plugin_get_configure_widget (EPlugin *plugin);

Plugin itself should have implemented "e_plugin_lib_get_configure_widget" function * of prototype EPluginLibGetConfigureWidgetFunc.

e_plugin_xml_prop ()

gchar *
e_plugin_xml_prop (xmlNodePtr node,
                   const gchar *id);

A static helper function to look up a property on an XML node, and ensure it is allocated in GLib system memory.

e_plugin_xml_prop_domain ()

gchar *
e_plugin_xml_prop_domain (xmlNodePtr node,
                          const gchar *id,
                          const gchar *domain);

A static helper function to look up a property on an XML node, and translate it based on domain .

e_plugin_xml_int ()

gint
e_plugin_xml_int (xmlNodePtr node,
                  const gchar *id,
                  gint def);

A static helper function to look up a property on an XML node as an integer. If the property doesn't exist, then def is returned as a default value instead.

e_plugin_xml_content ()

gchar *
e_plugin_xml_content (xmlNodePtr node);

A static helper function to retrieve the entire textual content of an XML node, and ensure it is allocated in GLib system memory. If GLib isn't using the system malloc them it must copy the content.

e_plugin_xml_content_domain ()

gchar *
e_plugin_xml_content_domain (xmlNodePtr node,
                             const gchar *domain);

A static helper function to retrieve the entire textual content of an XML node, and ensure it is allocated in GLib system memory. If GLib isn't using the system malloc them it must copy the content.

e_plugin_hook_new ()

EPluginHook *
e_plugin_hook_new (EPlugin *plugin,
                   xmlNodePtr root);

e_plugin_hook_enable ()

void
e_plugin_hook_enable (EPluginHook *plugin_hook,
                      gint state);

Set the enabled state of the plugin hook. This is called by the plugin code.

THIS IS NOT FULY IMEPLEMENTED YET

e_plugin_hook_mask ()

guint32
e_plugin_hook_mask (xmlNodePtr root,
                    const EPluginHookTargetKey *map,
                    const gchar *prop);

This is a static helper function which looks up a property prop on the XML node root , and then uses the map table to convert it into a bitmask. The property value is a comma separated list of enumeration strings which are indexed into the map table.

e_plugin_hook_id ()

guint32
e_plugin_hook_id (xmlNodePtr root,
                  const EPluginHookTargetKey *map,
                  const gchar *prop);

This is a static helper function which looks up a property prop on the XML node root , and then uses the map table to convert it into an integer.

This is used as a helper wherever you need to represent an enumerated value in the XML.

E_PLUGIN_CLASSID

#define E_PLUGIN_CLASSID "org.gnome.evolution.plugin"

struct EPluginAuthor

struct EPluginAuthor {
	gchar *name;
	gchar *email;
};

enum EPluginFlags

struct EPluginHookTargetKey

struct EPluginHookTargetKey {
	const gchar *key;
	guint32 value;
};

struct EPluginHookTargetMap

struct EPluginHookTargetMap {
	const gchar *type;
	gint id;
	const EPluginHookTargetKey *mask_bits; /* null terminated array */
};

The “enabled” property

  “enabled”                  gboolean

Whether the plugin is enabled.

Flags: Read / Write

Default value: TRUE