ksync Library API Documentation

AddressBookSyncee Class Reference

This class provides an implementation of the interface for KSync. More...

#include <addressbooksyncee.h>

Inheritance diagram for AddressBookSyncee:

KSyncee List of all members.

Public Member Functions

AddressBookSyncEntry * firstEntry ()
 Return the first KSyncEntry object of the data set.

AddressBookSyncEntry * nextEntry ()
 Return the next KSyncEntry object of the data set.

void addEntry (KSyncEntry *)
 Add a KSyncEntry object to this data set.

void removeEntry (KSyncEntry *)
 Remove a KSyncEntry.

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

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


Detailed Description

This class provides an implementation of the interface for KSync.

It provides syncing of AddressBook files.

Definition at line 29 of file addressbooksyncee.h.


Member Function Documentation

AddressBookSyncEntry * AddressBookSyncee::firstEntry  )  [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.

Implements KSyncee.

Definition at line 71 of file addressbooksyncee.cpp.

AddressBookSyncEntry * AddressBookSyncee::nextEntry  )  [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.

Implements KSyncee.

Definition at line 77 of file addressbooksyncee.cpp.

void AddressBookSyncee::addEntry KSyncEntry  )  [virtual]
 

Add a KSyncEntry object to this data set.

Ownership of the object remains with the caller.

Implements KSyncee.

Definition at line 91 of file addressbooksyncee.cpp.

void AddressBookSyncee::removeEntry KSyncEntry  )  [virtual]
 

Remove a KSyncEntry.

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

Implements KSyncee.

Definition at line 102 of file addressbooksyncee.cpp.

bool AddressBookSyncee::read  )  [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 successfull, otherwise false.

Implements KSyncee.

Definition at line 57 of file addressbooksyncee.cpp.

References KSyncee::filename().

bool AddressBookSyncee::write  )  [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 successfull, otherwise false.

Implements KSyncee.

Definition at line 63 of file addressbooksyncee.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 15 11:40:48 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001