summaryrefslogtreecommitdiff
path: root/src/location/doc/src/qtlocation-changes.qdoc
blob: 1330412dcffeb9d0ff2ce94b13b081f57efd66fc (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page qtlocation-changes.html
\title Qt Location QML API changes since 5.4
\brief Information about the Qt Location QML API changes since 5.4

This page lists the QtLocation QML API changes since the first Qt Location Technology Preview
in Qt 5.4. Since Qt 5.6 this API is considered to be final and subsequent releases will
not break the given API anymore.

\note The public C++ API remained binary compatible since Qt 5.4.

\b{\l{QtLocation::Map}{Map} Component}
\list
    \li removed wheelAngleChanged() signal
    \li added \l[QML]{QtLocation::Map::}{error} property
    \li added \l[QML]{QtLocation::Map::}{errorString} property
    \li added \l[QML]{QtLocation::Map::}{copyrightLinkActivated} signal
    \li removed toScreenPosition() method
    \li added \l[QML]{QtLocation::Map::}{fromCoordinate}() method
    \li replaced cameraStopped() method with \l[QML]{QtLocation::Map::}{prefetchData} method
    \li replaced fitViewportToGeoShape() method with \l[QML]{QtLocation::Map::}{visibleRegion} property
    \li added \l[QML]{QtLocation::Map::}{color} property
    \li added \l[QML]{QtLocation::Map::}{clearData} method
\endlist

\b{\l{QtLocation::MapGestureArea}{MapGestureArea} Component}
\list
 \li removed movementStopped() signal
 \li replaced isPanActive and isPinchActive properties with \l[QML]{QtLocation::MapGestureArea::}{panActive}
     and \l[QML]{QtLocation::MapGestureArea::}{pinchActive} properties
 \li replaced activeGestures with \l[QML]{QtLocation::MapGestureArea::}{acceptedGestures}
 \li replaced MapGestureArea.ZoomGesture with \l[QML]{QtLocation::MapGestureArea::acceptedGestures}{MapGestureArea.PinchGesture}
 \li removed properties panEnabled and pinchEnabled, please use \l[QML]{QtLocation::MapGestureArea::}{acceptedGestures} instead
\endlist

\b{\l{QtLocation::MapPolyline}{MapPolyline} Component}
\list
 \li added \l[QML]{QtLocation::MapPolyline::}{containsCoordinate} method
 \li added \l[QML]{QtLocation::MapPolyline::}{coordinateAt} method
 \li added \l[QML]{QtLocation::MapPolyline::}{insertCoordinate} method
 \li added \l[QML]{QtLocation::MapPolyline::}{replaceCoordinate} method
 \li added \l[QML]{QtLocation::MapPolyline::}{removeCoordinate} method
\endlist

\b Geoservice's plugin parameters
\list
    \li the \l{Qt Location HERE Plugin}{HERE} plugin uses the \c here prefix in front of each plugin parameter name
    \li the \l{Qt Location Open Street Map Plugin}{OSM} plugin uses the \c osm prefix in front of each plugin parameter name
\endlist
*/