kitchensync Library API Documentation

KSync::AddressBookSyncee Class Reference

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

#include <addressbooksyncee.h>

Inheritance diagram for KSync::AddressBookSyncee:

Inheritance graph
[legend]
Collaboration diagram for KSync::AddressBookSyncee:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Supports {
  FamilyName, GivenName, AdditionalName, Prefix,
  Suffix, NickName, Birthday, HomeAddress,
  BusinessAddress, TimeZone, Geo, Title,
  Role, Organization, Note, Url,
  Secrecy, Picture, Sound, Agent,
  HomeNumbers, OfficeNumbers, Messenger, PreferredNumber,
  Voice, Fax, Cell, Video,
  Mailbox, Modem, CarPhone, ISDN,
  PCS, Pager, HomeFax, WorkFax,
  OtherTel, Category, Custom, Keys,
  Logo, Email, Emails
}

Public Member Functions

 AddressBookSyncee (KABC::AddressBook *)
void reset ()
AddressBookSyncEntry * firstEntry ()
AddressBookSyncEntry * nextEntry ()
void addEntry (SyncEntry *)
void removeEntry (SyncEntry *)
SyncEntry::PtrList added ()
SyncEntry::PtrList modified ()
SyncEntry::PtrList removed ()
QString type () const
QString newId () const
bool writeBackup (const QString &)
bool restoreBackup (const QString &)

Detailed Description

This class provides an implementation of the interface for KSync.

It provides syncing of AddressBook files.

Definition at line 67 of file addressbooksyncee.h.


Member Function Documentation

void AddressBookSyncee::reset  )  [virtual]
 

Reset Syncee to initial state.

This is called when the data the Syncee operates on is changed externally, i.e. without using the Syncees addEntry() removeEntry(), replaceEntry() methods.

Reimplemented from KSync::Syncee.

Definition at line 289 of file addressbooksyncee.cpp.

AddressBookSyncEntry * AddressBookSyncee::firstEntry  )  [virtual]
 

Return the first SyncEntry object of the data set.

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

Implements KSync::Syncee.

Definition at line 294 of file addressbooksyncee.cpp.

AddressBookSyncEntry * AddressBookSyncee::nextEntry  )  [virtual]
 

Return the next SyncEntry object of the data set.

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

Implements KSync::Syncee.

Definition at line 299 of file addressbooksyncee.cpp.

void AddressBookSyncee::addEntry SyncEntry  )  [virtual]
 

Add a SyncEntry object to this data set.

Ownership of the object remains with the caller.

Implements KSync::Syncee.

Definition at line 312 of file addressbooksyncee.cpp.

References KSync::Syncee::hasChanged().

void AddressBookSyncee::removeEntry SyncEntry  )  [virtual]
 

Remove a SyncEntry.

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

Implements KSync::Syncee.

Definition at line 336 of file addressbooksyncee.cpp.

SyncEntry::PtrList AddressBookSyncee::added  )  [virtual]
 

What was added?

Reimplemented from KSync::Syncee.

Definition at line 383 of file addressbooksyncee.cpp.

SyncEntry::PtrList AddressBookSyncee::modified  )  [virtual]
 

What was modified?

Reimplemented from KSync::Syncee.

Definition at line 388 of file addressbooksyncee.cpp.

SyncEntry::PtrList AddressBookSyncee::removed  )  [virtual]
 

What was removed?

Reimplemented from KSync::Syncee.

Definition at line 393 of file addressbooksyncee.cpp.

QString AddressBookSyncee::type  )  const [virtual]
 

The type of the Syncee.

Reimplemented from KSync::Syncee.

Definition at line 410 of file addressbooksyncee.cpp.

QString AddressBookSyncee::newId  )  const [virtual]
 

When dealing with special uid Konnector- You might want a new uid to be generated.

To later find an Entry again you'll need this map

Reimplemented from KSync::Syncee.

Definition at line 415 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 kitchensync Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu May 3 20:21:12 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003