kitchensync

KSync::SyncUi Class Reference

#include <syncui.h>

Inheritance diagram for KSync::SyncUi:

KSync::SyncUiFirst KSync::SyncUiKde KSync::SyncUiSecond List of all members.

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 46 of file syncui.h.


Public Member Functions

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

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.

Reimplemented in KSync::SyncUiKde, KSync::SyncUiFirst, and KSync::SyncUiSecond.

Definition at line 39 of file syncui.cpp.

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.

Reimplemented in KSync::SyncUiKde, KSync::SyncUiFirst, and KSync::SyncUiSecond.

Definition at line 48 of file syncui.cpp.

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

Inform the user that both items where deleted.

Reimplemented in KSync::SyncUiKde, KSync::SyncUiFirst, and KSync::SyncUiSecond.

Definition at line 57 of file syncui.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys