qtmobility/src/contacts/qcontactmanager.cpp
changeset 15 1f895d8a5b2b
parent 14 6fbed849b4f4
equal deleted inserted replaced
14:6fbed849b4f4 15:1f895d8a5b2b
   361 
   361 
   362 /*!
   362 /*!
   363   Returns the list of contacts stored in the manager sorted according to the given list of \a sortOrders.
   363   Returns the list of contacts stored in the manager sorted according to the given list of \a sortOrders.
   364 
   364 
   365   The \a fetchHint parameter describes the optimization hints that a manager may take.
   365   The \a fetchHint parameter describes the optimization hints that a manager may take.
   366   If the \a fetchHint is the default constructed hint, all existing details and relationships
   366   If the \a fetchHint is the default constructed hint, all existing details, relationships and action preferences
   367   in the matching contacts will be returned.  A client should not make changes to a contact which has
   367   in the matching contacts will be returned.  A client should not make changes to a contact which has
   368   been retrieved using a fetch hint other than the default fetch hint.  Doing so will result in information
   368   been retrieved using a fetch hint other than the default fetch hint.  Doing so will result in information
   369   loss when saving the contact back to the manager (as the "new" restricted contact will
   369   loss when saving the contact back to the manager (as the "new" restricted contact will
   370   replace the previously saved contact in the backend).
   370   replace the previously saved contact in the backend).
   371 
   371 
   382 
   382 
   383   Depending on the manager implementation, this filtering operation might be slow and involve retrieving all the
   383   Depending on the manager implementation, this filtering operation might be slow and involve retrieving all the
   384   contacts and testing them against the supplied filter - see the \l isFilterSupported() function.
   384   contacts and testing them against the supplied filter - see the \l isFilterSupported() function.
   385 
   385 
   386   The \a fetchHint parameter describes the optimization hints that a manager may take.
   386   The \a fetchHint parameter describes the optimization hints that a manager may take.
   387   If the \a fetchHint is the default constructed hint, all existing details and relationships
   387   If the \a fetchHint is the default constructed hint, all existing details, relationships and action preferences
   388   in the matching contacts will be returned.  A client should not make changes to a contact which has
   388   in the matching contacts will be returned.  A client should not make changes to a contact which has
   389   been retrieved using a fetch hint other than the default fetch hint.  Doing so will result in information
   389   been retrieved using a fetch hint other than the default fetch hint.  Doing so will result in information
   390   loss when saving the contact back to the manager (as the "new" restricted contact will
   390   loss when saving the contact back to the manager (as the "new" restricted contact will
   391   replace the previously saved contact in the backend).
   391   replace the previously saved contact in the backend).
   392 
   392 
   403 
   403 
   404   If the contact does not exist, an empty, default constructed QContact will be returned,
   404   If the contact does not exist, an empty, default constructed QContact will be returned,
   405   and the error returned by \l error() will be \c QContactManager::DoesNotExistError.
   405   and the error returned by \l error() will be \c QContactManager::DoesNotExistError.
   406 
   406 
   407   The \a fetchHint parameter describes the optimization hints that a manager may take.
   407   The \a fetchHint parameter describes the optimization hints that a manager may take.
   408   If the \a fetchHint is the default constructed hint, all existing details and relationships
   408   If the \a fetchHint is the default constructed hint, all existing details, relationships and action preferences
   409   in the matching contact will be returned.  A client should not make changes to a contact which has
   409   in the matching contact will be returned.  A client should not make changes to a contact which has
   410   been retrieved using a fetch hint other than the default fetch hint.  Doing so will result in information
   410   been retrieved using a fetch hint other than the default fetch hint.  Doing so will result in information
   411   loss when saving the contact back to the manager (as the "new" restricted contact will
   411   loss when saving the contact back to the manager (as the "new" restricted contact will
   412   replace the previously saved contact in the backend).
   412   replace the previously saved contact in the backend).
   413 
   413 
   553  */
   553  */
   554 QContact QContactManager::compatibleContact(const QContact& original)
   554 QContact QContactManager::compatibleContact(const QContact& original)
   555 {
   555 {
   556     d->m_error = QContactManager::NoError;
   556     d->m_error = QContactManager::NoError;
   557     return d->m_engine->compatibleContact(original, &d->m_error);
   557     return d->m_engine->compatibleContact(original, &d->m_error);
       
   558 }
       
   559 
       
   560 /*!
       
   561   \deprecated
       
   562 */
       
   563 QString QContactManager::synthesizedDisplayLabel(const QContact& contact) const
       
   564 {
       
   565     d->m_error = QContactManager::NoError;
       
   566     return d->m_engine->synthesizedDisplayLabel(contact, &d->m_error);
   558 }
   567 }
   559 
   568 
   560 /*!
   569 /*!
   561   Returns a display label for a \a contact which is synthesized from its details in a manager specific
   570   Returns a display label for a \a contact which is synthesized from its details in a manager specific
   562   manner.
   571   manner.
   628 {
   637 {
   629     d->m_error = QContactManager::NoError;
   638     d->m_error = QContactManager::NoError;
   630     return d->m_engine->selfContactId(&d->m_error);
   639     return d->m_engine->selfContactId(&d->m_error);
   631 }
   640 }
   632 
   641 
   633 
       
   634 /*!
   642 /*!
   635   Returns a list of relationships in which the contact identified by the given \a participantId participates in the given \a role.
   643   Returns a list of relationships in which the contact identified by the given \a participantId participates in the given \a role.
   636   If \a participantId is the default-constructed id, \a role is ignored and all relationships are returned.
   644   If \a participantId is the default-constructed id, \a role is ignored and all relationships are returned.
   637  */
   645  */
   638 QList<QContactRelationship> QContactManager::relationships(const QContactId& participantId, QContactRelationship::Role role) const
   646 QList<QContactRelationship> QContactManager::relationships(const QContactId& participantId, QContactRelationship::Role role) const
   774 
   782 
   775 /*!
   783 /*!
   776   \enum QContactManager::ManagerFeature
   784   \enum QContactManager::ManagerFeature
   777   This enum describes the possible features that a particular manager may support
   785   This enum describes the possible features that a particular manager may support
   778   \value Groups The manager supports saving contacts of the \c QContactType::TypeGroup type
   786   \value Groups The manager supports saving contacts of the \c QContactType::TypeGroup type
   779   \omitvalue ActionPreferences The manager supports saving preferred details per action per contact
   787   \value ActionPreferences The manager supports saving preferred details per action per contact
   780   \value DetailOrdering When a contact is retrieved, the manager will return the details in the same order in which they were saved
   788   \value DetailOrdering When a contact is retrieved, the manager will return the details in the same order in which they were saved
   781   \value Relationships The manager supports at least some types of relationships between contacts
   789   \value Relationships The manager supports at least some types of relationships between contacts
   782   \value ArbitraryRelationshipTypes The manager supports relationships of arbitrary types between contacts
   790   \value ArbitraryRelationshipTypes The manager supports relationships of arbitrary types between contacts
   783   \value MutableDefinitions The manager supports saving, updating or removing detail definitions.  Some built-in definitions may still be immutable
   791   \value MutableDefinitions The manager supports saving, updating or removing detail definitions.  Some built-in definitions may still be immutable
   784   \value SelfContact The manager supports the concept of saving a contact which represents the current user
   792   \value SelfContact The manager supports the concept of saving a contact which represents the current user