diff options
Diffstat (limited to 'doc/devel')
7 files changed, 76 insertions, 51 deletions
diff --git a/doc/devel/importer/evolution-shell-importer-sections.txt b/doc/devel/importer/evolution-shell-importer-sections.txt index f14b8addcb..e2474f6375 100644 --- a/doc/devel/importer/evolution-shell-importer-sections.txt +++ b/doc/devel/importer/evolution-shell-importer-sections.txt @@ -1,5 +1,4 @@ <INCLUDE>evolution-importer.h</INCLUDE> -<INCLUDE>evolution-importer-client.h</INCLUDE> <SECTION> <FILE>evolution-importer</FILE> @@ -29,13 +28,36 @@ EvolutionImporterPrivate </SECTION> +<INCLUDE>evolution-importer-listener.h</INCLUDE> +<SECTION> +<FILE>evolution-importer-listener</FILE> +EVOLUTION_IMPORTER_LISTENER +<TITLE>EvolutionImporterListener</TITLE> + +EvolutionImporterListenerCallback + +evolution_importer_listener_new + +<SUBSECTION Standard> +EVOLUTION_TYPE_IMPORTER_LISTENER +EVOLUTION_IMPORTER_LISTENER +EVOLUTION_IMPORTER_LISTENER_CLASS +EVOLUTION_IS_IMPORTER_LISTENER +EVOLUTION_IS_IMPORTER_LISTENER_CLASS +evolution_importer_listener_get_type + +<SUBSECTION Private> +EvolutionImporterListener +EvolutionImporterListenerPrivate + +</SECTION> + +<INCLUDE>evolution-importer-client.h</INCLUDE> <SECTION> <FILE>evolution-importer-client</FILE> EVOLUTION_IMPORTER_CLIENT <TITLE>EvolutionImporterClient</TITLE> -EvolutionImporterClientCallback - evolution_importer_client_new evolution_importer_client_new_from_id evolution_importer_client_support_format @@ -53,6 +75,5 @@ evolution_importer_client_get_type <SUBSECTION Private> EvolutionImporterClient -EvolutionImporterClientPrivate </SECTION> diff --git a/doc/devel/importer/evolution-shell-importer.hierarchy b/doc/devel/importer/evolution-shell-importer.hierarchy index 550c81c298..5f1b55c709 100644 --- a/doc/devel/importer/evolution-shell-importer.hierarchy +++ b/doc/devel/importer/evolution-shell-importer.hierarchy @@ -1,5 +1,14 @@ GtkObject + GtkWidget + GtkRange + GtkScale + GtkContainer + GtkBin + GtkButton + GtkToggleButton + GtkCheckButton BonoboObject EvolutionImporter Handle to remote Bonobo::Unknown EvolutionImporterClient + EvolutionImporterListener diff --git a/doc/devel/importer/evolution-shell-importer.types b/doc/devel/importer/evolution-shell-importer.types index 60143b3eb3..9dcdf5f0f1 100644 --- a/doc/devel/importer/evolution-shell-importer.types +++ b/doc/devel/importer/evolution-shell-importer.types @@ -2,6 +2,8 @@ #include <bonobo.h> #include <evolution/importer/evolution-importer.h> #include <evolution/importer/evolution-importer-client.h> +#include <evolution/importer/evolution-importer-listener.h> evolution_importer_get_type evolution_importer_client_get_type +evolution_importer_listener_get_type diff --git a/doc/devel/importer/private-reference.sgml b/doc/devel/importer/private-reference.sgml index 28f7d681c7..d28c7b8591 100644 --- a/doc/devel/importer/private-reference.sgml +++ b/doc/devel/importer/private-reference.sgml @@ -9,6 +9,7 @@ </para> </partintro> + &EvolutionImporterListener; &EvolutionImporterClient; </reference> diff --git a/doc/devel/importer/tmpl/evolution-importer-client.sgml b/doc/devel/importer/tmpl/evolution-importer-client.sgml index ac1718dc7e..8122e4fb2d 100644 --- a/doc/devel/importer/tmpl/evolution-importer-client.sgml +++ b/doc/devel/importer/tmpl/evolution-importer-client.sgml @@ -2,11 +2,11 @@ EvolutionImporterClient <!-- ##### SECTION Short_Description ##### --> - +A #GtkObject based client to simplify use of a GNOME_Evolution_Importer object. <!-- ##### SECTION Long_Description ##### --> <para> - +This #GtkObject provides a convience wrapper to the GNOME_Evolution_Importer object, providing error checking and hiding all the CORBA internals from the user. </para> <!-- ##### SECTION See_Also ##### --> @@ -16,21 +16,10 @@ EvolutionImporterClient <!-- ##### MACRO EVOLUTION_IMPORTER_CLIENT ##### --> <para> - -</para> - -@obj: - - -<!-- ##### USER_FUNCTION EvolutionImporterClientCallback ##### --> -<para> - +Casts a #GtkObject into an #EvolutionImporterClient </para> -@client: -@result: -@more_items: -@data: +@obj: A #GtkObject <!-- ##### FUNCTION evolution_importer_client_new ##### --> @@ -77,6 +66,8 @@ EvolutionImporterClient </para> @client: +@listener: +<!-- # Unused Parameters # --> @callback: @closure: diff --git a/doc/devel/importer/tmpl/evolution-importer.sgml b/doc/devel/importer/tmpl/evolution-importer.sgml index a1c7160eae..8d8351aed2 100644 --- a/doc/devel/importer/tmpl/evolution-importer.sgml +++ b/doc/devel/importer/tmpl/evolution-importer.sgml @@ -2,11 +2,11 @@ EvolutionImporter <!-- ##### SECTION Short_Description ##### --> - +A #BonoboObject that implements the GNOME/Evolution/Importer interface. <!-- ##### SECTION Long_Description ##### --> <para> - +A #BonoboObject wrapper around the GNOME/Evolution/Importer interface, providing error checking and reference counting, hiding the CORBA internals from the user and providing a simple way to create a GNOME_Evolution_Importer object. </para> <!-- ##### SECTION See_Also ##### --> @@ -16,53 +16,53 @@ EvolutionImporter <!-- ##### MACRO EVOLUTION_IMPORTER ##### --> <para> - +Casts a #GtkObject into an #EvolutionImporter. </para> -@obj: +@obj: A #GtkObject. <!-- ##### USER_FUNCTION EvolutionImporterSupportFormatFn ##### --> <para> - +The type of function that is called when the importer wishes to find out if the importing component can support the file given in @filename. </para> -@importer: -@filename: -@closure: -@Returns: +@importer: The #EvolutionImporter. +@filename: The filename of the file to check. +@closure: The data passed into evolution_importer_new (). +@Returns: A #gboolean. TRUE if the importing component can import the file, FALSE otherwise. <!-- ##### USER_FUNCTION EvolutionImporterLoadFileFn ##### --> <para> - +The type of function that is called when the importer wishes the importing component to load the file given in @filename, and initialise itself. </para> -@importer: -@filename: -@closure: -@Returns: +@importer: The #EvolutionImporter. +@filename: The filename of the file to load. +@closure: The data passed into evolution_importer_new (). +@Returns: A #gboolean. TRUE if the load and initialisation was successful, FALSE otherwise. <!-- ##### USER_FUNCTION EvolutionImporterProcessItemFn ##### --> <para> - +The type of function that is called when the importer wants the importing component to process the next item (or items) in a file. </para> -@importer: -@listener: -@closure: -@ev: +@importer: The #EvolutionImporter +@listener: A GNOME_Evolution_Importer_Listener CORBA object. +@closure: The data passed into evolution_importer_new (). +@ev: A #CORBA_Environment for returning any CORBA exceptions. <!-- ##### USER_FUNCTION EvolutionImporterGetErrorFn ##### --> <para> - +The type of function that is called when the importer wants to get a string version of an error. Not all importing components support this function. </para> -@importer: -@closure: -@Returns: +@importer: The #EvolutionImporter. +@closure: The data passed to evolution_importer_new (). +@Returns: A string representation of the error, or NULL if there was no error, or the importing component does not support the getError method. <!-- ##### ENUM EvolutionImporterResult ##### --> @@ -70,15 +70,6 @@ EvolutionImporter </para> -@EVOLUTION_IMPORTER_OK: -@EVOLUTION_IMPORTER_UNSUPPORTED_OPERATION: -@EVOLUTION_IMPORTER_INTERRUPTED: -@EVOLUTION_IMPORTER_BUSY: -@EVOLUTION_IMPORTER_NOT_READY: -@EVOLUTION_IMPORTER_UNKNOWN_DATA: -@EVOLUTION_IMPORTER_BAD_DATA: -@EVOLUTION_IMPORTER_BAD_FILE: -@EVOLUTION_IMPORTER_UNKNOWN_ERROR: <!-- ##### FUNCTION evolution_importer_new ##### --> <para> diff --git a/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml b/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml index e69de29bb2..7a9a98034b 100644 --- a/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml +++ b/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml @@ -0,0 +1,10 @@ +<!-- ##### USER_FUNCTION EvolutionImporterClientCallback ##### --> +<para> + +</para> + +@client: +@result: +@more_items: +@data: + |