diff -r 000000000000 -r 876b1a06bc25 src/contacts/qcontactmanager.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/contacts/qcontactmanager.h Wed Aug 25 15:49:42 2010 +0300 @@ -0,0 +1,196 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + + +#ifndef QCONTACTMANAGER_H +#define QCONTACTMANAGER_H + +#include + +#include +#include +#include +#include +#include + +#include "qtcontactsglobal.h" +#include "qcontact.h" +#include "qcontactid.h" +#include "qcontactrelationship.h" +#include "qcontactsortorder.h" +#include "qcontactfetchhint.h" + +QTM_BEGIN_NAMESPACE + +class QContactFilter; +class QContactAction; + +class QContactManagerData; +class Q_CONTACTS_EXPORT QContactManager : public QObject +{ + Q_OBJECT + +public: +#if Q_QDOC // qdoc's parser fails to recognise the default map argument + explicit QContactManager(const QString& managerName = QString(), const QMap& parameters = 0, QObject* parent = 0); + QContactManager(const QString& managerName, int implementationVersion, const QMap& parameters = 0, QObject* parent = 0); +#else + explicit QContactManager(const QString& managerName = QString(), const QMap& parameters = (QMap()), QObject* parent = 0); + QContactManager(const QString& managerName, int implementationVersion, const QMap& parameters = (QMap()), QObject* parent = 0); +#endif + explicit QContactManager(QObject* parent); + + static QContactManager* fromUri(const QString& uri, QObject* parent = 0); + ~QContactManager(); // dtor + + QString managerName() const; // e.g. "Symbian" + QMap managerParameters() const; // e.g. "filename=private.db" + QString managerUri() const; // managerName + managerParameters + int managerVersion() const; + + static bool parseUri(const QString& uri, QString* managerName, QMap* params); // replaces the above. + static QString buildUri(const QString& managerName, const QMap& params, int implementationVersion = -1); + + /* The values of the Error enum are still to be decided! */ + enum Error { + NoError = 0, + DoesNotExistError, + AlreadyExistsError, + InvalidDetailError, + InvalidRelationshipError, + LockedError, + DetailAccessError, + PermissionsError, + OutOfMemoryError, + NotSupportedError, + BadArgumentError, + UnspecifiedError, + VersionMismatchError, + LimitReachedError, + InvalidContactTypeError + }; + + /* Error reporting */ + QContactManager::Error error() const; + + /* Contacts - Accessors and Mutators */ + QList contactIds(const QList& sortOrders = QList()) const; + QList contactIds(const QContactFilter& filter, const QList& sortOrders = QList()) const; + + QList contacts(const QList& sortOrders = QList(), const QContactFetchHint& fetchHint = QContactFetchHint()) const; + QList contacts(const QContactFilter& filter, const QList& sortOrders = QList(), const QContactFetchHint& fetchHint = QContactFetchHint()) const; + QContact contact(const QContactLocalId& contactId, const QContactFetchHint& fetchHint = QContactFetchHint()) const; // retrieve a contact + + bool saveContact(QContact* contact); // note: MODIFIES contact (sets the contactId) + bool removeContact(const QContactLocalId& contactId); // remove the contact from the persistent store + + bool saveContacts(QList* contacts, QMap* errorMap); // batch API - save. + bool removeContacts(const QList& contactIds, QMap* errorMap); // batch API - remove. + + /* Return a pruned or modified contact which is valid and can be saved in the manager */ + QContact compatibleContact(const QContact& original); // Preliminary function! + + /* deprecated - to be removed after the transition period has elapsed */ + QString Q_DECL_DEPRECATED synthesizedDisplayLabel(const QContact& contact) const; + /* Synthesize the display label of a contact */ + QString synthesizedContactDisplayLabel(const QContact& contact) const; + void synthesizeContactDisplayLabel(QContact* contact) const; + + /* "Self" contact id (MyCard) */ + bool setSelfContactId(const QContactLocalId& contactId); + QContactLocalId selfContactId() const; + + /* Relationships */ + QList relationships(const QContactId& participantId, QContactRelationship::Role role = QContactRelationship::Either) const; + QList relationships(const QString& relationshipType = QString(), const QContactId& participantId = QContactId(), QContactRelationship::Role role = QContactRelationship::Either) const; + bool saveRelationship(QContactRelationship* relationship); + bool saveRelationships(QList* relationships, QMap* errorMap); + bool removeRelationship(const QContactRelationship& relationship); + bool removeRelationships(const QList& relationships, QMap* errorMap); + + /* Definitions - Accessors and Mutators */ + QMap detailDefinitions(const QString& contactType = QContactType::TypeContact) const; + QContactDetailDefinition detailDefinition(const QString& definitionName, const QString& contactType = QContactType::TypeContact) const; + bool saveDetailDefinition(const QContactDetailDefinition& def, const QString& contactType = QContactType::TypeContact); + bool removeDetailDefinition(const QString& definitionName, const QString& contactType = QContactType::TypeContact); + + /* Functionality reporting */ + enum ManagerFeature { + Groups = 0, // backend supports QContactType::TypeGroup type contacts (convenience for clients... should be deprecated) + ActionPreferences, // per-contact action preferences + MutableDefinitions, + Relationships, + ArbitraryRelationshipTypes, + RelationshipOrdering, // deprecated along with setRelationshipOrder() etc in QContact. + DetailOrdering, + SelfContact, + Anonymous, + ChangeLogs + }; + bool hasFeature(QContactManager::ManagerFeature feature, const QString& contactType = QContactType::TypeContact) const; + bool isRelationshipTypeSupported(const QString& relationshipType, const QString& contactType = QContactType::TypeContact) const; // replaces the above + QList supportedDataTypes() const; + bool isFilterSupported(const QContactFilter& filter) const; + QStringList supportedContactTypes() const; + + /* return a list of available backends for which a QContactManager can be constructed. */ + static QStringList availableManagers(); + +Q_SIGNALS: + void dataChanged(); + void contactsAdded(const QList& contactIds); + void contactsChanged(const QList& contactIds); + void contactsRemoved(const QList& contactIds); + void relationshipsAdded(const QList& affectedContactIds); + void relationshipsRemoved(const QList& affectedContactIds); + void selfContactIdChanged(const QContactLocalId& oldId, const QContactLocalId& newId); // need both? or just new? + +private: + friend class QContactManagerData; + void createEngine(const QString& managerName, const QMap& parameters); + Q_DISABLE_COPY(QContactManager) + // private data pointer + QContactManagerData* d; +}; + +QTM_END_NAMESPACE + +#endif