Qtopia Home - Classes - Hierachy - Annotated - Functions - Licenses - Reference

SyncAppInterface Class Reference

The SyncAppInterface class provides an interface for loading and saving data of a Qtopia application. More...

#include <interfaces/syncapp.h>

List of all member functions.

Public Members

• virtual void start ( CenterInterface * ) = 0
• enum MergeAction { AutoMerge, ManualMerge, Conflicting }
• virtual MergeAction merge ( const MergeML::Change & rec1, const MergeML::Change & rec2, QValueList<MergeML::Change> & manualMergeOut ) = 0
• virtual bool mergeChangeChange () const = 0
• virtual void done () = 0
• virtual QValueList<MergeML::Record> load ( const QString & dataset, const QString & filename ) const = 0
• virtual void save ( const QString & dataset, const QString & filename, const QValueList<MergeML::Record> & ) = 0
• enum FileLocation { Settings, Application, InvalidFileLocation }
• virtual QPair<QString, FileLocation> fileForDataSet ( const QString & dataSet ) const = 0
• virtual QMap<int, int> uniqueness ( const QString & dataSet ) const = 0
• virtual QString keyName ( const QString & dataset, int key ) const = 0
• virtual int key ( const QString & dataset, const QString & keyString ) const = 0
• virtual QString palmtopApplicationName () const = 0

Detailed Description

For every Qtopia application that should be synced with a Qtopia Desktop component, there has to be exactly one SyncAppInterface implementation capable of reading and saving the Qtopia applications native file format. Qtopia Desktop by default implements SyncAppInterfaces for the "Contacts", "Calendar" and "Todo List" Qtopia applications.

The most important functions in this interface are load() and save() which load/save native Qtopia application data from/to a file. Both work on a QValueList of MergeML::Records which the native applications data is converted to/from.

The SyncAppInterface also provides to methods to map integer representations of data keys to their name and vice versa. keyName() returns the name of a key for a given integer representation while key() returns the integer representing a key of a given name.

The palmtopApplicationName() method returns the name of the Qtopia application whose native application data this interface is capable of loading/saving.

The uniqueness() method returns a mapping of keys and their uniqueness used in the syncing process.

The fileForSyncApp() method returns the name and location of the file used by the Qtopia application to store application data on the Qtopia device.

See also PluginInterface, MergeInterface, CenterInterface, ImportInterface, ExportInterface, and Qtopia Desktop Classes.

Member Type Documentation

SyncAppInterface::FileLocation

This enum describes the location of the file on the device.

• SyncAppInterface::Settings - the file exists in the Settings directory.
• SyncAppInterface::Application - the file exists in the Application directory.
• SyncAppInterface::InvalidFileLocation - there is no file to store or fetch.

SyncAppInterface::MergeAction

This enum describes how Qtopia Desktop should handle merges.

• SyncAppInterface::AutoMerge - means Qtopia Desktop should do the merge
• SyncAppInterface::ManualMerge - means your plugin handled the merge in the merge() method
• SyncAppInterface::Conflicting - means your plugin did the merge and detected a conflict

Member Function Documentation

void SyncAppInterface::done () [pure virtual]

This method is called after synchronization is done for your plugin. If you need to do any form of postprocessing after synchronization, you can safely do it in this method.

QPair<QString, FileLocation> SyncAppInterface::fileForDataSet ( const QString & dataSet ) const [pure virtual]

Returns a QPair of the filename and the location used to store data in dataSet format.

int SyncAppInterface::key ( const QString & dataset, const QString & keyString ) const [pure virtual]

Returns the integer representing the key named keyString of data format dataset.

QString SyncAppInterface::keyName ( const QString & dataset, int key ) const [pure virtual]

Returns the name of the key represented by the integer key of data format dataset.

QValueList<MergeML::Record> SyncAppInterface::load ( const QString & dataset, const QString & filename ) const [pure virtual]

This function is called by Qtopia Desktop to read a dataset from a file. It is passed the filename of the file to load in filename and the name of the data format in dataset.

It returns a list of MergeML::Records.

MergeAction SyncAppInterface::merge ( const MergeML::Change & rec1, const MergeML::Change & rec2, QValueList<MergeML::Change> & manualMergeOut ) [pure virtual]

Reimplement this method if you need to handle special cases during synchronization which cannot be automatically handled by Qtopia Desktop. Note that all merges will be passed to this method. Return SyncAppInterface::AutoMerge where you want Qtopia Desktop to handle the merges.

rec1 and rec2 is the two records that needs to be merged together. The results of the merge should be written to manualMergeOut.

If you discover a conflict you should return SyncAppInterface::Conflicting after adding your changes to manualMergeOut, otherwise if you did the merge and no conflicts were detected return SyncAppInterface::ManualMerge

bool SyncAppInterface::mergeChangeChange () const [pure virtual]

Return false in this method if you do not want Qtopia Desktop to attempt merging two changed records into one change.

QString SyncAppInterface::palmtopApplicationName () const [pure virtual]

Returns the name of the Qtopia Desktop component associated with this dataset.

void SyncAppInterface::save ( const QString & dataset, const QString & filename, const QValueList<MergeML::Record> & ) [pure virtual]

This function is called by Qtopia Desktop to save a list of MergeML::Records to a file with filename filename in data format dataset.

void SyncAppInterface::start ( CenterInterface * ) [pure virtual]

This method is called before synchronization is being started for your plugin. If you need to do any form of preprocessing before synchronization, you can safely do it in this method.

QMap<int, int> SyncAppInterface::uniqueness ( const QString & dataSet ) const [pure virtual]

Returns a QMap of uniqueness values for keys of data format dataSet.

This file is part of the Qtopia platform, copyright © 1995-2005 Trolltech, all rights reserved.