EImportHook

EImportHook

Functions

Types and Values

Description

Functions

EImportCompleteFunc ()

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

EImportCompleteFunc is deprecated and should not be used in newly-written code.


EImportStatusFunc ()

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

EImportStatusFunc is deprecated and should not be used in newly-written code.


EImportFactoryFunc ()

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

EImportFactoryFunc is deprecated and should not be used in newly-written code.


EImportImporterFunc ()

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

EImportImporterFunc is deprecated and should not be used in newly-written code.


EImportSupportedFunc ()

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

EImportSupportedFunc is deprecated and should not be used in newly-written code.


EImportWidgetFunc ()

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

EImportWidgetFunc is deprecated and should not be used in newly-written code.


EImportImportFunc ()

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

EImportImportFunc is deprecated and should not be used in newly-written code.


e_import_new ()

EImport *
e_import_new (const gchar *id);

e_import_new is deprecated and should not be used in newly-written code.


e_import_class_add_importer ()

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

e_import_class_add_importer is deprecated and should not be used in newly-written code.

Parameters

klass

An initialised implementing instance of EImport.

 

importer

Importer to add.

 

freefunc

If supplied, called to free the importer node when it is no longer needed.

 

data

Data for the callback.

 

e_import_get_importers ()

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

e_import_get_importers is deprecated and should not be used in newly-written code.

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.

Parameters

import

an EImport

 

target

an EImportTarget

 

Returns

A list of importers. The list should be freed when no longer needed.


e_import_construct ()

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

e_import_construct is deprecated and should not be used in newly-written code.

Used by implementing classes to initialise base parameters.

Parameters

import

The instance to initialise.

 

id

The name of the instance.

 

Returns

ep is returned.


e_import_import ()

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

e_import_import is deprecated and should not be used in newly-written code.

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.

Parameters

import

an EImport

 

target

Target to import.

 

importer

Importer to use.

 

status

Status callback, called with progress information.

 

done

Complete callback, will always be called once complete.

 

data

user data for callback functions

 

e_import_cancel ()

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

e_import_cancel is deprecated and should not be used in newly-written code.


e_import_get_widget ()

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

e_import_get_widget is deprecated and should not be used in newly-written code.

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.

Parameters

import

an EImport

 

target

Target of interest

 

importer

Importer to get widget of

 

Returns

NULL if the importer doesn't support/require a destination.


e_import_get_preview_widget ()

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

e_import_get_preview_widget is deprecated and should not be used in newly-written code.

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.

Parameters

import

an EImport

 

target

Target of interest

 

im

Importer to get a preview widget of

 

Returns

NULL if the importer doesn't support preview.


e_import_status ()

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

e_import_status is deprecated and should not be used in newly-written code.


e_import_complete ()

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

e_import_complete is deprecated and should not be used in newly-written code.

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

Parameters

import

an EImport

 

target

Target just completed (unused currently)

 

error

a GError for the operation, NULL when succeeded

 

e_import_target_new ()

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

e_import_target_new is deprecated and should not be used in newly-written code.

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

Parameters

import

an EImport

 

type

type, up to implementor

 

size

Size of object to allocate.

 

e_import_target_free ()

void
e_import_target_free (EImport *import,
                      gpointer target);

e_import_target_free is deprecated and should not be used in newly-written code.

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

Parameters

import

an EImport

 

target

the target to free

 

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_uri is deprecated and should not be used in newly-written code.


e_import_target_new_home ()

EImportTargetHome *
e_import_target_new_home (EImport *import);

e_import_target_new_home is deprecated and should not be used in newly-written code.


e_import_hook_class_add_target_map ()

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

e_import_hook_class_add_target_map is deprecated and should not be used in newly-written code.

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.

Types and Values

enum e_import_target_t

e_import_target_t is deprecated and should not be used in newly-written code.

Members

E_IMPORT_TARGET_URI

   

E_IMPORT_TARGET_HOME

   

E_IMPORT_TARGET_LAST

   

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;
};

EImportImporter is deprecated and should not be used in newly-written code.


struct EImportTarget

struct EImportTarget {
	EImport *import;

	guint32 type;

	GData *data;

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

EImportTarget is deprecated and should not be used in newly-written code.


struct EImportTargetURI

struct EImportTargetURI {
	EImportTarget target;

	gchar *uri_src;
	gchar *uri_dest;
};

EImportTargetURI is deprecated and should not be used in newly-written code.


struct EImportTargetHome

struct EImportTargetHome {
	EImportTarget target;
};

EImportTargetHome is deprecated and should not be used in newly-written code.


EImportHookTargetMap

typedef struct _EPluginHookTargetMap EImportHookTargetMap;

EImportHookTargetMap is deprecated and should not be used in newly-written code.


EImportHookTargetMask

typedef struct _EPluginHookTargetKey EImportHookTargetMask;

EImportHookTargetMask is deprecated and should not be used in newly-written code.


struct EImportHookImporter

struct EImportHookImporter {
	EImportImporter importer;

	/* user_data == EImportHook */

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

EImportHookImporter is deprecated and should not be used in newly-written code.


struct EImportHookClass

struct EImportHookClass {
	EPluginHookClass hook_class;

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

EImportHookClass is deprecated and should not be used in newly-written code.

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

Members

EPluginHookClass hook_class;

Superclass.

 

GHashTable *target_map;

A table of EImportHookTargetMap structures describing the possible target types supported by this class.

 

EImportClass *import_class;

The EImport derived class that this hook implementation drives.

 

EImportFactory

typedef struct _EImportFactory EImportFactory;

EImportFactory is deprecated and should not be used in newly-written code.