Versions historic

NA_IIMPORTER_TYPE

#define NA_IIMPORTER_TYPE                       ( na_iimporter_get_type())

NA_IIMPORTER()

#define NA_IIMPORTER( instance )                ( G_TYPE_CHECK_INSTANCE_CAST( instance, NA_IIMPORTER_TYPE, NAIImporter ))

NA_IS_IIMPORTER()

#define NA_IS_IIMPORTER( instance )             ( G_TYPE_CHECK_INSTANCE_TYPE( instance, NA_IIMPORTER_TYPE ))

NA_IIMPORTER_GET_INTERFACE()

#define NA_IIMPORTER_GET_INTERFACE( instance )  ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IIMPORTER_TYPE, NAIImporterInterface ))

NAIImporter

typedef struct _NAIImporter NAIImporter;

NAIImporterInterface

typedef struct {
	/**
	 * get_version:
	 * @instance: the #NAIImporter provider.
	 *
	 * This method is called by the &prodname; program each time
	 * it needs to know which version of this interface the plugin
	 * implements.
	 *
	 * If this method is not implemented by the plugin,
	 * the &prodname; program considers that the plugin only implements
	 * the version 1 of the #NAIImporter interface.
	 *
	 * Returns: the version of this interface supported by the plugin.
	 *
	 * Since: 2.30
	 */
	guint ( *get_version )    ( const NAIImporter *instance );

	/**
	 * import_from_uri:
	 * @instance: the #NAIImporter provider.
	 * @parms: a #NAIImporterImportFromUriParms structure.
	 *
	 * Imports an item.
	 *
	 * Returns: the return code of the operation.
	 *
	 * Since: 2.30
	 */
	guint ( *import_from_uri )( const NAIImporter *instance, NAIImporterImportFromUriParms *parms );
} NAIImporterInterface;

This defines the interface that a NAIImporter should implement.

enum NAIImporterImportMode

typedef enum {
	IMPORTER_MODE_NO_IMPORT = 1,
	IMPORTER_MODE_RENUMBER,
	IMPORTER_MODE_OVERRIDE,
	IMPORTER_MODE_ASK
}
	NAIImporterImportMode;

Define the mode of an import operation.

enum NAIImporterImportStatus

typedef enum {
	IMPORTER_CODE_OK = 0,
	IMPORTER_CODE_PROGRAM_ERROR,
	IMPORTER_CODE_NOT_WILLING_TO,
	IMPORTER_CODE_NO_ITEM_ID,
	IMPORTER_CODE_NO_ITEM_TYPE,
	IMPORTER_CODE_UNKNOWN_ITEM_TYPE,
	IMPORTER_CODE_CANCELLED
}
	NAIImporterImportStatus;

Define the return status of an import operation.

NAIImporterCheckFn ()

NAObjectItem *      NAIImporterCheckFn                  (const NAObjectItem *imported,
                                                         void *fn_data);

This function may be provided by the caller in order the NAIImporter provider be able to check for pre-existence of the imported item. This function should return the already existing item which has the same id than the currently being imported one, or NULL if the imported id will be unique.

If this function is not provided, then the NAIImporter provider will not be able to check for duplicates. In this case, the id of the imported item should be systematically regenerated as a unique id, regardless of the asked import mode.

Since 2.30

NAIImporterAskUserFn ()

guint               NAIImporterAskUserFn                (const NAObjectItem *imported,
                                                         const NAObjectItem *existing,
                                                         void *fn_data);

This function may be provided by the caller as a convenience way for the NAIImporter to ask the user to know what to do in the case of a duplicate id.

If this function is not provided, and the NAIImporter does not have any other way to ask the user, then a 'no import' policy should be preferred when managing duplicate identifiers.

Since 2.30

NAIImporterImportFromUriParms

typedef struct {
	guint                version;
	gchar               *uri;
	guint                asked_mode;
	gboolean             exist;
	guint                import_mode;
	NAObjectItem        *imported;
	NAIImporterCheckFn   check_fn;
	void                *check_fn_data;
	NAIImporterAskUserFn ask_fn;
	void                *ask_fn_data;
	GSList              *messages;
} NAIImporterImportFromUriParms;

This structure allows all used parameters when importing from an URI to be passed and received through a single structure.

Since 2.30

NAIImporterManageImportModeParms

typedef struct {
	guint                version;
	NAObjectItem        *imported;
	guint                asked_mode;
	NAIImporterCheckFn   check_fn;
	void                *check_fn_data;
	NAIImporterAskUserFn ask_fn;
	void                *ask_fn_data;
	gboolean             exist;
	guint                import_mode;
	GSList              *messages;
} NAIImporterManageImportModeParms;

This structure allows all used parameters when managing the import mode to be passed and received through a single structure.

Since 2.30

na_iimporter_import_from_uri ()

guint               na_iimporter_import_from_uri        (const NAIImporter *importer,
                                                         NAIImporterImportFromUriParms *parms);

Tries to import a NAObjectItem from the URI specified in parms, returning the result in parms->imported.

Since 2.30

na_iimporter_manage_import_mode ()

guint               na_iimporter_manage_import_mode     (NAIImporterManageImportModeParms *parms);

Since 2.30