1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtOrganizer module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
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 The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#include "qorganizermanagerenginefactory.h"
35
36QT_BEGIN_NAMESPACE_ORGANIZER
37
38/*!
39 \class QOrganizerManagerEngineFactory
40 \brief The QOrganizerManagerEngineFactory class provides the interface to implement the creation
41 of organizer manager engine instances.
42 \inmodule QtOrganizer
43 \ingroup organizer-backends
44
45 This class should only be used by backend developers. All the functions are only called internally
46 by QOrganizerManager, and should not be called by others.
47
48 More information on writing a organizer engine plugin is available in the \l{Qt Organizer Manager Engines}
49 documentation.
50
51 \sa QOrganizerManager, QOrganizerManagerEngine
52 */
53
54/*!
55 A default, empty destructor.
56 */
57QOrganizerManagerEngineFactory::~QOrganizerManagerEngineFactory()
58{
59}
60
61/*!
62 \fn QOrganizerManagerEngineFactory::engine(const QMap<QString, QString> &parameters, QOrganizerManager::Error *error)
63
64 This function should return an instance of the engine provided by this factory.
65
66 The \a parameters supplied can be ignored or interpreted as desired.
67
68 If a supplied parameter results in an unfulfillable request, or some other error occurs, this
69 function may return a null pointer, and the client developer will get an invalid QOrganizerManager
70 in return. Any error should be saved in \a error.
71 */
72
73/*!
74 \fn QOrganizerManagerEngineFactory::managerName() const
75
76 This function should return a unique string that identifies the engines provided by this factory.
77
78 Typically this would be of the form "org.qt-project.Qt.SampleOrganizerEngine", with the appropriate
79 domain and engine name substituted.
80 */
81
82/*!
83 \internal
84 */
85QStringList QOrganizerManagerEngineFactory::keys() const
86{
87 return QStringList() << managerName();
88}
89
90#include "moc_qorganizermanagerenginefactory.cpp"
91
92QT_END_NAMESPACE_ORGANIZER
93

source code of qtpim/src/organizer/qorganizermanagerenginefactory.cpp