QOF: qofbookmerge.h File Reference

QOF 0.7.5

Data Structures | Macros | Enumerations
qofbookmerge.h File Reference
Query Object Framework » Merge: Merging QofBook structures

API for merging two `QofBook` structures with collision handling. More...

`#include "qofutil.h"`
`#include "qofbook.h"`
`#include "qofclass.h"`
`#include "qofobject.h"`
`#include "qofinstance.h"`
`#include "qoflog.h"`

Go to the source code of this file.

## Data Structures
struct | QofBookMergeRule
| One rule per entity, built into a single GList for the entire merge. More...
struct | QofBookMergeData
| mergeData contains the essential context data for any merge. More...

## Macros
#define | QOF_MOD_MERGE "qof-merge"

## Enumerations
enum | QofBookMergeResult { MERGE_UNDEF, MERGE_ABSOLUTE, MERGE_NEW, MERGE_REPORT, MERGE_DUPLICATE, MERGE_UPDATE, MERGE_INVALID }
| Results of collisions and user resolution. More...

## qof_book_merge API
typedef void(* | QofBookMergeRuleForeachCB) (QofBookMergeData *, QofBookMergeRule *, guint)
| Definition of the dialogue control callback routine. More...
QofBookMergeData * | qof_book_merge_init (QofBook *importBook, QofBook *targetBook)
| Initialise the QofBookMerge process. More...
void | qof_book_merge_rule_foreach (QofBookMergeData *mergeData, QofBookMergeRuleForeachCB callback, QofBookMergeResult mergeResult)
| Dialogue Control Callback. More...
gchar * | qof_book_merge_param_as_string (QofParam *qtparam, QofEntity *qtEnt)
| provides easy string access to parameter data for dialogue use More...
QofBookMergeData * | qof_book_merge_update_result (QofBookMergeData *mergeData, QofBookMergeResult tag)
| called by dialogue callback to set the result of user intervention More...
gint | qof_book_merge_commit (QofBookMergeData *mergeData)
| Commits the import data to the target book. More...
void | qof_book_merge_abort (QofBookMergeData *mergeData)
| Abort the merge and free all memory allocated by the merge. More...

## Detailed Description

API for merging two `QofBook` structures with collision handling.

Author
  Copyright (c) 2004-2005 Neil Williams linux.nosp@m.@cod.nosp@m.ehelp.nosp@m..co..nosp@m.uk

Definition in file qofbookmerge.h.