summaryrefslogtreecommitdiff
path: root/src/location/qgeopositioninfosource.cpp
diff options
context:
space:
mode:
authorDavid Laing <david.laing@nokia.com>2011-06-07 15:01:04 +1000
committerDavid Laing <david.laing@nokia.com>2011-06-07 15:01:04 +1000
commit0acfa951558d0f1768537dbe058069aafe9ab4e6 (patch)
treec236b2cb13adda7330517799c33f11bf1e655653 /src/location/qgeopositioninfosource.cpp
parent06dd9db5b1d807b9fcd323700d3543421935a54c (diff)
downloadqtlocation-0acfa951558d0f1768537dbe058069aafe9ab4e6.tar.gz
Adds changes from Qt Mobility Location repository.
There have been bug and documentation fixes applied to the Qt Mobility repository since Qt Location was moved to the Qt 5 repository. This commit is the result of a manual merge of those changes, with care taken to try to avoid undoing any changes made when Qt Location was moved into the Qt repo.
Diffstat (limited to 'src/location/qgeopositioninfosource.cpp')
-rw-r--r--src/location/qgeopositioninfosource.cpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/location/qgeopositioninfosource.cpp b/src/location/qgeopositioninfosource.cpp
index c1992d13..b11b8f7d 100644
--- a/src/location/qgeopositioninfosource.cpp
+++ b/src/location/qgeopositioninfosource.cpp
@@ -314,6 +314,7 @@ QGeoPositionInfoSource::~QGeoPositionInfoSource()
Note: Subclass implementations must call the base implementation of
setUpdateInterval() so that updateInterval() returns the correct value.
+ \since 1.0
*/
void QGeoPositionInfoSource::setUpdateInterval(int msec)
{
@@ -337,6 +338,7 @@ int QGeoPositionInfoSource::updateInterval() const
\bold {Note:} When reimplementing this method, subclasses must call the
base method implementation to ensure preferredPositioningMethods() returns the correct value.
+ \since 1.0
\sa supportedPositioningMethods()
*/
void QGeoPositionInfoSource::setPreferredPositioningMethods(PositioningMethods methods)
@@ -349,6 +351,7 @@ void QGeoPositionInfoSource::setPreferredPositioningMethods(PositioningMethods m
/*!
Returns the positioning methods set by setPreferredPositioningMethods().
+ \since 1.0
*/
QGeoPositionInfoSource::PositioningMethods QGeoPositionInfoSource::preferredPositioningMethods() const
{
@@ -365,6 +368,7 @@ QGeoPositionInfoSource::PositioningMethods QGeoPositionInfoSource::preferredPosi
Note: Symbian applications will need to have the Location capability
otherwise this will return 0.
+ \since 1.0
*/
QGeoPositionInfoSource *QGeoPositionInfoSource::createDefaultSource(QObject *parent)
@@ -465,6 +469,7 @@ QStringList QGeoPositionInfoSource::availableSources()
If \a fromSatellitePositioningMethodsOnly is true, this returns the last
known position received from a satellite positioning method; if none
is available, a null update is returned.
+ \since 1.0
*/
/*!
@@ -472,6 +477,7 @@ QStringList QGeoPositionInfoSource::availableSources()
Returns the positioning methods available to this source.
+ \since 1.0
\sa setPreferredPositioningMethods()
*/
@@ -482,6 +488,7 @@ QStringList QGeoPositionInfoSource::availableSources()
This is the minimum value accepted by setUpdateInterval() and
requestUpdate().
+ \since 1.0
*/
@@ -498,12 +505,14 @@ QStringList QGeoPositionInfoSource::availableSources()
lost or if a hardware error is detected. Position updates will recommence if the data becomes
available later on. The updateTimout() signal will not be emitted again until after the
periodic updates resume.
+ \since 1.0
*/
/*!
\fn virtual void QGeoPositionInfoSource::stopUpdates() = 0;
Stops emitting updates at regular intervals.
+ \since 1.0
*/
/*!
@@ -524,6 +533,7 @@ QStringList QGeoPositionInfoSource::availableSources()
If the source uses multiple positioning methods, it tries to gets the
current position from the most accurate positioning method within the
given timeout.
+ \since 1.0
*/
/*!
@@ -533,6 +543,7 @@ QStringList QGeoPositionInfoSource::availableSources()
when an update becomes available.
The \a update value holds the value of the new update.
+ \since 1.0
*/
/*!
@@ -544,6 +555,7 @@ QStringList QGeoPositionInfoSource::availableSources()
If startUpdates() has been called, this signal will be emitted if this QGeoPositionInfoSource
subclass determines that it will not be able to provide further regular updates. This signal
will not be emitted again until after the regular updates resume.
+ \since 1.0
*/
#include "moc_qgeopositioninfosource.cpp"