blob: 1c7736a37fce4fa7e142fe986c0cb8a51a106a13 (
plain) (
tree)
|
|
<!-- ##### SECTION Title ##### -->
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 ##### -->
<para>
</para>
<!-- ##### MACRO EVOLUTION_IMPORTER ##### -->
<para>
Casts a #GtkObject into an #EvolutionImporter.
</para>
@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: 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: The #EvolutionImporter.
@filename: The filename of the file to load.
@folderpath:
@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: 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: 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 ##### -->
<para>
</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>
</para>
@support_format_fn:
@load_file_fn:
@process_item_fn:
@get_error_fn:
@closure:
@Returns:
|
