ksync
KSyncer Class Reference
#include <ksyncer.h>
Detailed Description
This class provides syncing of sets of data entries.
- See also:
- KSyncEntry, KSyncee, KSyncUi
To perform a syncing process you have to create objects of the concrete subclasses of KSyncee, representing the type of the data to be synced. They are added to KSyncer with the function addSyncee(). When all data sets to be synced are added, call the sync() functions to perform the actual syncing.
For conflict resolution, a user interface is needed. This has to be a subclass of KSyncUi and is provided, when constructing a Ksyncer instance.
Definition at line 232 of file ksyncer.h.
Public Member Functions | |
KSyncer (KSyncUi *ui=0) | |
virtual | ~KSyncer () |
void | addSyncee (KSyncee *) |
void | sync () |
void | syncAllToTarget (KSyncee *target, bool writeback=false) |
void | syncToTarget (KSyncee *syncee, KSyncee *target, bool override=false) |
Constructor & Destructor Documentation
KSyncer::KSyncer | ( | KSyncUi * | ui = 0 |
) |
Create a KSyncer instance.
You have to provide an instance of a conflict resolution user interface, which is used to resolve conflicts in the synced data, which cannot be resolved automatically. The UI does not necessarily have to be interactive.
Definition at line 144 of file ksyncer.cpp.
Member Function Documentation
void KSyncer::addSyncee | ( | KSyncee * | ) |
void KSyncer::sync | ( | ) |
Sync all data sets.
After execution of this functions all data sets, which have been added to KSyncer contain the same set of data.
This function might call conflict resolution functions of the KSyncUi object.
Definition at line 163 of file ksyncer.cpp.
void KSyncer::syncAllToTarget | ( | KSyncee * | target, | |
bool | writeback = false | |||
) |
Sync all data sets with a target data sets.
After execution of this function the target KSyncee data set contains a combination of all data sets added to KSyncer. The added data sets are not changed.
This function might call conflict resolution functions of the KSyncUi object.
Definition at line 180 of file ksyncer.cpp.
Sync one specific data set to a target data set.
After execution of this function the target contains the combination of the two data sets. Only the target is changed.
This function might call conflict resolution functions of the KSyncUi object.
Definition at line 197 of file ksyncer.cpp.
The documentation for this class was generated from the following files: