qtmobility/src/contacts/details/qcontactdetails.cpp
changeset 5 453da2cfceef
parent 4 90517678cc4f
child 11 06b8e2af4411
equal deleted inserted replaced
4:90517678cc4f 5:453da2cfceef
    48 
    48 
    49 #include "qcontactdetails.h"
    49 #include "qcontactdetails.h"
    50 
    50 
    51 QTM_BEGIN_NAMESPACE
    51 QTM_BEGIN_NAMESPACE
    52 
    52 
       
    53 
       
    54 /* template docs:
       
    55 
       
    56    XXXX::FieldYYYY:
       
    57        The field key constant for the YYYY value.
       
    58        \sa yyyy(), setYyyy()
       
    59 
       
    60    XXXX::DefinitionName:
       
    61         The string constant for the definition name of QContactXXXX details.
       
    62 
       
    63    XXXX::FieldSubType
       
    64         The field key constant for the field that stores the sub type of a XXXX.
       
    65         \sa subType(), setSubType()
       
    66 
       
    67    XXXX::SubTypeYYYY
       
    68         The predefined string constant for a sub type value,
       
    69         indicating blah blah blah.
       
    70         \sa subTypes(), setSubTypes()
       
    71  */
       
    72 
       
    73 
       
    74 /* ==================== QContactSyncTarget ======================= */
       
    75 
       
    76 /*!
       
    77    \class QContactSyncTarget
       
    78    \brief The QContactSyncTarget class provides a sync target
       
    79    for a contact.
       
    80    \ingroup contacts-details
       
    81  */
       
    82 
       
    83 /*!
       
    84     \variable QContactSyncTarget::DefinitionName
       
    85     The string constant for the definition name of QContactSyncTarget details.
       
    86 */
       
    87 Q_DEFINE_LATIN1_CONSTANT(QContactSyncTarget::DefinitionName, "SyncTarget");
       
    88 
       
    89 /*!
       
    90     \variable QContactSyncTarget::FieldSyncTarget
       
    91 
       
    92    The field key constant for the sync target value.
       
    93    \sa syncTarget(), setSyncTarget()
       
    94  */
       
    95 Q_DEFINE_LATIN1_CONSTANT(QContactSyncTarget::FieldSyncTarget, "SyncTarget");
       
    96 
       
    97 /*!
       
    98    \fn QContactSyncTarget::syncTarget() const
       
    99 
       
   100    Returns the identifier of the backend store to which the contact
       
   101    containing this detail should be synchronized.
       
   102  */
       
   103 
       
   104 /*!
       
   105    \fn QContactSyncTarget::setSyncTarget(const QString& syncTarget)
       
   106 
       
   107    Sets the identifier of the backend store to which the contact
       
   108    containing this detail should be synchronized to \a syncTarget.
       
   109  */
       
   110 
       
   111 /* ==================== QContactEmailAddress ======================= */
       
   112 
       
   113 
       
   114 /*!
       
   115    \class QContactEmailAddress
       
   116 
       
   117    \brief The QContactEmailAddress class contains an email address of
       
   118    a contact.
       
   119    \ingroup contacts-details
       
   120  */
       
   121 
       
   122 /*!
       
   123    \variable QContactEmailAddress::DefinitionName
       
   124    The string constant for the definition name of QContactEmailAddress details.
       
   125  */
       
   126 Q_DEFINE_LATIN1_CONSTANT(QContactEmailAddress::DefinitionName, "EmailAddress");
       
   127 
       
   128 /*!
       
   129    \variable QContactEmailAddress::FieldEmailAddress
       
   130 
       
   131    The field key constant for the email address value.
       
   132    \sa emailAddress(), setEmailAddress()
       
   133  */
       
   134 Q_DEFINE_LATIN1_CONSTANT(QContactEmailAddress::FieldEmailAddress, "EmailAddress");
       
   135 
       
   136 /*!
       
   137    \fn QContactEmailAddress::emailAddress() const
       
   138    Returns the email address of the contact which is stored in this detail.
       
   139  */
       
   140 
       
   141 /*!
       
   142    \fn QContactEmailAddress::setEmailAddress(const QString& emailAddress)
       
   143    Sets the email address of the contact which is stored in this detail to \a emailAddress.
       
   144  */
       
   145 
       
   146 /* ==================== QContactFamily ======================= */
       
   147 /*!
       
   148    \class QContactFamily
       
   149    \brief The QContactFamily class contains names of
       
   150    family members of a contact.
       
   151    \ingroup contacts-details
       
   152  */
       
   153 
       
   154 /*!
       
   155    \variable QContactFamily::DefinitionName
       
   156    The string constant for the definition name of QContactFamily details.
       
   157  */
       
   158 Q_DEFINE_LATIN1_CONSTANT(QContactFamily::DefinitionName, "Family");
       
   159 
       
   160 /*!
       
   161    \variable QContactFamily::FieldSpouse
       
   162 
       
   163    The field key constant for the value containing the name of a spouse.
       
   164    \sa spouse(), setSpouse()
       
   165  */
       
   166 Q_DEFINE_LATIN1_CONSTANT(QContactFamily::FieldSpouse, "Spouse");
       
   167 
       
   168 /*!
       
   169    \variable QContactFamily::FieldChildren
       
   170 
       
   171    The field key constant for the value containing the names of children.
       
   172    \sa children(), setChildren()
       
   173  */
       
   174 Q_DEFINE_LATIN1_CONSTANT(QContactFamily::FieldChildren, "Children");
       
   175 
       
   176 /*!
       
   177    \fn QContactFamily::spouse() const
       
   178    Returns the name of the spouse of the contact which is stored in this detail.
       
   179  */
       
   180 
       
   181 /*!
       
   182    \fn QContactFamily::setSpouse(const QString& spouseName)
       
   183    Sets the name of the spouse of the contact which is stored in this detail to \a spouseName.
       
   184  */
       
   185 
       
   186 /*!
       
   187    \fn QContactFamily::children() const
       
   188    Returns the names of the children of the contact which is stored in this detail.
       
   189  */
       
   190 
       
   191 /*!
       
   192    \fn QContactFamily::setChildren(const QStringList& childrenNames)
       
   193    Sets the names of the children of the contact which is stored in this detail to \a childrenNames.
       
   194  */
       
   195 
       
   196 /* ==================== QContactAnniversary ======================= */
       
   197 
       
   198 /*!
       
   199    \class QContactAnniversary
       
   200    \brief The QContactAnniversary class contains an anniversary of a contact.
       
   201    \ingroup contacts-details
       
   202  */
       
   203 
       
   204 /*!
       
   205    \variable QContactAnniversary::DefinitionName
       
   206    The string constant for the definition name of QContactAnniversary details.
       
   207  */
       
   208 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::DefinitionName, "Anniversary");
       
   209 
       
   210 /*!
       
   211    \variable QContactAnniversary::FieldOriginalDate
       
   212 
       
   213    The field key constant for the original anniversary date value.
       
   214    \sa originalDate(), setOriginalDate()
       
   215  */
       
   216 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldOriginalDate, "OriginalDate");
       
   217 
       
   218 /*!
       
   219    \variable QContactAnniversary::FieldEvent
       
   220 
       
   221    The field key constant for the name of the event value.
       
   222    \sa event(), setEvent()
       
   223  */
       
   224 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldEvent, "Event");
       
   225 
       
   226 /*!
       
   227    \variable QContactAnniversary::FieldCalendarId
       
   228 
       
   229    The field key constant for the value containing the id of the calendar event.
       
   230    \sa calendarId(), setCalendarId()
       
   231  */
       
   232 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldCalendarId, "CalendarId");
       
   233 
       
   234 /*!
       
   235    \variable QContactAnniversary::FieldSubType
       
   236 
       
   237    The field key constant for the field that stores the sub type of a QContactAnniversary.
       
   238    \sa subType(), setSubType()
       
   239  */
       
   240 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldSubType, "SubType");
       
   241 
       
   242 
       
   243 /*!
       
   244    \variable QContactAnniversary::SubTypeWedding
       
   245 
       
   246     The predefined string constant for a sub type value,
       
   247     indicating this anniversary is a wedding anniversary.
       
   248     \sa subType(), setSubType()
       
   249  */
       
   250 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeWedding, "Wedding");
       
   251 
       
   252 /*!
       
   253    \variable QContactAnniversary::SubTypeEngagement
       
   254 
       
   255     The predefined string constant for a sub type value,
       
   256     indicating this anniversary is the anniversary of an engagement.
       
   257     \sa subType(), setSubType()
       
   258  */
       
   259 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeEngagement, "Engagement");
       
   260 
       
   261 /*!
       
   262    \variable QContactAnniversary::SubTypeHouse
       
   263    \internal
       
   264 
       
   265     The predefined string constant for a sub type value,
       
   266     indicating this anniversary is the anniversary of a new residence.
       
   267     \sa subType(), setSubType()
       
   268  */
       
   269 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeHouse, "House");
       
   270 
       
   271 /*!
       
   272    \variable QContactAnniversary::SubTypeEmployment
       
   273 
       
   274     The predefined string constant for a sub type value,
       
   275     indicating this anniversary is the anniversary of a start of
       
   276     employment.
       
   277     \sa subType(), setSubType()
       
   278  */
       
   279 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeEmployment, "Employment");
       
   280 
       
   281 /*!
       
   282    \variable QContactAnniversary::SubTypeMemorial
       
   283 
       
   284     The predefined string constant for a sub type value,
       
   285     indicating this anniversary is an anniversary of an event of sentimental significance.
       
   286     \sa subType(), setSubType()
       
   287  */
       
   288 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeMemorial, "Memorial");
       
   289 
       
   290 /*!
       
   291    \fn QContactAnniversary::originalDate() const
       
   292    Returns the original date of occurrence of the event stored in this detail.
       
   293  */
       
   294 
       
   295 /*!
       
   296    \fn QContactAnniversary::setOriginalDate(const QDate& date)
       
   297    Sets the original date of occurrence of the event stored in this detail to \a date.
       
   298  */
       
   299 
       
   300 /*!
       
   301    \fn QContactAnniversary::calendarId() const
       
   302  * Returns the identifier of the calendar entry associated with this anniversary.
       
   303  */
       
   304 
       
   305 /*!
       
   306    \fn QContactAnniversary::setCalendarId(const QString& calendarId)
       
   307    Sets the identifier of the calendar entry associated with this anniversary to \a calendarId.
       
   308  */
       
   309 
       
   310 /*!
       
   311    \fn QContactAnniversary::event() const
       
   312    Returns the name of the event for which this detail contains information.
       
   313  */
       
   314 
       
   315 /*!
       
   316    \fn QContactAnniversary::setEvent(const QString& event)
       
   317    Sets the name of the event for which this detail contains information to \a event.
       
   318  */
       
   319 
       
   320 /*!
       
   321    \fn QContactAnniversary::setSubType(const QString& subType)
       
   322    Sets the subtype which this detail implements to be the given \a subType.
       
   323  */
       
   324 
       
   325 /*!
       
   326    \fn QContactAnniversary::subType() const
       
   327    Returns the subtype that this detail implements, if defined.
       
   328  */
       
   329 
       
   330 /* ==================== QContactAvatar ======================= */
       
   331 
       
   332 /*!
       
   333    \class QContactAvatar
       
   334    \brief The QContactAvatar class contains the avatar of a contact.
       
   335    \ingroup contacts-details
       
   336  */
       
   337 
       
   338 /*!
       
   339    \variable QContactAvatar::DefinitionName
       
   340    The string constant for the definition name of QContactAvatar details.
       
   341  */
       
   342 Q_DEFINE_LATIN1_CONSTANT(QContactAvatar::DefinitionName, "Avatar");
       
   343 
       
   344 /*!
       
   345    \variable QContactAvatar::FieldImageUrl
       
   346 
       
   347    The field key constant for the value containing the URL of the avatar image.
       
   348    \sa imageUrl(), setImageUrl()
       
   349  */
       
   350 Q_DEFINE_LATIN1_CONSTANT(QContactAvatar::FieldImageUrl, "ImageUrl");
       
   351 
       
   352 /*!
       
   353    \variable QContactAvatar::FieldVideoUrl
       
   354 
       
   355    The field key constant for the value containing the URL of a video avatar.
       
   356    \sa videoUrl(), setVideoUrl()
       
   357  */
       
   358 Q_DEFINE_LATIN1_CONSTANT(QContactAvatar::FieldVideoUrl, "VideoUrl");
       
   359 
       
   360 /*!
       
   361   \fn QContactAvatar::imageUrl() const
       
   362   Returns the url of an avatar image associated with the contact
       
   363  */
       
   364 
       
   365 /*!
       
   366   \fn QContactAvatar::setImageUrl(const QUrl& imageUrl)
       
   367   Sets the url of an avatar image associated with the contact to \a imageUrl
       
   368  */
       
   369 
       
   370 /*!
       
   371   \fn QContactAvatar::videoUrl() const
       
   372   Returns the url of an avatar video associated with the contact
       
   373  */
       
   374 
       
   375 /*!
       
   376   \fn QContactAvatar::setVideoUrl(const QUrl& videoUrl)
       
   377   Sets the url of an avatar video associated with the contact to \a videoUrl
       
   378  */
       
   379 
       
   380 /* ==================== QContactAddress ======================= */
       
   381 
       
   382 
       
   383 // XXX TODO - explain the different segments and their typical mapping
    53 /*!
   384 /*!
    54    \class QContactAddress
   385    \class QContactAddress
    55    \brief The QContactAddress class contains an address of a contact.
   386    \brief The QContactAddress class contains an address of a contact.
    56    \ingroup contacts-details
   387    \ingroup contacts-details
    57  */
   388  */
    58 
   389 
    59 /*!
   390 /*!
    60    \class QContactAnniversary
   391    \variable QContactAddress::DefinitionName
    61    \brief The QContactAnniversary class contains the anniversary of a contact.
   392    The string constant for the definition name of QContactAddress details.
       
   393  */
       
   394 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::DefinitionName, "Address");
       
   395 
       
   396 /*!
       
   397    \variable QContactAddress::FieldStreet
       
   398 
       
   399    The field key constant for the value containing the street segment.
       
   400    \sa street(), setStreet()
       
   401  */
       
   402 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldStreet, "Street");
       
   403 
       
   404 /*!
       
   405    \variable QContactAddress::FieldLocality
       
   406 
       
   407    The field key constant for the value containing the locality segment.
       
   408    \sa locality(), setLocality()
       
   409  */
       
   410 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldLocality, "Locality");
       
   411 
       
   412 /*!
       
   413    \variable QContactAddress::FieldRegion
       
   414 
       
   415    The field key constant for the value containing the region segment.
       
   416    \sa region(), setRegion()
       
   417  */
       
   418 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldRegion, "Region");
       
   419 
       
   420 /*!
       
   421    \variable QContactAddress::FieldPostcode
       
   422 
       
   423    The field key constant for the value containing the postcode segment.
       
   424    \sa postcode(), setPostcode()
       
   425  */
       
   426 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldPostcode, "Postcode");
       
   427 
       
   428 /*!
       
   429    \variable QContactAddress::FieldCountry
       
   430 
       
   431    The field key constant for the value containing the country segment.
       
   432    \sa country(), setCountry()
       
   433  */
       
   434 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldCountry, "Country");
       
   435 
       
   436 /*!
       
   437    \variable QContactAddress::FieldPostOfficeBox
       
   438 
       
   439    The field key constant for the value containing the post office box segment.
       
   440    \sa postOfficeBox(), setPostOfficeBox()
       
   441  */
       
   442 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldPostOfficeBox, "PostOfficeBox");
       
   443 
       
   444 /*!
       
   445    \variable QContactAddress::FieldSubTypes
       
   446 
       
   447    The field key constant for the field that stores the sub types of a QContactAddress.
       
   448    \sa subTypes(), setSubTypes()
       
   449  */
       
   450 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldSubTypes, "SubTypes");
       
   451 
       
   452 /*!
       
   453    \variable QContactAddress::SubTypeParcel
       
   454 
       
   455     The predefined string constant for a sub type value,
       
   456     indicating this address is an address for parcel delivery.
       
   457     \sa subTypes(), setSubTypes()
       
   458  */
       
   459 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypeParcel, "Parcel");
       
   460 
       
   461 /*!
       
   462    \variable QContactAddress::SubTypePostal
       
   463 
       
   464     The predefined string constant for a sub type value,
       
   465     indicating this address is an address for postal delivery.
       
   466     \sa subTypes(), setSubTypes()
       
   467  */
       
   468 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypePostal, "Postal");
       
   469 
       
   470 /*!
       
   471    \variable QContactAddress::SubTypeDomestic
       
   472 
       
   473     The predefined string constant for a sub type value,
       
   474     indicating this address is an address for domestic mail delivery.
       
   475     \sa subTypes(), setSubTypes()
       
   476  */
       
   477 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypeDomestic, "Domestic");
       
   478 
       
   479 /*!
       
   480    \variable QContactAddress::SubTypeInternational
       
   481 
       
   482     The predefined string constant for a sub type value,
       
   483     indicating this address is an address for international mail delivery.
       
   484     \sa subTypes(), setSubTypes()
       
   485  */
       
   486 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypeInternational, "International");
       
   487 
       
   488 /*!
       
   489    \fn QContactAddress::postOfficeBox() const
       
   490    Returns the post office box segment of the address stored in this detail.
       
   491  */
       
   492 
       
   493 /*!
       
   494    \fn QContactAddress::setPostOfficeBox(const QString& postOfficeBox)
       
   495    Sets the post office box segment of the address stored in this detail to \a postOfficeBox.
       
   496  */
       
   497 
       
   498 /*!
       
   499    \fn QContactAddress::street() const
       
   500    Returns the street segment of the address stored in this detail.
       
   501  */
       
   502 
       
   503 /*!
       
   504    \fn QContactAddress::setStreet(const QString& street)
       
   505    Sets the street segment of the address stored in this detail to \a street.
       
   506  */
       
   507 
       
   508 /*!
       
   509    \fn QContactAddress::locality() const
       
   510    Returns the locality segment of the address stored in this detail.
       
   511  */
       
   512 
       
   513 /*!
       
   514    \fn QContactAddress::setLocality(const QString& locality)
       
   515    Sets the locality segment of the address stored in this detail to \a locality.
       
   516  */
       
   517 
       
   518 /*!
       
   519    \fn QContactAddress::region() const
       
   520    Returns the region segment of the address stored in this detail.
       
   521  */
       
   522 
       
   523 /*!
       
   524    \fn QContactAddress::setRegion(const QString& region)
       
   525    Sets the region segment of the address stored in this detail to \a region.
       
   526  */
       
   527 
       
   528 /*!
       
   529    \fn QContactAddress::postcode() const
       
   530    Returns the postcode segment of the address stored in this detail.
       
   531  */
       
   532 
       
   533 /*!
       
   534    \fn QContactAddress::setPostcode(const QString& postcode)
       
   535    Sets the postcode segment of the address stored in this detail to \a postcode.
       
   536  */
       
   537 
       
   538 /*!
       
   539    \fn QContactAddress::country() const
       
   540    Returns the country segment of the address stored in this detail.
       
   541  */
       
   542 
       
   543 /*!
       
   544    \fn QContactAddress::setCountry(const QString& country)
       
   545    Sets the country segment of the address stored in this detail to \a country.
       
   546  */
       
   547 
       
   548 /*!
       
   549    \fn QContactAddress::setSubTypes(const QStringList& subTypes)
       
   550    Sets the subtypes which this detail implements to be those contained in the list of given \a subTypes.
       
   551  */
       
   552 
       
   553 /*!
       
   554    \fn QContactAddress::setSubTypes(const QString& subType)
       
   555    Sets the subtypes which this detail implements to be just the given \a subType.
       
   556  */
       
   557 
       
   558 /*!
       
   559    \fn QContactAddress::subTypes() const
       
   560    Returns the list of subtypes that this detail implements.
       
   561  */
       
   562 
       
   563 /* ==================== QContactUrl ======================= */
       
   564 
       
   565 /*!
       
   566    \class QContactUrl
       
   567    \brief The QContactUrl class contains a url associated with
       
   568    a contact.
    62    \ingroup contacts-details
   569    \ingroup contacts-details
    63  */
   570  */
    64 
   571 
    65 /*!
   572 /*!
    66    \class QContactAvatar
   573    \variable QContactUrl::DefinitionName
    67    \brief The QContactAvatar class contains the avatar of a contact.
   574    The string constant for the definition name of QContactUrl details.
       
   575  */
       
   576 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::DefinitionName, "Url");
       
   577 
       
   578 /*!
       
   579    \variable QContactUrl::FieldUrl
       
   580 
       
   581    The field key constant for the value containing the URL.
       
   582    \sa url(), setUrl()
       
   583  */
       
   584 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::FieldUrl, "Url");
       
   585 
       
   586 /*!
       
   587    \variable QContactUrl::FieldSubType
       
   588 
       
   589    The field key constant for the field that stores the sub type of a QContactUrl.
       
   590    \sa subType(), setSubType()
       
   591  */
       
   592 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::FieldSubType, "SubType");
       
   593 
       
   594 /*!
       
   595    \variable QContactUrl::SubTypeHomePage
       
   596 
       
   597     The predefined string constant for a sub type value,
       
   598     indicating this url is a contact's home page.
       
   599     \sa subType(), setSubType()
       
   600  */
       
   601 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::SubTypeHomePage, "HomePage");
       
   602 
       
   603 /*!
       
   604    \variable QContactUrl::SubTypeFavourite
       
   605 
       
   606     The predefined string constant for a sub type value,
       
   607     indicating this url is one of the contact's favourite URLs (or bookmarks).
       
   608     \sa subType(), setSubType()
       
   609  */
       
   610 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::SubTypeFavourite, "Favourite");
       
   611 
       
   612 /*!
       
   613    \fn QContactUrl::url() const
       
   614    Returns the url stored in this detail.
       
   615  */
       
   616 
       
   617 /*!
       
   618    \fn QContactUrl::setUrl(const QString& url)
       
   619    Sets the url stored in this detail to \a url.
       
   620  */
       
   621 
       
   622 /*!
       
   623    \fn QContactUrl::setSubType(const QString& subType)
       
   624    Sets the subtype which this detail implements to be the given \a subType.
       
   625  */
       
   626 
       
   627 /*!
       
   628    \fn QContactUrl::subType() const
       
   629    Returns the subtype that this detail implements, if defined.
       
   630  */
       
   631 
       
   632 /* ==================== QContactPhonenumber ======================= */
       
   633 
       
   634 /*!
       
   635     \class QContactPhoneNumber
       
   636     \brief The QContactPhoneNumber class provides a phone number
       
   637     of a contact.
       
   638     \ingroup contacts-details
       
   639 */
       
   640 
       
   641 
       
   642 /*!
       
   643     \variable QContactPhoneNumber::DefinitionName
       
   644     The string constant for the definition name of QContactPhoneNumber details.
       
   645 */
       
   646 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::DefinitionName, "PhoneNumber");
       
   647 
       
   648 /*!
       
   649    \variable QContactPhoneNumber::FieldNumber
       
   650 
       
   651    The field key constant for the value containing the phone number.
       
   652    \sa number(), setNumber()
       
   653  */
       
   654 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::FieldNumber, "PhoneNumber");
       
   655 
       
   656 /*!
       
   657    \variable QContactPhoneNumber::FieldSubTypes
       
   658 
       
   659    The field key constant for the field that stores the sub types of a QContactPhoneNumber.
       
   660    \sa subTypes(), setSubTypes()
       
   661  */
       
   662 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::FieldSubTypes, "SubTypes");
       
   663 
       
   664 /*!
       
   665    \variable QContactPhoneNumber::SubTypeLandline
       
   666 
       
   667     The predefined string constant for a sub type value,
       
   668     indicating this phone number is a landline number.
       
   669     \sa subTypes(), setSubTypes()
       
   670  */
       
   671 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeLandline, "Landline");
       
   672 
       
   673 /*!
       
   674    \variable QContactPhoneNumber::SubTypeMobile
       
   675 
       
   676     The predefined string constant for a sub type value,
       
   677     indicating this phone number is a mobile (cellular) number.
       
   678     \sa subTypes(), setSubTypes()
       
   679  */
       
   680 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeMobile, "Mobile");
       
   681 
       
   682 /*!
       
   683    \variable QContactPhoneNumber::SubTypeFax
       
   684 
       
   685     The predefined string constant for a sub type value,
       
   686     indicating this phone number is a fax number.
       
   687     \sa subTypes(), setSubTypes()
       
   688  */
       
   689 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeFax, "Fax");
       
   690 
       
   691 /*!
       
   692    \variable QContactPhoneNumber::SubTypePager
       
   693 
       
   694     The predefined string constant for a sub type value,
       
   695     indicating this phone number is a pager number.
       
   696     \sa subTypes(), setSubTypes()
       
   697  */
       
   698 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypePager, "Pager");
       
   699 
       
   700 /*!
       
   701    \variable QContactPhoneNumber::SubTypeCar
       
   702 
       
   703     The predefined string constant for a sub type value,
       
   704     indicating this phone number is a car phone.
       
   705     \sa subTypes(), setSubTypes()
       
   706  */
       
   707 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeCar, "Car");
       
   708 
       
   709 /*!
       
   710    \variable QContactPhoneNumber::SubTypeBulletinBoardSystem
       
   711 
       
   712     The predefined string constant for a sub type value,
       
   713     indicating this phone number is a bulletin board system.
       
   714     \sa subTypes(), setSubTypes()
       
   715  */
       
   716 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeBulletinBoardSystem, "BulletinBoardSystem");
       
   717 
       
   718 /*!
       
   719    \variable QContactPhoneNumber::SubTypeVoice
       
   720 
       
   721     The predefined string constant for a sub type value,
       
   722     indicating this phone number supports voice transmission.
       
   723     \sa subTypes(), setSubTypes()
       
   724  */
       
   725 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeVoice, "Voice");
       
   726 
       
   727 /*!
       
   728    \variable QContactPhoneNumber::SubTypeModem
       
   729 
       
   730     The predefined string constant for a sub type value,
       
   731     indicating this phone number supports data transmission.
       
   732     \sa subTypes(), setSubTypes()
       
   733  */
       
   734 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeModem, "Modem");
       
   735 
       
   736 /*!
       
   737    \variable QContactPhoneNumber::SubTypeVideo
       
   738 
       
   739     The predefined string constant for a sub type value,
       
   740     indicating this phone number supports video transmission.
       
   741     \sa subTypes(), setSubTypes()
       
   742  */
       
   743 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeVideo, "Video");
       
   744 
       
   745 /*!
       
   746    \variable QContactPhoneNumber::SubTypeMessagingCapable
       
   747 
       
   748     The predefined string constant for a sub type value,
       
   749     indicating this phone number supports messaging services.
       
   750     \sa subTypes(), setSubTypes()
       
   751  */
       
   752 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeMessagingCapable, "MessagingCapable");
       
   753 
       
   754 /*!
       
   755    \variable QContactPhoneNumber::SubTypeAssistant
       
   756 
       
   757     The predefined string constant for a sub type value,
       
   758     indicating this phone number is the number of an assistant.
       
   759     \sa subTypes(), setSubTypes()
       
   760  */
       
   761 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeAssistant, "Assistant");
       
   762 
       
   763 /*!
       
   764    \variable QContactPhoneNumber::SubTypeDtmfMenu
       
   765 
       
   766     The predefined string constant for a sub type value,
       
   767     indicating this phone number supports DTMF-controlled voice menu navigation.
       
   768     \sa subTypes(), setSubTypes()
       
   769  */
       
   770 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeDtmfMenu, "DtmfMenu");
       
   771 
       
   772 
       
   773 /*!
       
   774    \fn QContactPhoneNumber::number() const
       
   775    Returns the phone number stored in this detail.
       
   776  */
       
   777 
       
   778 /*!
       
   779    \fn QContactPhoneNumber::setNumber(const QString& number)
       
   780    Sets the phone number stored in this detail to \a number.
       
   781  */
       
   782 
       
   783 /*!
       
   784    \fn QContactPhoneNumber::setSubTypes(const QStringList& subTypes)
       
   785    Sets the subtypes which this detail implements to be those contained in the list of given \a subTypes
       
   786  */
       
   787 
       
   788 /*!
       
   789    \fn QContactPhoneNumber::setSubTypes(const QString& subType)
       
   790    Sets the subtypes which this detail implements to be just the given \a subType.
       
   791  */
       
   792 
       
   793 /*!
       
   794    \fn QContactPhoneNumber::subTypes() const
       
   795    Returns the list of subtypes that this detail implements.
       
   796  */
       
   797 
       
   798 /* ==================== QContactBirthday ======================= */
       
   799 
       
   800 /*!
       
   801    \class QContactBirthday
       
   802    \brief The QContactBirthday class contains a birthday of a contact.
    68    \ingroup contacts-details
   803    \ingroup contacts-details
    69  */
   804  */
    70 
   805 
    71 /*!
   806 /*!
    72    \class QContactBirthday
   807    \variable QContactBirthday::DefinitionName
    73    \brief The QContactBirthday class contains the birthday of a contact.
   808    The string constant for the definition name of QContactBirthday details.
       
   809  */
       
   810 Q_DEFINE_LATIN1_CONSTANT(QContactBirthday::DefinitionName, "Birthday");
       
   811 
       
   812 /*!
       
   813    \variable QContactBirthday::FieldBirthday
       
   814 
       
   815    The field key constant for the value containing the birthday date.
       
   816    \sa date(), setDate()
       
   817  */
       
   818 Q_DEFINE_LATIN1_CONSTANT(QContactBirthday::FieldBirthday, "Birthday");
       
   819 
       
   820 /*!
       
   821    \fn QContactBirthday::date() const
       
   822    Returns the date of the birthday which is stored in this detail.
       
   823  */
       
   824 
       
   825 /*!
       
   826    \fn QContactBirthday::setDate(const QDate& date)
       
   827    Sets the date of the birthday which is stored in this detail to \a date.
       
   828  */
       
   829 
       
   830 /* ==================== QContactGender ======================= */
       
   831 
       
   832 /*!
       
   833    \class QContactGender
       
   834    \brief The QContactGender class contains the gender of a contact.
    74    \ingroup contacts-details
   835    \ingroup contacts-details
    75  */
   836  */
    76 
   837 
       
   838 /*!
       
   839    \variable QContactGender::DefinitionName
       
   840    The string constant for the definition name of QContactGender details.
       
   841  */
       
   842 Q_DEFINE_LATIN1_CONSTANT(QContactGender::DefinitionName, "Gender");
       
   843 
       
   844 /*!
       
   845    \variable QContactGender::FieldGender
       
   846 
       
   847    The field key constant for the value containing the gender.
       
   848    \sa gender(), setGender()
       
   849  */
       
   850 Q_DEFINE_LATIN1_CONSTANT(QContactGender::FieldGender, "Gender");
       
   851 
       
   852 /*!
       
   853    \variable QContactGender::GenderMale
       
   854    The value that identifies this contact as being male.
       
   855  */
       
   856 Q_DEFINE_LATIN1_CONSTANT(QContactGender::GenderMale, "Male");
       
   857 
       
   858 /*!
       
   859    \variable QContactGender::GenderFemale
       
   860    The value that identifies this contact as being female.
       
   861  */
       
   862 Q_DEFINE_LATIN1_CONSTANT(QContactGender::GenderFemale, "Female");
       
   863 
       
   864 /*!
       
   865    \variable QContactGender::GenderUnspecified
       
   866    The value that identifies this contact as being of unspecified gender.
       
   867  */
       
   868 Q_DEFINE_LATIN1_CONSTANT(QContactGender::GenderUnspecified, "Unspecified");
       
   869 
       
   870 /*!
       
   871    \fn QContactGender::gender() const
       
   872 
       
   873    Returns the gender of the contact, as stored in this detail.  The
       
   874    possible values for the value stored are "Male", "Female" and
       
   875    "Unspecified".
       
   876  */
       
   877 
       
   878 /*!
       
   879    \fn QContactGender::setGender(const QString& gender)
       
   880 
       
   881    Sets the gender of the contact (as stored in this detail) to \a
       
   882    gender, if \a gender is either "Male" or "Female", otherwise sets
       
   883    it to "Unspecified".
       
   884  */
       
   885 
       
   886 /* ==================== QContactGeolocation ======================= */
       
   887 
       
   888 /*!
       
   889    \class QContactGeoLocation
       
   890    \brief The QContactGeoLocation class contains a global location
       
   891    coordinate associated with a contact.
       
   892    \ingroup contacts-details
       
   893 */
       
   894 
       
   895 /*!
       
   896    \variable QContactGeoLocation::DefinitionName
       
   897    The string constant for the definition name of QContactGeoLocation details.
       
   898  */
       
   899 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::DefinitionName, "GeoLocation");
       
   900 
       
   901 /*!
       
   902    \variable QContactGeoLocation::FieldLabel
       
   903 
       
   904    The field key constant for the value containing the location label.
       
   905    \sa label(), setLabel()
       
   906  */
       
   907 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldLabel, "Label");
       
   908 
       
   909 /*!
       
   910    \variable QContactGeoLocation::FieldLatitude
       
   911 
       
   912    The field key constant for the value containing the latitude.
       
   913    \sa latitude(), setLatitude()
       
   914  */
       
   915 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldLatitude, "Latitude");
       
   916 
       
   917 /*!
       
   918    \variable QContactGeoLocation::FieldLongitude
       
   919 
       
   920    The field key constant for the value containing the longitude.
       
   921    \sa longitude(), setLongitude()
       
   922  */
       
   923 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldLongitude, "Longitude");
       
   924 
       
   925 /*!
       
   926    \variable QContactGeoLocation::FieldAccuracy
       
   927 
       
   928    The field key constant for the value containing the location (latitude/longitude) accuracy.
       
   929    \sa accuracy(), setAccuracy()
       
   930  */
       
   931 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldAccuracy, "Accuracy");
       
   932 
       
   933 /*!
       
   934    \variable QContactGeoLocation::FieldAltitude
       
   935 
       
   936    The field key constant for the value containing the altitude.
       
   937    \sa altitude(), setAltitude()
       
   938  */
       
   939 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldAltitude, "Altitude");
       
   940 
       
   941 
       
   942 /*!
       
   943    \variable QContactGeoLocation::FieldAltitudeAccuracy
       
   944 
       
   945    The field key constant for the value containing the accuracy of the altitude.
       
   946    \sa altitudeAccuracy(), setAltitudeAccuracy()
       
   947  */
       
   948 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldAltitudeAccuracy, "AltitudeAccuracy");
       
   949 
       
   950 /*!
       
   951    \variable QContactGeoLocation::FieldHeading
       
   952 
       
   953    The field key constant for the value containing the heading.
       
   954    \sa heading(), setHeading()
       
   955  */
       
   956 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldHeading, "Heading");
       
   957 
       
   958 /*!
       
   959    \variable QContactGeoLocation::FieldSpeed
       
   960 
       
   961    The field key constant for the value containing the speed.
       
   962    \sa speed(), setSpeed()
       
   963  */
       
   964 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldSpeed, "Speed");
       
   965 
       
   966 /*!
       
   967    \variable QContactGeoLocation::FieldTimestamp
       
   968 
       
   969    The field key constant for the value containing the timestamp of the location information.
       
   970    \sa timestamp(), setTimestamp()
       
   971  */
       
   972 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldTimestamp, "Timestamp");
       
   973 
       
   974 /*!
       
   975    \fn QContactGeoLocation::setLabel(const QString& label)
       
   976    Sets the label of the location stored in the detail to \a label.
       
   977  */
       
   978 
       
   979 /*!
       
   980    \fn QContactGeoLocation::label() const
       
   981    Returns the label of the location stored in the detail.
       
   982  */
       
   983 
       
   984 /*!
       
   985    \fn QContactGeoLocation::setLatitude(double latitude)
       
   986 
       
   987    Sets the latitude portion of the coordinate (in decimal degrees) of
       
   988    the location stored in the detail to \a latitude.
       
   989  */
       
   990 
       
   991 /*!
       
   992    \fn QContactGeoLocation::latitude() const
       
   993 
       
   994    Returns the latitude portion of the coordinate (specified in
       
   995    decimal degrees) of the location stored in the detail.
       
   996  */
       
   997 
       
   998 /*!
       
   999    \fn QContactGeoLocation::setLongitude(double longitude)
       
  1000 
       
  1001    Sets the longitude portion of the coordinate (in decimal degrees)
       
  1002    of the location stored in the detail to \a longitude.
       
  1003  */
       
  1004 
       
  1005 /*!
       
  1006    \fn QContactGeoLocation::longitude() const
       
  1007 
       
  1008    Returns the longitude portion of the coordinate (specified in
       
  1009    decimal degrees) of the location stored in the detail.
       
  1010  */
       
  1011 
       
  1012 /*!
       
  1013    \fn QContactGeoLocation::setAccuracy(double accuracy)
       
  1014 
       
  1015    Specifies that the latitude and longitude portions of the location
       
  1016    stored in the detail are accurate to within \a accuracy metres.
       
  1017  */
       
  1018 
       
  1019 /*!
       
  1020    \fn QContactGeoLocation::accuracy() const
       
  1021 
       
  1022    Returns the accuracy (in metres) of the latitude and longitude of
       
  1023    the location stored in the detail.
       
  1024  */
       
  1025 
       
  1026 /*!
       
  1027    \fn QContactGeoLocation::setAltitude(double altitude)
       
  1028 
       
  1029    Sets the altitude portion of the coordinate (in metres above the
       
  1030    ellipsoid) of the location stored in the detail to \a altitude.
       
  1031  */
       
  1032 
       
  1033 /*!
       
  1034    \fn QContactGeoLocation::altitude() const
       
  1035    Returns the altitude (in metres) of the location stored in the detail.
       
  1036  */
       
  1037 
       
  1038 /*!
       
  1039    \fn QContactGeoLocation::setAltitudeAccuracy(double altitudeAccuracy)
       
  1040 
       
  1041    Sets the altitude-accuracy portion of the coordinate (in metres) of
       
  1042    the location stored in the detail to \a altitudeAccuracy.
       
  1043  */
       
  1044 
       
  1045 /*!
       
  1046    \fn QContactGeoLocation::altitudeAccuracy() const
       
  1047 
       
  1048    Returns the accuracy of the altitude portion of the location stored
       
  1049    in the detail.
       
  1050  */
       
  1051 
       
  1052 /*!
       
  1053    \fn QContactGeoLocation::setHeading(double heading)
       
  1054 
       
  1055    Sets the heading portion of the coordinate (in decimal degrees
       
  1056    clockwise relative to true north) of the location-aware device at
       
  1057    the time of measurement to \a heading.
       
  1058  */
       
  1059 
       
  1060 /*!
       
  1061    \fn QContactGeoLocation::heading() const
       
  1062 
       
  1063    Returns the heading (at the time of measurement) of the
       
  1064    location-aware device that recorded (or was provided) the
       
  1065    measurement.
       
  1066  */
       
  1067 
       
  1068 /*!
       
  1069    \fn QContactGeoLocation::setSpeed(double speed)
       
  1070 
       
  1071    Sets the speed portion of the coordinate (in metres per second) of
       
  1072    the location-aware device at the time of measurement to \a speed.
       
  1073  */
       
  1074 
       
  1075 /*!
       
  1076    \fn QContactGeoLocation::speed() const
       
  1077 
       
  1078    Returns the speed (at the time of measurement) of the
       
  1079    location-aware device that recorded (or was provided) the
       
  1080    measurement.
       
  1081  */
       
  1082 
       
  1083 /*!
       
  1084    \fn QContactGeoLocation::setTimestamp(const QDateTime& timestamp)
       
  1085 
       
  1086    Sets the creation (or first-valid) timestamp of the location
       
  1087    information to \a timestamp.
       
  1088  */
       
  1089 
       
  1090 /*!
       
  1091    \fn QContactGeoLocation::timestamp() const
       
  1092 
       
  1093    Returns the timestamp associated with the location stored in the
       
  1094    detail.
       
  1095  */
       
  1096 
       
  1097 /* ==================== QContactGuid ======================= */
       
  1098 
       
  1099 /*!
       
  1100    \class QContactGuid
       
  1101    \brief The QContactGuid class contains a globally unique
       
  1102    Id of a contact, for use in synchronization with other datastores.
       
  1103    \ingroup contacts-details
       
  1104  */
       
  1105 
       
  1106 /*!
       
  1107    \variable QContactGuid::DefinitionName
       
  1108    The string constant for the definition name of QContactGuid details.
       
  1109  */
       
  1110 Q_DEFINE_LATIN1_CONSTANT(QContactGuid::DefinitionName, "Guid");
       
  1111 
       
  1112 /*!
       
  1113    \variable QContactGuid::FieldGuid
       
  1114 
       
  1115    The field key constant for the value containing the GUID.
       
  1116    \sa guid(), setGuid()
       
  1117  */
       
  1118 Q_DEFINE_LATIN1_CONSTANT(QContactGuid::FieldGuid, "Guid");
       
  1119 
       
  1120 /*!
       
  1121    \fn QContactGuid::guid() const
       
  1122 
       
  1123    Returns the globally unique identifier which is stored in this
       
  1124    detail.
       
  1125  */
       
  1126 
       
  1127 /*!
       
  1128    \fn QContactGuid::setGuid(const QString& guid)
       
  1129    Sets the globally unique identifier which is stored in this detail to \a guid.
       
  1130  */
       
  1131 
       
  1132 /* ==================== QContactName ======================= */
       
  1133 
       
  1134 /*!
       
  1135    \class QContactName
       
  1136    \brief The QContactName class contains a name of a contact.
       
  1137    \ingroup contacts-details
       
  1138  */
       
  1139 
       
  1140 /*!
       
  1141    \variable QContactName::DefinitionName
       
  1142    The string constant for the definition name of QContactName details.
       
  1143  */
       
  1144 Q_DEFINE_LATIN1_CONSTANT(QContactName::DefinitionName, "Name");
       
  1145 
       
  1146 /*!
       
  1147    \variable QContactName::FieldPrefix
       
  1148 
       
  1149    The field key constant for the value containing the prefix part of the name.
       
  1150    \sa prefix(), setPrefix()
       
  1151  */
       
  1152 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldPrefix, "Prefix");
       
  1153 
       
  1154 /*!
       
  1155    \variable QContactName::FieldFirstName
       
  1156 
       
  1157    The field key constant for the value containing the first name part of the name.
       
  1158    \sa firstName(), setFirstName()
       
  1159  */
       
  1160 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldFirstName, "FirstName");
       
  1161 
       
  1162 /*!
       
  1163    \variable QContactName::FieldMiddleName
       
  1164 
       
  1165    The field key constant for the value containing the middle name part of the name.
       
  1166    \sa middleName(), setMiddleName()
       
  1167  */
       
  1168 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldMiddleName, "MiddleName");
       
  1169 
       
  1170 /*!
       
  1171    \variable QContactName::FieldLastName
       
  1172 
       
  1173    The field key constant for the value containing the last name part of the name.
       
  1174    \sa lastName(), setLastName()
       
  1175  */
       
  1176 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldLastName, "LastName");
       
  1177 
       
  1178 /*!
       
  1179    \variable QContactName::FieldSuffix
       
  1180 
       
  1181    The field key constant for the value containing the suffix part of the name.
       
  1182    \sa suffix(), setSuffix()
       
  1183  */
       
  1184 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldSuffix, "Suffix");
       
  1185 
       
  1186 /*!
       
  1187    \variable QContactName::FieldCustomLabel
       
  1188 
       
  1189    The field key constant for the value containing a custom formatted label.
       
  1190    \sa customLabel(), setCustomLabel()
       
  1191  */
       
  1192 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldCustomLabel, "CustomLabel");
       
  1193 
       
  1194 /*!
       
  1195    \fn QContactName::prefix() const
       
  1196    Returns the prefix segment of the name stored in this detail.
       
  1197  */
       
  1198 
       
  1199 /*!
       
  1200    \fn QContactName::setPrefix(const QString& prefix)
       
  1201    Sets the prefix segment of the name stored in this detail to \a prefix.
       
  1202  */
       
  1203 
       
  1204 /*!
       
  1205    \fn QContactName::firstName() const
       
  1206    Returns the first (given) name segment of the name stored in this detail.
       
  1207  */
       
  1208 
       
  1209 /*!
       
  1210    \fn QContactName::setFirstName(const QString& firstName)
       
  1211    Sets the first name segment of the name stored in this detail to \a firstName.
       
  1212  */
       
  1213 
       
  1214 /*!
       
  1215    \fn QContactName::middleName() const
       
  1216    
       
  1217    Returns the middle (additional, or other) name segment of the name
       
  1218    stored in this detail.
       
  1219  */
       
  1220 
       
  1221 /*!
       
  1222    \fn QContactName::setMiddleName(const QString& middleName)
       
  1223    Sets the middle name segment of the name stored in this detail to \a middleName.
       
  1224  */
       
  1225 
       
  1226 /*!
       
  1227    \fn QContactName::lastName() const
       
  1228 
       
  1229    Returns the last (family, or surname) name segment of the name
       
  1230    stored in this detail.
       
  1231  */
       
  1232 
       
  1233 /*!
       
  1234    \fn QContactName::setLastName(const QString& lastName)
       
  1235    Sets the last name segment of the name stored in this detail to \a lastName.
       
  1236  */
       
  1237 
       
  1238 /*!
       
  1239    \fn QContactName::suffix() const
       
  1240    Returns the suffix segment of the name stored in this detail.
       
  1241  */
       
  1242 
       
  1243 /*!
       
  1244    \fn QContactName::setSuffix(const QString& suffix)
       
  1245    Sets the suffix segment of the name stored in this detail to \a suffix.
       
  1246  */
       
  1247 
       
  1248 /*!
       
  1249    \fn QContactName::customLabel() const
       
  1250    Returns the custom label of the name stored in this detail.
       
  1251  */
       
  1252 
       
  1253 /*!
       
  1254    \fn QContactName::setCustomLabel(const QString& customLabel)
       
  1255    Sets the custom label of the name stored in this detail to \a customLabel.
       
  1256  */
       
  1257 
       
  1258 /* ==================== QContactNickname ======================= */
       
  1259 
       
  1260 /*!
       
  1261    \class QContactNickname
       
  1262    \brief The QContactNickname class contains a nickname of a contact.
       
  1263    \ingroup contacts-details
       
  1264  */
       
  1265 
       
  1266 /*!
       
  1267 \variable QContactNickname::DefinitionName
       
  1268 The string constant for the definition name of QContactNickname details.
       
  1269 */
       
  1270 Q_DEFINE_LATIN1_CONSTANT(QContactNickname::DefinitionName, "Nickname");
       
  1271 
       
  1272 /*!
       
  1273    \variable QContactNickname::FieldNickname
       
  1274 
       
  1275    The field key constant for the value containing the nickname.
       
  1276    \sa nickname(), setNickname()
       
  1277  */
       
  1278 Q_DEFINE_LATIN1_CONSTANT(QContactNickname::FieldNickname, "Nickname");
       
  1279 
       
  1280 /*!
       
  1281    \fn QContactNickname::setNickname(const QString& nickname)
       
  1282    Sets the nickname of the contact which is stored in this detail to \a nickname.
       
  1283  */
       
  1284 
       
  1285 /*!
       
  1286    \fn QContactNickname::nickname() const
       
  1287    Returns the nickname of the contact which is stored in this detail.
       
  1288  */
       
  1289 
       
  1290 /* ==================== QContactNote ======================= */
       
  1291 
       
  1292 /*!
       
  1293    \class QContactNote
       
  1294    \brief The QContactNote class contains a note associated
       
  1295    with a contact.
       
  1296    \ingroup contacts-details
       
  1297  */
       
  1298 
       
  1299 /*!
       
  1300    \variable QContactNote::DefinitionName
       
  1301    The string constant for the definition name of QContactNote details.
       
  1302 */
       
  1303 Q_DEFINE_LATIN1_CONSTANT(QContactNote::DefinitionName, "Note");
       
  1304 
       
  1305 /*!
       
  1306    \variable QContactNote::FieldNote
       
  1307 
       
  1308    The field key constant for the value containing the note.
       
  1309    \sa note(), setNote()
       
  1310  */
       
  1311 Q_DEFINE_LATIN1_CONSTANT(QContactNote::FieldNote, "Note");
       
  1312 
       
  1313 
       
  1314 /*!
       
  1315    \fn QContactNote::setNote(const QString& note)
       
  1316    Sets a note associated with a contact to \a note.
       
  1317  */
       
  1318 
       
  1319 /*!
       
  1320    \fn QContactNote::note() const
       
  1321    Returns a string for a note associated with a contact.
       
  1322  */
       
  1323 
       
  1324 /* ==================== QContactTag ======================= */
       
  1325 
       
  1326 /*!
       
  1327    \class QContactTag
       
  1328    \brief The QContactTag class contains a tag associated with a
       
  1329    contact.
       
  1330    \ingroup contacts-details
       
  1331  */
       
  1332 
       
  1333 /*!
       
  1334    \variable QContactTag::DefinitionName
       
  1335    The string constant for the definition name of QContactTag details.
       
  1336  */
       
  1337 Q_DEFINE_LATIN1_CONSTANT(QContactTag::DefinitionName, "Tag");
       
  1338 
       
  1339 /*!
       
  1340    \variable QContactTag::FieldTag
       
  1341 
       
  1342     The field key constant for the value containing the tag.
       
  1343    \sa tag(), setTag()
       
  1344  */
       
  1345 Q_DEFINE_LATIN1_CONSTANT(QContactTag::FieldTag, "Tag");
       
  1346 
       
  1347 /*!
       
  1348    \fn QContactTag::setTag(const QString& tag)
       
  1349    Sets the tag associated with a contact which is stored in this detail to \a tag.
       
  1350  */
       
  1351 
       
  1352 /*!
       
  1353    \fn QContactTag::tag() const
       
  1354    Returns the tag associated with a contact which is stored in this detail.
       
  1355  */
       
  1356 
       
  1357 /* ==================== QContactThumbnail ======================= */
       
  1358 
       
  1359 /*!
       
  1360    \class QContactThumbnail
       
  1361    \brief The QContactThumbnail class contains a thumbnail used
       
  1362    in display lists to represent the contact.
       
  1363    \ingroup contacts-details
       
  1364  */
       
  1365 
       
  1366 /*!
       
  1367    \variable QContactThumbnail::DefinitionName
       
  1368    The string constant for the definition name of QContactThumbnail details.
       
  1369  */
       
  1370 Q_DEFINE_LATIN1_CONSTANT(QContactThumbnail::DefinitionName, "Thumbnail");
       
  1371 
       
  1372 /*!
       
  1373    \variable QContactThumbnail::FieldThumbnail
       
  1374 
       
  1375    The field key constant for the value containing the thumbnail image.
       
  1376    \sa thumbnail(), setThumbnail()
       
  1377  */
       
  1378 Q_DEFINE_LATIN1_CONSTANT(QContactThumbnail::FieldThumbnail, "Thumbnail");
       
  1379 
       
  1380 /*!
       
  1381   \fn QContactThumbnail::thumbnail() const
       
  1382   Returns the thumbnail image of the contact
       
  1383  */
       
  1384 
       
  1385 /*!
       
  1386   \fn QContactThumbnail::setThumbnail(const QImage& thumbnail)
       
  1387   Sets the thumbnail image of the contact to be \a thumbnail
       
  1388  */
       
  1389 
       
  1390 /* ==================== QContactTimestamp ======================= */
       
  1391 
       
  1392 /*!
       
  1393    \class QContactTimestamp
       
  1394    \brief The QContactTimestamp class contains the creation and
       
  1395    last-modified timestamp associated with the contact.
       
  1396    \ingroup contacts-details
       
  1397  */
       
  1398 
       
  1399 /*!
       
  1400 \variable QContactTimestamp::DefinitionName
       
  1401 The string constant for the definition name of QContactTimestamp details.
       
  1402 */
       
  1403 Q_DEFINE_LATIN1_CONSTANT(QContactTimestamp::DefinitionName, "Timestamp");
       
  1404 
       
  1405 /*!
       
  1406    \variable QContactTimestamp::FieldModificationTimestamp
       
  1407 
       
  1408    The field key constant for the value of the last modified timestamp.
       
  1409    \sa lastModified(), setLastModified()
       
  1410  */
       
  1411 Q_DEFINE_LATIN1_CONSTANT(QContactTimestamp::FieldModificationTimestamp, "ModificationTimestamp");
       
  1412 
       
  1413 /*!
       
  1414    \variable QContactTimestamp::FieldCreationTimestamp
       
  1415 
       
  1416    The field key constant for the value of the timestamp a contact was created.
       
  1417    \sa created(), setCreated()
       
  1418  */
       
  1419 Q_DEFINE_LATIN1_CONSTANT(QContactTimestamp::FieldCreationTimestamp, "CreationTimestamp");
       
  1420 
       
  1421 /*!
       
  1422    \fn QContactTimestamp::created() const
       
  1423    Returns the creation timestamp saved in this detail.
       
  1424  */
       
  1425 
       
  1426 /*!
       
  1427    \fn QContactTimestamp::lastModified() const
       
  1428    Returns the last-modified timestamp saved in this detail.
       
  1429  */
       
  1430 
       
  1431 /*!
       
  1432    \fn QContactTimestamp::setCreated(const QDateTime& dateTime)
       
  1433    Sets the creation timestamp saved in this detail to \a dateTime.
       
  1434  */
       
  1435 
       
  1436 /*!
       
  1437    \fn QContactTimestamp::setLastModified(const QDateTime& dateTime)
       
  1438    Sets the last-modified timestamp saved in this detail to \a dateTime.
       
  1439  */
       
  1440 
       
  1441 /* ==================== QContactType ======================= */
       
  1442 
       
  1443 /*!
       
  1444    \class QContactType
       
  1445    \brief The QContactType class describes the type of the contact.
       
  1446    \ingroup contacts-details
       
  1447  */
       
  1448 
       
  1449 /*!
       
  1450 \variable QContactType::DefinitionName
       
  1451 The string constant for the definition name of QContactType details.
       
  1452 */
       
  1453 Q_DEFINE_LATIN1_CONSTANT(QContactType::DefinitionName, "Type");
       
  1454 
       
  1455 /*!
       
  1456    \variable QContactType::FieldType
       
  1457 
       
  1458    The field key constant for the type value which is stored in details of
       
  1459    the QContactType definition.
       
  1460  */
       
  1461 Q_DEFINE_LATIN1_CONSTANT(QContactType::FieldType, "Type");
       
  1462 
       
  1463 
       
  1464 /*!
       
  1465    \variable QContactType::TypeContact
       
  1466 
       
  1467     The predefined string constant for a type value,
       
  1468     indicating this contact is an ordinary contact.
       
  1469     \sa setType(), type()
       
  1470  */
       
  1471 Q_DEFINE_LATIN1_CONSTANT(QContactType::TypeContact, "Contact");
       
  1472 
       
  1473 /*!
       
  1474    \variable QContactType::TypeGroup
       
  1475 
       
  1476     The predefined string constant for a type value,
       
  1477     indicating this contact is a group contact.
       
  1478 
       
  1479     Contacts of this type are able to be the first contact in
       
  1480     relationships of the \c QContactRelationship::HasMember type.
       
  1481 
       
  1482     To enumerate the ids of members of a group, the client should
       
  1483     retrieve the relationships which involve the group from the manager
       
  1484     in which the group is saved.
       
  1485 
       
  1486     \sa setType(), type()
       
  1487  */
       
  1488 Q_DEFINE_LATIN1_CONSTANT(QContactType::TypeGroup, "Group");
       
  1489 
       
  1490 /*!
       
  1491    \fn QContactType::type() const
       
  1492    Returns the contact type value stored in this detail.
       
  1493  */
       
  1494 
       
  1495 /*!
       
  1496    \fn QContactType::setType(const QString& type)
       
  1497    Sets the type of the contact to be the give \a type.
       
  1498  */
       
  1499 
       
  1500 /* ==================== QContactDisplayLabel ======================= */
       
  1501 
       
  1502 // XXX TODO make this better
    77 /*!
  1503 /*!
    78    \class QContactDisplayLabel
  1504    \class QContactDisplayLabel
    79    \brief The QContactDisplayLabel class is the (possibly synthesized)
  1505    \brief The QContactDisplayLabel class is the (possibly synthesized)
    80    display label of a contact.
  1506    display label of a contact.
    81    \ingroup contacts-details
  1507    \ingroup contacts-details
    82  */
  1508  */
    83 
  1509 
    84 /*!
  1510 /*!
    85    \class QContactEmailAddress
  1511    \variable QContactDisplayLabel::DefinitionName
    86 
  1512 
    87    \brief The QContactEmailAddress class contains the email address of
  1513    The string constant for the definition name of QContactDisplayLabel details.
    88    a contact.
  1514  */
       
  1515 Q_DEFINE_LATIN1_CONSTANT(QContactDisplayLabel::DefinitionName, "DisplayLabel");
       
  1516 
       
  1517 
       
  1518 /*!
       
  1519    \variable QContactDisplayLabel::FieldLabel
       
  1520 
       
  1521    The field key constant for the value of the display label.
       
  1522    \sa label()
       
  1523  */
       
  1524 Q_DEFINE_LATIN1_CONSTANT(QContactDisplayLabel::FieldLabel, "Label");
       
  1525 
       
  1526 /*!
       
  1527    \fn QContactDisplayLabel::label() const
       
  1528    Returns the display label of the contact.
       
  1529  */
       
  1530 
       
  1531 /* ==================== QContactOnlineAccount ======================= */
       
  1532 
       
  1533 // XXX TODO explain link to QContactPresence
       
  1534 
       
  1535 /*!
       
  1536    \class QContactOnlineAccount
       
  1537    \brief The QContactOnlineAccount class provides an online account,
       
  1538    which the contact uses to communicate with friends and family.
       
  1539 
       
  1540    A QContactOnlineAccount consists of the account details required to
       
  1541    communicate with the contact, including the account URI, the capabilities
       
  1542    of the account, the service provider of the account, and the type of the account.
       
  1543 
       
  1544    Presence information for a particular QContactOnlineAccount detail is provided
       
  1545    in a QContactPresence detail which is linked (via linkedDetailUris()) to the
       
  1546    account detail.  This information is generally provided by the backend, and is
       
  1547    not modifiable by clients.
       
  1548 
       
  1549    \sa QContactPresence
       
  1550 
    89    \ingroup contacts-details
  1551    \ingroup contacts-details
    90  */
  1552  */
    91 
  1553 
    92 /*!
  1554 /*!
    93    \class QContactFamily
  1555    \variable QContactOnlineAccount::DefinitionName
    94    \brief The QContactFamily class contains the names of the
  1556    The string constant for the definition name of QContactOnlineAccount details.
    95    family members of a contact.
  1557  */
    96    \ingroup contacts-details
  1558 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::DefinitionName, "OnlineAccount");
    97  */
  1559 
    98 
  1560 /*!
    99 /*!
  1561    \variable QContactOnlineAccount::FieldCapabilities
   100    \class QContactGender
  1562 
   101    \brief The QContactGender class contains the gender of a contact.
  1563    The field key constant for the account capabilities value.
   102    \ingroup contacts-details
  1564    \sa capabilities(), setCapabilities()
   103  */
  1565  */
   104 
  1566 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldCapabilities, "Capabilities");
   105 /*!
  1567 
   106    \class QContactGeoLocation
  1568 /*!
   107    \brief The QContactGeoLocation class contains the global location
  1569    \variable QContactOnlineAccount::FieldAccountUri
   108    coordinate associated with a contact.
  1570 
   109    \ingroup contacts-details
  1571    The field key constant for the account uri value.
   110 */
  1572    \sa accountUri(), setAccountUri()
   111 
  1573  */
   112 /*!
  1574 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldAccountUri, "AccountUri");
   113    \class QContactGlobalPresence
  1575 
   114    \brief The QContactGlobalPresence class provides aggregated presence information
  1576 /*!
   115    for a contact, synthesized or supplied by the backend.
  1577    \variable QContactOnlineAccount::FieldServiceProvider
   116    \ingroup contacts-details
  1578 
   117  */
  1579    The field key constant for the account service provider name.
   118 
  1580    \sa serviceProvider(), setServiceProvider()
   119 /*!
  1581  */
   120    \class QContactGuid
  1582 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldServiceProvider, "ServiceProvider");
   121    \brief The QContactGuid class contains the globally unique
  1583 
   122    Id of a contact.
  1584 /*!
   123    \ingroup contacts-details
  1585    \variable QContactOnlineAccount::FieldSubTypes
   124  */
  1586 
   125 
  1587    The field key constant for the field that stores the sub types of a QContactOnlineAccount.
   126 /*!
  1588    \sa subTypes(), setSubTypes()
   127    \class QContactName
  1589  */
   128    \brief The QContactName class contains the name of a contact.
  1590 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldSubTypes, "SubTypes");
   129    \ingroup contacts-details
  1591 
   130  */
  1592 /*!
   131 
  1593    \variable QContactOnlineAccount::SubTypeSip
   132 /*!
  1594 
   133    \class QContactNickname
  1595     The predefined string constant for a sub type value,
   134    \brief The QContactNickname class contains a nickname of a contact.
  1596     indicating this online account supports SIP.
   135    \ingroup contacts-details
  1597     \sa subTypes(), setSubTypes()
   136  */
  1598  */
   137 
  1599 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeSip, "Sip");
   138 /*!
  1600 
   139    \class QContactNote
  1601 /*!
   140    \brief The QContactNote class contains a note associated
  1602    \variable QContactOnlineAccount::SubTypeSipVoip
   141    with a contact.
  1603 
   142    \ingroup contacts-details
  1604     The predefined string constant for a sub type value,
   143  */
  1605     indicating this online account supports SIP based VOIP.
   144 
  1606     \sa subTypes(), setSubTypes()
   145 /*!
  1607  */
   146    \class QContactOnlineAccount
  1608 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeSipVoip, "SipVoip");
   147    \brief The QContactOnlineAccount class provides the online account,
  1609 
   148    which the contact uses to communicate with friends and family.
  1610 /*!
   149    \ingroup contacts-details
  1611    \variable QContactOnlineAccount::SubTypeImpp
   150  */
  1612 
       
  1613     The predefined string constant for a sub type value,
       
  1614     indicating this online account supports IMPP.
       
  1615     \sa subTypes(), setSubTypes()
       
  1616  */
       
  1617 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeImpp, "Impp");
       
  1618 
       
  1619 /*!
       
  1620    \variable QContactOnlineAccount::SubTypeVideoShare
       
  1621 
       
  1622     The predefined string constant for a sub type value,
       
  1623     indicating this online account supports VideoShare.
       
  1624     \sa subTypes(), setSubTypes()
       
  1625  */
       
  1626 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeVideoShare, "VideoShare");
       
  1627 
       
  1628 
       
  1629 /*!
       
  1630    \fn QContactOnlineAccount::setAccountUri(const QString& accountUri)
       
  1631    
       
  1632    Sets the universal resource identifier of the contact's online
       
  1633    account to \a accountUri.
       
  1634  */
       
  1635 
       
  1636 /*!
       
  1637    \fn QContactOnlineAccount::accountUri() const
       
  1638 
       
  1639    Returns the universal resource identifier of the online account of
       
  1640    the contact.
       
  1641  */
       
  1642 
       
  1643 /*!
       
  1644    \fn QContactOnlineAccount::setServiceProvider(const QString& serviceProvider)
       
  1645 
       
  1646    Sets the service provider of the contact's online account to \a
       
  1647    serviceProvider.
       
  1648  */
       
  1649 
       
  1650 /*!
       
  1651    \fn QContactOnlineAccount::serviceProvider() const
       
  1652    Returns the service provider of the online account of the contact.
       
  1653  */
       
  1654 
       
  1655 /*!
       
  1656    \fn QContactOnlineAccount::setSubTypes(const QStringList& subTypes)
       
  1657    
       
  1658    Sets the subtypes which this detail implements to be those
       
  1659    contained in the list of given \a subTypes.
       
  1660  */
       
  1661 
       
  1662 /*!
       
  1663    \fn QContactOnlineAccount::setSubTypes(const QString& subType)
       
  1664    Sets the subtypes which this detail implements to be just the given \a subType.
       
  1665  */
       
  1666 
       
  1667 /*!
       
  1668    \fn QContactOnlineAccount::subTypes() const
       
  1669    Returns the list of subtypes that this detail implements.
       
  1670  */
       
  1671 
       
  1672 /*!
       
  1673    \fn QContactOnlineAccount::setCapabilities(const QStringList& capabilities)
       
  1674 
       
  1675    Sets the capabilities of the online account about which this detail stores
       
  1676    presence information to \a capabilities.  The \a capabilities list is a
       
  1677    list of service-provider specified strings which together identify the
       
  1678    types of communication which may be possible.
       
  1679  */
       
  1680 
       
  1681 /*!
       
  1682    \fn QContactOnlineAccount::capabilities() const
       
  1683 
       
  1684    Returns the capabilities of the online account about which this detail stores
       
  1685    presence information.
       
  1686  */
       
  1687 
       
  1688 /* ==================== QContactOrganization ======================= */
   151 
  1689 
   152 /*!
  1690 /*!
   153    \class QContactOrganization
  1691    \class QContactOrganization
   154    \brief The QContactOrganization class provides details about an
  1692    \brief The QContactOrganization class provides details about an
   155    organization that the contact is either a part of, or stands for.
  1693    organization that the contact is either a part of, or stands for.
   156    \ingroup contacts-details
  1694    \ingroup contacts-details
   157  */
  1695  */
   158 
  1696 
   159 /*!
  1697 /*!
   160    \class QContactPhoneNumber
       
   161    \brief The QContactPhoneNumber class provides a phone number
       
   162    of a contact.
       
   163    \ingroup contacts-details
       
   164  */
       
   165 
       
   166 /*!
       
   167    \class QContactPresence
       
   168    \brief The QContactPresence class provides presence information
       
   169    for an online account of a contact.
       
   170    \ingroup contacts-details
       
   171  */
       
   172 
       
   173 /*!
       
   174    \class QContactRingtone
       
   175    \brief The QContactRingtone class provides a ringtone associated
       
   176    with a contact
       
   177    \ingroup contacts-details
       
   178  */
       
   179 
       
   180 /*!
       
   181    \class QContactSyncTarget
       
   182    \brief The QContactSyncTarget class provides a sync target
       
   183    for a contact.
       
   184    \ingroup contacts-details
       
   185  */
       
   186 
       
   187 /*!
       
   188    \class QContactTag
       
   189    \brief The QContactTag class contains a tag associated with a
       
   190    contact.
       
   191    \ingroup contacts-details
       
   192  */
       
   193 
       
   194 /*!
       
   195    \class QContactThumbnail
       
   196    \brief The QContactThumbnail class contains a thumbnail used
       
   197    in display lists to represent the contact.
       
   198    \ingroup contacts-details
       
   199  */
       
   200 
       
   201 /*!
       
   202    \class QContactTimestamp
       
   203    \brief The QContactTimestamp class contains the creation and
       
   204    last-modified timestamp associated with the contact.
       
   205    \ingroup contacts-details
       
   206  */
       
   207 
       
   208 /*!
       
   209    \class QContactType
       
   210    \brief The QContactType class describes the type of the contact.
       
   211    \ingroup contacts-details
       
   212  */
       
   213 
       
   214 /*!
       
   215    \class QContactUrl
       
   216    \brief The QContactUrl class contains a url associated with
       
   217    a contact.
       
   218    \ingroup contacts-details
       
   219  */
       
   220 
       
   221 /*!
       
   222    \variable QContactName::DefinitionName
       
   223    The constant string which identifies the definition of details which are names.
       
   224  */
       
   225 Q_DEFINE_LATIN1_CONSTANT(QContactName::DefinitionName, "Name");
       
   226 
       
   227 /*!
       
   228    \variable QContactNickname::DefinitionName
       
   229    The constant string which identifies the definition of details which are nicknames.
       
   230  */
       
   231 Q_DEFINE_LATIN1_CONSTANT(QContactNickname::DefinitionName, "Nickname");
       
   232 
       
   233 /*!
       
   234    \variable QContactNote::DefinitionName
       
   235    The constant string which identifies the definition of details which are notes.
       
   236  */
       
   237 Q_DEFINE_LATIN1_CONSTANT(QContactNote::DefinitionName, "Note");
       
   238 
       
   239 /*!
       
   240    \variable QContactAvatar::DefinitionName
       
   241    The constant string which identifies the definition of details which are avatars.
       
   242  */
       
   243 Q_DEFINE_LATIN1_CONSTANT(QContactAvatar::DefinitionName, "Avatar");
       
   244 
       
   245 /*!
       
   246    \variable QContactAddress::DefinitionName
       
   247    The constant string which identifies the definition of details which are street addresses.
       
   248  */
       
   249 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::DefinitionName, "Address");
       
   250 
       
   251 /*!
       
   252    \variable QContactPhoneNumber::DefinitionName
       
   253    The constant string which identifies the definition of details which are phone numbers.
       
   254  */
       
   255 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::DefinitionName, "PhoneNumber");
       
   256 
       
   257 /*!
       
   258    \variable QContactPresence::DefinitionName
       
   259    The constant string which identifies the definition of details which contain presence information.
       
   260  */
       
   261 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::DefinitionName, "Presence");
       
   262 
       
   263 /*!
       
   264    \variable QContactPresence::FieldTimestamp
       
   265 
       
   266    The constant key for which the last update timestamp value is stored in details
       
   267    of the QContactPresence type.
       
   268  */
       
   269 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldTimestamp, "Timestamp");
       
   270 
       
   271 /*!
       
   272    \variable QContactPresence::FieldNickname
       
   273 
       
   274    The constant key for which the nickname value is stored in details
       
   275    of the QContactPresence type.
       
   276  */
       
   277 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldNickname, "Nickname");
       
   278 
       
   279 /*!
       
   280    \variable QContactPresence::FieldPresenceState
       
   281 
       
   282    The constant key for which the presence state value is stored in details
       
   283    of the QContactPresence typel.
       
   284  */
       
   285 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldPresenceState, "PresenceState");
       
   286 
       
   287 /*!
       
   288    \variable QContactPresence::FieldPresenceStateText
       
   289 
       
   290    The constant key for which the presence provider provided text representation
       
   291    of the presence state is stored in details of the QContactPresence type.
       
   292  */
       
   293 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldPresenceStateText, "PresenceStateText");
       
   294 
       
   295 /*!
       
   296    \variable QContactPresence::FieldPresenceStateImageUrl
       
   297 
       
   298    The constant key for which the image url value for the current presence state
       
   299    is stored in details of the QContactPresence type.
       
   300  */
       
   301 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldPresenceStateImageUrl, "PresenceStateImageUrl");
       
   302 
       
   303 /*!
       
   304    \variable QContactPresence::FieldCustomMessage
       
   305 
       
   306    The constant key for which the user-entered custom message for their state
       
   307    is stored in details of the QContactPresence type.
       
   308  */
       
   309 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldCustomMessage, "CustomMessage");
       
   310 
       
   311 /*!
       
   312    \variable QContactRingtone::DefinitionName
       
   313    The constant string which identifies the definition of details which are ringtones.
       
   314  */
       
   315 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::DefinitionName, "Ringtone");
       
   316 
       
   317 /*!
       
   318    \variable QContactSyncTarget::DefinitionName
       
   319    The constant string which identifies the definition of details which are synchronization target stores.
       
   320  */
       
   321 Q_DEFINE_LATIN1_CONSTANT(QContactSyncTarget::DefinitionName, "SyncTarget");
       
   322 
       
   323 /*!
       
   324    \variable QContactTimestamp::DefinitionName
       
   325    The constant string which identifies the definition of details which are contact synchronization timestamps.
       
   326  */
       
   327 Q_DEFINE_LATIN1_CONSTANT(QContactTimestamp::DefinitionName, "Timestamp");
       
   328 
       
   329 /*!
       
   330    \variable QContactType::DefinitionName
       
   331    The constant string which identifies the definition of details which identify the type of the contact.
       
   332  */
       
   333 Q_DEFINE_LATIN1_CONSTANT(QContactType::DefinitionName, "Type");
       
   334 
       
   335 /*!
       
   336    \variable QContactGuid::DefinitionName
       
   337    The constant string which identifies the definition of details which are globally unique identifiers.
       
   338  */
       
   339 Q_DEFINE_LATIN1_CONSTANT(QContactGuid::DefinitionName, "Guid");
       
   340 
       
   341 /*!
       
   342    \variable QContactEmailAddress::DefinitionName
       
   343    The constant string which identifies the definition of details which are email addresses.
       
   344  */
       
   345 Q_DEFINE_LATIN1_CONSTANT(QContactEmailAddress::DefinitionName, "EmailAddress");
       
   346 
       
   347 /*!
       
   348    \variable QContactFamily::DefinitionName
       
   349    The constant string which identifies the definition of details which contain the names of the contact's family.
       
   350  */
       
   351 Q_DEFINE_LATIN1_CONSTANT(QContactFamily::DefinitionName, "Family");
       
   352 
       
   353 /*!
       
   354    \variable QContactUrl::DefinitionName
       
   355    The constant string which identifies the definition of details which are universal resource location paths.
       
   356  */
       
   357 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::DefinitionName, "Url");
       
   358 
       
   359 /*!
       
   360    \variable QContactBirthday::DefinitionName
       
   361    The constant string which identifies the definition of details which are the dates of birthdays.
       
   362  */
       
   363 Q_DEFINE_LATIN1_CONSTANT(QContactBirthday::DefinitionName, "Birthday");
       
   364 
       
   365 /*!
       
   366    \variable QContactAnniversary::DefinitionName
       
   367    The constant string which identifies the definition of details which are anniversary dates.
       
   368  */
       
   369 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::DefinitionName, "Anniversary");
       
   370 
       
   371 /*!
       
   372    \variable QContactGender::DefinitionName
       
   373 
       
   374    The constant string which identifies the definition of details
       
   375    which identify the gender of a contact in a given context.
       
   376  */
       
   377 Q_DEFINE_LATIN1_CONSTANT(QContactGender::DefinitionName, "Gender");
       
   378 
       
   379 /*!
       
   380    \variable QContactGeoLocation::DefinitionName
       
   381 
       
   382    The constant string which identifies the definition of details
       
   383    which describe a location associated with a contact.
       
   384  */
       
   385 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::DefinitionName, "GeoLocation");
       
   386 
       
   387 /*!
       
   388    \variable QContactGlobalPresence::DefinitionName
       
   389    The constant string which identifies the definition of details which contain presence information.
       
   390  */
       
   391 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::DefinitionName, "GlobalPresence");
       
   392 
       
   393 /*!
       
   394    \variable QContactGlobalPresence::FieldTimestamp
       
   395 
       
   396    The constant key for which the last update timestamp value is stored in details
       
   397    of the QContactGlobalPresence type.
       
   398  */
       
   399 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldTimestamp, "Timestamp");
       
   400 
       
   401 /*!
       
   402    \variable QContactGlobalPresence::FieldNickname
       
   403 
       
   404    The constant key for which the nickname value is stored in details
       
   405    of the QContactGlobalPresence type.
       
   406  */
       
   407 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldNickname, "Nickname");
       
   408 
       
   409 /*!
       
   410    \variable QContactGlobalPresence::FieldPresenceState
       
   411 
       
   412    The constant key for which the presence state value is stored in details
       
   413    of the QContactGlobalPresence typel.
       
   414  */
       
   415 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldPresenceState, "PresenceState");
       
   416 
       
   417 /*!
       
   418    \variable QContactGlobalPresence::FieldPresenceStateText
       
   419 
       
   420    The constant key for which the presence provider provided text representation
       
   421    of the presence state is stored in details of the QContactGlobalPresence type.
       
   422  */
       
   423 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldPresenceStateText, "PresenceStateText");
       
   424 
       
   425 /*!
       
   426    \variable QContactGlobalPresence::FieldPresenceStateImageUrl
       
   427 
       
   428    The constant key for which the image url value for the current presence state
       
   429    is stored in details of the QContactGlobalPresence type.
       
   430  */
       
   431 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldPresenceStateImageUrl, "PresenceStateImageUrl");
       
   432 
       
   433 /*!
       
   434    \variable QContactGlobalPresence::FieldCustomMessage
       
   435 
       
   436    The constant key for which the user-entered custom message for their state
       
   437    is stored in details of the QContactGlobalPresence type.
       
   438  */
       
   439 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldCustomMessage, "CustomMessage");
       
   440 
       
   441 /*!
       
   442    \variable QContactOnlineAccount::DefinitionName
       
   443 
       
   444    The constant string which identifies the definition of details
       
   445    which identify the organization to which a contact belongs in a
       
   446    given context.
       
   447  */
       
   448 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::DefinitionName, "OnlineAccount");
       
   449 
       
   450 /*!
       
   451    \variable QContactTag::DefinitionName
       
   452    The constant string which identifies the definition of details which are tags.
       
   453  */
       
   454 Q_DEFINE_LATIN1_CONSTANT(QContactTag::DefinitionName, "Tag");
       
   455 
       
   456 /*!
       
   457    \variable QContactThumbnail::DefinitionName
       
   458    The constant string which identifies the definition of details which are thumbnails.
       
   459  */
       
   460 Q_DEFINE_LATIN1_CONSTANT(QContactThumbnail::DefinitionName, "Thumbnail");
       
   461 
       
   462 /*!
       
   463    \variable QContactOnlineAccount::FieldCapabilities
       
   464 
       
   465    The constant key for which the account capabilities value is stored in
       
   466    details of the QContactOnlineAccount type.
       
   467  */
       
   468 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldCapabilities, "Capabilities");
       
   469 
       
   470 /*!
       
   471    \variable QContactOnlineAccount::FieldAccountUri
       
   472 
       
   473    The constant key for which the remote account uri value is stored
       
   474    in details of the QContactOnlineAccount type.
       
   475  */
       
   476 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldAccountUri, "AccountUri");
       
   477 
       
   478 /*!
       
   479    \variable QContactOnlineAccount::FieldServiceProvider
       
   480 
       
   481    The constant key for which the service provider value is stored in
       
   482    details of the QContactOnlineAccount type.
       
   483  */
       
   484 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldServiceProvider, "ServiceProvider");
       
   485 
       
   486 /*!
       
   487    \variable QContactOnlineAccount::FieldSubTypes
       
   488 
       
   489    The constant key for which the subtypes value is stored in details
       
   490    of the QContactOnlineAccount type.
       
   491  */
       
   492 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::FieldSubTypes, "SubTypes");
       
   493 
       
   494 /*!
       
   495    \variable QContactOnlineAccount::SubTypeSip
       
   496 
       
   497    The constant attribute value which describes the online account as
       
   498    supporting SIP.
       
   499  */
       
   500 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeSip, "Sip");
       
   501 
       
   502 /*!
       
   503    \variable QContactOnlineAccount::SubTypeSipVoip
       
   504 
       
   505    The constant attribute value which describes the online account as
       
   506    supporting SIP-based VoIP.
       
   507  */
       
   508 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeSipVoip, "SipVoip");
       
   509 
       
   510 /*!
       
   511    \variable QContactOnlineAccount::SubTypeImpp
       
   512 
       
   513    The constant attribute value which describes the online account as
       
   514    supporting IMPP.
       
   515  */
       
   516 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeImpp, "Impp");
       
   517 
       
   518 /*!
       
   519    \variable QContactOnlineAccount::SubTypeVideoShare
       
   520 
       
   521    The constant attribute value which describes the online account as
       
   522    supporting VideoShare.
       
   523  */
       
   524 Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::SubTypeVideoShare, "VideoShare");
       
   525 
       
   526 /*!
       
   527    \variable QContactOrganization::DefinitionName
  1698    \variable QContactOrganization::DefinitionName
   528 
  1699    The string constant for the definition name of QContactOrganization details.
   529    The constant string which identifies the definition of details
       
   530    which identify the organization to which a contact belongs in a
       
   531    given context.
       
   532  */
  1700  */
   533 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::DefinitionName, "Organization");
  1701 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::DefinitionName, "Organization");
   534 
  1702 
   535 /*!
  1703 /*!
   536    \variable QContactDisplayLabel::DefinitionName
       
   537 
       
   538    The constant string which identifies the definition of details
       
   539    which contain a display label of a contact.
       
   540  */
       
   541 Q_DEFINE_LATIN1_CONSTANT(QContactDisplayLabel::DefinitionName, "DisplayLabel");
       
   542 
       
   543 
       
   544 /*!
       
   545    \variable QContactPhoneNumber::FieldNumber
       
   546 
       
   547    The constant key for which the phone number value is stored in
       
   548    details of the QContactPhoneNumber type.
       
   549  */
       
   550 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::FieldNumber, "PhoneNumber");
       
   551 
       
   552 /*!
       
   553    \variable QContactPhoneNumber::FieldSubTypes
       
   554 
       
   555    The constant key for which the subtype values are stored in details
       
   556    of the QContactPhoneNumber type.
       
   557  */
       
   558 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::FieldSubTypes, "SubTypes");
       
   559 
       
   560 /*!
       
   561    \variable QContactEmailAddress::FieldEmailAddress
       
   562 
       
   563    The constant key for which the email address value is stored in
       
   564    details of the QContactEmailAddress type.
       
   565  */
       
   566 Q_DEFINE_LATIN1_CONSTANT(QContactEmailAddress::FieldEmailAddress, "EmailAddress");
       
   567 
       
   568 /*!
       
   569    \variable QContactFamily::FieldSpouse
       
   570 
       
   571    The constant key for which the spouse name value is stored in
       
   572    details of the QContactFamily type.
       
   573  */
       
   574 Q_DEFINE_LATIN1_CONSTANT(QContactFamily::FieldSpouse, "Spouse");
       
   575 
       
   576 /*!
       
   577    \variable QContactFamily::FieldChildren
       
   578 
       
   579    The constant key for which the children names value is stored in
       
   580    details of the QContactFamily type.
       
   581  */
       
   582 Q_DEFINE_LATIN1_CONSTANT(QContactFamily::FieldChildren, "Children");
       
   583 
       
   584 /*!
       
   585    \variable QContactGuid::FieldGuid
       
   586 
       
   587    The constant key for which the globally unique identifier value is
       
   588    stored in details of the QContactGuid type.
       
   589  */
       
   590 Q_DEFINE_LATIN1_CONSTANT(QContactGuid::FieldGuid, "Guid");
       
   591 
       
   592 /*!
       
   593    \variable QContactSyncTarget::FieldSyncTarget
       
   594 
       
   595    The constant key for which the value of the target store for
       
   596    synchronization is stored in details of the QContactSyncTarget type.
       
   597  */
       
   598 Q_DEFINE_LATIN1_CONSTANT(QContactSyncTarget::FieldSyncTarget, "SyncTarget");
       
   599 
       
   600 /*!
       
   601    \variable QContactAvatar::FieldImageUrl
       
   602 
       
   603    The constant key for which the url of the avatar image value is stored in
       
   604    details of the QContactAvatar type.
       
   605  */
       
   606 Q_DEFINE_LATIN1_CONSTANT(QContactAvatar::FieldImageUrl, "ImageUrl");
       
   607 
       
   608 /*!
       
   609    \variable QContactAvatar::FieldVideoUrl
       
   610 
       
   611    The constant key for which the url of the avatar video value is stored in
       
   612    details of the QContactAvatar type.
       
   613  */
       
   614 Q_DEFINE_LATIN1_CONSTANT(QContactAvatar::FieldVideoUrl, "VideoUrl");
       
   615 
       
   616 /*!
       
   617    \variable QContactName::FieldPrefix
       
   618 
       
   619    The constant key for which the name prefix value is stored in
       
   620    details of the QContactName type.
       
   621  */
       
   622 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldPrefix, "Prefix");
       
   623 
       
   624 /*!
       
   625    \variable QContactName::FieldFirstName
       
   626 
       
   627    The constant key for which the first name value is stored in
       
   628    details of the QContactName type.
       
   629  */
       
   630 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldFirstName, "FirstName");
       
   631 
       
   632 /*!
       
   633    \variable QContactName::FieldMiddleName
       
   634 
       
   635    The constant key for which the middle name value is stored in
       
   636    details of the QContactName type.
       
   637  */
       
   638 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldMiddleName, "MiddleName");
       
   639 
       
   640 /*!
       
   641    \variable QContactName::FieldLastName
       
   642 
       
   643    The constant key for which the last name value is stored in details
       
   644    of the QContactName type.
       
   645  */
       
   646 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldLastName, "LastName");
       
   647 
       
   648 /*!
       
   649    \variable QContactName::FieldSuffix
       
   650 
       
   651    The constant key for which the name suffix value is stored in
       
   652    details of the QContactName type.
       
   653  */
       
   654 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldSuffix, "Suffix");
       
   655 
       
   656 /*!
       
   657    \variable QContactName::FieldCustomLabel
       
   658 
       
   659    The constant key for which the custom name label value is stored in
       
   660    details of the QContactName type, if supported.
       
   661  */
       
   662 Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldCustomLabel, "CustomLabel");
       
   663 
       
   664 /*!
       
   665    \variable QContactNickname::FieldNickname
       
   666 
       
   667    The constant key for which the nickname value is stored in details
       
   668    of the QContactNickname type.
       
   669  */
       
   670 Q_DEFINE_LATIN1_CONSTANT(QContactNickname::FieldNickname, "Nickname");
       
   671 
       
   672 /*!
       
   673    \variable QContactNote::FieldNote
       
   674 
       
   675    The constant key for which the note value is stored in details of
       
   676    the QContactNote type.
       
   677  */
       
   678 Q_DEFINE_LATIN1_CONSTANT(QContactNote::FieldNote, "Note");
       
   679 
       
   680 /*!
       
   681    \variable QContactAddress::FieldStreet
       
   682 
       
   683    The constant key for which the street value is stored in details of
       
   684    the QContactAddress type.
       
   685  */
       
   686 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldStreet, "Street");
       
   687 
       
   688 /*!
       
   689    \variable QContactAddress::FieldLocality
       
   690 
       
   691    The constant key for which the locality value is stored in details
       
   692    of the QContactAddress type.
       
   693  */
       
   694 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldLocality, "Locality");
       
   695 
       
   696 /*!
       
   697    \variable QContactAddress::FieldRegion
       
   698 
       
   699    The constant key for which the region value is stored in details of
       
   700    the QContactAddress type.
       
   701  */
       
   702 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldRegion, "Region");
       
   703 
       
   704 /*!
       
   705    \variable QContactAddress::FieldPostcode
       
   706 
       
   707    The constant key for which the postcode value is stored in details
       
   708    of the QContactAddress type.
       
   709  */
       
   710 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldPostcode, "Postcode");
       
   711 
       
   712 /*!
       
   713    \variable QContactAddress::FieldCountry
       
   714 
       
   715    The constant key for which the country value is stored in details
       
   716    of the QContactAddress type.
       
   717  */
       
   718 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldCountry, "Country");
       
   719 
       
   720 /*!
       
   721    \variable QContactAddress::FieldPostOfficeBox
       
   722 
       
   723    The constant key for which the post office box value is stored in
       
   724    details of the QContactAddress type.
       
   725  */
       
   726 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldPostOfficeBox, "PostOfficeBox");
       
   727 
       
   728 /*!
       
   729    \variable QContactAddress::FieldSubTypes
       
   730 
       
   731    The constant key for which the subtypes value is stored in details
       
   732    of the QContactAddress type.
       
   733  */
       
   734 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::FieldSubTypes, "SubTypes");
       
   735 
       
   736 /*!
       
   737    \variable QContactUrl::FieldUrl
       
   738 
       
   739    The constant key for which the url value is stored in details of
       
   740    the QContactUrl type.
       
   741  */
       
   742 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::FieldUrl, "Url");
       
   743 
       
   744 /*!
       
   745    \variable QContactUrl::FieldSubType
       
   746 
       
   747    The constant key for which the subtypes value is stored in details
       
   748    of the QContactUrl type.
       
   749  */
       
   750 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::FieldSubType, "SubType");
       
   751 
       
   752 /*!
       
   753    \variable QContactBirthday::FieldBirthday
       
   754 
       
   755    The constant key for which the birthday date value is stored in
       
   756    details of the QContactBirthday type.
       
   757  */
       
   758 Q_DEFINE_LATIN1_CONSTANT(QContactBirthday::FieldBirthday, "Birthday");
       
   759 
       
   760 /*!
       
   761    \variable QContactAnniversary::FieldOriginalDate
       
   762 
       
   763    The constant key for which the anniversary original event date
       
   764    value is stored in details of the QContactAnniversary type.
       
   765  */
       
   766 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldOriginalDate, "OriginalDate");
       
   767 
       
   768 /*!
       
   769    \variable QContactAnniversary::FieldEvent
       
   770 
       
   771    The constant key for which the name of the event is stored in
       
   772    details of the QContactAnniversary type.
       
   773  */
       
   774 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldEvent, "Event");
       
   775 
       
   776 /*!
       
   777    \variable QContactAnniversary::FieldCalendarId
       
   778 
       
   779    The constant key for which the value of the identifier of the
       
   780    associated calendar entry is stored in details of the
       
   781    QContactAnniversary type.
       
   782  */
       
   783 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldCalendarId, "CalendarId");
       
   784 
       
   785 /*!
       
   786    \variable QContactAnniversary::FieldSubType
       
   787 
       
   788    The constant key for which the subtypes value is stored in details
       
   789    of the QContactAnniversary type.
       
   790  */
       
   791 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::FieldSubType, "SubType");
       
   792 
       
   793 /*!
       
   794    \variable QContactDisplayLabel::FieldLabel
       
   795 
       
   796    The constant key for which the display label value is stored in
       
   797    details of the QContactDisplayLabel type.
       
   798  */
       
   799 Q_DEFINE_LATIN1_CONSTANT(QContactDisplayLabel::FieldLabel, "Label");
       
   800 
       
   801 /*!
       
   802    \variable QContactGender::FieldGender
       
   803 
       
   804    The constant key for which the gender value is stored in details of
       
   805    the QContactGender type.
       
   806  */
       
   807 Q_DEFINE_LATIN1_CONSTANT(QContactGender::FieldGender, "Gender");
       
   808 
       
   809 /*!
       
   810    \variable QContactGender::GenderMale
       
   811    The value that identifies this contact as being male.
       
   812  */
       
   813 Q_DEFINE_LATIN1_CONSTANT(QContactGender::GenderMale, "Male");
       
   814 
       
   815 /*!
       
   816    \variable QContactGender::GenderFemale
       
   817    The value that identifies this contact as being female.
       
   818  */
       
   819 Q_DEFINE_LATIN1_CONSTANT(QContactGender::GenderFemale, "Female");
       
   820 
       
   821 /*!
       
   822    \variable QContactGender::GenderUnspecified
       
   823    The value that identifies this contact as being of unspecified gender.
       
   824  */
       
   825 Q_DEFINE_LATIN1_CONSTANT(QContactGender::GenderUnspecified, "Unspecified");
       
   826 
       
   827 /*!
       
   828    \variable QContactGeoLocation::FieldLabel
       
   829 
       
   830    The constant key for which the location label value is stored in
       
   831    details of the QContactGeoLocation type.
       
   832  */
       
   833 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldLabel, "Label");
       
   834 
       
   835 /*!
       
   836    \variable QContactGeoLocation::FieldLatitude
       
   837 
       
   838    The constant key for which the latitude value is stored in details
       
   839    of the QContactGeoLocation type.
       
   840  */
       
   841 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldLatitude, "Latitude");
       
   842 
       
   843 /*!
       
   844    \variable QContactGeoLocation::FieldLongitude
       
   845 
       
   846    The constant key for which the longitude value is stored in details
       
   847    of the QContactGeoLocation type.
       
   848  */
       
   849 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldLongitude, "Longitude");
       
   850 
       
   851 /*!
       
   852    \variable QContactGeoLocation::FieldAccuracy
       
   853 
       
   854    The constant key for which the location accuracy value is stored in
       
   855    details of the QContactGeoLocation type.
       
   856  */
       
   857 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldAccuracy, "Accuracy");
       
   858 
       
   859 /*!
       
   860    \variable QContactGeoLocation::FieldAltitude
       
   861 
       
   862    The constant key for which the altitude value is stored in details
       
   863    of the QContactGeoLocation type.
       
   864  */
       
   865 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldAltitude, "Altitude");
       
   866 
       
   867 
       
   868 /*!
       
   869    \variable QContactGeoLocation::FieldAltitudeAccuracy
       
   870 
       
   871    The constant key for which the altitude accuracy value is stored in
       
   872    details of the QContactGeoLocation type.
       
   873  */
       
   874 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldAltitudeAccuracy, "AltitudeAccuracy");
       
   875 
       
   876 /*!
       
   877    \variable QContactGeoLocation::FieldHeading
       
   878 
       
   879    The constant key for which the heading value is stored in details
       
   880    of the QContactGeoLocation type.
       
   881  */
       
   882 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldHeading, "Heading");
       
   883 
       
   884 /*!
       
   885    \variable QContactGeoLocation::FieldSpeed
       
   886 
       
   887    The constant key for which the speed value is stored in details of
       
   888    the QContactGeoLocation type.
       
   889  */
       
   890 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldSpeed, "Speed");
       
   891 
       
   892 /*!
       
   893    \variable QContactTag::FieldTag
       
   894 
       
   895    The constant key for which the tag value is stored in details
       
   896    of the QContactTag type.
       
   897  */
       
   898 Q_DEFINE_LATIN1_CONSTANT(QContactTag::FieldTag, "Tag");
       
   899 
       
   900 /*!
       
   901    \variable QContactGeoLocation::FieldTimestamp
       
   902 
       
   903    The constant key for which the timestamp value is stored in details
       
   904    of the QContactGeoLocation type.
       
   905  */
       
   906 Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldTimestamp, "Timestamp");
       
   907 
       
   908 /*!
       
   909    \variable QContactOrganization::FieldName
  1704    \variable QContactOrganization::FieldName
   910 
  1705 
   911    The constant key for which the name value is stored in details of
  1706    The field key constant for the value of the organization name.
   912    the QContactOrganization type.
  1707    \sa name(), setName()
   913  */
  1708  */
   914 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldName, "Name");
  1709 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldName, "Name");
   915 
  1710 
   916 /*!
  1711 /*!
   917    \variable QContactOrganization::FieldLogoUrl
  1712    \variable QContactOrganization::FieldLogoUrl
   918 
  1713 
   919    The constant key for which the logo url is stored in details
  1714    The field key constant for the URL of the organization logo image.
   920    of the QContactOrganization type.
  1715    \sa logoUrl(), setLogoUrl()
   921  */
  1716  */
   922 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldLogoUrl, "LogoUrl");
  1717 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldLogoUrl, "LogoUrl");
   923 
  1718 
   924 /*!
  1719 /*!
   925    \variable QContactOrganization::FieldDepartment
  1720    \variable QContactOrganization::FieldDepartment
   926 
  1721 
   927    The constant key for which the organization's department value is
  1722    The field key constant for the value of the department name.
   928    stored in details of the QContactOrganization type.
  1723    \sa department(), setDepartment()
   929  */
  1724  */
   930 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldDepartment, "Department");
  1725 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldDepartment, "Department");
   931 
  1726 
   932 /*!
  1727 /*!
   933    \variable QContactOrganization::FieldLocation
  1728    \variable QContactOrganization::FieldLocation
   934 
  1729 
   935    The constant key for which the organization's location (or the
  1730    The field key constant for the value of the location of the organization.
   936    location of the contact's part of the organization) value is stored
  1731    \sa location(), setLocation()
   937    in details of the QContactOrganization type.
       
   938  */
  1732  */
   939 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldLocation, "Location");
  1733 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldLocation, "Location");
   940 
  1734 
   941 /*!
  1735 /*!
   942    \variable QContactOrganization::FieldRole
  1736    \variable QContactOrganization::FieldRole
   943 
  1737 
   944    The constant key for which the contact's role within the
  1738    The field key constant for the value of the contact's role in the organization.
   945    organization is stored in details of the QContactOrganization type.
  1739    \sa role(), setRole()
   946  */
  1740  */
   947 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldRole, "Role");
  1741 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldRole, "Role");
   948 
  1742 
   949 /*!
  1743 /*!
   950    \variable QContactOrganization::FieldTitle
  1744    \variable QContactOrganization::FieldTitle
   951 
  1745 
   952    The constant key for which the contact's title within the
  1746    The field key constant for the value of the contact's title in the organization.
   953    organization is stored in details of the QContactOrganization type.
  1747    \sa title(), setTitle()
   954  */
  1748  */
   955 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldTitle, "Title");
  1749 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldTitle, "Title");
   956 
  1750 
   957 /*!
  1751 /*!
   958    \variable QContactOrganization::FieldAssistantName
  1752    \variable QContactOrganization::FieldAssistantName
   959 
  1753 
   960    The constant key for which the contact's assistant name within the
  1754    The field key constant for the value of the name of the contact's assistant.
   961    organization is stored in details of the QContactOrganization type.
  1755    \sa assistantName(), setAssistantName()
   962  */
  1756  */
   963 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldAssistantName, "AssistantName");
  1757 Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldAssistantName, "AssistantName");
   964 
       
   965 /*!
       
   966    \variable QContactRingtone::FieldAudioRingtoneUrl
       
   967 
       
   968    The constant key for which the uri of the audio ringtone value is
       
   969    stored in details of the QContactRingtone type.
       
   970  */
       
   971 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::FieldAudioRingtoneUrl, "AudioRingtoneUrl");
       
   972 
       
   973 /*!
       
   974    \variable QContactRingtone::FieldVideoRingtoneUrl
       
   975 
       
   976    The constant key for which the uri of the video ringtone value is
       
   977    stored in details of the QContactRingtone type.
       
   978  */
       
   979 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::FieldVideoRingtoneUrl, "VideoRingtoneUrl");
       
   980 
       
   981 /*!
       
   982    \variable QContactRingtone::FieldVibrationRingtoneUrl
       
   983 
       
   984    The constant key for which the uri of the vibration ringtone value is
       
   985    stored in details of the QContactRingtone type.
       
   986  */
       
   987 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::FieldVibrationRingtoneUrl, "VibrationRingtoneUrl");
       
   988 
       
   989 /*!
       
   990    \variable QContactThumbnail::FieldThumbnail
       
   991 
       
   992    The constant key for which the thumbnail image is stored in details
       
   993    of the QContactThumbnail type.
       
   994  */
       
   995 Q_DEFINE_LATIN1_CONSTANT(QContactThumbnail::FieldThumbnail, "Thumbnail");
       
   996 
       
   997 /*!
       
   998    \variable QContactTimestamp::FieldModificationTimestamp
       
   999 
       
  1000    The constant key for the value which is stored in details of the
       
  1001    QContactTimestamp type which describes the last modification date
       
  1002    and time of a contact.
       
  1003  */
       
  1004 Q_DEFINE_LATIN1_CONSTANT(QContactTimestamp::FieldModificationTimestamp, "ModificationTimestamp");
       
  1005 
       
  1006 /*!
       
  1007    \variable QContactTimestamp::FieldCreationTimestamp
       
  1008 
       
  1009    The constant key for the value which is stored in details of the
       
  1010    QContactTimestamp type which describes the creation date and time
       
  1011    of a contact.
       
  1012  */
       
  1013 Q_DEFINE_LATIN1_CONSTANT(QContactTimestamp::FieldCreationTimestamp, "CreationTimestamp");
       
  1014 
       
  1015 /*!
       
  1016    \variable QContactType::FieldType
       
  1017 
       
  1018    The constant key for the type value which is stored in details of
       
  1019    the QContactType definition.
       
  1020  */
       
  1021 Q_DEFINE_LATIN1_CONSTANT(QContactType::FieldType, "Type");
       
  1022 
       
  1023 
       
  1024 /*!
       
  1025    \variable QContactType::TypeContact
       
  1026 
       
  1027    The constant attribute value which describes the contact as being
       
  1028    an ordinary contact.
       
  1029  */
       
  1030 Q_DEFINE_LATIN1_CONSTANT(QContactType::TypeContact, "Contact");
       
  1031 
       
  1032 /*!
       
  1033    \variable QContactType::TypeGroup
       
  1034 
       
  1035    The constant attribute value which describes the contact as being a
       
  1036    group.
       
  1037  */
       
  1038 Q_DEFINE_LATIN1_CONSTANT(QContactType::TypeGroup, "Group");
       
  1039 
       
  1040 /*!
       
  1041    \variable QContactPhoneNumber::SubTypeLandline
       
  1042 
       
  1043    The constant attribute value which describes the phone number as
       
  1044    identifying a landline phone.
       
  1045  */
       
  1046 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeLandline, "Landline");
       
  1047 
       
  1048 /*!
       
  1049    \variable QContactPhoneNumber::SubTypeMobile
       
  1050 
       
  1051    The constant attribute value which describes the phone number as
       
  1052    identifying a mobile phone.
       
  1053  */
       
  1054 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeMobile, "Mobile");
       
  1055 
       
  1056 /*!
       
  1057    \variable QContactPhoneNumber::SubTypeFax
       
  1058 
       
  1059    The constant attribute value which describes the phone number as
       
  1060    identifying a fax machine.
       
  1061  */
       
  1062 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeFax, "Fax");
       
  1063 
       
  1064 /*!
       
  1065    \variable QContactPhoneNumber::SubTypePager
       
  1066 
       
  1067    The constant attribute value which describes the phone number as
       
  1068    identifying a pager device.
       
  1069  */
       
  1070 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypePager, "Pager");
       
  1071 
       
  1072 /*!
       
  1073    \variable QContactPhoneNumber::SubTypeCar
       
  1074 
       
  1075    The constant attribute value which describes the phone number as
       
  1076    identifying a car phone.
       
  1077  */
       
  1078 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeCar, "Car");
       
  1079 
       
  1080 /*!
       
  1081    \variable QContactPhoneNumber::SubTypeBulletinBoardSystem
       
  1082 
       
  1083    The constant attribute value which describes the phone number as
       
  1084    identifying a bulletin board system.
       
  1085  */
       
  1086 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeBulletinBoardSystem, "BulletinBoardSystem");
       
  1087 
       
  1088 /*!
       
  1089    \variable QContactPhoneNumber::SubTypeVoice
       
  1090 
       
  1091    The constant attribute value which describes the phone number as
       
  1092    supporting voice transmission.
       
  1093  */
       
  1094 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeVoice, "Voice");
       
  1095 
       
  1096 /*!
       
  1097    \variable QContactPhoneNumber::SubTypeModem
       
  1098 
       
  1099    The constant attribute value which describes the phone number as
       
  1100    supporting digital data transfer.
       
  1101  */
       
  1102 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeModem, "Modem");
       
  1103 
       
  1104 /*!
       
  1105    \variable QContactPhoneNumber::SubTypeVideo
       
  1106 
       
  1107    The constant attribute value which describes the phone number as
       
  1108    supporting video transmission.
       
  1109  */
       
  1110 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeVideo, "Video");
       
  1111 
       
  1112 /*!
       
  1113    \variable QContactPhoneNumber::SubTypeMessagingCapable
       
  1114 
       
  1115    The constant attribute value which describes the phone number as
       
  1116    supporting messaging services.
       
  1117  */
       
  1118 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeMessagingCapable, "MessagingCapable");
       
  1119 
       
  1120 /*!
       
  1121    \variable QContactPhoneNumber::SubTypeAssistant
       
  1122 
       
  1123    The constant attribute value which describes the phone number as an
       
  1124    assistant phone number.
       
  1125  */
       
  1126 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeAssistant, "Assistant");
       
  1127 
       
  1128 /*!
       
  1129    \variable QContactPhoneNumber::SubTypeDtmfMenu
       
  1130 
       
  1131    The constant attribute value which describes the phone number as
       
  1132    supporting DTMF-controlled electronic menu navigation.
       
  1133  */
       
  1134 Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeDtmfMenu, "DtmfMenu");
       
  1135 
       
  1136 /*!
       
  1137    \variable QContactAddress::SubTypeParcel
       
  1138 
       
  1139    The constant attribute value which describes the address as being
       
  1140    an address for parcel delivery.
       
  1141  */
       
  1142 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypeParcel, "Parcel");
       
  1143 
       
  1144 /*!
       
  1145    \variable QContactAddress::SubTypePostal
       
  1146 
       
  1147    The constant attribute value which describes the address as being
       
  1148    an address for postal delivery.
       
  1149  */
       
  1150 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypePostal, "Postal");
       
  1151 
       
  1152 /*!
       
  1153    \variable QContactAddress::SubTypeDomestic
       
  1154 
       
  1155    The constant attribute value which describes the address as being a
       
  1156    domestic address.
       
  1157  */
       
  1158 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypeDomestic, "Domestic");
       
  1159 
       
  1160 /*!
       
  1161    \variable QContactAddress::SubTypeInternational
       
  1162 
       
  1163    The constant attribute value which describes the address as being
       
  1164    an international address.
       
  1165  */
       
  1166 Q_DEFINE_LATIN1_CONSTANT(QContactAddress::SubTypeInternational, "International");
       
  1167 
       
  1168 /*!
       
  1169    \variable QContactUrl::SubTypeHomePage
       
  1170 
       
  1171    The constant attribute value which describes the url as being the
       
  1172    homepage of the contact.
       
  1173  */
       
  1174 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::SubTypeHomePage, "HomePage");
       
  1175 
       
  1176 /*!
       
  1177    \variable QContactUrl::SubTypeFavourite
       
  1178 
       
  1179    The constant attribute value which describes the url as being a
       
  1180    favourite page of the contact.
       
  1181  */
       
  1182 Q_DEFINE_LATIN1_CONSTANT(QContactUrl::SubTypeFavourite, "Favourite");
       
  1183 
       
  1184 /*!
       
  1185    \variable QContactAnniversary::SubTypeWedding
       
  1186 
       
  1187    The constant attribute value which describes the anniversary as
       
  1188    being a wedding anniversary.
       
  1189  */
       
  1190 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeWedding, "Wedding");
       
  1191 
       
  1192 /*!
       
  1193    \variable QContactAnniversary::SubTypeEngagement
       
  1194 
       
  1195    The constant attribute value which describes the anniversary as
       
  1196    being an engagement anniversary.
       
  1197  */
       
  1198 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeEngagement, "Engagement");
       
  1199 
       
  1200 /*!
       
  1201    \variable QContactAnniversary::SubTypeHouse
       
  1202 
       
  1203    The constant attribute value which describes the anniversary as
       
  1204    being an anniversary of ownership of a particular residence.
       
  1205  */
       
  1206 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeHouse, "House");
       
  1207 
       
  1208 /*!
       
  1209    \variable QContactAnniversary::SubTypeEmployment
       
  1210 
       
  1211    The constant attribute value which describes the anniversary as
       
  1212    being an anniversary of employment at a particular company.
       
  1213  */
       
  1214 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeEmployment, "Employment");
       
  1215 
       
  1216 /*!
       
  1217    \variable QContactAnniversary::SubTypeMemorial
       
  1218 
       
  1219    The constant attribute value which describes the anniversary as
       
  1220    being an anniversary of an event of sentimental significance.
       
  1221  */
       
  1222 Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeMemorial, "Memorial");
       
  1223 
       
  1224 
       
  1225 /*!
       
  1226    \fn QContactSyncTarget::syncTarget() const
       
  1227 
       
  1228    Returns the identifier of the backend store to which the contact
       
  1229    containing this detail should be synchronized.
       
  1230  */
       
  1231 
       
  1232 /*!
       
  1233    \fn QContactSyncTarget::setSyncTarget(const QString& syncTarget)
       
  1234 
       
  1235    Sets the identifier of the backend store to which the contact
       
  1236    containing this detail should be synchronized to \a syncTarget.
       
  1237  */
       
  1238 
       
  1239 /*!
       
  1240    \fn QContactEmailAddress::emailAddress() const
       
  1241    Returns the email address of the contact which is stored in this detail.
       
  1242  */
       
  1243 
       
  1244 /*!
       
  1245    \fn QContactEmailAddress::setEmailAddress(const QString& emailAddress)
       
  1246    Sets the email address of the contact which is stored in this detail to \a emailAddress.
       
  1247  */
       
  1248 
       
  1249 /*!
       
  1250    \fn QContactFamily::spouse() const
       
  1251    Returns the name of the spouse of the contact which is stored in this detail.
       
  1252  */
       
  1253 
       
  1254 /*!
       
  1255    \fn QContactFamily::setSpouse(const QString& spouseName)
       
  1256    Sets the name of the spouse of the contact which is stored in this detail to \a spouseName.
       
  1257  */
       
  1258 
       
  1259 /*!
       
  1260    \fn QContactFamily::children() const
       
  1261    Returns the names of the children of the contact which is stored in this detail.
       
  1262  */
       
  1263 
       
  1264 /*!
       
  1265    \fn QContactFamily::setChildren(const QStringList& childrenNames)
       
  1266    Sets the names of the children of the contact which is stored in this detail to \a childrenNames.
       
  1267  */
       
  1268 
       
  1269 /*!
       
  1270    \fn QContactAnniversary::originalDate() const
       
  1271    Returns the original date of occurrence of the event stored in this detail.
       
  1272  */
       
  1273 
       
  1274 /*!
       
  1275    \fn QContactAnniversary::setOriginalDate(const QDate& date)
       
  1276    Sets the original date of occurrence of the event stored in this detail to \a date.
       
  1277  */
       
  1278 
       
  1279 /*!
       
  1280    \fn QContactAnniversary::calendarId() const
       
  1281  * Returns the identifier of the calendar entry associated with this anniversary.
       
  1282  */
       
  1283 
       
  1284 /*!
       
  1285    \fn QContactAnniversary::setCalendarId(const QString& calendarId)
       
  1286    Sets the identifier of the calendar entry associated with this anniversary to \a calendarId.
       
  1287  */
       
  1288 
       
  1289 /*!
       
  1290    \fn QContactAnniversary::event() const
       
  1291    Returns the name of the event for which this detail contains information.
       
  1292  */
       
  1293 
       
  1294 /*!
       
  1295    \fn QContactAnniversary::setEvent(const QString& event)
       
  1296    Sets the name of the event for which this detail contains information to \a event.
       
  1297  */
       
  1298 
       
  1299 /*!
       
  1300    \fn QContactAnniversary::setSubType(const QString& subType)
       
  1301    Sets the subtype which this detail implements to be the given \a subType.
       
  1302  */
       
  1303 
       
  1304 /*!
       
  1305    \fn QContactAnniversary::subType() const
       
  1306    Returns the subtype that this detail implements, if defined.
       
  1307  */
       
  1308 
       
  1309 /*!
       
  1310   \fn QContactAvatar::imageUrl() const
       
  1311   Returns the url of an avatar image associated with the contact
       
  1312  */
       
  1313 
       
  1314 /*!
       
  1315   \fn QContactAvatar::setImageUrl(const QUrl& imageUrl)
       
  1316   Sets the url of an avatar image associated with the contact to \a imageUrl
       
  1317  */
       
  1318 
       
  1319 /*!
       
  1320   \fn QContactAvatar::videoUrl() const
       
  1321   Returns the url of an avatar video associated with the contact
       
  1322  */
       
  1323 
       
  1324 /*!
       
  1325   \fn QContactAvatar::setVideoUrl(const QUrl& videoUrl)
       
  1326   Sets the url of an avatar video associated with the contact to \a videoUrl
       
  1327  */
       
  1328 
       
  1329 /*!
       
  1330    \fn QContactAddress::postOfficeBox() const
       
  1331    Returns the post office box segment of the address stored in this detail.
       
  1332  */
       
  1333 
       
  1334 /*!
       
  1335    \fn QContactAddress::setPostOfficeBox(const QString& postOfficeBox)
       
  1336    Sets the post office box segment of the address stored in this detail to \a postOfficeBox.
       
  1337  */
       
  1338 
       
  1339 /*!
       
  1340    \fn QContactAddress::street() const
       
  1341    Returns the street segment of the address stored in this detail.
       
  1342  */
       
  1343 
       
  1344 /*!
       
  1345    \fn QContactAddress::setStreet(const QString& street)
       
  1346    Sets the street segment of the address stored in this detail to \a street.
       
  1347  */
       
  1348 
       
  1349 /*!
       
  1350    \fn QContactAddress::locality() const
       
  1351    Returns the locality segment of the address stored in this detail.
       
  1352  */
       
  1353 
       
  1354 /*!
       
  1355    \fn QContactAddress::setLocality(const QString& locality)
       
  1356    Sets the locality segment of the address stored in this detail to \a locality.
       
  1357  */
       
  1358 
       
  1359 /*!
       
  1360    \fn QContactAddress::region() const
       
  1361    Returns the region segment of the address stored in this detail.
       
  1362  */
       
  1363 
       
  1364 /*!
       
  1365    \fn QContactAddress::setRegion(const QString& region)
       
  1366    Sets the region segment of the address stored in this detail to \a region.
       
  1367  */
       
  1368 
       
  1369 /*!
       
  1370    \fn QContactAddress::postcode() const
       
  1371    Returns the postcode segment of the address stored in this detail.
       
  1372  */
       
  1373 
       
  1374 /*!
       
  1375    \fn QContactAddress::setPostcode(const QString& postcode)
       
  1376    Sets the postcode segment of the address stored in this detail to \a postcode.
       
  1377  */
       
  1378 
       
  1379 /*!
       
  1380    \fn QContactAddress::country() const
       
  1381    Returns the country segment of the address stored in this detail.
       
  1382  */
       
  1383 
       
  1384 /*!
       
  1385    \fn QContactAddress::setCountry(const QString& country)
       
  1386    Sets the country segment of the address stored in this detail to \a country.
       
  1387  */
       
  1388 
       
  1389 /*!
       
  1390    \fn QContactAddress::setSubTypes(const QStringList& subTypes)
       
  1391    Sets the subtypes which this detail implements to be those contained in the list of given \a subTypes.
       
  1392  */
       
  1393 
       
  1394 /*!
       
  1395    \fn QContactAddress::setSubTypes(const QString& subType)
       
  1396    Sets the subtypes which this detail implements to be just the given \a subType.
       
  1397  */
       
  1398 
       
  1399 /*!
       
  1400    \fn QContactAddress::subTypes() const
       
  1401    Returns the list of subtypes that this detail implements.
       
  1402  */
       
  1403 
       
  1404 /*!
       
  1405    \fn QContactUrl::url() const
       
  1406    Returns the url stored in this detail.
       
  1407  */
       
  1408 
       
  1409 /*!
       
  1410    \fn QContactUrl::setUrl(const QString& url)
       
  1411    Sets the url stored in this detail to \a url.
       
  1412  */
       
  1413 
       
  1414 /*!
       
  1415    \fn QContactUrl::setSubType(const QString& subType)
       
  1416    Sets the subtype which this detail implements to be the given \a subType.
       
  1417  */
       
  1418 
       
  1419 /*!
       
  1420    \fn QContactUrl::subType() const
       
  1421    Returns the subtype that this detail implements, if defined.
       
  1422  */
       
  1423 
       
  1424 /*!
       
  1425    \fn QContactPhoneNumber::number() const
       
  1426    Returns the phone number stored in this detail.
       
  1427  */
       
  1428 
       
  1429 /*!
       
  1430    \fn QContactPhoneNumber::setNumber(const QString& number)
       
  1431    Sets the phone number stored in this detail to \a number.
       
  1432  */
       
  1433 
       
  1434 /*!
       
  1435    \fn QContactPhoneNumber::setSubTypes(const QStringList& subTypes)
       
  1436    Sets the subtypes which this detail implements to be those contained in the list of given \a subTypes
       
  1437  */
       
  1438 
       
  1439 /*!
       
  1440    \fn QContactPhoneNumber::setSubTypes(const QString& subType)
       
  1441    Sets the subtypes which this detail implements to be just the given \a subType.
       
  1442  */
       
  1443 
       
  1444 /*!
       
  1445    \fn QContactPhoneNumber::subTypes() const
       
  1446    Returns the list of subtypes that this detail implements.
       
  1447  */
       
  1448 
       
  1449 /*!
       
  1450    \fn QContactBirthday::date() const
       
  1451    Returns the date of the birthday which is stored in this detail.
       
  1452  */
       
  1453 
       
  1454 /*!
       
  1455    \fn QContactBirthday::setDate(const QDate& date)
       
  1456    Sets the date of the birthday which is stored in this detail to \a date.
       
  1457  */
       
  1458 
       
  1459 /*!
       
  1460    \fn QContactGender::gender() const
       
  1461 
       
  1462    Returns the gender of the contact, as stored in this detail.  The
       
  1463    possible values for the value stored are "Male", "Female" and
       
  1464    "Unspecified".
       
  1465  */
       
  1466 
       
  1467 /*!
       
  1468    \fn QContactGender::setGender(const QString& gender)
       
  1469 
       
  1470    Sets the gender of the contact (as stored in this detail) to \a
       
  1471    gender, if \a gender is either "Male" or "Female", otherwise sets
       
  1472    it to "Unspecified".
       
  1473  */
       
  1474 
       
  1475 /*!
       
  1476    \fn QContactGeoLocation::setLabel(const QString& label)
       
  1477    Sets the label of the location stored in the detail to \a label.
       
  1478  */
       
  1479 
       
  1480 /*!
       
  1481    \fn QContactGeoLocation::label() const
       
  1482    Returns the label of the location stored in the detail.
       
  1483  */
       
  1484 
       
  1485 /*!
       
  1486    \fn QContactGeoLocation::setLatitude(double latitude)
       
  1487 
       
  1488    Sets the latitude portion of the coordinate (in decimal degrees) of
       
  1489    the location stored in the detail to \a latitude.
       
  1490  */
       
  1491 
       
  1492 /*!
       
  1493    \fn QContactGeoLocation::latitude() const
       
  1494 
       
  1495    Returns the latitude portion of the coordinate (specified in
       
  1496    decimal degrees) of the location stored in the detail.
       
  1497  */
       
  1498 
       
  1499 /*!
       
  1500    \fn QContactGeoLocation::setLongitude(double longitude)
       
  1501 
       
  1502    Sets the longitude portion of the coordinate (in decimal degrees)
       
  1503    of the location stored in the detail to \a longitude.
       
  1504  */
       
  1505 
       
  1506 /*!
       
  1507    \fn QContactGeoLocation::longitude() const
       
  1508 
       
  1509    Returns the longitude portion of the coordinate (specified in
       
  1510    decimal degrees) of the location stored in the detail.
       
  1511  */
       
  1512 
       
  1513 /*!
       
  1514    \fn QContactGeoLocation::setAccuracy(double accuracy)
       
  1515 
       
  1516    Specifies that the latitude and longitude portions of the location
       
  1517    stored in the detail are accurate to within \a accuracy metres.
       
  1518  */
       
  1519 
       
  1520 /*!
       
  1521    \fn QContactGeoLocation::accuracy() const
       
  1522 
       
  1523    Returns the accuracy (in metres) of the latitude and longitude of
       
  1524    the location stored in the detail.
       
  1525  */
       
  1526 
       
  1527 /*!
       
  1528    \fn QContactGeoLocation::setAltitude(double altitude)
       
  1529 
       
  1530    Sets the altitude portion of the coordinate (in metres above the
       
  1531    ellipsoid) of the location stored in the detail to \a altitude.
       
  1532  */
       
  1533 
       
  1534 /*!
       
  1535    \fn QContactGeoLocation::altitude() const
       
  1536    Returns the altitude (in metres) of the location stored in the detail.
       
  1537  */
       
  1538 
       
  1539 /*!
       
  1540    \fn QContactGeoLocation::setAltitudeAccuracy(double altitudeAccuracy)
       
  1541 
       
  1542    Sets the altitude-accuracy portion of the coordinate (in metres) of
       
  1543    the location stored in the detail to \a altitudeAccuracy.
       
  1544  */
       
  1545 
       
  1546 /*!
       
  1547    \fn QContactGeoLocation::altitudeAccuracy() const
       
  1548 
       
  1549    Returns the accuracy of the altitude portion of the location stored
       
  1550    in the detail.
       
  1551  */
       
  1552 
       
  1553 /*!
       
  1554    \fn QContactGeoLocation::setHeading(double heading)
       
  1555 
       
  1556    Sets the heading portion of the coordinate (in decimal degrees
       
  1557    clockwise relative to true north) of the location-aware device at
       
  1558    the time of measurement to \a heading.
       
  1559  */
       
  1560 
       
  1561 /*!
       
  1562    \fn QContactGeoLocation::heading() const
       
  1563 
       
  1564    Returns the heading (at the time of measurement) of the
       
  1565    location-aware device that recorded (or was provided) the
       
  1566    measurement.
       
  1567  */
       
  1568 
       
  1569 /*!
       
  1570    \fn QContactGeoLocation::setSpeed(double speed)
       
  1571 
       
  1572    Sets the speed portion of the coordinate (in metres per second) of
       
  1573    the location-aware device at the time of measurement to \a speed.
       
  1574  */
       
  1575 
       
  1576 /*!
       
  1577    \fn QContactGeoLocation::speed() const
       
  1578 
       
  1579    Returns the speed (at the time of measurement) of the
       
  1580    location-aware device that recorded (or was provided) the
       
  1581    measurement.
       
  1582  */
       
  1583 
       
  1584 /*!
       
  1585    \fn QContactGeoLocation::setTimestamp(const QDateTime& timestamp)
       
  1586 
       
  1587    Sets the creation (or first-valid) timestamp of the location
       
  1588    information to \a timestamp.
       
  1589  */
       
  1590 
       
  1591 /*!
       
  1592    \fn QContactGeoLocation::timestamp() const
       
  1593 
       
  1594    Returns the timestamp associated with the location stored in the
       
  1595    detail.
       
  1596  */
       
  1597 
       
  1598 /*!
       
  1599    \fn QContactGuid::guid() const
       
  1600 
       
  1601    Returns the globally unique identifier which is stored in this
       
  1602    detail.
       
  1603  */
       
  1604 
       
  1605 /*!
       
  1606    \fn QContactGuid::setGuid(const QString& guid)
       
  1607    Sets the globally unique identifier which is stored in this detail to \a guid.
       
  1608  */
       
  1609 
       
  1610 /*!
       
  1611    \fn QContactName::prefix() const
       
  1612    Returns the prefix segment of the name stored in this detail.
       
  1613  */
       
  1614 
       
  1615 /*!
       
  1616    \fn QContactName::setPrefix(const QString& prefix)
       
  1617    Sets the prefix segment of the name stored in this detail to \a prefix.
       
  1618  */
       
  1619 
       
  1620 /*!
       
  1621    \fn QContactName::firstName() const
       
  1622    Returns the first (given) name segment of the name stored in this detail.
       
  1623  */
       
  1624 
       
  1625 /*!
       
  1626    \fn QContactName::setFirstName(const QString& firstName)
       
  1627    Sets the first name segment of the name stored in this detail to \a firstName.
       
  1628  */
       
  1629 
       
  1630 /*!
       
  1631    \fn QContactName::middleName() const
       
  1632    
       
  1633    Returns the middle (additional, or other) name segment of the name
       
  1634    stored in this detail.
       
  1635  */
       
  1636 
       
  1637 /*!
       
  1638    \fn QContactName::setMiddleName(const QString& middleName)
       
  1639    Sets the middle name segment of the name stored in this detail to \a middleName.
       
  1640  */
       
  1641 
       
  1642 /*!
       
  1643    \fn QContactName::lastName() const
       
  1644 
       
  1645    Returns the last (family, or surname) name segment of the name
       
  1646    stored in this detail.
       
  1647  */
       
  1648 
       
  1649 /*!
       
  1650    \fn QContactName::setLastName(const QString& lastName)
       
  1651    Sets the last name segment of the name stored in this detail to \a lastName.
       
  1652  */
       
  1653 
       
  1654 /*!
       
  1655    \fn QContactName::suffix() const
       
  1656    Returns the suffix segment of the name stored in this detail.
       
  1657  */
       
  1658 
       
  1659 /*!
       
  1660    \fn QContactName::setSuffix(const QString& suffix)
       
  1661    Sets the suffix segment of the name stored in this detail to \a suffix.
       
  1662  */
       
  1663 
       
  1664 /*!
       
  1665    \fn QContactName::customLabel() const
       
  1666    Returns the custom label of the name stored in this detail.
       
  1667  */
       
  1668 
       
  1669 /*!
       
  1670    \fn QContactName::setCustomLabel(const QString& customLabel)
       
  1671    Sets the custom label of the name stored in this detail to \a customLabel.
       
  1672  */
       
  1673 
       
  1674 /*!
       
  1675    \fn QContactNickname::setNickname(const QString& nickname)
       
  1676    Sets the nickname of the contact which is stored in this detail to \a nickname.
       
  1677  */
       
  1678 
       
  1679 /*!
       
  1680    \fn QContactNickname::nickname() const
       
  1681    Returns the nickname of the contact which is stored in this detail.
       
  1682  */
       
  1683 
       
  1684 /*!
       
  1685    \fn QContactNote::setNote(const QString& note)
       
  1686    Sets a note associated with a contact to \a note.
       
  1687  */
       
  1688 
       
  1689 /*!
       
  1690    \fn QContactNote::note() const
       
  1691    Returns a string for a note associated with a contact.
       
  1692  */
       
  1693 
       
  1694 /*!
       
  1695    \fn QContactTag::setTag(const QString& tag)
       
  1696    Sets the tag associated with a contact which is stored in this detail to \a tag.
       
  1697  */
       
  1698 
       
  1699 /*!
       
  1700    \fn QContactTag::tag() const
       
  1701    Returns the tag associated with a contact which is stored in this detail.
       
  1702  */
       
  1703 
       
  1704 /*!
       
  1705   \fn QContactThumbnail::thumbnail() const
       
  1706   Returns the thumbnail image of the contact
       
  1707  */
       
  1708 
       
  1709 /*!
       
  1710   \fn QContactThumbnail::setThumbnail(const QImage& thumbnail)
       
  1711   Sets the thumbnail image of the contact to be \a thumbnail
       
  1712  */
       
  1713 
       
  1714 /*!
       
  1715    \fn QContactTimestamp::created() const
       
  1716    Returns the creation timestamp saved in this detail.
       
  1717  */
       
  1718 
       
  1719 /*!
       
  1720    \fn QContactTimestamp::lastModified() const
       
  1721    Returns the last-modified timestamp saved in this detail.
       
  1722  */
       
  1723 
       
  1724 /*!
       
  1725    \fn QContactTimestamp::setCreated(const QDateTime& dateTime)
       
  1726    Sets the creation timestamp saved in this detail to \a dateTime.
       
  1727  */
       
  1728 
       
  1729 /*!
       
  1730    \fn QContactTimestamp::setLastModified(const QDateTime& dateTime)
       
  1731    Sets the last-modified timestamp saved in this detail to \a dateTime.
       
  1732  */
       
  1733 
       
  1734 /*!
       
  1735    \fn QContactType::type() const
       
  1736    Returns the contact type value stored in this detail.
       
  1737  */
       
  1738 
       
  1739 /*!
       
  1740    \fn QContactType::setType(const QString& type)
       
  1741    Sets the type of the contact to be the give \a type.
       
  1742  */
       
  1743 
       
  1744 
       
  1745 /*!
       
  1746    \fn QContactDisplayLabel::label() const
       
  1747    Returns the display label of the contact.
       
  1748  */
       
  1749 
       
  1750 /*!
       
  1751    \fn QContactOnlineAccount::setAccountUri(const QString& accountUri)
       
  1752    
       
  1753    Sets the universal resource identifier of the contact's online
       
  1754    account to \a accountUri.
       
  1755  */
       
  1756 
       
  1757 /*!
       
  1758    \fn QContactOnlineAccount::accountUri() const
       
  1759 
       
  1760    Returns the universal resource identifier of the online account of
       
  1761    the contact.
       
  1762  */
       
  1763 
       
  1764 /*!
       
  1765    \fn QContactOnlineAccount::setServiceProvider(const QString& serviceProvider)
       
  1766 
       
  1767    Sets the service provider of the contact's online account to \a
       
  1768    serviceProvider.
       
  1769  */
       
  1770 
       
  1771 /*!
       
  1772    \fn QContactOnlineAccount::serviceProvider() const
       
  1773    Returns the service provider of the online account of the contact.
       
  1774  */
       
  1775 
       
  1776 /*!
       
  1777    \fn QContactOnlineAccount::setSubTypes(const QStringList& subTypes)
       
  1778    
       
  1779    Sets the subtypes which this detail implements to be those
       
  1780    contained in the list of given \a subTypes.
       
  1781  */
       
  1782 
       
  1783 /*!
       
  1784    \fn QContactOnlineAccount::setSubTypes(const QString& subType)
       
  1785    Sets the subtypes which this detail implements to be just the given \a subType.
       
  1786  */
       
  1787 
       
  1788 /*!
       
  1789    \fn QContactOnlineAccount::subTypes() const
       
  1790    Returns the list of subtypes that this detail implements.
       
  1791  */
       
  1792 
       
  1793 /*!
       
  1794    \fn QContactOnlineAccount::setCapabilities(const QStringList& capabilities)
       
  1795 
       
  1796    Sets the capabilities of the online account about which this detail stores
       
  1797    presence information to \a capabilities.  The \a capabilities list is a
       
  1798    list of service-provider specified strings which together identify the
       
  1799    types of communication which may be possible.
       
  1800  */
       
  1801 
       
  1802 /*!
       
  1803    \fn QContactOnlineAccount::capabilities() const
       
  1804 
       
  1805    Returns the capabilities of the online account about which this detail stores
       
  1806    presence information.
       
  1807  */
       
  1808 
  1758 
  1809 /*!
  1759 /*!
  1810    \fn QContactOrganization::setName(const QString& name)
  1760    \fn QContactOrganization::setName(const QString& name)
  1811    Sets the name of the organization stored in this detail to \a name.
  1761    Sets the name of the organization stored in this detail to \a name.
  1812  */
  1762  */
  1886 
  1836 
  1887    Returns the name of the default assistant of contacts belonging to
  1837    Returns the name of the default assistant of contacts belonging to
  1888    this organization.
  1838    this organization.
  1889  */
  1839  */
  1890 
  1840 
       
  1841 /* ==================== QContactRingtone ======================= */
       
  1842 
       
  1843 /*!
       
  1844    \class QContactRingtone
       
  1845    \brief The QContactRingtone class provides a ringtone associated
       
  1846    with a contact
       
  1847    \ingroup contacts-details
       
  1848  */
       
  1849 
       
  1850 /*!
       
  1851 \variable QContactRingtone::DefinitionName
       
  1852 The string constant for the definition name of QContactRingtone details.
       
  1853 */
       
  1854 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::DefinitionName, "Ringtone");
       
  1855 
       
  1856 /*!
       
  1857    \variable QContactRingtone::FieldAudioRingtoneUrl
       
  1858 
       
  1859    The field key constant for the value of the URL for an audio ringtone.
       
  1860    \sa setAudioRingtoneUrl(), audioRingtoneUrl()
       
  1861  */
       
  1862 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::FieldAudioRingtoneUrl, "AudioRingtoneUrl");
       
  1863 
       
  1864 /*!
       
  1865    \variable QContactRingtone::FieldVideoRingtoneUrl
       
  1866 
       
  1867    The field key constant for the value of the URL for a video ringtone.
       
  1868    \sa setVideoRingtoneUrl(), videoRingtoneUrl()
       
  1869  */
       
  1870 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::FieldVideoRingtoneUrl, "VideoRingtoneUrl");
       
  1871 
       
  1872 /*!
       
  1873    \variable QContactRingtone::FieldVibrationRingtoneUrl
       
  1874 
       
  1875    The field key constant for the value of the URL for a vibration ringtone.
       
  1876    \sa setVibrationRingtoneUrl(), vibrationRingtoneUrl()
       
  1877  */
       
  1878 Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::FieldVibrationRingtoneUrl, "VibrationRingtoneUrl");
       
  1879 
  1891 /*!
  1880 /*!
  1892   \fn QContactRingtone::audioRingtoneUrl() const
  1881   \fn QContactRingtone::audioRingtoneUrl() const
  1893 
  1882 
  1894   Returns the uri of the audio ringtone stored in the ringtone detail.
  1883   Returns the uri of the audio ringtone stored in the ringtone detail.
  1895  */
  1884  */
  1925 
  1914 
  1926   Sets the uri of the vibration ringtone stored in the ringtone detail
  1915   Sets the uri of the vibration ringtone stored in the ringtone detail
  1927   to \a vibrationRingtoneUrl.
  1916   to \a vibrationRingtoneUrl.
  1928  */
  1917  */
  1929 
  1918 
       
  1919 /* ==================== QContactPresence ======================= */
       
  1920 
       
  1921 // XXX TODO add more stuff here
       
  1922 /*!
       
  1923    \class QContactPresence
       
  1924    \brief The QContactPresence class provides presence information
       
  1925    for an online account of a contact.
       
  1926 
       
  1927    Presence information for a particular QContactOnlineAccount detail is provided
       
  1928    in a QContactPresence detail which is linked (via linkedDetailUris()) to the
       
  1929    account detail.  This information is generally provided by the backend, and is
       
  1930    not modifiable by clients.
       
  1931 
       
  1932    Presence information can include update timestamp, screen name,
       
  1933    and the status icon, status value, and status text provided by
       
  1934    the service provider, as well as user defined status message.
       
  1935 
       
  1936    \sa QContactOnlineAccount
       
  1937 
       
  1938    \ingroup contacts-details
       
  1939  */
       
  1940 
       
  1941 /*!
       
  1942    \variable QContactPresence::DefinitionName
       
  1943    The string constant for the definition name of QContactPresence details.
       
  1944  */
       
  1945 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::DefinitionName, "Presence");
       
  1946 
       
  1947 /*!
       
  1948    \variable QContactPresence::FieldTimestamp
       
  1949    The field key constant for the timestamp value.
       
  1950    \sa setTimestamp(), timestamp()
       
  1951  */
       
  1952 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldTimestamp, "Timestamp");
       
  1953 
       
  1954 /*!
       
  1955    \variable QContactPresence::FieldNickname
       
  1956    The field key constant for the nickname value.
       
  1957    \sa setNickname(), nickname()
       
  1958  */
       
  1959 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldNickname, "Nickname");
       
  1960 
       
  1961 /*!
       
  1962    \variable QContactPresence::FieldPresenceState
       
  1963    The field key constant for the presence state enumeration value.
       
  1964    \sa setPresenceState(), presenceState()
       
  1965  */
       
  1966 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldPresenceState, "PresenceState");
       
  1967 
       
  1968 /*!
       
  1969    \variable QContactPresence::FieldPresenceStateText
       
  1970    The field key constant for the presence state description value.
       
  1971    \sa setPresenceStateText(), presenceStateText()
       
  1972  */
       
  1973 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldPresenceStateText, "PresenceStateText");
       
  1974 
       
  1975 /*!
       
  1976    \variable QContactPresence::FieldPresenceStateImageUrl
       
  1977    The field key constant for the presence state image URL.
       
  1978    \sa setPresenceStateImageUrl(), presenceStateImageUrl()
       
  1979  */
       
  1980 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldPresenceStateImageUrl, "PresenceStateImageUrl");
       
  1981 
       
  1982 /*!
       
  1983    \variable QContactPresence::FieldCustomMessage
       
  1984    The field key constant for the user-entered custom presence message.
       
  1985    \sa setCustomMessage(), customMessage()
       
  1986  */
       
  1987 Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldCustomMessage, "CustomMessage");
       
  1988 
  1930 /*!
  1989 /*!
  1931    \fn QContactPresence::setTimestamp(const QDateTime& updateTimestamp)
  1990    \fn QContactPresence::setTimestamp(const QDateTime& updateTimestamp)
  1932 
  1991 
  1933    Sets the update timestamp of the presence detail to be
  1992    Sets the timestamp for the last update of the presence detail to be
  1934    \a updateTimestamp.
  1993    \a updateTimestamp.
  1935  */
  1994  */
  1936 
  1995 
  1937 /*!
  1996 /*!
  1938    \fn QContactPresence::timestamp() const
  1997    \fn QContactPresence::timestamp() const
  1957 
  2016 
  1958 /*!
  2017 /*!
  1959   \enum QContactPresence::PresenceState
  2018   \enum QContactPresence::PresenceState
  1960 
  2019 
  1961   This enum defines the possible presence states supported by the default schema.
  2020   This enum defines the possible presence states supported by the default schema.
       
  2021   Not all presence providers support all of these states.
  1962 
  2022 
  1963   \value PresenceUnknown Signifies that the presence state of the contact is not currently known
  2023   \value PresenceUnknown Signifies that the presence state of the contact is not currently known
  1964   \value PresenceAvailable Signifies that the contact is available
  2024   \value PresenceAvailable Signifies that the contact is available
  1965   \value PresenceHidden Signifies that the contact is hidden
  2025   \value PresenceHidden Signifies that the contact is hidden
  1966   \value PresenceBusy Signifies that the contact is busy
  2026   \value PresenceBusy Signifies that the contact is busy
  2001 /*!
  2061 /*!
  2002   \fn QContactPresence::setCustomMessage(const QString& customMessage)
  2062   \fn QContactPresence::setCustomMessage(const QString& customMessage)
  2003 
  2063 
  2004    Sets the custom status message from the contact for the online account
  2064    Sets the custom status message from the contact for the online account
  2005    about which this detail stores presence information, to \a customMessage.
  2065    about which this detail stores presence information, to \a customMessage.
       
  2066    This custom message would have been set by the contact,
       
  2067    and does not necessarily correspond to a particular presence state.
  2006  */
  2068  */
  2007 
  2069 
  2008 /*!
  2070 /*!
  2009    \fn QContactPresence::customMessage() const
  2071    \fn QContactPresence::customMessage() const
  2010 
  2072 
  2023    \fn QContactPresence::presenceStateImageUrl() const
  2085    \fn QContactPresence::presenceStateImageUrl() const
  2024 
  2086 
  2025    Returns the last-known status image url of the contact for the online account
  2087    Returns the last-known status image url of the contact for the online account
  2026    about which this detail stores presence information.
  2088    about which this detail stores presence information.
  2027  */
  2089  */
       
  2090 
       
  2091 /* ==================== QContactGlobalPresence ======================= */
       
  2092 
       
  2093 /*!
       
  2094    \class QContactGlobalPresence
       
  2095    \brief The QContactGlobalPresence class provides aggregated presence information
       
  2096    for a contact, synthesized or supplied by the backend.
       
  2097    \ingroup contacts-details
       
  2098  */
       
  2099 
       
  2100 /*!
       
  2101    \variable QContactGlobalPresence::DefinitionName
       
  2102    The string constant for the definition name of QContactGlobalPresence details.
       
  2103  */
       
  2104 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::DefinitionName, "GlobalPresence");
       
  2105 
       
  2106 /*!
       
  2107    \variable QContactGlobalPresence::FieldTimestamp
       
  2108    The field key constant for the timestamp value.
       
  2109    \sa setTimestamp(), timestamp()
       
  2110  */
       
  2111 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldTimestamp, "Timestamp");
       
  2112 
       
  2113 /*!
       
  2114    \variable QContactGlobalPresence::FieldNickname
       
  2115    The field key constant for the nickname value.
       
  2116    \sa setNickname(), nickname()
       
  2117  */
       
  2118 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldNickname, "Nickname");
       
  2119 
       
  2120 /*!
       
  2121    \variable QContactGlobalPresence::FieldPresenceState
       
  2122    The field key constant for the presence state enumeration value.
       
  2123    \sa setPresenceState(), presenceState()
       
  2124  */
       
  2125 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldPresenceState, "PresenceState");
       
  2126 
       
  2127 /*!
       
  2128    \variable QContactGlobalPresence::FieldPresenceStateText
       
  2129    The field key constant for the presence state description value.
       
  2130    \sa setPresenceStateText(), presenceStateText()
       
  2131  */
       
  2132 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldPresenceStateText, "PresenceStateText");
       
  2133 
       
  2134 /*!
       
  2135    \variable QContactGlobalPresence::FieldPresenceStateImageUrl
       
  2136    The field key constant for the presence state image URL.
       
  2137    \sa setPresenceStateImageUrl(), presenceStateImageUrl()
       
  2138  */
       
  2139 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldPresenceStateImageUrl, "PresenceStateImageUrl");
       
  2140 
       
  2141 /*!
       
  2142    \variable QContactGlobalPresence::FieldCustomMessage
       
  2143 
       
  2144    The field key constant for the user-entered custom presence message.
       
  2145    \sa setCustomMessage(), customMessage()
       
  2146  */
       
  2147 Q_DEFINE_LATIN1_CONSTANT(QContactGlobalPresence::FieldCustomMessage, "CustomMessage");
  2028 
  2148 
  2029 /*!
  2149 /*!
  2030    \fn QContactGlobalPresence::setTimestamp(const QDateTime& updateTimestamp)
  2150    \fn QContactGlobalPresence::setTimestamp(const QDateTime& updateTimestamp)
  2031 
  2151 
  2032    Sets the update timestamp of the global presence detail to be
  2152    Sets the update timestamp of the global presence detail to be
  2111    Returns the last-known status image url of the contact.
  2231    Returns the last-known status image url of the contact.
  2112  */
  2232  */
  2113 
  2233 
  2114 
  2234 
  2115 
  2235 
  2116 /* Convenience filters */
  2236 
  2117 
  2237 /* ==================== Convenience Filters ======================= */
  2118 /*!
  2238 
  2119     Returns a filter suitable for finding
  2239 /*!
  2120     contacts with a display label matching the specified \a label.
  2240     Returns a filter suitable for finding contacts with a display label containing the specified
       
  2241     \a label.
  2121 */
  2242 */
  2122 QContactFilter QContactDisplayLabel::match(const QString &label)
  2243 QContactFilter QContactDisplayLabel::match(const QString &label)
  2123 {
  2244 {
  2124     QContactDetailFilter f;
  2245     QContactDetailFilter f;
  2125     f.setDetailDefinitionName(QContactDisplayLabel::DefinitionName);
  2246     f.setDetailDefinitionName(QContactDisplayLabel::DefinitionName,
       
  2247                               QContactDisplayLabel::FieldLabel);
  2126     f.setValue(label);
  2248     f.setValue(label);
       
  2249     f.setMatchFlags(QContactFilter::MatchContains);
  2127 
  2250 
  2128     return f;
  2251     return f;
  2129 }
  2252 }
  2130 
  2253 
  2131 /*!
  2254 /*!
  2132     Returns a filter suitable for finding
  2255     Returns a filter suitable for finding contacts with a name with a first name containing the
  2133     contacts with a name matching the specified \a firstName and
  2256     specified \a firstName and a last name containing the specified \a lastName.  If either
  2134     \a lastName.  If either parameter is empty, any value will match
  2257     parameter is empty, any value will match that component.
  2135     that component.
       
  2136 */
  2258 */
  2137 QContactFilter QContactName::match(const QString &firstName, const QString &lastName)
  2259 QContactFilter QContactName::match(const QString &firstName, const QString &lastName)
  2138 {
  2260 {
  2139     if (firstName.isEmpty()) {
  2261     if (firstName.isEmpty()) {
  2140         if (lastName.isEmpty()) {
  2262         if (lastName.isEmpty()) {
  2145         } else {
  2267         } else {
  2146             // Contact with matching lastname
  2268             // Contact with matching lastname
  2147             QContactDetailFilter f;
  2269             QContactDetailFilter f;
  2148             f.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldLastName);
  2270             f.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldLastName);
  2149             f.setValue(lastName);
  2271             f.setValue(lastName);
       
  2272             f.setMatchFlags(QContactFilter::MatchContains);
  2150             return f;
  2273             return f;
  2151         }
  2274         }
  2152     } else {
  2275     } else {
  2153         if (lastName.isEmpty()) {
  2276         if (lastName.isEmpty()) {
  2154             // Contact with matching firstName
  2277             // Contact with matching firstName
  2155             QContactDetailFilter f;
  2278             QContactDetailFilter f;
  2156             f.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldFirstName);
  2279             f.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldFirstName);
  2157             f.setValue(firstName);
  2280             f.setValue(firstName);
       
  2281             f.setMatchFlags(QContactFilter::MatchContains);
  2158             return f;
  2282             return f;
  2159         } else {
  2283         } else {
  2160             // Match a contact with the specified first and last names
  2284             // Match a contact with the specified first and last names
  2161             // XXX This needs multi detail filter!
  2285             // XXX This needs multi detail filter!
  2162 
  2286 
  2163             // Best we can currently do is "and" and assume there's only one name per contact
  2287             // Best we can currently do is "and" and assume there's only one name per contact
  2164             QContactDetailFilter f;
  2288             QContactDetailFilter f;
  2165             f.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldFirstName);
  2289             f.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldFirstName);
  2166             f.setValue(firstName);
  2290             f.setValue(firstName);
       
  2291             f.setMatchFlags(QContactFilter::MatchContains);
  2167             QContactDetailFilter l;
  2292             QContactDetailFilter l;
  2168             l.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldLastName);
  2293             l.setDetailDefinitionName(QContactName::DefinitionName, QContactName::FieldLastName);
  2169             l.setValue(lastName);
  2294             l.setValue(lastName);
       
  2295             l.setMatchFlags(QContactFilter::MatchContains);
  2170 
  2296 
  2171             return f & l;
  2297             return f & l;
  2172         }
  2298         }
  2173     }
  2299     }
  2174 }
  2300 }
  2175 
  2301 
  2176 /*!
  2302 /*!
  2177     Returns a filter suitable for finding
  2303     Returns a filter suitable for finding contacts with any name field (e.g. first, last) that
  2178     contacts with a name field (e.g. first, last) that
  2304     contains the supplied \a name.
  2179     matches the supplied \a name.
       
  2180 */
  2305 */
  2181 QContactFilter QContactName::match(const QString &name)
  2306 QContactFilter QContactName::match(const QString &name)
  2182 {
  2307 {
  2183     QContactDetailFilter l;
  2308     QContactUnionFilter nameFilter;
  2184     l.setDetailDefinitionName(QContactName::DefinitionName);
  2309     QStringList nameFields;
  2185     l.setValue(name);
  2310     nameFields << QContactName::FieldCustomLabel
  2186     return l;
  2311             << QContactName::FieldFirstName
       
  2312             << QContactName::FieldLastName
       
  2313             << QContactName::FieldMiddleName
       
  2314             << QContactName::FieldPrefix
       
  2315             << QContactName::FieldSuffix;
       
  2316     foreach (const QString& fieldName, nameFields) {
       
  2317         QContactDetailFilter subFilter;
       
  2318         subFilter.setDetailDefinitionName(QContactName::DefinitionName, fieldName);
       
  2319         subFilter.setValue(name);
       
  2320         subFilter.setMatchFlags(QContactFilter::MatchContains);
       
  2321         nameFilter.append(subFilter);
       
  2322     }
       
  2323     return nameFilter;
  2187 }
  2324 }
  2188 
  2325 
  2189 /*!
  2326 /*!
  2190     Returns a filter suitable for finding
  2327     Returns a filter suitable for finding contacts with an email address containing the specified
  2191     contacts with an email address matching the specified \a emailAddress.
  2328     \a emailAddress.
  2192 */
  2329 */
  2193 QContactFilter QContactEmailAddress::match(const QString &emailAddress)
  2330 QContactFilter QContactEmailAddress::match(const QString &emailAddress)
  2194 {
  2331 {
  2195     QContactDetailFilter l;
  2332     QContactDetailFilter l;
  2196     l.setDetailDefinitionName(QContactEmailAddress::DefinitionName, QContactEmailAddress::FieldEmailAddress);
  2333     l.setDetailDefinitionName(QContactEmailAddress::DefinitionName, QContactEmailAddress::FieldEmailAddress);
  2197     l.setValue(emailAddress);
  2334     l.setValue(emailAddress);
       
  2335     l.setMatchFlags(QContactFilter::MatchContains);
  2198     return l;
  2336     return l;
  2199 }
  2337 }
  2200 
  2338 
  2201 /*!
  2339 /*!
  2202     Returns a filter suitable for finding
  2340     Returns a filter suitable for finding contacts with a phone number containing the specified
  2203     contacts with a phone number matching the specified \a number.
  2341     \a number.
  2204 */
  2342 */
  2205 QContactFilter QContactPhoneNumber::match(const QString &number)
  2343 QContactFilter QContactPhoneNumber::match(const QString &number)
  2206 {
  2344 {
  2207     QContactDetailFilter l;
  2345     QContactDetailFilter l;
  2208     l.setDetailDefinitionName(QContactPhoneNumber::DefinitionName, QContactPhoneNumber::FieldNumber);
  2346     l.setDetailDefinitionName(QContactPhoneNumber::DefinitionName, QContactPhoneNumber::FieldNumber);