kitchensync Library API Documentation

KSync::Konnector Class Reference

This class provides the interface for a Konnector. More...

#include <konnector.h>

Inheritance diagram for KSync::Konnector:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef QPtrList< KonnectorList

Signals

void synceesRead (Konnector *)
void synceeReadError (Konnector *)
void synceesWritten (Konnector *)
void synceeWriteError (Konnector *)
void sig_progress (Konnector *, const Progress &)
void sig_error (Konnector *, const Error &)
void sig_downloaded (Konnector *, const SynceeList &)

Public Member Functions

 Konnector (const KConfig *config)
virtual ~Konnector ()
void writeConfig (KConfig *config)
virtual SynceeList syncees ()=0
virtual bool readSyncees ()=0
virtual bool writeSyncees ()=0
virtual Kapabilities capabilities ()=0
virtual bool connectDevice ()=0
virtual bool disconnectDevice ()=0
bool isConnected () const
virtual KonnectorInfo info () const =0
virtual void add (const QString &res)
virtual void remove (const QString &res)
virtual QStringList resources () const
virtual QStringList builtIn () const

Protected Member Functions

void progress (const Progress &)
void error (const Error &)

Detailed Description

This class provides the interface for a Konnector.

A Konnector is a class responsible for communication with a certain kind of PIM data source. It does the actual transport of the data and conversion of data is needed. It provides the PIM data in a generic way using the KSyncee class which is suitable for further processing within KDE, e.g. for syncing or being accessed by a kioslave.

Definition at line 53 of file konnector.h.


Constructor & Destructor Documentation

Konnector::Konnector const KConfig *  config  ) 
 

Construct Konnector from information in config file.

Definition at line 29 of file konnector.cpp.

Konnector::~Konnector  )  [virtual]
 

Destruct Konnector object.

Definition at line 34 of file konnector.cpp.


Member Function Documentation

void Konnector::writeConfig KConfig *  config  ) 
 

Write configuration to config file.

Definition at line 38 of file konnector.cpp.

virtual SynceeList KSync::Konnector::syncees  )  [pure virtual]
 

Get list of Syncees used by this Konnector.

It will contain a Syncee for each supported data type. If readSyncees() hasn't be called before, the Syncees will be empty.

Implemented in KSync::DummyKonnector, and Threaded::ThreadedPlugin.

virtual bool KSync::Konnector::readSyncees  )  [pure virtual]
 

Request list of Syncee objects containing PIM data from connected entity.

The response is sent with the signal synceesRead(). If an error occurs during read the signal synceeReadError() is emitted.

Returns:
true, if request could successfully be started, false otherwise.

Implemented in KSync::AgendaPlugin, KSync::AgendaPlugin, KSync::DummyKonnector, and Threaded::ThreadedPlugin.

Referenced by KSync::Engine::go().

virtual bool KSync::Konnector::writeSyncees  )  [pure virtual]
 

Request to write back data contained in Syncee objects hold by the connected entity.

The end of the write operation is signalled with synceesWritten(). If an error occurs during write the signal synceeWriteError() is emitted.

Returns:
true, if request could successfully be started, false otherwise.

Implemented in KSync::AgendaPlugin, KSync::AgendaPlugin, KSync::DummyKonnector, and Threaded::ThreadedPlugin.

void KSync::Konnector::synceesRead Konnector  )  [signal]
 

Emitted when Syncee list becomes available as response to requestSyncees().

Referenced by KSync::DummyKonnector::readSyncees().

void KSync::Konnector::synceeReadError Konnector  )  [signal]
 

Emitted when an error occurs during read.

void KSync::Konnector::synceesWritten Konnector  )  [signal]
 

Emitted when Syncee list was successfully written back to connected entity.

Referenced by KSync::DummyKonnector::writeSyncees().

void KSync::Konnector::synceeWriteError Konnector  )  [signal]
 

Emitted when an error occurs during write.

virtual Kapabilities KSync::Konnector::capabilities  )  [pure virtual]
 

Return capabilities of the Konnector.

Implemented in KSync::AgendaPlugin, KSync::AgendaPlugin, KSync::DummyKonnector, and Threaded::ThreadedPlugin.

virtual bool KSync::Konnector::connectDevice  )  [pure virtual]
 

Connect device.

Return true, if device could be connected.

Implemented in KSync::AgendaPlugin, KSync::AgendaPlugin, KSync::DummyKonnector, and Threaded::ThreadedPlugin.

Referenced by KSync::Engine::go().

virtual bool KSync::Konnector::disconnectDevice  )  [pure virtual]
 

Disconnect device.

Implemented in KSync::AgendaPlugin, KSync::AgendaPlugin, KSync::DummyKonnector, and Threaded::ThreadedPlugin.

virtual KonnectorInfo KSync::Konnector::info  )  const [pure virtual]
 

Return meta information about this Konnector.

Implemented in KSync::AgendaPlugin, KSync::AgendaPlugin, KSync::DummyKonnector, and Threaded::ThreadedPlugin.

QStringList Konnector::builtIn  )  const [virtual]
 

the Syncees that are supported builtIn

Definition at line 73 of file konnector.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 Wed Oct 17 09:54:29 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003