summaryrefslogtreecommitdiffstats
path: root/src/location/landmarks/qlandmarkmanager.h
blob: 4b94860012b7d326e1bfb115b9154a16bbd39bd2 (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
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/****************************************************************************
**
** 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$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, 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, Digia gives you certain additional
** rights.  These rights are described in the Digia 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.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QLANDMARKMANAGER_H
#define QLANDMARKMANAGER_H

#include "qmobilityglobal.h"
#include "qlandmarkid.h"
#include "qlandmarkfilter.h"
#include "qlandmarksortorder.h"
#include "qlandmarkcategoryid.h"
#include "qlandmarknamesort.h"
#include "qlandmarkfilter.h"
#include "qlandmarkcategory.h"
#include "qlandmark.h"

#include <qlatin1constant.h>
#include <QObject>
#include <QMap>
class QIODevice;
class QStringList;

QTM_BEGIN_NAMESPACE
class QLandmarkManagerPrivate;
class QLandmarkManagerEngine;

class Q_LOCATION_EXPORT QLandmarkManager: public QObject
{
    Q_OBJECT
public:
    enum Error {
        NoError = 0,
        DoesNotExistError,
        LandmarkDoesNotExistError,
        CategoryDoesNotExistError,
        AlreadyExistsError,
        LockedError,
        PermissionsError,
        OutOfMemoryError,
        VersionMismatchError,
        NotSupportedError,
        BadArgumentError,
        InvalidManagerError,
        ParsingError,
        CancelError,
        UnknownError,
    };

    enum SupportLevel {
        NativeSupport,
        EmulatedSupport,
        NoSupport
    };

    enum ManagerFeature {
        ImportExportFeature,
        NotificationsFeature
    };


    enum TransferOption {
        IncludeCategoryData,
        ExcludeCategoryData,
        AttachSingleCategory
    };

    enum TransferOperation {
        ImportOperation,
        ExportOperation
    };

#ifdef Q_QDOC
    static const QLatin1Constant Gpx;
    static const QLatin1Constant Lmx;
    static const QLatin1Constant Kml;
    static const QLatin1Constant Kmz;
#else
    Q_DECLARE_LATIN1_CONSTANT(Gpx, "Gpx");
    Q_DECLARE_LATIN1_CONSTANT(Lmx, "Lmx");
    Q_DECLARE_LATIN1_CONSTANT(Kml, "Kml");
    Q_DECLARE_LATIN1_CONSTANT(Kmz, "Kmz");
#endif

#ifdef Q_QDOC
    QLandmarkManager(QObject *parent = 0);
    QLandmarkManager(const QString &managerName, const QMap<QString, QString> &parameters = 0, QObject *parent = 0);
#else
    QLandmarkManager(QObject *parent = 0);
    QLandmarkManager(const QString &managerName, const QMap<QString, QString>& parameters = (QMap<QString, QString>()), QObject *parent = 0);
#endif
    virtual ~QLandmarkManager();

    bool saveLandmark(QLandmark *landmark);
    bool saveLandmarks(QList<QLandmark> *landmarks);

    bool removeLandmark(const QLandmarkId &landmarkId);
    bool removeLandmark(const QLandmark &landmark);

    bool removeLandmarks(const QList<QLandmarkId> &landmarksIds);
    bool removeLandmarks(const QList<QLandmark> &landmarks);

    bool saveCategory(QLandmarkCategory *category);
    bool removeCategory(const QLandmarkCategoryId &categoryId);
    bool removeCategory(const QLandmarkCategory &category);

    QLandmarkCategory category(const QLandmarkCategoryId &categoryId) const;
    QList<QLandmarkCategory> categories(const QList<QLandmarkCategoryId> &categoryIds) const;

    QList<QLandmarkCategory> categories( int limit=-1, int offset=0, const QLandmarkNameSort &nameSort = QLandmarkNameSort()) const;
    QList<QLandmarkCategoryId> categoryIds(int limit =-1, int offset=0, const QLandmarkNameSort &nameSort = QLandmarkNameSort()) const;

    QLandmark landmark(const QLandmarkId &landmarkId) const;
    QList<QLandmark> landmarks(const QLandmarkFilter &filter,
                                int limit, int offset,
                                const QList<QLandmarkSortOrder>& sortOrders) const;
    QList<QLandmark> landmarks(const QLandmarkFilter &filter = QLandmarkFilter(),
                            int limit=-1, int offset=0,
                            const QLandmarkSortOrder &sortOrder = QLandmarkSortOrder()) const;

    QList<QLandmark> landmarks(const QList<QLandmarkId> &landmarkIds) const;
    QList<QLandmarkId> landmarkIds(const QLandmarkFilter &filter,
                                    int limit, int offset,
                                   const QList<QLandmarkSortOrder> &sortOrders)const;
    QList<QLandmarkId> landmarkIds(const QLandmarkFilter &filter = QLandmarkFilter(),
                                    int limit=-1, int offset =0,
                                   const QLandmarkSortOrder &sortOrder = QLandmarkSortOrder()) const;

    bool importLandmarks(QIODevice *device, const QString &format= QString() ,QLandmarkManager::TransferOption option = IncludeCategoryData, const QLandmarkCategoryId& = QLandmarkCategoryId());
    bool importLandmarks(const QString &fileName, const QString &format = QString(),QLandmarkManager::TransferOption option = IncludeCategoryData, const QLandmarkCategoryId& = QLandmarkCategoryId());
    bool exportLandmarks(QIODevice *device, const QString &format, const QList<QLandmarkId> &landmarkIds = QList<QLandmarkId>(), QLandmarkManager::TransferOption option = IncludeCategoryData) const;
    bool exportLandmarks(const QString &, const QString &format, const QList<QLandmarkId> &landmarkIds = QList<QLandmarkId>(), QLandmarkManager::TransferOption option = IncludeCategoryData) const;

    QStringList supportedFormats(TransferOperation operation) const;

    Error error() const;
    QString errorString() const;
    QMap<int, QLandmarkManager::Error> errorMap() const;

    bool isFeatureSupported(ManagerFeature feature) const;
    SupportLevel filterSupportLevel(const QLandmarkFilter &filter) const;
    SupportLevel sortOrderSupportLevel(const QLandmarkSortOrder &sortOrder) const;

    bool isReadOnly() const;
    bool isReadOnly(const QLandmarkId &id) const;
    bool isReadOnly(const QLandmarkCategoryId &id) const;

    QStringList searchableLandmarkAttributeKeys() const;

    QString managerName() const;
    QMap<QString, QString> managerParameters() const;
    QString managerUri() const;
    int managerVersion() const;

    static QStringList availableManagers();
    static QString buildUri(const QString& managerName, const QMap<QString, QString>& params,int implementationVersion = -1);
    static QLandmarkManager* fromUri(const QString& uri, QObject* parent = 0);
    static bool parseUri(const QString& uri, QString* managerName, QMap<QString, QString>* params);

Q_SIGNALS:
    void dataChanged();
    void landmarksAdded(const QList<QLandmarkId> &landmarkIds);
    void landmarksChanged(const QList<QLandmarkId> &landmarkIds);
    void landmarksRemoved(const QList<QLandmarkId> &landmarkIds);

    void categoriesAdded(const QList<QLandmarkCategoryId> &categoryIds);
    void categoriesChanged(const QList<QLandmarkCategoryId> &categoryIds);
    void categoriesRemoved(const QList<QLandmarkCategoryId> &categoryIds);

protected:
    void connectNotify(const char *signal);
    void disconnectNotify(const char *signal);

private:
    QLandmarkManagerPrivate *d_ptr;
    Q_DECLARE_PRIVATE(QLandmarkManager)
    friend class QLandmarkAbstractRequest;
    QLandmarkManagerEngine *engine();
};

QTM_END_NAMESPACE

#endif