QOrganizerItemDetail Class

Detailed Description

The QOrganizerItemDetail class represents a single, complete detail about an organizer item.

All of the information for an organizer item is stored in one or more QOrganizerItemDetail objects.

A detail is a group of logically related bits of data - for example, a QOrganizerItemTimestamp is a single detail that has multiple fields (timestamp of creation, timestamp of last update, etc). Different organizer managers may support different details for different item types, e.g. certain manager may not support the timestamp, while others do.

In general, QOrganizerItemDetail and the built in subclasses (like QOrganizerEventTime) provide convenience and standardized access to values. For example, QOrganizerEventTime provides a convenient API for manipulating a QOrganizerItemDetail to describe the start and end time of an event. Subclasses also provide constants for the names of fields (like QOrganizerEventTime::FieldStartDateTime). Typically the constants for field names start with Field, and the constants for predefined values of a field start with the name of that field (e.g. TypeEvent is a predefined constant for FieldType).

QOrganizerItemDetail objects act like type checked values. In general, you can assign them to and fro and have reasonable behaviour, like the following example.

 QOrganizerItemDescription description;
 description.setDescription("Some descriptive text");
 // description.value(QOrganizerItemDescription::FieldDescription) == "Some descriptive text";
 // description.type() == QOrganizerItemDetail::TypeDescription

 QOrganizerItemDetail detail = description;
 // detail.value(QOrganizerItemDescription::FieldDescription) == "Some descriptive text";
 // detail.type() == QOrganizerItemDetail::TypeDescription

 QOrganizerItemDescription otherDescription = detail;
 // otherDescription.description() == "Some descriptive text";
 // otherDescription.type() == QOrganizerItemDetail::TypeDescription

 QOrganizerItemDisplayLabel label = detail;
 // label is now a default constructed QOrganizerItemDisplayLabel
 // label.value(QOrganizerItemDescription::FieldDescription) is empty
 // label.type() == QOrganizerItemDetail::TypeDisplayLabel

 QOrganizerItemDisplayLabel otherLabel = description;
 // otherLabel is now a default constructed QOrganizerItemDisplayLabel
 // otherLabel.value(QOrganizerItemDescription::FieldDescription) is empty
 // otherLabel.type() == QOrganizerItemDetail::TypeDisplayLabel