QGeoPositionInfoSource Class

// 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.

[signal] void QGeoPositionInfoSource::errorOccurred(QGeoPositionInfoSource::Error positioningError)

This signal is emitted after an error occurred. The positioningError parameter describes the type of error that occurred.

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

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.

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

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(), an errorOccurred() signal with the UpdateTimeoutError 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 get the current position from the most accurate positioning method within the given timeout.

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

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 errorOccurred() signal with the UpdateTimeoutError 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 UpdateTimeoutError error will not be emitted again until after the periodic updates resume.

On iOS, starting from version 8, Core Location framework requires additional entries in the application's Info.plist with keys NSLocationAlwaysUsageDescription or NSLocationWhenInUseUsageDescription and a string to be displayed in the authorization prompt. The key NSLocationWhenInUseUsageDescription is used when requesting permission to use location services while the app is in the foreground. The key NSLocationAlwaysUsageDescription is used when requesting permission to use location services whenever the app is running (both the foreground and the background). If both entries are defined, NSLocationWhenInUseUsageDescription has a priority in the foreground mode.

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

Stops emitting updates at regular intervals.

[signal, since Qt 5.12] void QGeoPositionInfoSource::supportedPositioningMethodsChanged()

This signal is emitted when the supported positioning methods changed. The cause for a change could be a user turning Location services on/off or restricting Location services to certain types (e.g. GPS only). Note that changes to the supported positioning methods cannot be detected on all platforms. supportedPositioningMethods() provides an overview of the current platform support.

This function was introduced in Qt 5.12.

[virtual] QGeoPositionInfoSource::~QGeoPositionInfoSource()

Destroys the position source.

[static] QStringList QGeoPositionInfoSource::availableSources()

Returns a list of available source plugins. This includes any default backend plugin for the current platform.

[virtual, since Qt 5.14] QVariant QGeoPositionInfoSource::backendProperty(const QString &name) const

Returns the value of the backend-specific property named name, if present. Otherwise, the returned value will be invalid. Supported backend-specific properties are listed and described in Qt Positioning plugins#Default plugins.

This function was introduced in Qt 5.14.

See also setBackendProperty.

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

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 nullptr if the system has no default position source, no valid plugins could be found or the user does not have the permission to access the current position.

[static, since Qt 5.14] QGeoPositionInfoSource *QGeoPositionInfoSource::createDefaultSource(const QVariantMap &parameters, QObject *parent)

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 nullptr if the system has no default position source, no valid plugins could be found or the user does not have the permission to access the current position.

This method passes parameters to the factory to configure the source.

This function was introduced in Qt 5.14.

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

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

Returns nullptr if the plugin cannot be found.

[static, since Qt 5.14] QGeoPositionInfoSource *QGeoPositionInfoSource::createSource(const QString &sourceName, const QVariantMap &parameters, QObject *parent)

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

Returns nullptr if the plugin cannot be found.

This method passes parameters to the factory to configure the source.

This function was introduced in Qt 5.14.

[pure virtual] QGeoPositionInfoSource::Error QGeoPositionInfoSource::error() const

Returns the type of error that last occurred.

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

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.

[virtual, since Qt 5.14] bool QGeoPositionInfoSource::setBackendProperty(const QString &name, const QVariant &value)

Sets the backend-specific property named name to value. Returns true on success, false otherwise. Backend-specific properties can be used to configure the positioning subsystem behavior at runtime. Supported backend-specific properties are listed and described in Qt Positioning plugins#Default plugins.

This function was introduced in Qt 5.14.

See also backendProperty.

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

Returns the positioning methods available to this source. Availability is defined as being usable at the time of calling this function. Therefore user settings like turned off location service or limitations to Satellite-based position providers are reflected by this function. Runtime notifications when the status changes can be obtained via supportedPositioningMethodsChanged().

Not all platforms distinguish the different positioning methods or communicate the current user configuration of the device. The following table provides an overview of the current platform situation:

See also supportedPositioningMethodsChanged() and setPreferredPositioningMethods().