summaryrefslogtreecommitdiff
path: root/src/location/maps
diff options
context:
space:
mode:
authorPaolo Angelelli <paolo.angelelli@qt.io>2018-12-04 17:56:21 +0100
committerPaolo Angelelli <paolo.angelelli@qt.io>2018-12-05 07:33:33 +0000
commit41e1fb33ab89a2b00927677cfec09ba6cf22e29d (patch)
tree6e17d2d591261f8da233466b67fd40df75c513b0 /src/location/maps
parent6de40d98a9f7c5402f211985e663ae1699e52e6f (diff)
downloadqtlocation-41e1fb33ab89a2b00927677cfec09ba6cf22e29d.tar.gz
Explain how to use QAbstractNavigator
Add a block of comment to explain implementors how to implement the API. Change-Id: Ib5e2aca11c8b3a91a958d1dc45573189e9ff5a81 Reviewed-by: Michael Brasser <michael.brasser@live.com> Reviewed-by: BogDan Vatra <bogdan@kdab.com>
Diffstat (limited to 'src/location/maps')
-rw-r--r--src/location/maps/qnavigationmanagerengine_p.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/location/maps/qnavigationmanagerengine_p.h b/src/location/maps/qnavigationmanagerengine_p.h
index 4ac459cc..e7b3876c 100644
--- a/src/location/maps/qnavigationmanagerengine_p.h
+++ b/src/location/maps/qnavigationmanagerengine_p.h
@@ -66,6 +66,12 @@ class QNavigationManagerEnginePrivate;
class QDeclarativeNavigatorParams;
class QDeclarativeGeoWaypoint;
+/*
+ This class is not supposed to react on QDeclarativeNavigator properties changes.
+ This class is meant to react only on start, stop and setTrackPosition.
+ Upon start(), it is supposed to fetch all info from the QDeclarativeNavigatorParams that the engine is supposed
+ to inject.
+*/
class Q_LOCATION_PRIVATE_EXPORT QAbstractNavigator: public QObject
{
Q_OBJECT