~chris.gagnon/+junk/qtpim-coverage

« back to all changes in this revision

Viewing changes to src/contacts/qcontactmanagerenginefactory.cpp

  • Committer: chris.gagnon
  • Date: 2013-12-10 23:09:37 UTC
  • Revision ID: chris.gagnon@canonical.com-20131210230937-2akf1ft1edcttk87
first post

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the QtContacts module of the Qt Toolkit.
 
7
**
 
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.
 
16
**
 
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.
 
24
**
 
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.
 
28
**
 
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.
 
36
**
 
37
**
 
38
** $QT_END_LICENSE$
 
39
**
 
40
****************************************************************************/
 
41
 
 
42
 
 
43
#include "qcontactmanagerenginefactory.h"
 
44
 
 
45
QT_BEGIN_NAMESPACE_CONTACTS
 
46
 
 
47
/*!
 
48
  \class QContactManagerEngineFactory
 
49
  \brief The QContactManagerEngineFactory class provides the interface for
 
50
 plugins that implement QContactManagerEngine functionality.
 
51
 
 
52
  \inmodule QtContacts
 
53
 
 
54
  \ingroup contacts-backends
 
55
 
 
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.
 
60
 
 
61
  More information on writing a contacts engine plugin is available in
 
62
  the \l{Qt Contacts Manager Engines} documentation.
 
63
 
 
64
  \sa QContactManager, QContactManagerEngine
 
65
 */
 
66
 
 
67
/*!
 
68
  A default, empty destructor.
 
69
 */
 
70
QContactManagerEngineFactory::~QContactManagerEngineFactory()
 
71
{
 
72
}
 
73
 
 
74
/*!
 
75
  \internal
 
76
 */
 
77
QStringList QContactManagerEngineFactory::keys() const
 
78
{
 
79
    return QStringList() << managerName();
 
80
}
 
81
 
 
82
/*!
 
83
  \fn QContactManagerEngineFactory::engine(const QMap<QString, QString>& parameters, QContactManager::Error* error)
 
84
 
 
85
  This function is called by the QContactManager implementation to
 
86
  create an instance of the engine provided by this factory.
 
87
 
 
88
  The \a parameters supplied can be ignored or interpreted as desired.
 
89
 
 
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
 
93
  reference.
 
94
 */
 
95
 
 
96
/*!
 
97
    \fn QContactManagerEngineFactory::createContactEngineId(const QMap<QString, QString> &parameters, const QString &engineIdString) const
 
98
 
 
99
    This function should return an engine-specific Contact ID, according to the given \a parameters and
 
100
    the \a engineIdString.
 
101
 */
 
102
 
 
103
/*!
 
104
  \fn QContactManagerEngineFactory::managerName() const
 
105
 
 
106
  This function should return a unique string that identifies
 
107
  the engines provided by this factory.
 
108
 
 
109
  Typically this would be of the form "org.qt-project.Qt.SampleContactEngine", with
 
110
  the appropriate domain and engine name substituted.
 
111
 */
 
112
 
 
113
/*!
 
114
  \fn QContactManagerEngineFactory::supportedImplementationVersions() const
 
115
 
 
116
  This function should return a list of versions of the engine which this factory can instantiate.
 
117
 */
 
118
QList<int> QContactManagerEngineFactory::supportedImplementationVersions() const
 
119
{
 
120
    return QList<int>();
 
121
}
 
122
 
 
123
#include "moc_qcontactmanagerenginefactory.cpp"
 
124
 
 
125
QT_END_NAMESPACE_CONTACTS