KSync::SyncEntry Class Reference
An entry of a dataset which is to be synced. More...
#include <syncentry.h>
Inheritance diagram for KSync::SyncEntry:

Public Types | |
typedef QPtrList< SyncEntry > | PtrList |
enum | Equalness { Different = -1, Equal = 0, EqualButModifiedThis = 1, EqualButModifiedOther = 2, EqualButModifiedBoth = 3 } |
enum | Status { Undefined = -1, Added = 0, Modified = 1, Removed = 2 } |
Public Member Functions | |
SyncEntry (Syncee *parent) | |
SyncEntry (const SyncEntry &) | |
virtual QString | type () const =0 |
virtual QString | name ()=0 |
virtual QString | id ()=0 |
virtual void | setId (const QString &id) |
virtual QString | timestamp ()=0 |
virtual bool | equals (SyncEntry *)=0 |
virtual int | match (SyncEntry *entry) |
virtual int | compareTo (SyncEntry *entry) |
virtual int | state () const |
virtual bool | wasAdded () const |
virtual bool | wasModified () const |
virtual bool | wasRemoved () const |
virtual void | setState (int state=Undefined) |
virtual void | setSyncState (int state=Undefined) |
virtual int | syncState () const |
virtual SyncEntry * | clone ()=0 |
void | setSyncee (Syncee *) |
Syncee * | syncee () |
virtual bool | mergeWith (SyncEntry *) |
void | setDontSync (bool) |
bool | dontSync () const |
virtual KPIM::DiffAlgo * | diffAlgo (SyncEntry *, SyncEntry *) |
Detailed Description
An entry of a dataset which is to be synced.
- Author:
- Cornelius Schumacher
SyncEntry objects are collected by a Syncee objects.
Definition at line 48 of file syncentry.h.
Constructor & Destructor Documentation
|
This is the basic constructor of a SyncEntry. Every SyncEntry should have a parent Syncee where it belongs to. Definition at line 29 of file syncentry.cpp. |
Member Function Documentation
|
Return a string describing the type of the entry.
Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry. |
|
Return a string describing this entry. This is presented to the user as identifier for the entry, when user interaction is required. Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry. Referenced by KSync::SyncUi::confirmDelete(), KSync::SyncUi::deconflict(), and KSync::Syncee::saveLog(). |
|
Return a unique id. This is used to uniquely identify the entry. Two entries having the same id are considered to be two variants of the same entry. No two entries of the same KSyncee data set must have the same id. Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry. Referenced by KSync::Syncee::findEntry(), KSync::Syncee::hasChanged(), KSync::SyncUi::informBothDeleted(), and KSync::Syncee::saveLog(). |
|
Set unique id.
Definition at line 106 of file syncentry.cpp. |
|
Return a time stamp representing the time of the last change. This is only used to compare, if an entry has changed or not. It is not used to define an order of changes. If an entry has been copied from one KSyncee data set to another KSyncee data set, the timestamp has to be the same on both entries. If the user has changed the entry in one data set the timestamp has to be different. Return QString::null, if there is no timestamp available. This means that the user has to manually select which entry is the new one. Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry. Referenced by KSync::Syncee::hasChanged(), and KSync::Syncee::saveLog(). |
|
Return, if the two entries are equal. Two entries are considered to be equal, if they contain exactly the same information, including the same id and timestamp. Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry. |
|
For future versions match should try to match one SyncEntry with another.
Definition at line 54 of file syncentry.cpp. |
|
Compares one SyncEntry to another. This functions differs from equals and match in some ways. it returns 0 if both are equal, -1 if not equal at all, or the state of equalnes Equal or EqualModifiedThis, EqualModifiedOther, EqualModifiedBoth -2 if not implemented Definition at line 59 of file syncentry.cpp. |
|
The status of this SyncEntry either Undefined, Added, Modified or Removed.
Definition at line 64 of file syncentry.cpp. Referenced by KSync::Syncee::modificationState(). |
|
Convience functions for the state of an Entry.
Definition at line 69 of file syncentry.cpp. |
|
Convience function for the state of an Entry modified.
Definition at line 74 of file syncentry.cpp. |
|
Convience function for the state of an Entry.
Definition at line 79 of file syncentry.cpp. |
|
Sets the stae of this SyncEntry.
Definition at line 84 of file syncentry.cpp. |
|
Set sync state (e.g. Added, Modified) of SyncEntry. Definition at line 90 of file syncentry.cpp. |
|
Returns the sync state of this entry.
Definition at line 95 of file syncentry.cpp. |
|
Creates an exact copy of the this SyncEntry deleting the original is save.
Implemented in KSync::OpieDesktopSyncEntry, and KSync::UnknownSyncEntry. |
|
Set the Syncee data set, the entry belongs to.
Definition at line 49 of file syncentry.cpp. |
|
Return the Syncee data set, the entry belongs to.
Definition at line 100 of file syncentry.cpp. Referenced by KSync::SyncUi::confirmDelete(). |
|
Merges two sync entries where ever one entry does not support one specific attribute.
Definition at line 110 of file syncentry.cpp. |
|
Set if the entry should be synced or not.
Definition at line 115 of file syncentry.cpp. |
|
Returns the diffing algorithm which is used to present the differences between the two SyncEntries when a conflict occurs.
Definition at line 125 of file syncentry.cpp. |
The documentation for this class was generated from the following files: