Some API documentation for the importer

svn path=/trunk/; revision=7589

3 files changed, 194 insertions, 0 deletions

diff --git a/help/devel/importer/tmpl/evolution-importer-client.sgml b/help/devel/importer/tmpl/evolution-importer-client.sgml
new file mode 100644
index 0000000000..8e911a91dd
--- /dev/null
+++ b/help/devel/importer/tmpl/evolution-importer-client.sgml
@@ -0,0 +1,96 @@
+<!-- ##### SECTION Title ##### -->
+EvolutionImporterClient
+
+<!-- ##### SECTION Short_Description ##### -->
+GTK+ object for communication with importer components.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+  The #EvolutionImporterClient provides a GTK+ wrapper for the CORBA
+  interfaces that are used to communicate between the shell and the
+  importers. The #EvolutionImporterClient removes the need for CORBA
+  calls in the shell.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### MACRO EVOLUTION_IMPORTER_CLIENT ##### -->
+<para>
+  Casts a #GtkObject into an #EvolutionImporterClient
+</para>
+
+@obj: A GtkObject.
+
+
+<!-- ##### USER_FUNCTION EvolutionImporterClientCallback ##### -->
+<para>
+  The type of the function that will be called when the importer has something
+  to report to the shell.
+</para>
+
+@client: An #EvolutionImporterClient object.
+@result: An #EvolutionImporterResult describing the result of the action.
+@more_items: A #gboolean indicating whether there are any more items to be processed.
+@data: The data that was passed into evolution_importer_client_process_item().
+
+
+<!-- ##### FUNCTION evolution_importer_client_new ##### -->
+<para>
+
+</para>
+
+@objref: 
+@Returns: 
+
+
+<!-- ##### FUNCTION evolution_importer_client_new_from_id ##### -->
+<para>
+
+</para>
+
+@id: 
+@Returns: 
+
+
+<!-- ##### FUNCTION evolution_importer_client_support_format ##### -->
+<para>
+
+</para>
+
+@client: 
+@filename: 
+@Returns: 
+
+
+<!-- ##### FUNCTION evolution_importer_client_load_file ##### -->
+<para>
+
+</para>
+
+@client: 
+@filename: 
+@Returns: 
+
+
+<!-- ##### FUNCTION evolution_importer_client_process_item ##### -->
+<para>
+
+</para>
+
+@client: 
+@callback: 
+@closure: 
+
+
+<!-- ##### FUNCTION evolution_importer_client_get_error ##### -->
+<para>
+
+</para>
+
+@client: 
+@Returns: 
+
+
diff --git a/help/devel/importer/tmpl/evolution-importer.sgml b/help/devel/importer/tmpl/evolution-importer.sgml
new file mode 100644
index 0000000000..06aa2ea762
--- /dev/null
+++ b/help/devel/importer/tmpl/evolution-importer.sgml
@@ -0,0 +1,98 @@
+<!-- ##### SECTION Title ##### -->
+EvolutionImporter
+
+<!-- ##### SECTION Short_Description ##### -->
+GTK+ object used to create Evolution Importers .
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+  The #EvolutionImporter object provides a GTK+ wrapper for the CORBA
+  interface that is used to communicate between the importer and the
+  Evolution shell.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### MACRO EVOLUTION_IMPORTER ##### -->
+<para>
+  Casts a #GtkObject to an #EvolutionImporter
+</para>
+
+@obj: A GTK+ object.
+
+
+<!-- ##### USER_FUNCTION EvolutionImporterSupportFormatFn ##### -->
+<para>
+  The function that is called when the Evolution shell wants to know
+  whether this #EvolutionImporter is able to support the file specified
+  by @filename. 
+</para>
+
+@importer: An #EvolutionImporter object.
+@filename: The name of file to check.
+@closure: The data that was passed into evolution_importer_new ().
+@Returns: #TRUE if the importer can handle the file, #FALSE otherwise
+
+
+<!-- ##### USER_FUNCTION EvolutionImporterLoadFileFn ##### -->
+<para>
+  The function that is called when the Evolution shell wants the 
+  #EvolutionImporter to load a file.
+</para>
+
+@importer: An #EvolutionImporter object.
+@filename: The name of the file to load.
+@closure: The data that was passed into evolution_importer_new ().
+@Returns: #TRUE on success, #FALSE otherwise.
+
+
+<!-- ##### USER_FUNCTION EvolutionImporterProcessItemFn ##### -->
+<para>
+  The function that is called when the Evolution shell wants the
+  #EvolutionImporter to process the next item in the file.
+</para>
+
+<para>
+  This function may process one item, or it may process as many as it
+  wants/is able to.
+</para>
+
+@importer: An #EvolutionImporter object.
+@listener: A #CORBA_Object that will be informed of the results.
+@closure: The data that was passed into evolution_importer_new ().
+@ev: A #CORBA_Environment for returning any CORBA exceptions that may occur.
+
+
+<!-- ##### USER_FUNCTION EvolutionImporterGetErrorFn ##### -->
+<para>
+  The function that is called when the Evolution shell wants to find out
+  about any errors that may have occurred.
+</para>
+
+@importer: An #EvolutionImporter object.
+@closure: The data that was passed into evolution_importer_new ().
+@Returns: A string with the error message, or #NULL if there was none.
+
+
+<!-- ##### ENUM EvolutionImporterResult ##### -->
+<para>
+  These values describe the result of the processItem CORBA method.
+</para>
+
+
+<!-- ##### FUNCTION evolution_importer_new ##### -->
+<para>
+
+</para>
+
+@support_format_fn: 
+@load_file_fn: 
+@process_item_fn: 
+@get_error_fn: 
+@closure: 
+@Returns: 
+
+
diff --git a/help/devel/importer/tmpl/evolution-shell-importer-unused.sgml b/help/devel/importer/tmpl/evolution-shell-importer-unused.sgml
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/help/devel/importer/tmpl/evolution-shell-importer-unused.sgml