ksync
KSyncee Class Reference
#include <ksyncer.h>
Inheritance diagram for KSyncee:

Detailed Description
A data set to be synced.
- See also:
- KSyncEntry, KSyncer
The KSyncee class provides an interface, which has to be implemented by concrete subclasses.
KSyncer operates on KSyncee objects.
Definition at line 109 of file ksyncer.h.
Public Member Functions | |
KSyncee () | |
virtual | ~KSyncee () |
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 *) |
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().
Definition at line 72 of file ksyncer.cpp.
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.
Definition at line 85 of file ksyncer.cpp.
void KSyncee::setFilename | ( | const QString & | ) |
Set the filename, the data set is read from and written to.
Definition at line 62 of file ksyncer.cpp.
QString KSyncee::filename | ( | ) |
Return the filename, the data set is read from and written to.
Definition at line 67 of file ksyncer.cpp.
QString KSyncee::statusLogName | ( | ) |
Return the name of a config file, which is used to store status information about the data set.
Definition at line 131 of file ksyncer.cpp.
bool KSyncee::load | ( | ) |
Load the data set from the file with them name filename().
- Returns:
- true, if loading is successful, otherwise false.
Definition at line 101 of file ksyncer.cpp.
bool KSyncee::save | ( | ) |
Save the data set to the file with them name filename().
- Returns:
- true, if loading is successful, otherwise false.
Definition at line 109 of file ksyncer.cpp.
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().
Definition at line 120 of file ksyncer.cpp.
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.
Definition at line 91 of file ksyncer.cpp.
The documentation for this class was generated from the following files: