kitchensync Library API Documentation

KSync::SyncUi Class Reference

Syncing conflict resolution user interface. More...

#include <syncui.h>

List of all members.

Public Member Functions

virtual SyncEntrydeconflict (SyncEntry *syncEntry, SyncEntry *target)
virtual bool confirmDelete (SyncEntry *syncEntry, SyncEntry *target)
virtual void informBothDeleted (SyncEntry *syncEntry, SyncEntry *target)


Detailed Description

Syncing conflict resolution user interface.

Author:
Cornelius Schumacher
See also:
Syncer
This class provides the abstract interface to a conflict resolution user interface. It is needed for cases, when a syncing process cannot resolve conflicts automatically. This is the case, when the same data entry has been changed in different data sets in an incompatible way.

This class has to be implemented by a concrete subclass, which provides the actual user interface. While a GUI implementation, which provides interactive conflict resolution, is the most common implementation, there might also be use for a non-GUI or even non-interactive user interface.

Definition at line 44 of file syncui.h.


Member Function Documentation

SyncEntry * SyncUi::deconflict SyncEntry syncEntry,
SyncEntry target
[virtual]
 

Deconflict two conflicting SyncEntry objects.

Returns the entry, which has been chosen by the user to take precedence over the other.

The default implementation always returns 0, which should be interpreted to not sync the entries at all. Reimplement this function in a subclass to provide a more useful implementation to KSyncer.

Definition at line 39 of file syncui.cpp.

References KSync::SyncEntry::name().

bool SyncUi::confirmDelete SyncEntry syncEntry,
SyncEntry target
[virtual]
 

Confirm if the SyncEntry should be deleted.

It gets called if one side was unchanged and the other deleted.

Definition at line 48 of file syncui.cpp.

References KSync::SyncEntry::name(), KSync::Syncee::source(), and KSync::SyncEntry::syncee().

void SyncUi::informBothDeleted SyncEntry syncEntry,
SyncEntry target
[virtual]
 

Inform the user that both items where deleted.

Definition at line 57 of file syncui.cpp.

References KSync::SyncEntry::id().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kitchensync Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 22:42:11 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003