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 QDECLARATIVEGEOMANEUVER_H
38 #define QDECLARATIVEGEOMANEUVER_H
39 
40 //
41 //  W A R N I N G
42 //  -------------
43 //
44 // This file is not part of the Qt API.  It exists purely as an
45 // implementation detail.  This header file may change from version to
46 // version without notice, or even be removed.
47 //
48 // We mean it.
49 //
50 
51 #include <QtLocation/private/qlocationglobal_p.h>
52 #include <QtLocation/qgeomaneuver.h>
53 #include <QtQml/QQmlPropertyMap>
54 #include <QtPositioning/QGeoCoordinate>
55 
56 #include <QObject>
57 
58 
59 QT_BEGIN_NAMESPACE
60 
61 class Q_LOCATION_PRIVATE_EXPORT QDeclarativeGeoManeuver : public QObject
62 {
63     Q_OBJECT
64     Q_ENUMS(Direction)
65 
66     Q_PROPERTY(bool valid READ valid CONSTANT)
67     Q_PROPERTY(QGeoCoordinate position READ position CONSTANT)
68     Q_PROPERTY(QString instructionText READ instructionText CONSTANT)
69     Q_PROPERTY(Direction direction READ direction CONSTANT)
70     Q_PROPERTY(int timeToNextInstruction READ timeToNextInstruction CONSTANT)
71     Q_PROPERTY(qreal distanceToNextInstruction READ distanceToNextInstruction CONSTANT)
72     Q_PROPERTY(QGeoCoordinate waypoint READ waypoint CONSTANT)
73     Q_PROPERTY(bool waypointValid READ waypointValid CONSTANT)
74     Q_PROPERTY(QObject *extendedAttributes READ extendedAttributes NOTIFY extendedAttributesChanged REVISION 11)
75 
76 public:
77     enum Direction {
78         NoDirection = QGeoManeuver::NoDirection,
79         DirectionForward = QGeoManeuver::DirectionForward,
80         DirectionBearRight = QGeoManeuver::DirectionBearRight,
81         DirectionLightRight = QGeoManeuver::DirectionLightRight,
82         DirectionRight = QGeoManeuver::DirectionRight,
83         DirectionHardRight = QGeoManeuver::DirectionHardRight,
84         DirectionUTurnRight = QGeoManeuver::DirectionUTurnRight,
85         DirectionUTurnLeft = QGeoManeuver::DirectionUTurnLeft,
86         DirectionHardLeft = QGeoManeuver::DirectionHardLeft,
87         DirectionLeft = QGeoManeuver::DirectionLeft,
88         DirectionLightLeft = QGeoManeuver::DirectionLightLeft,
89         DirectionBearLeft = QGeoManeuver::DirectionBearLeft
90     };
91 
92     explicit QDeclarativeGeoManeuver(QObject *parent = 0);
93     QDeclarativeGeoManeuver(const QGeoManeuver &maneuver, QObject *parent = 0);
94     ~QDeclarativeGeoManeuver();
95 
96     bool valid() const;
97     bool waypointValid() const;
98 
99     QGeoCoordinate position() const;
100     QString instructionText() const;
101     Direction direction() const;
102     int timeToNextInstruction() const;
103     qreal distanceToNextInstruction() const;
104     QGeoCoordinate waypoint() const;
105     QQmlPropertyMap *extendedAttributes() const;
106 
107 Q_SIGNALS:
108     void extendedAttributesChanged();   //in practice is never emitted since parameters cannot be re-assigned
109                                         //the declaration is needed to avoid warnings about non-notifyable properties
110 
111 private:
112     QGeoManeuver maneuver_;
113     QQmlPropertyMap *m_extendedAttributes = nullptr;
114 };
115 
116 QT_END_NAMESPACE
117 
118 #endif
119