EImportCompleteFunc ()

void
(*EImportCompleteFunc) (EImport *ei,
                        const GError *error,
                        gpointer user_data);

EImportStatusFunc ()

void
(*EImportStatusFunc) (EImport *ei,
                      const gchar *what,
                      gint pc,
                      gpointer data);

EImportFactoryFunc ()

void
(*EImportFactoryFunc) (EImport *ei,
                       gpointer data);

EImportImporterFunc ()

void
(*EImportImporterFunc) (EImportImporter *importer,
                        gpointer data);

EImportSupportedFunc ()

gboolean
(*EImportSupportedFunc) (EImport *ei,
                         EImportTarget *Param2,
                         EImportImporter *im);

EImportWidgetFunc ()

GtkWidget *
(*EImportWidgetFunc) (EImport *ei,
                      EImportTarget *Param2,
                      EImportImporter *im);

EImportImportFunc ()

void
(*EImportImportFunc) (EImport *ei,
                      EImportTarget *Param2,
                      EImportImporter *im);

e_import_new ()

EImport *
e_import_new (const gchar *id);

e_import_class_add_importer ()

void
e_import_class_add_importer (EImportClass *klass,
                             EImportImporter *importer,
                             EImportImporterFunc freefunc,
                             gpointer data);

e_import_get_importers ()

GSList *
e_import_get_importers (EImport *import,
                        EImportTarget *target);

Get a list of importers. If target is supplied, then only importers which support the type and location specified by the target are listed. If target is NULL, then all importers are listed.

e_import_construct ()

EImport *
e_import_construct (EImport *import,
                    const gchar *id);

Used by implementing classes to initialise base parameters.

e_import_import ()

void
e_import_import (EImport *import,
                 EImportTarget *target,
                 EImportImporter *importer,
                 EImportStatusFunc status,
                 EImportCompleteFunc done,
                 gpointer data);

Run the import function of the selected importer. Once the importer has finished, it MUST call the e_import_complete() function. This allows importers to run in synchronous or asynchronous mode.

When complete, the done callback will be called.

e_import_cancel ()

void
e_import_cancel (EImport *import,
                 EImportTarget *target,
                 EImportImporter *importer);

e_import_get_widget ()

GtkWidget *
e_import_get_widget (EImport *import,
                     EImportTarget *target,
                     EImportImporter *importer);

Gets a widget that the importer uses to configure its destination. This widget should be packed into a container widget. It should not be shown_all.

e_import_get_preview_widget ()

GtkWidget *
e_import_get_preview_widget (EImport *import,
                             EImportTarget *target,
                             EImportImporter *im);

Gets a widget that the importer uses to preview data to be imported. This widget should be packed into a container widget. It should not be shown_all.

e_import_status ()

void
e_import_status (EImport *import,
                 EImportTarget *target,
                 const gchar *what,
                 gint pc);

e_import_complete ()

void
e_import_complete (EImport *import,
                   EImportTarget *target,
                   const GError *error);

Signify that an import is complete. This must be called by importer implementations when they are done.

e_import_target_new ()

gpointer
e_import_target_new (EImport *import,
                     gint type,
                     gsize size);

Allocate a new import target suitable for this class. Implementing classes will define the actual content of the target.

e_import_target_free ()

void
e_import_target_free (EImport *import,
                      gpointer target);

Free a target. The implementing class can override this method to free custom targets.

e_import_target_new_uri ()

EImportTargetURI *
e_import_target_new_uri (EImport *import,
                         const gchar *uri_src,
                         const gchar *uri_dst);

e_import_target_new_home ()

EImportTargetHome *
e_import_target_new_home (EImport *import);

e_import_hook_class_add_target_map ()

void
e_import_hook_class_add_target_map (EImportHookClass *klass,
                                    const EImportHookTargetMap *map);

class : The dervied EimportHook class. map : A map used to describe a single EImportTarget type for this class.

Add a targe tmap to a concrete derived class of EImport. The target map enumates the target types available for the implenting class.

enum e_import_target_t

struct EImportImporter

struct EImportImporter {
	enum _e_import_target_t type;

	gint pri;

	EImportSupportedFunc supported;
	EImportWidgetFunc get_widget;
	EImportImportFunc import;
	EImportImportFunc cancel;
	EImportWidgetFunc get_preview;

	gpointer user_data;

	/* ?? */
	gchar *name;
	gchar *description;
};

struct EImportTarget

struct EImportTarget {
	EImport *import;

	guint32 type;

	GData *data;

	/* implementation fields follow, depends on target type */
};

struct EImportTargetURI

struct EImportTargetURI {
	EImportTarget target;

	gchar *uri_src;
	gchar *uri_dest;
};

struct EImportTargetHome

struct EImportTargetHome {
	EImportTarget target;
};

EImportHookTargetMap

typedef struct _EPluginHookTargetMap EImportHookTargetMap;

EImportHookTargetMask

typedef struct _EPluginHookTargetKey EImportHookTargetMask;

struct EImportHookImporter

struct EImportHookImporter {
	EImportImporter importer;

	/* user_data == EImportHook */

	gchar *supported;
	gchar *get_widget;
	gchar *import;
	gchar *cancel;
};

struct EImportHookClass

struct EImportHookClass {
	EPluginHookClass hook_class;

	/* EImportHookTargetMap by .type */
	GHashTable *target_map;
	/* the import class these imports's belong to */
	EImportClass *import_class;
};

This is an abstract class defining the plugin hook point for import windows.

EImportFactory

typedef struct _EImportFactory EImportFactory;