Home · All Classes · All Functions ·

QContactDetail Class Reference

The QContactDetail class provides access to a single, complete detail about a contact. More...

    #include <QContactDetail>

Inherited by QContactAddress, QContactAnniversary, QContactAvatar, QContactBirthday, QContactDisplayLabel, QContactEmailAddress, QContactFamily, QContactGender, QContactGeoLocation, QContactGuid, QContactName, QContactNickname, QContactNote, QContactOnlineAccount, QContactOrganization, QContactPhoneNumber, QContactSyncTarget, QContactTimestamp, QContactType, and QContactUrl.


Public Types

enum AccessConstraint { NoConstraint, ReadOnly, Irremovable }
flags AccessConstraints

Public Functions

QContactDetail ()
QContactDetail ( const QString & thisDefinitionId )
QContactDetail ( const QContactDetail & other )
virtual ~QContactDetail ()
AccessConstraints accessConstraints () const
QStringList contexts () const
QString definitionName () const
QString detailUri () const
bool hasValue ( const QString & key ) const
bool isEmpty () const
int key () const
QStringList linkedDetailUris () const
QList<QContactActionDescriptor> preferredActions () const
bool removeValue ( const QString & key )
void resetKey ()
void setContexts ( const QStringList & contexts )
void setContexts ( const QString & context )
void setDetailUri ( const QString & detailUri )
void setLinkedDetailUris ( const QStringList & linkedDetailUris )
void setLinkedDetailUris ( const QString & linkedDetailUri )
void setPreferredActions ( const QList<QContactActionDescriptor> & preferredActions )
bool setValue ( const QString & key, const QVariant & value )
T value ( const QString & key ) const
QString value ( const QString & key ) const
QVariant variantValue ( const QString & key ) const
QVariantMap variantValues () const
bool operator!= ( const QContactDetail & other ) const
QContactDetail & operator= ( const QContactDetail & other )
bool operator== ( const QContactDetail & other ) const

Protected Functions

QContactDetail ( const QContactDetail & other, const QString & expectedDefinitionId )
QContactDetail & assign ( const QContactDetail & other, const QString & expectedDefinitionId )

Macros

Q_DECLARE_CUSTOM_CONTACT_DETAIL

Detailed Description

The QContactDetail class provides access to a single, complete detail about a contact.

All of the information for a contact is stored in one or more QContactDetail objects.

A detail is a group of logically related bits of data - for example, a street address is a single detail that has multiple fields (number, region, country etc). Every QContactDetail has an associated QContactDetailDefinition id that describes the fields, their data type, any restrictions on their values, and any restrictions on creating or updating details of that definition.

One field which is common to all details is the context field. This field is intended to store the context or contexts that this detail is associated with. Commonly this will be something like "Home" and/or "Work", although no limitations are placed on which values may be stored in this field in the default schema.

There are two other, related fields which are common to all details. The first is QContactDetail::FieldDetailUri, which stores the unique URI of the detail if one exists. The field is not mandatory, and backends are not required to verify that the given URI is indeed unique within the contact. The second field is QContactDetail::LinkedDetailUris, which stores a list of detail URIs to which this detail is linked. The link is one-way, and intended mainly for use by read-only details which are populated by the backend (for example, a presence detail which is linked to a particular online account detail of the contact).

It is possible to inherit from QContactDetail to provide convenience or standardized access to values. For example, QContactPhoneNumber provides a convenient API for manipulating a QContactDetail as a phone number, according to the schema.

If you wish to create your own, customized contact detail, you should use the Q_DECLARE_CUSTOM_CONTACT_DETAIL macro in order to ensure proper operation. See the predefined leaf classes (like QContactPhoneNumber, QContactAddress) for more information.

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

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

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

    QContactPhoneNumber otherNumber = detail;
    // otherNumber.number() == "555-1212";
    // otherNumber.definitionName() == QContactPhoneNumber::staticType()

    QContactAddress address = detail;
    // address is now a default constructed QContactAddress
    // address.error() == QContactDetail::IncompatibleAssignmentError
    // address.value(QContactPhoneNumber::FieldNumber) is empty
    // address.definitionName() == QContactAddress::staticType()

    QContactAddress otherAddress = number;
    // otherAddress is now a default constructed QContactAddress
    // otherAddress.error() == QContactDetail::IncompatibleAssignmentError
    // otherAddress.value(QContactPhoneNumber::FieldNumber) is empty
    // otherAddress.definitionName() == QContactAddress::staticType()

See also QContact, QContactDetailDefinition, QContactDetailFilter, QContactDetailRangeFilter, and Q_DECLARE_CUSTOM_CONTACT_DETAIL.


Member Type Documentation

enum QContactDetail::AccessConstraint
flags QContactDetail::AccessConstraints

This enum defines the access constraints for a detail. This information is typically provided by the manager when a contact is retrieved.

ConstantValueDescription
QContactDetail::NoConstraint0Users can read, write, and otherwise modify this detail in any manner.
QContactDetail::ReadOnly0x01Users cannot write or modify values in this detail.
QContactDetail::Irremovable0x02Users cannot remove this detail from a contact.

The AccessConstraints type is a typedef for QFlags<AccessConstraint>. It stores an OR combination of AccessConstraint values.


Member Function Documentation

QContactDetail::QContactDetail ()

Constructs a new, empty detail

QContactDetail::QContactDetail ( const QString & thisDefinitionId )

Constructs a new, empty detail of the definition identified by thisDefinitionId

QContactDetail::QContactDetail ( const QContactDetail & other )

Constructs a detail that is a copy of other

QContactDetail::QContactDetail ( const QContactDetail & other, const QString & expectedDefinitionId )   [protected]

Constructs a detail that is a copy of other if other is of the expected definition identified by expectedDefinitionId, else constructs a new, empty detail of the definition identified by the expectedDefinitionId

QContactDetail::~QContactDetail ()   [virtual]

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.

QContactDetail & QContactDetail::assign ( const QContactDetail & other, const QString & expectedDefinitionId )   [protected]

Assigns this detail to other if the definition of other is that identified by the given expectedDefinitionId, else assigns this detail to be a new, empty detail of the definition identified by the given expectedDefinitionId

QStringList 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::definitionName () const

Returns the (unique) name of the definition which defines the semantics and structure of this detail

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 ( const QString & key ) const

Returns true if this detail has a field with the given key, 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.

int QContactDetail::key () const

Returns the key of this detail.

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().

QList<QContactActionDescriptor> QContactDetail::preferredActions () const

Returns the list of preferred actions for this detail

See also setPreferredActions().

bool QContactDetail::removeValue ( const QString & key )

Removes the value stored in this detail for the given key. Returns true if a value was stored for the given key 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 ( const QStringList & 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 contexts() and setValue().

void QContactDetail::setContexts ( const QString & 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, QStringList(context));

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().

void QContactDetail::setPreferredActions ( const QList<QContactActionDescriptor> & preferredActions )

Sets the preferred actions for this detail to be the given list of preferredActions

See also preferredActions().

bool QContactDetail::setValue ( const QString & key, const QVariant & value )

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

See also value().

T QContactDetail::value ( const QString & key ) const

Returns the value of the template type associated with the given key

See also setValue().

QString QContactDetail::value ( const QString & key ) const

This is an overloaded function.

Returns the value stored in this detail for the given key as a QString, or an empty QString if no value for the given key exists

QVariant QContactDetail::variantValue ( const QString & key ) const

Returns the value stored in this detail for the given key as a QVariant, or an invalid QVariant if no value for the given key exists

QVariantMap QContactDetail::variantValues () const

Returns the values stored in this detail as a map from value key to value

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


Macro Documentation

Q_DECLARE_CUSTOM_CONTACT_DETAIL

Macro for simplifying declaring custom (leaf) detail classes.

If you are creating a convenience class for a type of QContactDetail, you should use this macro when declaring your class to ensure that it interoperates with other contact functionality.

Here is an example of a class (QContactPhoneNumber) using this macro. Note that the class provides some predefined constants and some convenience methods that return values associated with schema fields.

    class Q_CONTACTS_EXPORT QContactPhoneNumber : public QContactDetail
    {
    public:
    #ifdef Q_QDOC
        const char* DefinitionName;
        const char* FieldNumber;
        const char* FieldSubTypes;
        const char* SubTypeLandline;
        const char* SubTypeMobile;
        const char* SubTypeFacsimile;
        const char* SubTypePager;
        const char* SubTypeVoice;
        const char* SubTypeModem;
        const char* SubTypeVideo;
        const char* SubTypeCar;
        const char* SubTypeBulletinBoardSystem;
        const char* SubTypeMessagingCapable;
        const char* SubTypeAssistant;
        const char* SubTypeDtmfMenu;
    #else
        Q_DECLARE_CUSTOM_CONTACT_DETAIL(QContactPhoneNumber, "PhoneNumber")
        Q_DECLARE_LATIN1_LITERAL(FieldNumber, "PhoneNumber");
        Q_DECLARE_LATIN1_LITERAL(FieldSubTypes, "SubTypes");
        Q_DECLARE_LATIN1_LITERAL(SubTypeLandline, "Landline");
        Q_DECLARE_LATIN1_LITERAL(SubTypeMobile, "Mobile");
        Q_DECLARE_LATIN1_LITERAL(SubTypeFacsimile, "Facsimile");
        Q_DECLARE_LATIN1_LITERAL(SubTypePager, "Pager");
        Q_DECLARE_LATIN1_LITERAL(SubTypeVoice, "Voice");
        Q_DECLARE_LATIN1_LITERAL(SubTypeModem, "Modem");
        Q_DECLARE_LATIN1_LITERAL(SubTypeVideo, "Video");
        Q_DECLARE_LATIN1_LITERAL(SubTypeCar, "Car");
        Q_DECLARE_LATIN1_LITERAL(SubTypeBulletinBoardSystem, "BulletinBoardSystem");
        Q_DECLARE_LATIN1_LITERAL(SubTypeMessagingCapable, "MessagingCapable");
        Q_DECLARE_LATIN1_LITERAL(SubTypeAssistant, "Assistant");
        Q_DECLARE_LATIN1_LITERAL(SubTypeDtmfMenu, "DtmfMenu");
    #endif

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

        void setSubTypes(const QStringList& subTypes) {setValue(FieldSubTypes, subTypes);}
        void setSubTypes(const QString& subType) {setValue(FieldSubTypes, QStringList(subType));}
        QStringList subTypes() const {return value<QStringList>(FieldSubTypes);}

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


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0