KSyncee Class Reference
A data set to be synced. More...
#include <ksyncer.h>
Inherited by AddressBookSyncee, BookmarkSyncee, and CalendarSyncee.
Public Member Functions
- virtual KSyncEntry * firstEntry ()=0
- virtual KSyncEntry * nextEntry ()=0
- virtual KSyncEntry * findEntry (const QString &id)
- virtual void addEntry (KSyncEntry *)=0
- virtual void removeEntry (KSyncEntry *)=0
- void replaceEntry (KSyncEntry *oldEntry, KSyncEntry *newEntry)
- void setFilename (const QString &)
- QString filename ()
- QString statusLogName ()
- bool load ()
- bool save ()
- virtual bool read ()=0
- virtual bool write ()=0
- void writeLog ()
- bool hasChanged (KSyncEntry *)
Detailed Description
A data set to be synced.
- Author:
- Cornelius Schumacher
- See also:
- KSyncEntry, KSyncer
The KSyncee class provides an interface, which has to be implemented by concrete subclasses.
KSyncer operates on KSyncee objects.
Member Function Documentation
|
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. |
|
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. |
|
Find an entry identified by a unique id. See KSyncEntry::id(). |
|
Add a KSyncEntry object to this data set. Ownership of the object remains with the caller. Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee. |
|
Remove a KSyncEntry. The entry is removed from the data set, but the object is not deleted. Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee. |
|
Replace an entry of the data set by another. Ownership of the objects is handled as with the addEntry() and removeEntry() functions. |
|
Set the filename, the data set is read from and written to.
|
|
Return the filename, the data set is read from and written to.
|
|
Return the name of a config file, which is used to store status information about the data set.
|
|
Load the data set from the file with them name filename().
|
|
Save the data set to the file with them name filename().
|
|
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.
Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee. |
|
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.
Implemented in AddressBookSyncee, BookmarkSyncee, and CalendarSyncee. |
|
Write the status log file with the name statusLogName().
|
|
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:
- ksyncer.h
- ksyncer.cpp