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
|
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** 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 The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later 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 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QDECLARATIVENAVIGATOR_P_H
#define QDECLARATIVENAVIGATOR_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtLocation/private/qlocationglobal_p.h>
#include <QtQml/qqml.h>
#include <QSharedPointer>
#include <QtLocation/private/qparameterizableobject_p.h>
#include <QtLocation/qgeoserviceprovider.h>
Q_MOC_INCLUDE(<QtLocation/private/qdeclarativenavigator_p_p.h>)
Q_MOC_INCLUDE(<QtLocation/private/qdeclarativegeomap_p.h>)
Q_MOC_INCLUDE(<QtLocation/private/qdeclarativegeoroute_p.h>)
Q_MOC_INCLUDE(<QtLocation/private/qdeclarativegeoserviceprovider_p.h>)
Q_MOC_INCLUDE(<QtLocation/private/qnavigationmanagerengine_p.h>)
Q_MOC_INCLUDE(<QtPositioningQuick/private/qdeclarativepositionsource_p.h>)
QT_BEGIN_NAMESPACE
class QDeclarativeGeoServiceProvider;
class QDeclarativeGeoMap;
class QNavigationManager;
class QDeclarativeGeoRoute;
class QDeclarativeGeoRouteLeg;
class QDeclarativePositionSource;
class QDeclarativeGeoWaypoint;
class QGeoRoute;
class QGeoRouteLeg;
class QGeoRouteSegment;
class QDeclarativeNavigatorPrivate;
class QDeclarativeGeoRouteSegment;
class QDeclarativeNavigationBasicDirections;
class QAbstractNavigator;
class Q_LOCATION_PRIVATE_EXPORT QDeclarativeNavigator : public QParameterizableObject, public QQmlParserStatus
{
Q_OBJECT
Q_PROPERTY(QDeclarativeGeoServiceProvider *plugin READ plugin WRITE setPlugin NOTIFY pluginChanged)
Q_PROPERTY(QDeclarativeGeoMap *map READ map WRITE setMap NOTIFY mapChanged)
Q_PROPERTY(QDeclarativeGeoRoute *route READ route WRITE setRoute NOTIFY routeChanged)
Q_PROPERTY(QDeclarativePositionSource *positionSource READ positionSource WRITE setPositionSource NOTIFY positionSourceChanged)
Q_PROPERTY(bool active READ active WRITE setActive NOTIFY activeChanged)
Q_PROPERTY(bool navigatorReady READ navigatorReady NOTIFY navigatorReadyChanged)
Q_PROPERTY(bool trackPositionSource READ trackPositionSource WRITE setTrackPositionSource NOTIFY trackPositionSourceChanged)
Q_PROPERTY(bool automaticReroutingEnabled READ automaticReroutingEnabled WRITE setAutomaticReroutingEnabled NOTIFY automaticReroutingEnabledChanged)
Q_PROPERTY(bool isOnRoute READ isOnRoute NOTIFY isOnRouteChanged)
Q_PROPERTY(QDeclarativeNavigationBasicDirections *directions READ directions CONSTANT)
Q_PROPERTY(NavigationError error READ error NOTIFY errorChanged)
Q_PROPERTY(QString errorString READ errorString NOTIFY errorChanged)
Q_PROPERTY(QAbstractNavigator *engineHandle READ abstractNavigator CONSTANT)
Q_INTERFACES(QQmlParserStatus)
public:
enum NavigationError {
//QGeoServiceProvider related errors start here
NoError = QGeoServiceProvider::NoError,
NotSupportedError = QGeoServiceProvider::NotSupportedError, //TODO Qt6 consider merge with NotSupportedError
ConnectionError = QGeoServiceProvider::ConnectionError, //TODO Qt6 merge with Map's ConnectionError
LoaderError = QGeoServiceProvider::LoaderError,
UnknownParameterError = QGeoServiceProvider::UnknownParameterError, //TODO Qt6 consider rename UnsupportedOperationError
MissingRequiredParameterError = QGeoServiceProvider::MissingRequiredParameterError,
//we leave gap for future QGeoCodeReply errors
// Navigation-specific error should start at 100
UnknownError = 100
};
explicit QDeclarativeNavigator(QObject *parent = nullptr);
~QDeclarativeNavigator();
// QQmlParserStatus interface
void classBegin() override;
void componentComplete() override;
// QDeclarativeNavigator
void start();
void stop();
void setActive(bool active);
bool active() const;
void setPlugin(QDeclarativeGeoServiceProvider * plugin);
QDeclarativeGeoServiceProvider *plugin() const;
void setMap(QDeclarativeGeoMap *map);
QDeclarativeGeoMap * map() const;
void setRoute(QDeclarativeGeoRoute *route);
QDeclarativeGeoRoute *route() const;
void setPositionSource(QDeclarativePositionSource *positionSource);
QDeclarativePositionSource *positionSource() const;
// To enable/disable automatic route recalculation in the engines
bool automaticReroutingEnabled() const;
void setAutomaticReroutingEnabled(bool autoRerouting);
bool navigatorReady() const;
void setTrackPositionSource(bool trackPositionSource);
bool trackPositionSource() const;
// To discover/notify when the tracked position goes off the active navigation route
bool isOnRoute() const;
QDeclarativeNavigationBasicDirections *directions() const;
QAbstractNavigator *abstractNavigator() const;
NavigationError error() const;
QString errorString() const;
Q_INVOKABLE void recalculateRoutes();
signals:
void navigatorReadyChanged(bool ready);
void trackPositionSourceChanged(bool trackPositionSource);
void activeChanged(bool active);
void pluginChanged();
void mapChanged();
void routeChanged();
void positionSourceChanged();
void errorChanged();
void automaticReroutingEnabledChanged();
void isOnRouteChanged();
protected:
void pluginReady();
bool ensureEngine();
void updateReadyState();
void setError(NavigationError error, const QString &errorString);
private:
QScopedPointer<QDeclarativeNavigatorPrivate> d_ptr;
friend class QDeclarativeNavigatorPrivate;
friend class QDeclarativeNavigationBasicDirections;
};
QT_END_NAMESPACE
QML_DECLARE_TYPE(QDeclarativeNavigator)
#endif // QDECLARATIVENAVIGATOR_P_H
|
