|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 |
|
43 #include "qcontactmanagerenginefactory.h" |
|
44 |
|
45 QTM_BEGIN_NAMESPACE |
|
46 |
|
47 /*! |
|
48 \class QContactManagerEngineFactory |
|
49 \brief The QContactManagerEngineFactory class provides the interface for |
|
50 plugins that implement QContactManagerEngine functionality. |
|
51 \ingroup contacts-backends |
|
52 |
|
53 This class provides a simple interface for the creation of |
|
54 manager engine instances. Each factory has a specific id |
|
55 associated with it, which forms the \c managerName parameter |
|
56 when creating \l QContactManager objects. |
|
57 |
|
58 More information on writing a contacts engine plugin is available in |
|
59 the \l{Qt Contacts Manager Engines} documentation. |
|
60 |
|
61 \sa QContactManager, QContactManagerEngine |
|
62 */ |
|
63 |
|
64 /*! |
|
65 A default, empty destructor. |
|
66 */ |
|
67 QContactManagerEngineFactory::~QContactManagerEngineFactory() |
|
68 { |
|
69 } |
|
70 |
|
71 /*! |
|
72 \fn QContactManagerEngineFactory::engine(const QMap<QString, QString>& parameters, QContactManager::Error* error) |
|
73 |
|
74 This function is called by the QContactManager implementation to |
|
75 create an instance of the engine provided by this factory. |
|
76 |
|
77 The \a parameters supplied can be ignored or interpreted as desired. |
|
78 |
|
79 If a supplied parameter results in an unfulfillable request, or some other error |
|
80 occurs, this function may return a null pointer, and the client developer will get an |
|
81 invalid QContactManager in return. Any error should be stored in the supplied \a error |
|
82 reference. |
|
83 */ |
|
84 |
|
85 /*! |
|
86 \fn QContactManagerEngineFactory::managerName() const |
|
87 |
|
88 This function should return a unique string that identifies |
|
89 the engines provided by this factory. |
|
90 |
|
91 Typically this would be of the form "com.nokia.qt.contacts.engines.memory", with |
|
92 the appropriate domain and engine name substituted. |
|
93 */ |
|
94 |
|
95 /*! |
|
96 \fn QContactManagerEngineFactory::supportedImplementationVersions() const |
|
97 |
|
98 This function should return a list of versions of the engine which this factory can instantiate. |
|
99 */ |
|
100 QList<int> QContactManagerEngineFactory::supportedImplementationVersions() const |
|
101 { |
|
102 return QList<int>(); |
|
103 } |
|
104 |
|
105 QTM_END_NAMESPACE |