#include <qgeopositioninfosource_geoclue2_p.h>

Inheritance diagram for QGeoPositionInfoSourceGeoclue2:

Collaboration diagram for QGeoPositionInfoSourceGeoclue2:

Public Member Functions
	QGeoPositionInfoSourceGeoclue2 (const QVariantMap &parameters, QObject *parent=nullptr)

	~QGeoPositionInfoSourceGeoclue2 ()

void	setUpdateInterval (int msec) override

QGeoPositionInfo	lastKnownPosition (bool fromSatellitePositioningMethodsOnly=false) const override
	Returns an update containing the last known position, or a null update if none is available.

PositioningMethods	supportedPositioningMethods () const override
	Returns the positioning methods available to this source.

void	setPreferredPositioningMethods (PositioningMethods methods) override

int	minimumUpdateInterval () const override

Error	error () const override
	Returns the type of error that last occurred.

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

void	stopUpdates () override
	Stops emitting updates at regular intervals.

void	requestUpdate (int timeout=5000) override
	Attempts to get the current position and emit positionUpdated() with this information.

Public Member Functions inherited from QGeoPositionInfoSource
	QGeoPositionInfoSource (QObject *parent)
	Creates a position source with the specified parent.

virtual	~QGeoPositionInfoSource ()
	Destroys the position source.

int	updateInterval () const

QBindable< int >	bindableUpdateInterval ()

PositioningMethods	preferredPositioningMethods () const

QBindable< PositioningMethods >	bindablePreferredPositioningMethods ()

QString	sourceName () const

virtual bool	setBackendProperty (const QString &name, const QVariant &value)
	Sets the backend-specific property named name to value.

virtual QVariant	backendProperty (const QString &name) const
	Returns the value of the backend-specific property named name, if present.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Additional Inherited Members
Public Types inherited from QGeoPositionInfoSource
enum	Error { AccessError = 0 , ClosedError = 1 , UnknownSourceError = 2 , NoError = 3 , UpdateTimeoutError = 4 }
	The Error enumeration represents the errors which can occur. More...

enum	PositioningMethod { NoPositioningMethods = 0x00000000 , SatellitePositioningMethods = 0x000000ff , NonSatellitePositioningMethods = 0xffffff00 , AllPositioningMethods = 0xffffffff }
	Defines the types of positioning methods. More...

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QGeoPositionInfoSource
void	positionUpdated (const QGeoPositionInfo &update)
	If startUpdates() or requestUpdate() is called, this signal is emitted when an update becomes available.

void	errorOccurred (QGeoPositionInfoSource::Error)
	This signal is emitted after an error occurred.

void	supportedPositioningMethodsChanged ()
	This signal is emitted when the supported positioning methods changed.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QGeoPositionInfoSource
static 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.

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

static QGeoPositionInfoSource *	createSource (const QString &sourceName, QObject *parent)
	Creates and returns a position source with the given parent, by loading the plugin named sourceName.

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

static QStringList	availableSources ()
	Returns a list of available source plugins.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QGeoPositionInfoSource
	QGeoPositionInfoSource (QGeoPositionInfoSourcePrivate &dd, QObject *parent)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QGeoPositionInfoSource
int	updateInterval
	This property holds the requested interval in milliseconds between each update.

int	minimumUpdateInterval
	This property holds the minimum time (in milliseconds) required to retrieve a position update.

QString	sourceName
	This property holds the unique name of the position source implementation in use.

PositioningMethods	preferredPositioningMethods
	Sets the preferred positioning methods for this source.

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 17 of file qgeopositioninfosource_geoclue2_p.h.

Constructor & Destructor Documentation

◆ QGeoPositionInfoSourceGeoclue2()

QGeoPositionInfoSourceGeoclue2::QGeoPositionInfoSourceGeoclue2	(	const QVariantMap &	parameters,
		QObject *	parent = nullptr )

explicit

Definition at line 48 of file qgeopositioninfosource_geoclue2.cpp.

◆ ~QGeoPositionInfoSourceGeoclue2()

QGeoPositionInfoSourceGeoclue2::~QGeoPositionInfoSourceGeoclue2 ( )

Definition at line 68 of file qgeopositioninfosource_geoclue2.cpp.

Member Function Documentation

◆ error()

QGeoPositionInfoSource::Error QGeoPositionInfoSourceGeoclue2::error ( ) const

overridevirtual

Returns the type of error that last occurred.

Note: Since Qt6 the last error is always reset when calling startUpdates() or requestUpdate().

Implements QGeoPositionInfoSource.

Definition at line 120 of file qgeopositioninfosource_geoclue2.cpp.

◆ lastKnownPosition()

QGeoPositionInfo QGeoPositionInfoSourceGeoclue2::lastKnownPosition ( bool fromSatellitePositioningMethodsOnly = false ) const

overridevirtual

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.

Implements QGeoPositionInfoSource.

Definition at line 79 of file qgeopositioninfosource_geoclue2.cpp.

◆ minimumUpdateInterval()

int QGeoPositionInfoSourceGeoclue2::minimumUpdateInterval ( ) const

overridevirtual

Implements QGeoPositionInfoSource.

Definition at line 115 of file qgeopositioninfosource_geoclue2.cpp.

◆ requestUpdate()

void QGeoPositionInfoSourceGeoclue2::requestUpdate ( int timeout = 5000 )

overridevirtual

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 \l {QGeoPositionInfoSource::}{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.

Note: Since Qt6 this method always resets the last error to \l {QGeoPositionInfoSource::}{NoError} before requesting the position.; To understand how to use this method from an Android service, see \l {Qt Positioning on Android}.

Implements QGeoPositionInfoSource.

Definition at line 159 of file qgeopositioninfosource_geoclue2.cpp.

◆ setPreferredPositioningMethods()

void QGeoPositionInfoSourceGeoclue2::setPreferredPositioningMethods ( PositioningMethods methods )

overridevirtual

Reimplemented from QGeoPositionInfoSource.

Definition at line 109 of file qgeopositioninfosource_geoclue2.cpp.

◆ setUpdateInterval()

void QGeoPositionInfoSourceGeoclue2::setUpdateInterval ( int msec )

overridevirtual

Reimplemented from QGeoPositionInfoSource.

Definition at line 73 of file qgeopositioninfosource_geoclue2.cpp.

◆ startUpdates()

void QGeoPositionInfoSourceGeoclue2::startUpdates ( )

overridevirtual

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 \l {QGeoPositionInfoSource::} {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 \l {QGeoPositionInfoSource::}{UpdateTimeoutError} error will not be emitted again until after the periodic updates resume.

Note: Since Qt6 this method always resets the last error to \l {QGeoPositionInfoSource::}{NoError} before starting the updates.; To understand how to use this method from an Android service, see \l {Qt Positioning on Android}.

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.

Implements QGeoPositionInfoSource.

Definition at line 125 of file qgeopositioninfosource_geoclue2.cpp.

◆ stopUpdates()

void QGeoPositionInfoSourceGeoclue2::stopUpdates ( )

overridevirtual

Stops emitting updates at regular intervals.

Implements QGeoPositionInfoSource.

Definition at line 146 of file qgeopositioninfosource_geoclue2.cpp.

◆ supportedPositioningMethods()

QGeoPositionInfoSourceGeoclue2::PositioningMethods QGeoPositionInfoSourceGeoclue2::supportedPositioningMethods ( ) const

overridevirtual

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 \l 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:

\table \header

Platform
Brief Description \row
Android
Individual provider status and general Location service state are known and communicated when location service is active. \row
GeoClue
Hardcoced to always return AllPositioningMethods. \row
GeoClue2
Individual providers are not distinguishable but disabled Location services reflected. \row
iOS
Hardcoced to always return AllPositioningMethods. \row
macOS
Hardcoced to always return AllPositioningMethods. \row
Windows (UWP)
Individual providers are not distinguishable but disabled Location services reflected. \endtable