diff options
Diffstat (limited to 'src/location')
7 files changed, 50 insertions, 20 deletions
diff --git a/src/location/declarativemaps/qdeclarativegeomap.cpp b/src/location/declarativemaps/qdeclarativegeomap.cpp index 4f7c3945..1da71fb2 100644 --- a/src/location/declarativemaps/qdeclarativegeomap.cpp +++ b/src/location/declarativemaps/qdeclarativegeomap.cpp @@ -1303,7 +1303,7 @@ QGeoCoordinate QDeclarativeGeoMap::center() const \l zoomLevel of the map. Any previously set value to those properties will be overridden. - This property does not provide any change notifications. + \note Since Qt 5.14 This property provides change notifications. \since 5.6 */ diff --git a/src/location/declarativemaps/qdeclarativegeoroute.cpp b/src/location/declarativemaps/qdeclarativegeoroute.cpp index c536b65b..c1f5264b 100644 --- a/src/location/declarativemaps/qdeclarativegeoroute.cpp +++ b/src/location/declarativemaps/qdeclarativegeoroute.cpp @@ -385,9 +385,9 @@ QQmlPropertyMap *QDeclarativeGeoRoute::extendedAttributes() const /*! \qmlmethod bool QtLocation::Route::equals(Route other) - This method performs a deep comparison between this route and \a other. - - Returns \c true if the routes are considered equal, \c false otherwise. + This method performs deep comparison if the present route + is identical to the \a other route. + Returns \c true if the routes are equal. \since 5.12 */ diff --git a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp index f74557c0..bbfa9b57 100644 --- a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp +++ b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp @@ -117,8 +117,9 @@ static QList<QVariantMap> waypointMetadata(const QList<QDeclarativeGeoWaypoint * geographic routes from a backend provider. Routes include data about driving directions between two points, walking directions with multiple waypoints, and various other similar concepts. It functions much like other Model - types in QML (see for example \l {Models and Views in Qt Quick#Models}{ListModel}), - and interacts with views such as \l MapItemView, and \l{ListView}. + types in QML (see for example \l {Models and Views in Qt Quick#Models}{ListModel} + and \l {QtQuick.XmlListModel::XmlListModel}{XmlListModel}), and interacts with + views such as \l MapItemView, and \l{ListView}. Like \l Map and \l GeocodeModel, all the data for a RouteModel to work comes from a services plugin. This is contained in the \l{plugin} property, and @@ -243,11 +244,12 @@ void QDeclarativeGeoRouteModel::cancel() /*! \qmlmethod Route QtLocation::RouteModel::get(int index) - Returns the Route at given \a index. Use \l count property to check the - amount of routes available. The routes are indexed from zero, so the accessible range - is 0...(count - 1). + Returns the Route at the specified index \a int. Use the \l count + property to check the amount of routes available. The routes + are indexed from zero, so the accessible range is 0...(count - 1). - If you access out of bounds, a zero (null object) is returned and a warning is issued. + If you access out of bounds, a zero (null object) is returned and + a warning is issued. */ QDeclarativeGeoRoute *QDeclarativeGeoRouteModel::get(int index) @@ -993,8 +995,9 @@ void QDeclarativeGeoRouteQuery::setExcludedAreas(const QJSValue &value) /*! \qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle area) - Adds the given \a area to excluded areas (areas that the route must not cross). - Same area can only be added once. + Adds the specified \a georectangle from the excluded areas + (areas that the route must not cross). + The same area can only be added once. \sa removeExcludedArea, clearExcludedAreas */ @@ -1117,9 +1120,9 @@ void QDeclarativeGeoRouteQuery::addWaypoint(const QVariant &waypoint) /*! \qmlmethod void QtLocation::RouteQuery::removeWaypoint(coordinate) - Removes the given \a coordinate from the list of waypoints. If the same - coordinate appears multiple times, the most recently added coordinate - instance is removed. + Removes the given \a coordinate from the list of waypoints. If the + same coordinate appears multiple times, the most recently added + coordinate instance is removed. \sa addWaypoint, clearWaypoints */ @@ -1197,8 +1200,8 @@ void QDeclarativeGeoRouteQuery::flushWaypoints(QList<QDeclarativeGeoWaypoint *> /*! \qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType feature, FeatureWeight weight) - Defines the \a weight to associate with a \a feature during the planning of a - route. + Defines the weight (\a FeatureWeight) to associate with a feature + (\a FeatureType) during the planning of a route. Following lists the possible feature weights: diff --git a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp index 7a3873a4..86ff04af 100644 --- a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp +++ b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp @@ -413,7 +413,7 @@ void QDeclarativePolygonMapItem::setPath(const QJSValue &value) /*! \qmlmethod void MapPolygon::addCoordinate(coordinate) - Adds a \a coordinate to the path. + Adds the specified \a coordinate to the path. \sa removeCoordinate, path */ diff --git a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp index 5ca612db..10f3f0c3 100644 --- a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp +++ b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp @@ -860,7 +860,7 @@ int QDeclarativePolylineMapItem::pathLength() const /*! \qmlmethod void MapPolyline::addCoordinate(coordinate) - Adds a \a coordinate to the end of the path. + Adds the specified \a coordinate to the end of the path. \sa insertCoordinate, removeCoordinate, path */ diff --git a/src/location/doc/qtlocation.qdocconf b/src/location/doc/qtlocation.qdocconf index 0ffbe4d6..e5cf230b 100644 --- a/src/location/doc/qtlocation.qdocconf +++ b/src/location/doc/qtlocation.qdocconf @@ -33,7 +33,7 @@ qhp.QtLocation.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtlocation/qtlocation.tags -depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtquickcontrols qtlinguist qtxmlpatterns +depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtquickcontrols qtlinguist headerdirs += .. \ ../../imports/location diff --git a/src/location/labs/qdeclarativenavigator.cpp b/src/location/labs/qdeclarativenavigator.cpp index ae273774..b266779c 100644 --- a/src/location/labs/qdeclarativenavigator.cpp +++ b/src/location/labs/qdeclarativenavigator.cpp @@ -158,6 +158,33 @@ QT_BEGIN_NAMESPACE */ /*! + \qmlproperty bool Qt.labs.location::Navigator::automaticReroutingEnabled + + This property tells whether the Navigator should automatically recalculate + the route when the position from \l positionSource ends too far from the route. + The operation performed in such case is equivalent to calling \l recalculateRoutes. + The default value is \c true. + + \note Whether this property has any effect is plugin-dependent. + Also, whether or not it has an effect while the navigator is active is plugin-dependent. +*/ + +/*! + \qmlproperty bool Qt.labs.location::Navigator::isOnRoute + + While the Navigator is in active tracking mode, this property tells + whether the position from \l positionSource is on the route or not. +*/ + +/*! + \qmlmethod void Qt.labs.location::Navigator::recalculateRoutes() + + Calling this method forces the backend to trigger a routes recalculation. + + \sa automaticReroutingEnabled +*/ + +/*! \qmlproperty enumeration Qt.labs.location::Navigator::error \readonly |