diff options
author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2022-09-15 09:53:28 +0200 |
---|---|---|
committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2022-09-20 12:10:18 +0200 |
commit | 31c94ac5a7d905312e4459d44c24cbe5f105dc9d (patch) | |
tree | 7d8b5da2be4b2b78c63187f838134940225251e4 /src | |
parent | 4017f0ad8ccbade2121f24da3d82794272d56ade (diff) | |
download | qtlocation-31c94ac5a7d905312e4459d44c24cbe5f105dc9d.tar.gz |
Start with changes and porting documentation
Change-Id: I69531689995323ecbfd4014ff71e3d19858afbfc
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/location/doc/src/qt6-changes.qdoc | 86 | ||||
-rw-r--r-- | src/location/doc/src/qtlocation-changes.qdoc | 77 | ||||
-rw-r--r-- | src/location/doc/src/qtlocation.qdoc | 4 |
3 files changed, 88 insertions, 79 deletions
diff --git a/src/location/doc/src/qt6-changes.qdoc b/src/location/doc/src/qt6-changes.qdoc new file mode 100644 index 00000000..be9c9f77 --- /dev/null +++ b/src/location/doc/src/qt6-changes.qdoc @@ -0,0 +1,86 @@ +/**************************************************************************** +** +** Copyright (C) 2022 The Qt Company Ltd. +** Contact: https://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 https://www.qt.io/terms-conditions. For further +** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtlocation-changes-qt6.html + \title Changes to Qt Location + \ingroup changes-qt-5-to-6 + \brief Migrate Qt Location to Qt 6. + + Qt 6 is a result of the conscious effort to make the framework more + efficient and easy to use. + + We try to maintain binary and source compatibility for all the public + APIs in each release. But some changes were inevitable in an effort to + make Qt a better framework. + + In this topic we summarize those changes in Qt Location, and provide + guidance to handle them. + + \section1 Breaking public API changes + + \section2 Maps + + \list + \li The \c {MapRectangle::backend}, \c {MapCircle::backend}, + \c {MapPolyline::backend}, and \c {MapPolygon::backend} properties + have been removed. + \li The former QML element types \c Route, \c RouteSegment, and \c MapType + are now value types \l route, \l routeSegment, and \l mapType. + They can no longer be instantiated from QML, and their properties + can not be bound to. + \endlist + + \section2 Places + + \list + \li The \c {QPlaceImage}, {QPlaceEditorial}, and {QPlaceReview} classes + have been folded into \l QPlaceContent. + \li The \l QPlaceContent API has been changed to give access to a list of + QVariant values. + \endlist + + \list + \li The former QML element types \c PlaceUser, \c PlaceRatings, + \c PlaceAttribute, \c PlaceIcon, \c PlaceSupplier, and + \c PlaceContactDetail are now value types \l placeUser, + \l placeRatings, \l placeAttribute, \l placeIcon, + \l placeSupplier, and \l placeContactDetail. + They can no longer be instantiated from QML, and their properties + can not be bound to. + \endlist + + \section1 Other API changes + + \section2 Maps + + \section2 Places + + This section contains API improvements that do not break source + compatibility. However they might have an impact on the application logic, + so it is still useful to know about them. +*/ diff --git a/src/location/doc/src/qtlocation-changes.qdoc b/src/location/doc/src/qtlocation-changes.qdoc deleted file mode 100644 index 458c9e99..00000000 --- a/src/location/doc/src/qtlocation-changes.qdoc +++ /dev/null @@ -1,77 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://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 https://www.qt.io/terms-conditions. For further -** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.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 -*/ diff --git a/src/location/doc/src/qtlocation.qdoc b/src/location/doc/src/qtlocation.qdoc index 059d03f2..18e677b9 100644 --- a/src/location/doc/src/qtlocation.qdoc +++ b/src/location/doc/src/qtlocation.qdoc @@ -188,8 +188,8 @@ Qt Location available for a new platform. \li \l {Places Backend} {Places} \li Information for places backend implementors \row - \li \l {Qt Location QML API changes since 5.4}{API changes} - \li Information about QML API changes since 5.4 + \li \l {Changes to Qt Location}{API changes} + \li Information about porting from Qt 5 to Qt 6 \endtable \section1 Licenses and Attributions |