From d4137ae5df862352e45d064a57a0393099b5d044 Mon Sep 17 00:00:00 2001 From: Not Zed Date: Tue, 12 Jul 2005 04:34:24 +0000 Subject: Added some e-import stuff. 2005-07-12 Not Zed * build-eplugin-manual.pl: * evolution-plugin-manual.xml: Added some e-import stuff. svn path=/trunk/; revision=29726 --- doc/devel/ChangeLog | 6 ++ doc/devel/build-eplugin-manual.pl | 8 ++ doc/devel/evolution-plugin-manual.xml | 142 ++++++++++++++++++++++++++++++++++ 3 files changed, 156 insertions(+) diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog index 69ef0b5226..c22feb3b29 100644 --- a/doc/devel/ChangeLog +++ b/doc/devel/ChangeLog @@ -1,3 +1,9 @@ +2005-07-12 Not Zed + + * build-eplugin-manual.pl: + + * evolution-plugin-manual.xml: Added some e-import stuff. + 2005-05-19 Not Zed * evolution-plugin-manual.xml: added some stuff about the pseudo diff --git a/doc/devel/build-eplugin-manual.pl b/doc/devel/build-eplugin-manual.pl index 8cb951a516..1ddcb795d9 100755 --- a/doc/devel/build-eplugin-manual.pl +++ b/doc/devel/build-eplugin-manual.pl @@ -24,6 +24,10 @@ { 'files' => [ 'e-plugin.h', 'e-plugin.c' ], 'module' => 'e-util' }, + 'e-import.xml' => + { 'files' => [ 'e-import.c', 'e-import.c' ], + 'module' => 'e-util' }, + 'em-popup.xml' => { 'files' => [ 'em-popup.h', 'em-popup.c' ], 'module' => 'mail' }, @@ -228,6 +232,10 @@ END { 'type' => 'HookPoint', 'files' => [ 'e-shell-window.c' ], 'module' => 'shell' }, + 'es-importers.xml' => + { 'type' => 'HookClass', + 'files' => [ 'e-import.c' ], + 'module' => 'e-util' }, 'es-events.xml' => { 'type' => 'Event', 'files' => [ 'e-shell.c' ], diff --git a/doc/devel/evolution-plugin-manual.xml b/doc/devel/evolution-plugin-manual.xml index d184259ae4..d94ec5cc25 100644 --- a/doc/devel/evolution-plugin-manual.xml +++ b/doc/devel/evolution-plugin-manual.xml @@ -12,6 +12,7 @@ + @@ -25,6 +26,7 @@ + ]> @@ -1810,6 +1812,119 @@ + + + + Importers + + + Importers let &Evolution; import data from other or older programs + into its native format. + + + Importers are driven from a druid in the shell, they can work on + individual files, or multiple component application data. All + importers go through the same interface, is this data + present/supported, how do you control the import, and import the data. + + + Defining an import hook + + + * +]]> + + + target + + + The target type for this importer. File importers are of a + type uri and application importers are + of type home (indicating a 'home + directory'). + + + + + supported + + + A function to call to determine if the file is supported or + not. The function will be passed the target, and returns + non-NULL if the file is known or the application data exists. + + + + + get-widget + + + A factory method to get a widget to control the import. For + file-based importers, this should return a widget which lets + the user select the destination for the import. For + application importers this should return a widget which lets + the user choose what to import. Where possible, the + application importer should record whether or not the data + has already been imported and default any checkboxes + accordingly. + + + + + import + + + The function to call to import the data. This function + should generally invoke another thread, or run via an idle + handler callback. During the import it may call e_import_status() to + report progress. It must call e_import_complete() + once the import is complete, or has failed, or there was no + work selected by the user. + + + + + cancel + + + This optional callback will be invoked if the user activates + the cancel button on the import window. It should try to + short-cut further processing where possible. + + + + + name + + + The short name description of the importer, which will be + used in the import type selection dropdown, or next to the + application importer widgets. + + + + + description + + + A longer description of the importer. Currently unused. + + + + + + + @@ -2745,6 +2860,22 @@ &es-events; + + Importers + + + Importers are currently global to the shell. The importer class is + org.gnome.evolution.import:1.0. + + + Each plugin callback is passed the target. Once the target has been + passed to get-widget, the same target will be passed to import or + cancel. This allows information to be stored non-globally across + invocations by utilising the GData field in the target. + + &es-importers; + + @@ -2871,6 +3002,17 @@ &em-format-reference; + + + + EImport + + + The EImport object is used to hold a list of EImportImporter + structures, which are used to drive the importer window. + + &e-import-reference; + -- cgit v1.2.3