summaryrefslogtreecommitdiff
path: root/src/location/places/qplacemanagerenginefactory.cpp
blob: fe6b3e6a9125c5af4cc53b0c0e4de6a83c617a8a (plain)
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
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $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 "qplacemanagerenginefactory.h"

QT_BEGIN_NAMESPACE

/*!
    \class QPlaceManagerEngineFactory
    \brief The QPlaceManagerEngineFactory class provides the interface for
    plugins that implement QPlaceManagerEngine functionality.

    \inmodule QtLocation

    \ingroup places-backend

    This class provides a simple interface for the creation of
    place manager engine instances.  Each factory has a specific id
    associated with it, which forms the \c managerName parameter
    when creating \l QPlaceManager objects.

  \sa QPlaceManager, QPlaceManagerEngine
 */

/*!
  Destroys the engine factory.
 */
QPlaceManagerEngineFactory::~QPlaceManagerEngineFactory()
{
}


/*!
    \fn QPlaceManagerEngineFactory::managerName() const

    This function returns a unique string that identifies
    the engine provided by this factory.
*/

/*!
    \fn QPlaceManagerEngineFactory::engine(const QMap<QString, QString>& parameters,
                                           QPlaceManager::Error *error,
                                           QString *errorString)

    This function is called by the QPlaceManager 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 QPlaceManager in return.  Errors are stored in \a error and \a errorString.
 */

QT_END_NAMESPACE