diff options
author | Qt Forward Merge Bot <qt_forward_merge_bot@qt-project.org> | 2019-10-05 03:03:57 +0200 |
---|---|---|
committer | Qt Forward Merge Bot <qt_forward_merge_bot@qt-project.org> | 2019-10-05 03:03:57 +0200 |
commit | b44858e1e78820ce1139ee656a1892fb12c4799c (patch) | |
tree | 25a549413e57e096caa1b3a3b8240c4c91e8d5ec /src/location/declarativemaps/qdeclarativegeoroutemodel.cpp | |
parent | efdf3c266dce8791b78d1a851b16d2f4dbe8534e (diff) | |
parent | 25a220dd7370acdf04ee8f6d2d59f25d81cf42c7 (diff) | |
download | qtlocation-b44858e1e78820ce1139ee656a1892fb12c4799c.tar.gz |
Merge remote-tracking branch 'origin/5.14' into 5.15
Change-Id: I219a1353a21d29177e0cd7f21d64c06a8f28fced
Diffstat (limited to 'src/location/declarativemaps/qdeclarativegeoroutemodel.cpp')
-rw-r--r-- | src/location/declarativemaps/qdeclarativegeoroutemodel.cpp | 29 |
1 files changed, 16 insertions, 13 deletions
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: |