summaryrefslogtreecommitdiffstats
path: root/plugins/landmarks/symbian_landmarks/inc/qlandmarkmanagerengine_symbian.h
blob: ac2ff14b47d1accdada0cb889f94366db8660f07 (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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/****************************************************************************
 **
 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 ** All rights reserved.
 ** Contact: Nokia Corporation (qt-info@nokia.com)
 **
 ** 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$
 **
 ****************************************************************************/

#ifndef QLANDMARKMANAGERENGINE_SYMBIAN_H
#define QLANDMARKMANAGERENGINE_SYMBIAN_H

//
// QT LANDMARK MANAGER ENGINE IMPLEMENTATION
// -----------------------------------------
//
// This file exists implementation detail of QLandmarkManagerEngine class.  
// This header file may change from version to version without notice, or even be removed.
//
// We mean it.
//------------------------------------------
//
//system includes
#include <qglobal.h>
#include <qlandmarkmanagerengine.h>

QTM_USE_NAMESPACE
typedef QMap<int, QLandmarkManager::Error> ERROR_MAP;

// farward declarations
class LandmarkManagerEngineSymbianPrivate;

/***
 * 
 */
class LandmarkEventObserver
{
public:
    enum lmEvent
    {
        landmarkAdded = 0,
        landmarkUpdated,
        landmarkRemoved,
        categoryAdded,
        categoryUpdated,
        categoryRemoved,
        unknownChanges
    };

public:
    virtual void handleLandmarkEvent(LandmarkEventObserver::lmEvent event,
        QList<QLandmarkId> landmarkIds = QList<QLandmarkId> (),
        QList<QLandmarkCategoryId> categoryIds = QList<QLandmarkCategoryId> ()) = 0;
};

/***
 * 
 */
class QLandmarkManagerEngineSymbian: public QLandmarkManagerEngine, public LandmarkEventObserver
{
Q_OBJECT
public:
    QLandmarkManagerEngineSymbian(const QString &filename = QString());
    ~QLandmarkManagerEngineSymbian();

    /* URI reporting */
    QString managerName() const; // e.g. "com.nokia.qt.landmarks.engines.symbian"
    QMap<QString, QString> managerParameters() const; // e.g. "filename=private.db"
    int managerVersion() const;

    QString managerUri() const;

    /* Filtering */
    QList<QLandmarkId> landmarkIds(const QLandmarkFilter &filter, int limit, int offset,
        const QList<QLandmarkSortOrder>& sortOrders, QLandmarkManager::Error *error,
        QString *errorString) const;
    QList<QLandmarkCategoryId>
    categoryIds(int limit, int offset, const QLandmarkNameSort &nameSort,
        QLandmarkManager::Error *error, QString *errorString) const;

    /* Retrieval */
    QLandmark landmark(const QLandmarkId &landmarkId, QLandmarkManager::Error *error,
        QString *errorString) const;

    QList<QLandmark>
    landmarks(const QList<QLandmarkId> &landmarkIds, QMap<int, QLandmarkManager::Error> *errorMap,
        QLandmarkManager::Error *error, QString *errorString) const;
    QList<QLandmark> landmarks(const QLandmarkFilter &filter, int limit, int offset, const QList<
        QLandmarkSortOrder>& sortOrders, QLandmarkManager::Error *error, QString *errorString) const;

    QLandmarkCategory category(const QLandmarkCategoryId &landmarkCategoryId,
        QLandmarkManager::Error *error, QString *errorString) const;

    QList<QLandmarkCategory> categories(const QList<QLandmarkCategoryId> &landmarkCategoryIds,
        QMap<int, QLandmarkManager::Error> *errorMap, QLandmarkManager::Error *error,
        QString *errorString) const;
    QList<QLandmarkCategory> categories(int limit, int offset, const QLandmarkNameSort &nameSort,
        QLandmarkManager::Error *error, QString *errorString) const;

    /*saving and removing*/
    bool saveLandmark(QLandmark* landmark, QLandmarkManager::Error *error, QString *errorString);
    bool saveLandmarks(QList<QLandmark> * landmark, QMap<int, QLandmarkManager::Error> *errorMap,
        QLandmarkManager::Error *error, QString *errorString);
    bool removeLandmark(const QLandmarkId &landmarkId, QLandmarkManager::Error *error,
        QString *errorString);
    bool removeLandmarks(const QList<QLandmarkId> &landmarkId,
        QMap<int, QLandmarkManager::Error> *errorMap, QLandmarkManager::Error *error,
        QString *errorString);

    bool saveCategory(QLandmarkCategory* category, QLandmarkManager::Error *error,
        QString *errorString);
    bool removeCategory(const QLandmarkCategoryId &categoryId, QLandmarkManager::Error *error,
        QString *errorString);

    bool importLandmarks(QIODevice *device, const QString& format,
        QLandmarkManager::TransferOption option, const QLandmarkCategoryId& id,
        QLandmarkManager::Error *error, QString *errorString);
    bool exportLandmarks(QIODevice *device, const QString& format, const QList<QLandmarkId> &landmarkIds,
        QLandmarkManager::TransferOption option, QLandmarkManager::Error *error,
        QString *errorString) const;
    QStringList supportedFormats(QLandmarkManager::TransferOperation operation,
        QLandmarkManager::Error *error, QString *errorString) const;

    QLandmarkManager::SupportLevel filterSupportLevel(const QLandmarkFilter &filter,
        QLandmarkManager::Error *error, QString *errorString) const;
    QLandmarkManager::SupportLevel sortOrderSupportLevel(
        const QLandmarkSortOrder &sortOrder, QLandmarkManager::Error *error,
        QString *errorString) const;

    bool isFeatureSupported(QLandmarkManager::ManagerFeature feature,
        QLandmarkManager::Error *error, QString *errorString) const;

    bool isReadOnly(QLandmarkManager::Error *error, QString *errorString) const;
    bool isReadOnly(const QLandmarkId &landmarkId, QLandmarkManager::Error *error,
        QString *errorString) const;
    bool isReadOnly(const QLandmarkCategoryId &categoryId, QLandmarkManager::Error *error,
        QString *errorString) const;

    /* Asynchronous Request Support */
    void requestDestroyed(QLandmarkAbstractRequest* request);
    bool startRequest(QLandmarkAbstractRequest* request);
    bool cancelRequest(QLandmarkAbstractRequest* request);
    bool waitForRequestFinished(QLandmarkAbstractRequest* request, int msecs);

public:
    QStringList landmarkAttributeKeys(QLandmarkManager::Error *error, QString *errorString) const;
    QStringList categoryAttributeKeys(QLandmarkManager::Error *error, QString *errorString) const;
    QStringList searchableLandmarkAttributeKeys(QLandmarkManager::Error *error,
        QString *errorString) const;
public:

    static void updateLandmarkIdFetchRequest(QLandmarkIdFetchRequest* req,
        const QList<QLandmarkId>& result, QLandmarkManager::Error error,
        const QString &errorString, QLandmarkAbstractRequest::State newState);

    static void updateLandmarkFetchRequest(QLandmarkFetchRequest* req,
        const QList<QLandmark>& result, QLandmarkManager::Error error, const QString &errorString,
        QLandmarkAbstractRequest::State newState);

    static void updateLandmarkSaveRequest(QLandmarkSaveRequest* req,
        const QList<QLandmark>& result, QLandmarkManager::Error error, const QString &errorString,
        const ERROR_MAP &errorMap, QLandmarkAbstractRequest::State newState);

    static void updateLandmarkRemoveRequest(QLandmarkRemoveRequest* req,
        QLandmarkManager::Error error, const QString &errorString, const ERROR_MAP &errorMap,
        QLandmarkAbstractRequest::State newState);

    static void updateLandmarkCategoryIdFetchRequest(QLandmarkCategoryIdFetchRequest *req,
        const QList<QLandmarkCategoryId>& result, QLandmarkManager::Error error,
        const QString &errorString, QLandmarkAbstractRequest::State newState);

    static void updateLandmarkCategoryFetchRequest(QLandmarkCategoryFetchRequest *req, const QList<
        QLandmarkCategory>& result, QLandmarkManager::Error error, const QString &errorString,
        QLandmarkAbstractRequest::State newState);

    static void updateLandmarkCategorySaveRequest(QLandmarkCategorySaveRequest* req, const QList<
        QLandmarkCategory> &categories, QLandmarkManager::Error error, const QString &errorString,
        const ERROR_MAP &errorMap, QLandmarkAbstractRequest::State newState);

    static void updateLandmarkCategoryRemoveRequest(QLandmarkCategoryRemoveRequest* req,
        QLandmarkManager::Error error, const QString &errorString, const ERROR_MAP &errorMap,
        QLandmarkAbstractRequest::State newState);

    static void updateLandmarkFetchByIdRequest(QLandmarkFetchByIdRequest* req, const QList<
        QLandmark>& result, QLandmarkManager::Error error, const QString &errorString,
        const ERROR_MAP & errorMap, QLandmarkAbstractRequest::State newState);

    static void updateLandmarkCategoryFetchByIdRequest(QLandmarkCategoryFetchByIdRequest *req,
        const QList<QLandmarkCategory>& result, QLandmarkManager::Error error,
        const QString &errorString, const ERROR_MAP & errorMap,
        QLandmarkAbstractRequest::State newState);

    static void updateLandmarkImportRequest(QLandmarkImportRequest *req,
        const QList<QLandmarkId> &ids, QLandmarkManager::Error error, const QString &errorString,
        QLandmarkAbstractRequest::State newState);

    static void updateLandmarkExportRequest(QLandmarkExportRequest *req,
        QLandmarkManager::Error error, const QString &errorString,
        QLandmarkAbstractRequest::State newState);

    static void updateRequestState(QLandmarkAbstractRequest *req,
        QLandmarkAbstractRequest::State state);

    static QList<QLandmarkId> sortLandmarks(const QList<QLandmark>& landmarks, const QList<
        QLandmarkSortOrder> &sortOrders);

public:
    void handleLandmarkEvent(LandmarkEventObserver::lmEvent event, QList<QLandmarkId> landmarkIds,
        QList<QLandmarkCategoryId> categoryIds);

private:
    /**
     * POinter to the LandmarkManagerEngineSymbianPrivate
     * Owns
     */
    LandmarkManagerEngineSymbianPrivate* d_ptr;

};

#endif // QLANDMARKMANAGERENGINE_SYMBIAN_H
// end of file