kitchensync Library API Documentation

KSync::ActionPart Class Reference

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

#include <actionpart.h>

Collaboration diagram for KSync::ActionPart:

Collaboration graph
[legend]
List of all members.

Public Slots

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

Signals

void sig_progress (ActionPart *, int)
void sig_progress (ActionPart *, const Progress &)
void sig_error (ActionPart *, const Error &)
void sig_syncStatus (ActionPart *, int)

Public Member Functions

 ActionPart (QObject *parent=0, const char *name=0)
virtual QString type () const =0
virtual int syncProgress () const
virtual int syncStatus () const
virtual QString title () const =0
virtual QString description () const =0
virtual QPixmappixmap ()=0
virtual QString iconName () const =0
virtual bool hasGui () const
virtual bool configIsVisible () const
virtual bool canSync () const
virtual QWidgetconfigWidget ()
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 progress (const Progress &)
void error (const Error &)
void done ()

Protected Member Functions

bool confirmBeforeWriting () const
Corecore ()
Corecore () const
void progress (int)
void connectPartChange (const char *slot)
void connectPartProgress (const char *slot)
void connectPartError (const char *slot)
void connectKonnectorProgress (const char *slot)
void connectKonnectorError (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)

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 66 of file actionpart.h.


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"

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.

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.

Definition at line 54 of file actionpart.cpp.

bool ActionPart::configIsVisible  )  const [virtual]
 

if the config part is visible

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

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 172 of file actionpart.cpp.

References core().

Core * ActionPart::core  )  [protected]
 

Returns:
access to the shell

Definition at line 79 of file actionpart.cpp.

Referenced by confirmBeforeWriting(), and connectPartChange().

void ActionPart::progress int   )  [protected]
 

call this whenever you make progress

Definition at line 89 of file actionpart.cpp.

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

Connect to the PartChange signal.

See also:
MainWindow for the slot signature

Definition at line 115 of file actionpart.cpp.

References core().


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:24 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003