kpilot Library API Documentation

ConduitAction Class Reference

The SyncActions created by the factory should obey at least the argument test, indicating a dry run. More...

#include <plugin.h>

Inheritance diagram for ConduitAction:

ConduitProxy List of all members.

Public Methods

 ConduitAction (KPilotDeviceLink *, const char *name=0L, const QStringList &args=QStringList())
virtual ~ConduitAction ()
void setConfig (KConfig *c)
QString conduitName () const

Protected Methods

bool isTest () const
bool isBackup () const
bool isLocal () const
int getSyncDirection () const
eConflictResolution getConflictResolution () const
bool isFullSync () const
bool isFirstSync () const
bool openDatabases (const QString &dbName, bool *retrieved=0L)

Protected Attributes

KConfig * fConfig
PilotDatabasefDatabase
PilotDatabasefLocalDatabase
int fSyncDirection
eConflictResolution fConflictResolution
bool fFirstSync
QString fConduitName

Detailed Description

The SyncActions created by the factory should obey at least the argument test, indicating a dry run.

The device link is the link where the sync should run -- don't get the pilotPort() until the sync runs!

setConfig() will be called before the sync starts so that the conduit can read/write metadata and local settings.

Definition at line 196 of file plugin.h.


Member Function Documentation

bool ConduitAction::isFullSync   const [inline, protected]
 

A full sync happens for eFullSync, eCopyPCToHH and eCopyHHToPC.

It completely ignores all modified flags and walks through all records in the database.

Definition at line 223 of file plugin.h.

bool ConduitAction::isFirstSync   const [inline, protected]
 

A first sync (i.e.

database newly fetched from the handheld ) does not check for deleted records, but understands them as added on the other side. The flag is set by the conduits when opening the local database, or the calendar/addressbook (if it is empty). This also implies a full sync.

Definition at line 237 of file plugin.h.

bool ConduitAction::openDatabases const QString   dbName,
bool *    retrieved = 0L
[protected]
 

See openDatabases_ for info on the retrieved parameter.

In --local mode, retrieved is left unchanged.

Definition at line 304 of file plugin.cc.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kpilot Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:50 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003