1
/****************************************************************************
3
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4
** Contact: http://www.qt-project.org/legal
6
** This file is part of the QtContacts module of the Qt Toolkit.
8
** $QT_BEGIN_LICENSE:LGPL$
9
** Commercial License Usage
10
** Licensees holding valid commercial Qt licenses may use this file in
11
** accordance with the commercial license agreement provided with the
12
** Software or, alternatively, in accordance with the terms contained in
13
** a written agreement between you and Digia. For licensing terms and
14
** conditions see http://qt.digia.com/licensing. For further information
15
** use the contact form at http://qt.digia.com/contact-us.
17
** GNU Lesser General Public License Usage
18
** Alternatively, this file may be used under the terms of the GNU Lesser
19
** General Public License version 2.1 as published by the Free Software
20
** Foundation and appearing in the file LICENSE.LGPL included in the
21
** packaging of this file. Please review the following information to
22
** ensure the GNU Lesser General Public License version 2.1 requirements
23
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25
** In addition, as a special exception, Digia gives you certain additional
26
** rights. These rights are described in the Digia Qt LGPL Exception
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29
** GNU General Public License Usage
30
** Alternatively, this file may be used under the terms of the GNU
31
** General Public License version 3.0 as published by the Free Software
32
** Foundation and appearing in the file LICENSE.GPL included in the
33
** packaging of this file. Please review the following information to
34
** ensure the GNU General Public License version 3.0 requirements will be
35
** met: http://www.gnu.org/copyleft/gpl.html.
40
****************************************************************************/
43
#include "qcontactmanagerenginefactory.h"
45
QT_BEGIN_NAMESPACE_CONTACTS
48
\class QContactManagerEngineFactory
49
\brief The QContactManagerEngineFactory class provides the interface for
50
plugins that implement QContactManagerEngine functionality.
54
\ingroup contacts-backends
56
This class provides a simple interface for the creation of
57
manager engine instances. Each factory has a specific id
58
associated with it, which forms the \c managerName parameter
59
when creating \l QContactManager objects.
61
More information on writing a contacts engine plugin is available in
62
the \l{Qt Contacts Manager Engines} documentation.
64
\sa QContactManager, QContactManagerEngine
68
A default, empty destructor.
70
QContactManagerEngineFactory::~QContactManagerEngineFactory()
77
QStringList QContactManagerEngineFactory::keys() const
79
return QStringList() << managerName();
83
\fn QContactManagerEngineFactory::engine(const QMap<QString, QString>& parameters, QContactManager::Error* error)
85
This function is called by the QContactManager implementation to
86
create an instance of the engine provided by this factory.
88
The \a parameters supplied can be ignored or interpreted as desired.
90
If a supplied parameter results in an unfulfillable request, or some other error
91
occurs, this function may return a null pointer, and the client developer will get an
92
invalid QContactManager in return. Any error should be stored in the supplied \a error
97
\fn QContactManagerEngineFactory::createContactEngineId(const QMap<QString, QString> ¶meters, const QString &engineIdString) const
99
This function should return an engine-specific Contact ID, according to the given \a parameters and
100
the \a engineIdString.
104
\fn QContactManagerEngineFactory::managerName() const
106
This function should return a unique string that identifies
107
the engines provided by this factory.
109
Typically this would be of the form "org.qt-project.Qt.SampleContactEngine", with
110
the appropriate domain and engine name substituted.
114
\fn QContactManagerEngineFactory::supportedImplementationVersions() const
116
This function should return a list of versions of the engine which this factory can instantiate.
118
QList<int> QContactManagerEngineFactory::supportedImplementationVersions() const
123
#include "moc_qcontactmanagerenginefactory.cpp"
125
QT_END_NAMESPACE_CONTACTS