QGeoPositionInfoSource Class Reference

 #include <QGeoPositionInfoSource>

 // Emit updates every 10 seconds if available
 QGeoPositionInfoSource *source = QGeoPositionInfoSource::createDefaultSource(0);
 if (source)
     source->setUpdateInterval(10000);

Member Function Documentation

QGeoPositionInfoSource::QGeoPositionInfoSource ( QObject * parent )

Creates a position source with the specified parent.

QGeoPositionInfoSource::~QGeoPositionInfoSource () [virtual]

Destroys the position source.

QStringList QGeoPositionInfoSource::availableSources () [static]

Returns a list of available source plugins. Note that this list does not include the default platform backend, if one is available.

QGeoPositionInfoSource * QGeoPositionInfoSource::createDefaultSource ( QObject * parent ) [static]

Creates and returns a position source with the given parent that reads from the system's default sources of location data, or the plugin with the highest available priority.

Returns 0 if the system has no default position source and no valid plugins could be found.

Note: Symbian applications will need to have the Location capability otherwise this will return 0.

This function was introduced in Qt Mobility 1.0.

QGeoPositionInfoSource * QGeoPositionInfoSource::createSource ( const QString & sourceName, QObject * parent ) [static]

Creates and returns a position source with the given parent, by loading the plugin named sourceName.

Returns 0 if the plugin cannot be found.

QGeoPositionInfo QGeoPositionInfoSource::lastKnownPosition ( bool fromSatellitePositioningMethodsOnly = false ) const [pure virtual]

Returns an update containing the last known position, or a null update if none is available.

If fromSatellitePositioningMethodsOnly is true, this returns the last known position received from a satellite positioning method; if none is available, a null update is returned.

This function was introduced in Qt Mobility 1.0.

void QGeoPositionInfoSource::positionUpdated ( const QGeoPositionInfo & update ) [signal]

If startUpdates() or requestUpdate() is called, this signal is emitted when an update becomes available.

The update value holds the value of the new update.

This function was introduced in Qt Mobility 1.0.

PositioningMethods QGeoPositionInfoSource::preferredPositioningMethods () const

Returns the positioning methods set by setPreferredPositioningMethods().

This function was introduced in Qt Mobility 1.0.

See also setPreferredPositioningMethods().

void QGeoPositionInfoSource::requestUpdate ( int timeout = 0 ) [pure virtual slot]

Attempts to get the current position and emit positionUpdated() with this information. If the current position cannot be found within the given timeout (in milliseconds) or if timeout is less than the value returned by minimumUpdateInterval(), updateTimeout() is emitted.

If the timeout is zero, the timeout defaults to a reasonable timeout period as appropriate for the source.

This does nothing if another update request is in progress. However it can be called even if startUpdates() has already been called and regular updates are in progress.

If the source uses multiple positioning methods, it tries to gets the current position from the most accurate positioning method within the given timeout.

This function was introduced in Qt Mobility 1.0.

void QGeoPositionInfoSource::setPreferredPositioningMethods ( PositioningMethods methods ) [virtual]

Sets the preferred positioning methods for this source to methods.

If methods includes a method that is not supported by the source, the unsupported method will be ignored.

If methods does not include any methods supported by the source, the preferred methods will be set to the set of methods which the source supports.

Note: When reimplementing this method, subclasses must call the base method implementation to ensure preferredPositioningMethods() returns the correct value.

This function was introduced in Qt Mobility 1.0.

See also preferredPositioningMethods() and supportedPositioningMethods().

void QGeoPositionInfoSource::startUpdates () [pure virtual slot]

Starts emitting updates at regular intervals as specified by setUpdateInterval().

If setUpdateInterval() has not been called, the source will emit updates as soon as they become available.

An updateTimout() signal will be emitted if this QGeoPositionInfoSource subclass determines that it will not be able to provide regular updates. This could happen if a satellite fix is 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.

This function was introduced in Qt Mobility 1.0.

void QGeoPositionInfoSource::stopUpdates () [pure virtual slot]

Stops emitting updates at regular intervals.

This function was introduced in Qt Mobility 1.0.

PositioningMethods QGeoPositionInfoSource::supportedPositioningMethods () const [pure virtual]

Returns the positioning methods available to this source.

This function was introduced in Qt Mobility 1.0.

See also setPreferredPositioningMethods().

void QGeoPositionInfoSource::updateTimeout () [signal]

If requestUpdate() was called, this signal will be emitted if the current position could not be retrieved within the specified timeout.

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.

This function was introduced in Qt Mobility 1.0.