qof_book_merge.h File Reference


Detailed Description

API for merging two QofBook structures with collision handling.

Author:
Copyright (c) 2004-2005 Neil Williams <linux@codehelp.co.uk>

Definition in file qof_book_merge.h.

#include <glib.h>
#include "gnc-engine-util.h"
#include "qofbook.h"
#include "qofclass.h"
#include "qofobject.h"
#include "qofinstance.h"
#include "gnc-trace.h"

Go to the source code of this file.

Data Structures

struct  qof_book_mergeRule
 One rule per entity, built into a single GList for the entire merge. More...
struct  qof_book_mergeData
 mergeData contains the essential context data for any merge. More...

qof_book_merge API

typedef void(* qof_book_mergeRuleForeachCB )(qof_book_mergeData *, qof_book_mergeRule *, guint)
 Definition of the dialog control callback routine.
qof_book_mergeDataqof_book_mergeInit (QofBook *importBook, QofBook *targetBook)
 Initialise the qof_book_merge process.
void qof_book_mergeRuleForeach (qof_book_mergeData *mergeData, qof_book_mergeRuleForeachCB callback, qof_book_mergeResult mergeResult)
 Dialog Control Callback.
char * qof_book_merge_param_as_string (QofParam *qtparam, QofEntity *qtEnt)
 provides easy string access to parameter data for dialog use
qof_book_mergeDataqof_book_mergeUpdateResult (qof_book_mergeData *mergeData, qof_book_mergeResult tag)
 called by dialog callback to set the result of user intervention
int qof_book_mergeCommit (qof_book_mergeData *mergeData)
 Commits the import data to the target book.
void qof_book_merge_abort (qof_book_mergeData *mergeData)
 Abort the merge and free all memory allocated by the merge.

Defines

#define QOF_MOD_MERGE   "qof-merge"

Enumerations

enum  qof_book_mergeResult {
  MERGE_UNDEF, MERGE_ABSOLUTE, MERGE_NEW, MERGE_REPORT,
  MERGE_DUPLICATE, MERGE_UPDATE, MERGE_INVALID
}
 Results of collisions and user resolution. More...


Generated on Fri Oct 21 15:49:57 2005 for QOF by  doxygen 1.4.5