From f46a9a5aafe290dbf013cb7ef2b304c32a79993a Mon Sep 17 00:00:00 2001 From: Not Zed Date: Thu, 7 Oct 2004 09:49:24 +0000 Subject: some updates. 2004-10-07 Not Zed * evolution-plugin-manual.xml: some updates. svn path=/trunk/; revision=27496 --- doc/devel/ChangeLog | 4 + doc/devel/evolution-plugin-manual.xml | 184 +++++++++++++++++++++++----------- 2 files changed, 131 insertions(+), 57 deletions(-) (limited to 'doc/devel') diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog index 89afe74c72..18d59f736c 100644 --- a/doc/devel/ChangeLog +++ b/doc/devel/ChangeLog @@ -1,3 +1,7 @@ +2004-10-07 Not Zed + + * evolution-plugin-manual.xml: some updates. + 2004-09-09 Not Zed * evolution-plugin-manual.xml: updates. some not very readable, sigh. diff --git a/doc/devel/evolution-plugin-manual.xml b/doc/devel/evolution-plugin-manual.xml index 9e3331d74a..9ca1d5b535 100644 --- a/doc/devel/evolution-plugin-manual.xml +++ b/doc/devel/evolution-plugin-manual.xml @@ -408,6 +408,7 @@ + ]]> + + id + + + A unique string identifying this plugin. By convention this + will follow the java-like class namespace system. + e.g. com.ximian.evolution.test-plugin + + + type @@ -493,8 +504,17 @@ linkend="API-struct--EPluginLib">EPluginLib implements a concrete EPlugin type which loads GNU shared libraries via the GModule api. It simply resolves symbols directly from the loaded - shared object and invokes them with the same arguments as the - e_plugin_invoke method. + shared object and invokes them expecting a function signature of + EPluginLibFunc. + + + To manage plugin lifecycle, the function + e_plugin_lib_enable + will be invoked which allows the plugin to initialise itself. Its + signature should match EPluginLibEnableFunc, and it will + be called with enable=1. If the enable + function returns non-zero it is assumed to have failed intialisation + and will not be invoked further. @@ -1170,7 +1190,7 @@ + * * ]]> - - Need to define group tag - - - - type - - - The menu item type. The type maps directly to the - corresponding EConfigItem types. Only one of - book and druid - may be supplied for the entire configuration page, and this - will usually already be defined by the application. - - - - - path - - - The path to the configuration item in question. This is a - simple string that when sorted using an ASCII sort will place - the items in the right order. That is, sections before items - before pages before the root object. - - - - - label - - - The textual label of this item. This may only be supplied - for the section and page types. For sections it will be the - section frame text. For pages this will be the druid page - title or the notebook tab text. If a - factoryis supplied then this value is - not used. This will be translated based on the plugin - translation domain. - - - - - factory - - - If supplied, the factory method used to create the GtkWidget - elements for this configuration item. Factories may be - supplied for any of the item types. If no - label is set then the - factory must be set. - - - - + + + Group Element Properties + + + + id + + + The name of the configuration window to which this hook + applies. + + + + + target + + + The type of target this configuration window applies too. + This will normally be tied directly to the specific + configuration window itself. + + + + + commit + + + A callback which will be invoked to commit the + configuration data, if the configuration page isn't an + instant-apply one. This callback can write any + configuration changes to permanent storage. It is not used + for instant-apply windows. + + + + + abort + + + A callback which will be invoked to abort the configuration + process. This callback is called when the + Cancel button is pressed on stateful + configuration windows. + + + + + + + Item Element Properties + + + + type + + + The menu item type. The type maps directly to the + corresponding EConfigItem types. Only one of + book and druid + may be supplied for the entire configuration page, and this + will usually already be defined by the application. + + + + + path + + + The path to the configuration item in question. This is a + simple string that when sorted using an ASCII sort will place + the items in the right order. That is, sections before items + before pages before the root object. + + + + + label + + + The textual label of this item. This may only be supplied + for the section and page types. For sections it will be the + section frame text. For pages this will be the druid page + title or the notebook tab text. If a + factoryis supplied then this value is + not used. This will be translated based on the plugin + translation domain. + + + + + factory + + + If supplied, the factory method used to create the GtkWidget + elements for this configuration item. Factories may be + supplied for any of the item types. If no + label is set then the + factory must be set. + + + + + Generating Configuration Pages -- cgit