KDE PIM / Developers / API Docs / kitchensync

KSync::ActionPart Class Reference

A part represents an action, like making a backup, syncing something or just showing some data. More...

#include <actionpart.h>

Inherits Part.

Inherited by KSPlucker::PluckerPart, KSync::Backup, KSync::Debugger, KSync::OverviewPart, KSync::Restore, KSync::SyncerPart, and KSync::Viewer.

List of all members.

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions


Detailed Description

A part represents an action, like making a backup, syncing something or just showing some data.

Parts can be put into profiles. When the user triggers the profile the Konnectors are read if required, the actions of the parts are executed in the sequence configured by the user and then the Konnectors are written. If reading or writing the Konnectors is required is determined by the parts in the profile.

A profile can have more than one part of the same type. This allows to have profiles with action sequences like: show original data, make a backup, sync, show the resulting data.

The ActionPart is loaded into the KitchenSync Shell. Each ActionPart has to provide a QWidget and can provide a config dialog.


Constructor & Destructor Documentation

ActionPart::ActionPart QObject *  parent = 0,
const char *  name = 0
 

The simple constructor.

Parameters:
parent parent widget
name Qt name

Member Function Documentation

virtual QString KSync::ActionPart::type  )  const [pure virtual]
 

Returns:
the type of this part for example like "Addressbook"

int ActionPart::syncProgress  )  const [virtual]
 

Returns:
the progress made 0-100

int ActionPart::syncStatus  )  const [virtual]
 

the sync status

virtual QString KSync::ActionPart::title  )  const [pure virtual]
 

Returns:
a translated string which is used as title for this ActionPart.

virtual QString KSync::ActionPart::description  )  const [pure virtual]
 

Returns:
a short description

virtual QPixmap* KSync::ActionPart::pixmap  )  [pure virtual]
 

Returns:
a pixmap for this part

virtual QString KSync::ActionPart::iconName  )  const [pure virtual]
 

return a iconName

bool ActionPart::hasGui  )  const [virtual]
 

Return if the part has a GUI.

bool ActionPart::configIsVisible  )  const [virtual]
 

if the config part is visible

bool ActionPart::canSync  )  const [virtual]
 

Returns:
if the part canSync data :)

QWidget * ActionPart::configWidget  )  [virtual]
 

Returns:
a config widget. Always create a new one the ownership will be transferred

void ActionPart::sync const SynceeList in,
SynceeList out
[virtual]
 

if you want to sync implement that method After successfully syncing you need to call done() which will emit a signal

Parameters:
in The Syncee List coming from a KonnectorPlugin
out The Syncee List which will be written to the Konnector

bool ActionPart::confirmBeforeWriting  )  const [protected]
 

See if the user wants to be asked before writing the Syncees back.

Core * ActionPart::core  )  [protected]
 

Returns:
access to the shell

void KSync::ActionPart::progress int   )  [protected]
 

call this whenever you make progress

void ActionPart::connectPartChange const char *  slot  )  [protected]
 

Connect to the PartChange signal.

See also:
MainWindow for the slot signature

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