ksync Library API Documentation

AddressBookSyncee Class Reference

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

#include <addressbooksyncee.h>

Inheritance diagram for AddressBookSyncee:

KSyncee List of all members.

Public Methods

 AddressBookSyncee ()
 ~AddressBookSyncee ()
AddressBookSyncEntry * firstEntry ()
AddressBookSyncEntry * nextEntry ()
void addEntry (KSyncEntry *)
void removeEntry (KSyncEntry *)
bool read ()
bool write ()

Detailed Description

This class provides an implementation of the @KSyncee interface for KSync.

It provides syncing of AddressBook files.

Definition at line 49 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 95 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 101 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 115 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 126 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 successful, otherwise false.

Implements KSyncee.

Definition at line 79 of file addressbooksyncee.cpp.

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 successful, otherwise false.

Implements KSyncee.

Definition at line 87 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 ksync Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:37 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003