KDE 4.2 API Reference kpilot
ConduitAction Class Reference
#include <plugin.h>
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 191 of file plugin.h.
Public Member Functions | |
| ConduitAction (KPilotLink *, const char *name, const QVariantList &args=QVariantList()) | |
| QString | conduitName () const |
| bool | isFirstSync () const |
| bool | isFullSync () const |
| const SyncMode & | syncMode () const |
| virtual | ~ConduitAction () |
Protected Member Functions | |
| bool | changeSync (SyncMode::Mode m) |
| ConflictResolution | getConflictResolution () const |
| bool | openDatabases (const QString &dbName, bool *retrieved=0L) |
| void | setConflictResolution (ConflictResolution res) |
| void | setFirstSync (bool first) |
Protected Attributes | |
| QString | fConduitName |
| PilotDatabase * | fDatabase |
| PilotLocalDatabase * | fLocalDatabase |
Constructor & Destructor Documentation
| ConduitAction::ConduitAction | ( | KPilotLink * | p, | |
| const char * | name, | |||
| const QVariantList & | args = QVariantList() | |||
| ) |
Member Function Documentation
| bool ConduitAction::changeSync | ( | SyncMode::Mode | m | ) | [protected] |
Try to change the sync mode from what it is now to the mode m.
This may fail (ie. changing a backup to a restore is not kosher) and changeSync() will return false then.
| ConflictResolution ConduitAction::getConflictResolution | ( | ) | const [inline, protected] |
| bool ConduitAction::isFirstSync | ( | ) | const [inline] |
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.
| bool ConduitAction::isFullSync | ( | ) | const [inline] |
| bool ConduitAction::openDatabases | ( | const QString & | dbName, | |
| bool * | retrieved = 0L | |||
| ) | [protected] |
Open both the local copy of database dbName and the version on the Pilot.
Return true only if both opens succeed. If the local copy of the database does not exist, it is retrieved from the handheld. In this case, retrieved is set to true, otherwise it is left alone (i.e. retains its value and is not explicitly set to false).
- Parameters:
-
dbName database name to open. retrieved indicator whether the database had to be loaded from the handheld.
| void ConduitAction::setConflictResolution | ( | ConflictResolution | res | ) | [inline, protected] |
| void ConduitAction::setFirstSync | ( | bool | first | ) | [inline, protected] |
| const SyncMode& ConduitAction::syncMode | ( | ) | const [inline] |
Member Data Documentation
QString ConduitAction::fConduitName [protected] |
PilotDatabase* ConduitAction::fDatabase [protected] |
PilotLocalDatabase* ConduitAction::fLocalDatabase [protected] |
The documentation for this class was generated from the following files:
