KSync::Filter Class Reference
A Filter is a Dynamically Shared Object that is called to operate on a Syncee before and after syncing is done. More...
#include <filter.h>
Inherits QObject.
Public Types
- typedef QValueList< Filter * > List
Public Member Functions
- Filter (QObject *obj, const char *name)
- void load (KConfig *)
- void save (KConfig *)
- QString name () const
- virtual bool supports (Syncee *)=0
- virtual QWidget * configWidget (QWidget *parent)=0
- virtual void configWidgetClosed (QWidget *widget)=0
- virtual void convert (Syncee *)=0
- virtual void reconvert (Syncee *)=0
Protected Member Functions
Detailed Description
A Filter is a Dynamically Shared Object that is called to operate on a Syncee before and after syncing is done.For example this feature is used to filter out Records from specific Categories for specefic Syncees. The same feature could be used to have any file downloaded by a Konnector or KIO Resource and then convert an UnknownSyncee to something else before sync is taking place and it gets converted to a UnknownSyncee before writing back to the origin
You need to supply implementation for a configure dialog, a method to determine if you're able and want to filter a Syncee and then methods to convert and convert back (reconvert) this Syncee.
A Filter can have multiple instances with different Config Option set
Member Function Documentation
|
This method will call doLoad() which you need to implement if you need to read configuration data.
|
|
Get the translated name of the Filter. Get the Name of the Filter. Filters can call
|
|
Test if a Filter can operate on the Syncee. Before requesting to convert/reconvert the Syncee the KSync::Filter is asked to if it can operate on the Syncee. Filters need to implement it
|
|
Create a new Configure Widget. Create a new KConfig widget. Use
|
|
Called when config widget is closed.
|
|
Convert the Syncee before emitting the Read signal. Before the Syncee emits the read signal you can filter the Syncee. If you return a different Syncee the old one will be replaced. The old one will be cleaned up and removed by the KonnectorManager
|
|
Convert the Syncee before writing back. Before the Syncees gets written back to the Konnector you can filter it. If you return a different Syncee the old one will be replaced. The old one will be cleaned up and removed by the KonnectorManager
|
|
Return the KConfig Instance. Get KConfig object where the Configuration is stored. Do not change the group, and it is only valid from within the doLoad() method
|
|
Set the Name of the Filter. Set the Name returned by
|
The documentation for this class was generated from the following files:
- filter.h
- filter.cpp