diff options
author | Ivan Solovev <ivan.solovev@qt.io> | 2021-11-02 18:27:22 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-11-11 12:40:56 +0000 |
commit | 396bfc7d5047d4b1490a38f9efa79d6229fafed6 (patch) | |
tree | c01eaf811aa33891a27772c69a95def9422e0a13 | |
parent | 7b15d32c2125a28c6c351bfa2d1a3eaeb5b93f13 (diff) |
Clarify QGeoPositionInfoSource::updateInterval usage on macOS/iOS
Unlike other platforms, on macOS/iOS this property does not allow to
tune the update interval. Extend the docs to explicitly mention it.
Change-Id: I938bec1a6c348f3b5c6140a28f84588e49bbaed9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
(cherry picked from commit 54c65f72b378cb13aba7bc146067b97ca5ec4a87)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/positioning/qgeopositioninfosource.cpp | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/positioning/qgeopositioninfosource.cpp b/src/positioning/qgeopositioninfosource.cpp index e09be54e..4aaa314a 100644 --- a/src/positioning/qgeopositioninfosource.cpp +++ b/src/positioning/qgeopositioninfosource.cpp @@ -262,6 +262,12 @@ QVariant QGeoPositionInfoSource::backendProperty(const QString &name) const \note Subclass implementations must call the base implementation of \c {setUpdateInterval()} so that \c {updateInterval()} returns the correct value. + + \note This property can't be used to tune update frequency on iOS and macOS, + because their APIs do not provide such possibility. On these systems this + parameter is only used to set \l UpdateTimeoutError and trigger an + \l errorOccurred signal if the update is not received within the desired + interval. */ void QGeoPositionInfoSource::setUpdateInterval(int msec) { |