KDE PIM / Developers / API Docs / ksync

KSyncee Class Reference

A data set to be synced. More...

#include <ksyncer.h>

Inherited by AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.

List of all members.

Public Member Functions


Detailed Description

A data set to be synced.

Author:
Cornelius Schumacher
See also:
KSyncEntry, KSyncer
This class represents a data set of KSyncEntries. During a syncing process, two or more KSyncees are synced. After syncing they should be equal, that means they should contain the same set of KSyncEntries. Choices by the user can lead to deviations from complete equality.

The KSyncee class provides an interface, which has to be implemented by concrete subclasses.

KSyncer operates on KSyncee objects.


Member Function Documentation

virtual KSyncEntry* KSyncee::firstEntry  )  [pure virtual]
 

Return the first KSyncEntry object of the data set.

This function together with nextEntry() is used to iterate through all entries of a KSyncee data set.

Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.

virtual KSyncEntry* KSyncee::nextEntry  )  [pure virtual]
 

Return the next KSyncEntry object of the data set.

This function together with firstEntry() is used to iterate through all entries of a KSyncee data set.

Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.

KSyncEntry * KSyncee::findEntry const QString &  id  )  [virtual]
 

Find an entry identified by a unique id.

See KSyncEntry::id().

virtual void KSyncee::addEntry KSyncEntry  )  [pure virtual]
 

Add a KSyncEntry object to this data set.

Ownership of the object remains with the caller.

Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.

virtual void KSyncee::removeEntry KSyncEntry  )  [pure virtual]
 

Remove a KSyncEntry.

The entry is removed from the data set, but the object is not deleted.

Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.

void KSyncee::replaceEntry KSyncEntry oldEntry,
KSyncEntry newEntry
 

Replace an entry of the data set by another.

Ownership of the objects is handled as with the addEntry() and removeEntry() functions.

void KSyncee::setFilename const QString &   ) 
 

Set the filename, the data set is read from and written to.

QString KSyncee::filename  ) 
 

Return the filename, the data set is read from and written to.

QString KSyncee::statusLogName  ) 
 

Return the name of a config file, which is used to store status information about the data set.

bool KSyncee::load  ) 
 

Load the data set from the file with them name filename().

Returns:
true, if loading is successful, otherwise false.

bool KSyncee::save  ) 
 

Save the data set to the file with them name filename().

Returns:
true, if loading is successful, otherwise false.

virtual bool KSyncee::read  )  [pure virtual]
 

Read the data set from disk from the file with the name filename().

This function has to be reimplemented by concrete subclasses to provide the actual reading from disk.

Returns:
true, if reading is successful, otherwise false.

Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.

virtual bool KSyncee::write  )  [pure virtual]
 

Write the data set to disk to the file with the name filename().

This function has to be reimplemented by concrete subclasses to provide the actual writing to disk.

Returns:
true, if writing is successful, otherwise false.

Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.

void KSyncee::writeLog  ) 
 

Write the status log file with the name statusLogName().

bool KSyncee::hasChanged KSyncEntry  ) 
 

Return, if the given KSyncEntry has changed since the last syncing.

This information is retrieved by comparing the timestamps from the log file and the freshly read data set.


The documentation for this class was generated from the following files: