QOrganizerCollectionId Class

Member Function Documentation

QOrganizerCollectionId::QOrganizerCollectionId()

Constructs a new, null collection ID.

QOrganizerCollectionId::QOrganizerCollectionId(QOrganizerCollectionEngineId * engineId)

Constructs a manager-unique ID which wraps the given engine-unique engineId.

This ID takes ownership of the engineId and will delete it when this ID is destructed. Engine implementors must not delete the engineId, otherwise undefined behaviour will occur.

QOrganizerCollectionId::QOrganizerCollectionId(const QOrganizerCollectionId & other)

Constructs a new collection ID as a copy of other.

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) collection ID if the given idString is not a valid, serialized collection ID, or if the manager engine from which the ID refers to could not be found.

bool QOrganizerCollectionId::isNull() const

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

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".

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

Returns true if either the manager URI or ID of it is different to that of other.

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

Returns true if this ID is less than the other.

This ID will be considered less than the other if the manager URI of this ID is alphabetically less than the manager URI of the other. If both IDs have the same manager URI, this ID will be considered less than the other if the engine ID is less than the engine ID of the other.

The invalid, empty ID consists of an empty manager URI and a null engine 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.

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

Assigns the collection ID to be equal to other.

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

Returns true if it has the same manager URI and ID as other.