MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QOrganizerItemEngineId Class Reference

The QOrganizerItemEngineId class uniquely identifies an item within a particular engine plugin. More...

 #include <QOrganizerItemEngineId>

Inherits: QSharedData.

This class was introduced in Qt Mobility 1.1.

Public Functions

virtual ~QOrganizerItemEngineId ()
virtual QOrganizerItemEngineId * clone () const = 0
virtual QDebug & debugStreamOut ( QDebug & dbg ) const = 0
virtual uint hash () const = 0
virtual bool isEqualTo ( const QOrganizerItemEngineId * other ) const = 0
virtual bool isLessThan ( const QOrganizerItemEngineId * other ) const = 0
virtual QString managerUri () const = 0
virtual QString toString () const = 0

Detailed Description

The QOrganizerItemEngineId class uniquely identifies an item within a particular engine plugin.

Clients of the Organizer API should never use this class. Every engine implementor must implement a class derived from QOrganizerItemEngineId.

This class is provided so that engine implementors can implement their own id class (which may contain arbitrary data, and which may implement the required functions in an arbitrary manner).

Member Function Documentation

QOrganizerItemEngineId::~QOrganizerItemEngineId () [virtual]

Cleans up any memory in use by this engine item id.

QOrganizerItemEngineId * QOrganizerItemEngineId::clone () const [pure virtual]

Returns a deep-copy clone of this id. The caller takes ownership of the returned engine item id.

This function was introduced in Qt Mobility 1.1.

QDebug & QOrganizerItemEngineId::debugStreamOut ( QDebug & dbg ) const [pure virtual]

Streams this id out to the debug stream dbg.

This function was introduced in Qt Mobility 1.1.

uint QOrganizerItemEngineId::hash () const [pure virtual]

Returns the hash value of this id.

This function was introduced in Qt Mobility 1.1.

bool QOrganizerItemEngineId::isEqualTo ( const QOrganizerItemEngineId * other ) const [pure virtual]

Returns true if this id is equal to the other id; false otherwise. Note that when implementing this function, you do not have to check that the type is the same, since the function which calls this function (in QOrganizerItemId) does that check for you.

This function was introduced in Qt Mobility 1.1.

bool QOrganizerItemEngineId::isLessThan ( const QOrganizerItemEngineId * other ) const [pure virtual]

Returns true if this id is less than the other id; false otherwise. Note that when implementing this function, you do not have to check that the type is the same, since the function which calls this function (in QOrganizerItemId) does that check for you.

This function was introduced in Qt Mobility 1.1.

QString QOrganizerItemEngineId::managerUri () const [pure virtual]

Returns the manager URI of the constructed manager which created the id. If the item which the id identifies has not been deleted, the id should still be valid in the manager identified by the manager URI returned by this function.

This function was introduced in Qt Mobility 1.1.

QString QOrganizerItemEngineId::toString () const [pure virtual]

Serializes the id to a string. It contains all of the information required to identify a particular item in the manager which created the id, formatted according to the serialization format of the manager.

This function was introduced in Qt Mobility 1.1.