kitchensync

KSync::ActionPart Class Reference

#include <actionpart.h>

Inheritance diagram for KSync::ActionPart:

KSPlucker::PluckerPart KSync::Backup KSync::Debugger KSync::OverviewPart KSync::Restore KSync::SyncerPart KSync::Viewer List of all members.

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.

Definition at line 63 of file actionpart.h.


Public Slots

virtual void slotSynceesRead (KSync::Konnector *)
virtual void slotSynceeReadError (KSync::Konnector *)
virtual void slotSynceesWritten (KSync::Konnector *)
virtual void slotSynceeWriteError (KSync::Konnector *)
virtual void slotConfigOk ()

Public Member Functions

 ActionPart (QObject *parent=0, const char *name=0)
virtual ~ActionPart ()
virtual QString type () const=0
virtual int syncProgress () const
virtual int syncStatus () const
virtual QString title () const=0
virtual QString description () const=0
virtual QPixmap * pixmap ()=0
virtual QString iconName () const=0
virtual bool hasGui () const
virtual bool configIsVisible () const
virtual bool canSync () const
virtual QWidget * configWidget ()
virtual void sync (const SynceeList &in, SynceeList &out)
virtual void executeAction ()=0
virtual void filterKonnectors (QPtrList< Konnector > &)
virtual bool needsKonnectorRead () const
virtual bool needsKonnectorWrite () const

Protected Slots

void done ()

Protected Member Functions

bool confirmBeforeWriting () const
Corecore ()
Corecore () const
void progress (int)
void connectPartChange (const char *slot)
void connectSyncProgress (const char *slot)
void connectProfileChanged (const char *slot)
void connectKonnectorDownloaded (const char *slot)
void connectStartSync (const char *slot)
void connectDoneSync (const char *slot)

Constructor & Destructor Documentation

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

The simple constructor.

Parameters:
parent parent widget
name Qt name

Definition at line 31 of file actionpart.cpp.


Member Function Documentation

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

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

Implemented in KSync::Backup, KSync::Restore, KSync::Debugger, KSync::OverviewPart, KSPlucker::PluckerPart, KSync::SyncerPart, and KSync::Viewer.

int ActionPart::syncProgress (  )  const [virtual]

Returns:
the progress made 0-100

Definition at line 44 of file actionpart.cpp.

int ActionPart::syncStatus (  )  const [virtual]

the sync status

Definition at line 49 of file actionpart.cpp.

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

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

Implemented in KSync::Backup, KSync::Restore, KSync::Debugger, KSync::OverviewPart, KSPlucker::PluckerPart, KSync::SyncerPart, and KSync::Viewer.

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

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

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

bool ActionPart::hasGui (  )  const [virtual]

Return if the part has a GUI.

Reimplemented in KSync::Backup, KSync::Restore, KSync::Debugger, KSync::OverviewPart, KSPlucker::PluckerPart, KSync::SyncerPart, and KSync::Viewer.

Definition at line 54 of file actionpart.cpp.

bool ActionPart::configIsVisible (  )  const [virtual]

if the config part is visible

Reimplemented in KSPlucker::PluckerPart.

Definition at line 59 of file actionpart.cpp.

bool ActionPart::canSync (  )  const [virtual]

Returns:
if the part canSync data :)

Definition at line 64 of file actionpart.cpp.

QWidget * ActionPart::configWidget (  )  [virtual]

Returns:
a config widget.

Always create a new one the ownership will be transferred

Reimplemented in KSPlucker::PluckerPart.

Definition at line 69 of file actionpart.cpp.

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

Definition at line 74 of file actionpart.cpp.

bool ActionPart::confirmBeforeWriting (  )  const [protected]

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

Definition at line 130 of file actionpart.cpp.

Core * ActionPart::core (  )  [protected]

Returns:
access to the shell

Definition at line 79 of file actionpart.cpp.

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

Definition at line 98 of file actionpart.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys