QContactDetail Class

 QContactPhoneNumber number;
 number.setNumber("555-1212");
 // number.value(QContactPhoneNumber::FieldNumber) == "555-1212";
 // number.type() == QContactPhoneNumber::Type

 QContactDetail detail = number;
 // detail.value(QContactPhoneNumber::FieldNumber) == "555-1212";
 // detail.type() == QContactPhoneNumber::Type

 QContactPhoneNumber otherNumber = detail;
 // otherNumber.number() == "555-1212";
 // otherNumber.type() == QContactPhoneNumber::Type

 QContactAddress address = detail;
 // address is now a default constructed QContactAddress
 // address.value(QContactPhoneNumber::FieldNumber) is empty
 // address.type() == QContactAddress::Type

 QContactAddress otherAddress = number;
 // otherAddress is now a default constructed QContactAddress
 // otherAddress.value(QContactPhoneNumber::FieldNumber) is empty
 // otherAddress.type() == QContactAddress::Type

Member Function Documentation

QContactDetail::QContactDetail()

Constructs a new, empty detail

QContactDetail::QContactDetail(DetailType type)

Constructs a new, empty detail of the type identified by type.

QContactDetail::QContactDetail(const QContactDetail & other)

Constructs a detail that is a copy of other

QContactDetail::~QContactDetail()

Frees the memory used by this detail

AccessConstraints QContactDetail::accessConstraints() const

Returns the access constraints associated with the detail.

Some details may not be written to, while other details may not be removed from a contact.

See also QContactDetail::AccessConstraints.

QList<int> QContactDetail::contexts() const

This is a convenience function to return the Context field of this detail.

It is equivalent to the following code:

 value<QStringList>(QContactDetail::FieldContext);

See also setContexts() and value().

QString QContactDetail::detailUri() const

This is a convenience function to return the DetailUri field of this detail.

It is equivalent to the following code:

 value(QContactDetail::FieldDetailUri);

See also setDetailUri() and value().

bool QContactDetail::hasValue(int field) const

Returns true if this detail has a field with the given field, or false otherwise.

bool QContactDetail::isEmpty() const

Returns true if no values are contained in this detail. Note that context is stored as a value; hence, if a context is set, this function will return false.

An empty value (for example, the string "") is still a value contained in this detail, so this function will return false.

int QContactDetail::key() const

Returns the key of this detail.

Be aware that if a contact is retrieved (or reloaded) from the backend, the keys of any details it contains may have been changed by the backend, or other threads may have modified the contact details in the backend. Therefore, clients should reload the detail that they wish to save in or remove from a contact after retrieving the contact from the backend, in order to ascertain the keys of any such details.

QStringList QContactDetail::linkedDetailUris() const

This is a convenience function to return the Context field of this detail.

It is equivalent to the following code:

 value<QStringList>(QContactDetail::FieldLinkedDetailUris);

See also setLinkedDetailUris() and value().

bool QContactDetail::removeValue(int field)

Removes the value stored in this detail for the given field. Returns true if a value was stored for the given field and the operation succeeded, and false otherwise.

void QContactDetail::resetKey()

Causes the implicitly-shared detail to be detached from any other copies, and generates a new key for it. This ensures that calling QContact::saveDetail() will result in a new detail being saved, rather than another detail being updated.

void QContactDetail::setContexts(int context)

This is a convenience function that sets the Context field of this detail to the given context. It is useful if the detail is only valid in a single context.

It is equivalent to the following code:

 setValue(FieldContext, QList<int>() << context);

See also contexts() and setValue().

void QContactDetail::setContexts(const QList<int> & contexts)

This is a convenience function that sets the Context field of this detail to the given contexts.

It is equivalent to the following code:

 setValue(QContactDetail::FieldContext, contexts);

See also setValue().

void QContactDetail::setDetailUri(const QString & detailUri)

This is a convenience function that sets the DetailUri field of this detail to the given detailUri. In order to be linked to, a detail must have a specific and (per-contact) unique detail URI set.

It is equivalent to the following code:

 setValue(FieldDetailUri, detailUri);

See also detailUri() and setValue().

void QContactDetail::setLinkedDetailUris(const QStringList & linkedDetailUris)

This is a convenience function that sets the LinkedDetailUris field of this detail to the given linkedDetailUris.

It is equivalent to the following code:

 setValue(QContactDetail::FieldLinkedDetailUris, linkedDetailUris);

See also linkedDetailUris() and setValue().

void QContactDetail::setLinkedDetailUris(const QString & linkedDetailUri)

This is a convenience function that sets the LinkedDetailUris field of this detail to the given linkedDetailUri. It is useful if the detail is linked to a single other detail in the contact.

It is equivalent to the following code:

 setValue(FieldLinkedDetailUris, QStringList(linkedDetailUri));

See also setValue().

bool QContactDetail::setValue(int field, const QVariant & value)

Inserts value into the detail for the given field if value is valid. If value is invalid, removes the field with the given field from the detail. Returns true if the given value was set for the field (if the value was valid), or if the given field was removed from detail (if the value was invalid), and returns false if the field could not be removed (and the value was invalid)

See also value().

DetailType QContactDetail::type() const

Returns the (unique) enum of the type which defines the semantics and structure of this detail.

QVariant QContactDetail::value(int field) const

Returns the value stored in this detail for the given field. An invalid QVariant is returned if the value of field is not set.

See also setValue().

T QContactDetail::value(int field) const

QMap<int, QVariant> QContactDetail::values() const

Returns the values stored in this detail as a field-to-value map.

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

Returns true if the values or id of this detail is different to those of the other detail

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

Assigns this detail to other

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

Compares this detail to other. Returns true if the type, access constraints and values of other are equal to those of this detail. The keys of each detail are not considered during the comparison, in order to allow details from different contacts to be compared according to their values.

 class Q_CONTACTS_EXPORT QContactPhoneNumber : public QContactDetail
 {
 public:
 #ifndef Q_QDOC
     Q_DECLARE_CUSTOM_CONTACT_DETAIL(QContactPhoneNumber)
 #else
     static const DetailType Type;
 #endif

     enum PhoneNumberField {
         FieldNumber = 0,
         FieldSubTypes
     };

     enum SubType {
         SubTypeLandline = 0,
         SubTypeMobile,
         SubTypeFax,
         SubTypePager,
         SubTypeVoice,
         SubTypeModem,
         SubTypeVideo,
         SubTypeCar,
         SubTypeBulletinBoardSystem,
         SubTypeMessagingCapable,
         SubTypeAssistant,
         SubTypeDtmfMenu
     };

     void setNumber(const QString& number) {setValue(FieldNumber, number);}
     QString number() const {return value(FieldNumber).toString();}

     void setSubTypes(const QList<int> &subTypes) {setValue(FieldSubTypes, QVariant::fromValue(subTypes));}
     QList<int> subTypes() const {return value< QList<int> >(FieldSubTypes);}

     // Convenience filter
     static QContactFilter match(const QString& number);
 };