KDE PIM / Developers / API Docs / kpilot

RecordConduit::PCData Class Reference

This class is just a wrapper around the data on the PC, which provides a uniform interface for all different kinds of data like addressbook, calendar, todo list etc. More...

#include <recordConduit.h>

Inherited by VCalConduitBase::VCalDataBase.

List of all members.

Public Member Functions

Protected Attributes


Detailed Description

This class is just a wrapper around the data on the PC, which provides a uniform interface for all different kinds of data like addressbook, calendar, todo list etc.

Most method are pure-virtual, so they must be implemented by each conduit.


Member Function Documentation

virtual bool RecordConduit::PCData::loadData  )  [pure virtual]
 

Load the data from the PC (e.g.

contacts from the addressbook).

Returns:
true if successful, false if not

virtual bool RecordConduit::PCData::saveData  )  [pure virtual]
 

Save the PC data (e.g.

contacts to the addressbook).

Returns:
true if successful, false if not

virtual QString RecordConduit::PCData::description  )  const [pure virtual]
 

Description of the data on the PC, e.g.

the Addressbook, Calendar, etc.

virtual bool RecordConduit::PCData::isEmpty  )  const [pure virtual]
 

Return true if the data on the pc (e.g.

addressbook, calendar etc.) is empty

virtual Iterator RecordConduit::PCData::begin  )  [pure virtual]
 

reset the data pointer to the beginning of the data, e.g.

reset an iterator to begin()

virtual bool RecordConduit::PCData::atEnd const Iterator &   )  [pure virtual]
 

Return true if the pc data is at the end of its list.

virtual bool RecordConduit::PCData::increase Iterator &  it  )  [inline, virtual]
 

Return next entry in the data.

virtual bool RecordConduit::PCData::increaseNextModified Iterator &  it  )  [inline, virtual]
 

Return next modified entry in the data.

virtual PCEntry* RecordConduit::PCData::findByUid QString  uid  )  const [pure virtual]
 

Find the Palm Entry in the pc data.

Returns:
the match of the record found in the data on the PC, or an initialized empty entry if no match is found on the PC

bool RecordConduit::PCData::makeArchived RecordConduit::PCEntry pcEntry  )  [virtual]
 

make that entry on the pc archived (i.e.

deleted on the handheld, while present on the pc, but not synced to the handheld

virtual bool RecordConduit::PCData::updateEntry const PCEntry entry  )  [pure virtual]
 

Update the entry given.

If it doesn't exist yet, add it

virtual bool RecordConduit::PCData::removeEntry const PCEntry entry  )  [pure virtual]
 

Remove the entry given from the PC.

virtual bool RecordConduit::PCData::removeEntry const QString &  uid  )  [inline, virtual]
 

Remove the entry with the given id.

The default implementation searches the entry, and then calls removeEntry( PCEntry* ). Child classes might reimplement this to speed things up.

virtual bool RecordConduit::PCData::cleanup  )  [inline, virtual]
 

Clean up after the sync has been done and the changes were saved.

Returns:
true if cleanup was successful

bool RecordConduit::PCData::mapContactsToPilot QMap< recordid_t, QString > &  idContactMap  )  [virtual]
 

Builds the map which links record ids to uid's of PCEntry.

This is the slow implementation, that should always work. subclasses should reimplement it to speed things up.

virtual bool RecordConduit::PCData::changed  )  const [inline, virtual]
 

Return whether the data was changed.

virtual bool RecordConduit::PCData::setChanged bool  changed  )  [inline, virtual]
 

Set the changed flag on the pc data.

Returns:
the previous state of the changed flag

virtual int RecordConduit::PCData::count  )  const [inline, virtual]
 

Return the number of entries on the PC (-1 for unknown).


The documentation for this class was generated from the following files: