KSync::Konnector Class Reference
This class provides the interface for a Konnector. More...
#include <konnector.h>
Inherits Resource.
Inherited by KSync::DummyKonnector, KSync::KABCKonnector, KSync::KCalKonnector, KSync::LocalKonnector, KSync::QtopiaKonnector, KSync::RemoteKonnector, and Threaded::ThreadedPlugin.
Public Types
- typedef QPtrList< Konnector > List
- enum FilterMode { FilterBeforeSync, FilterAfterSync }
Signals
- void synceesRead (KSync::Konnector *)
- void synceeReadError (KSync::Konnector *)
- void synceesWritten (KSync::Konnector *)
- void synceeWriteError (KSync::Konnector *)
- void storagePathChanged (const QString &path)
Public Member Functions
- Konnector (const KConfig *config)
- virtual ~Konnector ()
- void writeConfig (KConfig *config)
- virtual SynceeList syncees ()=0
- virtual void appendSyncee (Syncee *ap)
- virtual bool readSyncees ()=0
- virtual bool writeSyncees ()=0
- QString storagePath () const
- void setStoragePath (const QString &path)
- KPIM::ProgressItem * progressItem (const QString &msg)
- 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
- void addFilter (KSync::Filter *)
- void removeFilter (KSync::Filter *)
- KSync::Filter::List filters () const
- void applyFilters (FilterMode)
Static Public Member Functions
- static QString generateMD5Sum (const QString &)
- static void purgeRemovedEntries (Syncee *)
Protected Slots
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.
Constructor & Destructor Documentation
|
Construct Konnector from information in config file.
|
|
Destruct Konnector object.
|
Member Function Documentation
|
Generate a MD5SUM from a QString. The intended use is with with storagePath() + "/" + generateMD5Sum(path) + "some_name.log" to really have unique identifiers
|
|
Remove SyncEntry::wasRemoved() itrems from the Syncee.
|
|
Write configuration to config file.
|
|
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. |
|
Append the Syncee to the internal list of Syncees. If the Konnector implements this method and can handle the format it will upload the Syncee on writeSyncees. The ownership of
|
|
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.
Implemented in KSync::DummyKonnector, and Threaded::ThreadedPlugin. |
|
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.
Implemented in KSync::DummyKonnector, and Threaded::ThreadedPlugin. |
|
If a Konnector needs to store permanent data, such as timestamps using the KSync::SyncHistory it'll use this path as base.
|
|
Set the path to where the Konnector should save its data to restore the SyncHistory on next sync. This is normally set by the part that does the syncing |
|
Returns a progress item with the given msg. The item is already connected to the progressItemCanceled() slot. You can reimplement this slot for special needs. |
|
Connect device. Return true, if device could be connected. Implemented in KSync::DummyKonnector, and Threaded::ThreadedPlugin. |
|
Disconnect device.
Implemented in KSync::DummyKonnector, and Threaded::ThreadedPlugin. |
|
Returns whether the device is connected.
|
|
Return meta information about this Konnector.
Implemented in KSync::DummyKonnector, and Threaded::ThreadedPlugin. |
|
the Syncees that are supported builtIn
|
|
Add a Filter to the list of filters ownership is transfered to the Konnector.
|
|
remove a Filter of the list of filters the ownership of the filter is transfered back to the caller
|
|
the list of filters
|
|
apply the filter to the synceeList()
|
|
Emitted when Syncee list becomes available as response to requestSyncees().
|
|
Emitted when an error occurs during read.
|
|
Emitted when Syncee list was successfully written back to connected entity.
|
|
Emitted when an error occurs during write.
|
|
Emitted when the sourcePath was changed.
|
The documentation for this class was generated from the following files:
- konnector.h
- konnector.cpp