QtMobility Reference Documentation

QOrganizerCollectionId Class Reference

The QOrganizerCollectionId class provides information that uniquely identifies a collection in a particular manager. More...

 #include <QOrganizerCollectionId>

This class was introduced in Qt Mobility 1.1.

Public Functions

QOrganizerCollectionId ()
QOrganizerCollectionId ( QOrganizerCollectionEngineId * engineItemId )
QOrganizerCollectionId ( const QOrganizerCollectionId & other )
~QOrganizerCollectionId ()
bool isNull () const
QString managerUri () const
QString toString () const
bool operator!= ( const QOrganizerCollectionId & other ) const
bool operator< ( const QOrganizerCollectionId & other ) const
QOrganizerCollectionId & operator= ( const QOrganizerCollectionId & other )
bool operator== ( const QOrganizerCollectionId & other ) const

Static Public Members

QOrganizerCollectionId fromString ( const QString & idString )

Detailed Description

The QOrganizerCollectionId class provides information that uniquely identifies a collection in a particular manager.

It consists of a manager URI which identifies the manager which manages the collection, and the id of the collection in that manager.

A "null" QOrganizerCollectionId has an empty manager URI, and an invalid QOrganizerCollectionId (0).

Member Function Documentation

QOrganizerCollectionId::QOrganizerCollectionId ()

Constructs a new, null collection id

QOrganizerCollectionId::QOrganizerCollectionId ( QOrganizerCollectionEngineId * engineItemId )

Constructs a manager-unique id which wraps the given engine-unique item id engineItemId. This id takes ownership of the engine-unique item id and will delete it when the id goes out of scope. Engine implementors must not delete the engineItemId or undefined behaviour will occur.

This function was introduced in Qt Mobility 1.1.

QOrganizerCollectionId::QOrganizerCollectionId ( const QOrganizerCollectionId & other )

Constructs a new collection id as a copy of other

This function was introduced in Qt Mobility 1.1.

QOrganizerCollectionId::~QOrganizerCollectionId ()

Cleans up the memory in use by the collection id

QOrganizerCollectionId QOrganizerCollectionId::fromString ( const QString & idString ) [static]

Deserializes the given idString. Returns a default-constructed (null) item id if the given idString is not a valid, serialized item id, or if the manager engine from which the id came could not be found.

This function was introduced in Qt Mobility 1.1.

bool QOrganizerCollectionId::isNull () const

Returns true if the id part of this id is a null (default constructed) id; otherwise, returns false.

This function was introduced in Qt Mobility 1.1.

QString QOrganizerCollectionId::managerUri () const

Returns the URI of the manager which contains the collection identified by this id

QString QOrganizerCollectionId::toString () const

Serializes the id to a string. The format of the string will be: "qtorganizer:managerName:constructionParams:serializedEngineLocalItemId"

This function was introduced in Qt Mobility 1.1.

bool QOrganizerCollectionId::operator!= ( const QOrganizerCollectionId & other ) const

Returns true if either the manager URI or id of the collection id is different to that of other

This function was introduced in Qt Mobility 1.1.

bool QOrganizerCollectionId::operator< ( const QOrganizerCollectionId & other ) const

Returns true if this id is less than the other id. This id will be considered less than the other id if the manager URI of this id is alphabetically less than the manager URI of the other id. If both ids have the same manager URI, this id will be considered less than the other id if the id of this id is less than the id of the other id.

The invalid, empty id consists of an empty manager URI and the invalid, zero id, and hence will be less than any non-invalid id.

This operator is provided primarily to allow use of a QOrganizerCollectionId as a key in a QMap.

This function was introduced in Qt Mobility 1.1.

QOrganizerCollectionId & QOrganizerCollectionId::operator= ( const QOrganizerCollectionId & other )

Assigns the collection id to be equal to other

This function was introduced in Qt Mobility 1.1.

bool QOrganizerCollectionId::operator== ( const QOrganizerCollectionId & other ) const

Returns true if the collection id has the same manager URI and id as other

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.