1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qorganizermanagerenginefactory.h"
QTM_BEGIN_NAMESPACE
/*!
\class QOrganizerManagerEngineFactory
\brief The QOrganizerManagerEngineFactory class provides the interface for
plugins that implement QOrganizerManagerEngine functionality.
\since 1.1
\inmodule QtOrganizer
\ingroup organizer-backends
This class provides a simple interface for the creation of
manager engine instances. Each factory has a specific id
associated with it, which forms the \c managerName parameter
when creating \l QOrganizerManager objects.
More information on writing a organizeritems engine plugin is available in
the \l{Qt Organizer Manager Engines} documentation.
\sa QOrganizerManager, QOrganizerManagerEngine
*/
/*!
A default, empty destructor.
*/
QOrganizerManagerEngineFactory::~QOrganizerManagerEngineFactory()
{
}
/*!
\fn QOrganizerManagerEngineFactory::engine(const QMap<QString, QString>& parameters, QOrganizerManager::Error* error)
This function is called by the QOrganizerManager implementation to
create an instance of the engine provided by this factory.
The \a parameters supplied can be ignored or interpreted as desired.
If a supplied parameter results in an unfulfillable request, or some other error
occurs, this function may return a null pointer, and the client developer will get an
invalid QOrganizerManager in return. Any error should be stored in the supplied \a error
reference.
\since 1.1
*/
/*!
\fn QOrganizerManagerEngineFactory::createCollectionEngineId(const QMap<QString, QString>& parameters, const QString& engineIdString) const
This function is used internally when deserializing an id. It allows the
deserialization functions to correctly allocate an engine-specific
id for an item, filled with the serialized data \a engineIdString.
Since the format of the id might be different depending on the construction
parameters \a parameters, these parameters are passed to the factory implementation
of this function.
Engine implementers must implement this function, but should not need
to call it.
\since 1.1
*/
/*!
\fn QOrganizerManagerEngineFactory::createItemEngineId(const QMap<QString, QString>& parameters, const QString& engineIdString) const
This function is used internally when deserializing an id. It allows the
deserialization functions to correctly allocate an engine-specific
id for a collection, filled with the serialized data \a engineIdString.
Since the format of the id might be different depending on the construction
parameters \a parameters, these parameters are passed to the factory implementation
of this function.
Engine implementers must implement this function, but should not need
to call it.
\since 1.1
*/
/*!
\fn QOrganizerManagerEngineFactory::managerName() const
This function should return a unique string that identifies
the engines provided by this factory.
Typically this would be of the form "com.nokia.qt.organizeritems.engines.memory", with
the appropriate domain and engine name substituted.
\since 1.1
*/
/*!
\fn QOrganizerManagerEngineFactory::supportedImplementationVersions() const
This function should return a list of versions of the engine which this factory can instantiate.
\since 1.1
*/
QList<int> QOrganizerManagerEngineFactory::supportedImplementationVersions() const
{
return QList<int>();
}
/*!
\fn QOrganizerItemEngineLocalId* QOrganizerItemManagerEngineFactory::createItemEngineLocalId() const
This abstract function create and return an QOrganizerItemEngineLocalId.
\since 1.1
*/
/*!
\fn QOrganizerCollectionEngineLocalId* QOrganizerItemManagerEngineFactory::createCollectionEngineLocalId()const
This abstract function create and return an QOrganizerCollectionEngineLocalId.
\since 1.1
*/
QTM_END_NAMESPACE
|
