diff -r 000000000000 -r 876b1a06bc25 src/contacts/qcontactfetchhint.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/contacts/qcontactfetchhint.cpp Wed Aug 25 15:49:42 2010 +0300 @@ -0,0 +1,198 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qcontactfetchhint.h" +#include "qcontactfetchhint_p.h" + +#include + +QTM_BEGIN_NAMESPACE + +/*! + \class QContactFetchHint + \brief The QContactFetchHint class provides hints to the manager about which contact + information needs to be retrieved in an asynchronous fetch request or a synchronous + function call. + + All of the hints may be ignored at the discretion of the manager, however if a manager + is able to optimize retrieval of contacts due to hints, it may do so. If a manager + ignores a hint, it must retrieve the full set of data that the hint refers to. + + The fetch hint contains: + \list + \o a list of detail definition names which the client is interested + in (empty if interested in all detail definitions) + \o a list of relationship types which the client is interested in + (empty if interested in all relationships) + \o some optimization flags which allow the client to tell the backend if they are + not interested in any relationships, any action preferences, or any binary blobs (images etc). + \endlist + + Important note: a client should not make changes to a contact which has been retrieved + using a fetch hint other than the default fetch hint. Doing so will result in information + loss when saving the contact back to the manager (as the "new" restricted contact will + replace the previously saved contact in the backend). + */ + +/*! + \enum QContactFetchHint::OptimizationHint + + This enum defines flags which may be set to inform the backend that the client does + not require certain information. The backend may safely ignore the hint, but then + must return the full set of information relating to the optimization hint. + + \value AllRequired Tells the backend that all information is required + \value NoRelationships Tells the backend that the client does not require retrieved contacts to include a cache of relationships + \value NoActionPreferences Tells the backend that the client does not require retrieved contacts to include a cache of action preferences + \value NoBinaryBlobs Tells the backend that the client does not require retrieved contacts to include binary blobs such as thumbnail images + */ + +/*! + Constructs a new contact fetch hint which requests that the backend fetch all information + */ +QContactFetchHint::QContactFetchHint() + : d(new QContactFetchHintPrivate) +{ +} + +/*! + Constructs a new contact fetch hint as a copy of \a other + */ +QContactFetchHint::QContactFetchHint(const QContactFetchHint &other) + : d(other.d) +{ +} + +/*! + Frees any memory in use by the fetch hint + */ +QContactFetchHint::~QContactFetchHint() +{ +} + +/*! + Assigns this fetch hint to be equal to the \a other fetch hint + */ +QContactFetchHint& QContactFetchHint::operator=(const QContactFetchHint& other) +{ + d = other.d; + return *this; +} + +/*! + Returns the list of definition names that identify detail definitions of which details + the manager should (at a minimum) retrieve when fetching contacts. + This hint may be ignored by the backend, in which case it will return the full set of details for + each contact retrieved. + + \sa setDetailDefinitionsHint() + */ +QStringList QContactFetchHint::detailDefinitionsHint() const +{ + return d->m_definitionsHint; +} + +/*! + Sets the list of definition names that identify detail definitions of which details + the manager should (at a minimum) retrieve when fetching contacts to \a definitionNames. + This hint may be ignored by the backend, in which case it will return the full set of details for + each contact retrieved. + + \sa detailDefinitionsHint() + */ +void QContactFetchHint::setDetailDefinitionsHint(const QStringList& definitionNames) +{ + d->m_definitionsHint = definitionNames; +} + +/*! + Returns the list of relationship types that the manager should (at a minimum) retrieve + when fetching contacts. + This hint may be ignored by the backend, in which case it will return the full set of + relationships for each contact retrieved. + + \sa setRelationshipTypesHint(), QContact::relationships() + */ +QStringList QContactFetchHint::relationshipTypesHint() const +{ + return d->m_relationshipsHint; +} + +/*! + Sets the list of relationship types that the manager should (at a minimum) retrieve + when fetching contacts to \a relationshipTypes. + This hint may be ignored by the backend, in which case it will return the full set of + relationships for each contact retrieved. + + \sa relationshipTypesHint(), QContact::relationships() + */ +void QContactFetchHint::setRelationshipTypesHint(const QStringList& relationshipTypes) +{ + d->m_relationshipsHint = relationshipTypes; +} + +/*! + Returns the optimization hint flags specified by the client. + These hints may be ignored by the backend, in which case it will return + the full set of information accessible in a contact, including + relationships, action preferences, and binary blobs. + + \sa setOptimizationHints() + */ +QContactFetchHint::OptimizationHints QContactFetchHint::optimizationHints() const +{ + return d->m_optimizationHints; +} + +/*! + Sets the optimization hint flags specified by the client to \a hints. + These hints may be ignored by the backend, in which case it will return + the full set of information accessible in a contact, including + relationships, action preferences, and binary blobs. + + \sa optimizationHints() + */ +void QContactFetchHint::setOptimizationHints(OptimizationHints hints) +{ + d->m_optimizationHints = hints; +} + +QTM_END_NAMESPACE