QtMobility Reference Documentation

QOrganizerManagerEngineFactory Class Reference

The QOrganizerManagerEngineFactory class provides the interface for plugins that implement QOrganizerManagerEngine functionality. More...

 #include <QOrganizerManagerEngineFactory>

This class was introduced in Qt Mobility 1.1.

Public Functions

virtual ~QOrganizerManagerEngineFactory ()
virtual QOrganizerCollectionEngineId * createCollectionEngineId ( const QMap<QString, QString> & parameters, const QString & engineIdString ) const = 0
virtual QOrganizerItemEngineId * createItemEngineId ( const QMap<QString, QString> & parameters, const QString & engineIdString ) const = 0
virtual QOrganizerManagerEngine * engine ( const QMap<QString, QString> & parameters, QOrganizerManager::Error * error ) = 0
virtual QString managerName () const = 0
virtual QList<int> supportedImplementationVersions () const

Detailed Description

The QOrganizerManagerEngineFactory class provides the interface for plugins that implement QOrganizerManagerEngine functionality.

This class provides a simple interface for the creation of manager engine instances. Each factory has a specific id associated with it, which forms the managerName parameter when creating QOrganizerManager objects.

More information on writing a organizeritems engine plugin is available in the Qt Organizer Manager Engines documentation.

See also QOrganizerManager and QOrganizerManagerEngine.

Member Function Documentation

QOrganizerManagerEngineFactory::~QOrganizerManagerEngineFactory () [virtual]

A default, empty destructor.

QOrganizerCollectionEngineId * QOrganizerManagerEngineFactory::createCollectionEngineId ( const QMap<QString, QString> & parameters, const QString & engineIdString ) const [pure virtual]

This function is used internally when deserializing an id. It allows the deserialization functions to correctly allocate an engine-specific id for an item, filled with the serialized data engineIdString.

Since the format of the id might be different depending on the construction parameters parameters, these parameters are passed to the factory implementation of this function.

Engine implementers must implement this function, but should not need to call it.

This function was introduced in Qt Mobility 1.1.

QOrganizerItemEngineId * QOrganizerManagerEngineFactory::createItemEngineId ( const QMap<QString, QString> & parameters, const QString & engineIdString ) const [pure virtual]

This function is used internally when deserializing an id. It allows the deserialization functions to correctly allocate an engine-specific id for a collection, filled with the serialized data engineIdString.

Since the format of the id might be different depending on the construction parameters parameters, these parameters are passed to the factory implementation of this function.

Engine implementers must implement this function, but should not need to call it.

This function was introduced in Qt Mobility 1.1.

QOrganizerManagerEngine * QOrganizerManagerEngineFactory::engine ( const QMap<QString, QString> & parameters, QOrganizerManager::Error * error ) [pure virtual]

This function is called by the QOrganizerManager implementation to create an instance of the engine provided by this factory.

The parameters supplied can be ignored or interpreted as desired.

If a supplied parameter results in an unfulfillable request, or some other error occurs, this function may return a null pointer, and the client developer will get an invalid QOrganizerManager in return. Any error should be stored in the supplied error reference.

This function was introduced in Qt Mobility 1.1.

QString QOrganizerManagerEngineFactory::managerName () const [pure virtual]

This function should return a unique string that identifies the engines provided by this factory.

Typically this would be of the form "com.nokia.qt.organizeritems.engines.memory", with the appropriate domain and engine name substituted.

This function was introduced in Qt Mobility 1.1.

QList<int> QOrganizerManagerEngineFactory::supportedImplementationVersions () const [virtual]

This function should return a list of versions of the engine which this factory can instantiate.

This function was introduced in Qt Mobility 1.1.

X

Thank you for giving your feedback.

Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.