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 QtLocation module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL3$
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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPLv3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or later as published by the Free
28 ** Software Foundation and appearing in the file LICENSE.GPL included in
29 ** the packaging of this file. Please review the following information to
30 ** ensure the GNU General Public License version 2.0 requirements will be
31 ** met: http://www.gnu.org/licenses/gpl-2.0.html.
32 **
33 ** $QT_END_LICENSE$
34 **
35 ****************************************************************************/
36 
37 #ifndef QGEOCODEREPLY_H
38 #define QGEOCODEREPLY_H
39 
40 #include <QtCore/QObject>
41 #include <QtCore/QList>
42 #include <QtPositioning/QGeoLocation>
43 
44 #include <QtLocation/qlocationglobal.h>
45 
46 QT_BEGIN_NAMESPACE
47 
48 class QGeoShape;
49 class QGeoCodeReplyPrivate;
50 
51 class Q_LOCATION_EXPORT QGeoCodeReply : public QObject
52 {
53     Q_OBJECT
54 
55 public:
56     enum Error {
57         NoError,
58         EngineNotSetError,
59         CommunicationError,
60         ParseError,
61         UnsupportedOptionError,
62         CombinationError,
63         UnknownError
64     };
65 
66     explicit QGeoCodeReply(Error error, const QString &errorString, QObject *parent = nullptr);
67     virtual ~QGeoCodeReply();
68 
69     bool isFinished() const;
70     Error error() const;
71     QString errorString() const;
72 
73     QGeoShape viewport() const;
74     QList<QGeoLocation> locations() const;
75 
76     int limit() const;
77     int offset() const;
78 
79     virtual void abort();
80 
81 Q_SIGNALS:
82     void finished();
83     void aborted();
84     void error(QGeoCodeReply::Error error, const QString &errorString = QString());
85 
86 protected:
87     explicit QGeoCodeReply(QObject *parent = nullptr);
88     explicit QGeoCodeReply(QGeoCodeReplyPrivate &dd, QObject *parent = nullptr);
89 
90     void setError(Error error, const QString &errorString);
91     void setFinished(bool finished);
92 
93     void setViewport(const QGeoShape &viewport);
94     void addLocation(const QGeoLocation &location);
95     void setLocations(const QList<QGeoLocation> &locations);
96 
97     void setLimit(int limit);
98     void setOffset(int offset);
99 
100 private:
101     QGeoCodeReplyPrivate *d_ptr;
102     Q_DISABLE_COPY(QGeoCodeReply)
103     friend class QGeoCodeReplyPrivate;
104 };
105 
106 QT_END_NAMESPACE
107 
108 #endif
109