Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QGeoPositionInfoSourceWinRT Class Reference

#include <qgeopositioninfosource_winrt_p.h>

+ Inheritance diagram for QGeoPositionInfoSourceWinRT:
+ Collaboration diagram for QGeoPositionInfoSourceWinRT:

Public Slots

void startUpdates () override
 
void stopUpdates () override
 
void requestUpdate (int timeout=0) override
 
- Public Slots inherited from QGeoPositionInfoSource
virtual void startUpdates ()=0
 Starts emitting updates at regular intervals as specified by setUpdateInterval().
 
virtual void stopUpdates ()=0
 Stops emitting updates at regular intervals.
 
virtual void requestUpdate (int timeout=0)=0
 Attempts to get the current position and emit positionUpdated() with this information.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void nativePositionUpdate (const QGeoPositionInfo)
 
- 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.
 

Public Member Functions

 QGeoPositionInfoSourceWinRT (QObject *parent=nullptr)
 
 ~QGeoPositionInfoSourceWinRT () override
 
int init ()
 
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
 
void setUpdateInterval (int msec) override
 
int minimumUpdateInterval () const override
 
Error error () const override
 Returns the type of error that last occurred.
 
HRESULT onPositionChanged (ABI::Windows::Devices::Geolocation::IGeolocator *locator, ABI::Windows::Devices::Geolocation::IPositionChangedEventArgs *args)
 
HRESULT onStatusChanged (ABI::Windows::Devices::Geolocation::IGeolocator *locator, ABI::Windows::Devices::Geolocation::IStatusChangedEventArgs *args)
 
bool requestAccess () const
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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...
 
- Static Public Member Functions inherited from QGeoPositionInfoSource
static QGeoPositionInfoSourcecreateDefaultSource (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 QGeoPositionInfoSourcecreateDefaultSource (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 QGeoPositionInfoSourcecreateSource (const QString &sourceName, QObject *parent)
 Creates and returns a position source with the given parent, by loading the plugin named sourceName.
 
static QGeoPositionInfoSourcecreateSource (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
QObjectsender () 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< QObjectDatad_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
 

Detailed Description

Definition at line 42 of file qgeopositioninfosource_winrt_p.h.

Constructor & Destructor Documentation

◆ QGeoPositionInfoSourceWinRT()

QGeoPositionInfoSourceWinRT::QGeoPositionInfoSourceWinRT ( QObject * parent = nullptr)

Definition at line 90 of file qgeopositioninfosource_winrt.cpp.

References d, QGeoPositionInfoSource::NoError, and qCDebug.

◆ ~QGeoPositionInfoSourceWinRT()

QGeoPositionInfoSourceWinRT::~QGeoPositionInfoSourceWinRT ( )
override

Definition at line 104 of file qgeopositioninfosource_winrt.cpp.

References qCDebug.

Member Function Documentation

◆ error()

QGeoPositionInfoSource::Error QGeoPositionInfoSourceWinRT::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 417 of file qgeopositioninfosource_winrt.cpp.

References QGeoPositionInfoSource::AccessError, d, QGeoPositionInfoSource::NoError, qCDebug, requestAccess(), and QGeoPositionInfoSource::UnknownSourceError.

Referenced by onStatusChanged().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ init()

int QGeoPositionInfoSourceWinRT::init ( )

Definition at line 110 of file qgeopositioninfosource_winrt.cpp.

References QGeoPositionInfoSource::AccessError, QGeoPositionInfoSource::AllPositioningMethods, QObject::connect(), d, Initialized, Initializing, nativePositionUpdate(), QGeoPositionInfoSource::NoPositioningMethods, QGeoPositionInfoSource::preferredPositioningMethods, Q_ASSERT, qCDebug, qWarning, requestAccess(), setPreferredPositioningMethods(), setUpdateInterval(), QTimer::timeout(), Uninitialized, and QGeoPositionInfoSource::UnknownSourceError.

Referenced by requestUpdate(), startUpdates(), and stopUpdates().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ lastKnownPosition()

QGeoPositionInfo QGeoPositionInfoSourceWinRT::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 164 of file qgeopositioninfosource_winrt.cpp.

References d, Q_UNUSED, and qCDebug.

◆ minimumUpdateInterval()

int QGeoPositionInfoSourceWinRT::minimumUpdateInterval ( ) const
overridevirtual

Implements QGeoPositionInfoSource.

Definition at line 243 of file qgeopositioninfosource_winrt.cpp.

References d.

Referenced by requestUpdate(), and setUpdateInterval().

+ Here is the caller graph for this function:

◆ nativePositionUpdate

void QGeoPositionInfoSourceWinRT::nativePositionUpdate ( const QGeoPositionInfo )
signal

Referenced by init(), and onPositionChanged().

+ Here is the caller graph for this function:

◆ onPositionChanged()

HRESULT QGeoPositionInfoSourceWinRT::onPositionChanged ( ABI::Windows::Devices::Geolocation::IGeolocator * locator,
ABI::Windows::Devices::Geolocation::IPositionChangedEventArgs * args )

Definition at line 450 of file qgeopositioninfosource_winrt.cpp.

References args, dateTime, QGeoPositionInfo::Direction, emit, QGeoPositionInfo::GroundSpeed, QGeoPositionInfo::HorizontalAccuracy, nativePositionUpdate(), pos, position(), Q_UNUSED, qCDebug, qErrnoWarning(), QTimeZone::UTC, and QGeoPositionInfo::VerticalAccuracy.

+ Here is the call graph for this function:

◆ onStatusChanged()

HRESULT QGeoPositionInfoSourceWinRT::onStatusChanged ( ABI::Windows::Devices::Geolocation::IGeolocator * locator,
ABI::Windows::Devices::Geolocation::IStatusChangedEventArgs * args )

◆ requestAccess()

bool QGeoPositionInfoSourceWinRT::requestAccess ( ) const

Definition at line 595 of file qgeopositioninfosource_winrt.cpp.

References await(), d, and qCDebug.

Referenced by error(), init(), and supportedPositioningMethods().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ requestUpdate

void QGeoPositionInfoSourceWinRT::requestUpdate ( int timeout = 0)
overrideslot

Definition at line 341 of file qgeopositioninfosource_winrt.cpp.

References d, emit, QGeoPositionInfoSource::errorOccurred(), init(), minimumUpdateInterval(), QGeoPositionInfoSource::NoError, qCDebug, and QGeoPositionInfoSource::UpdateTimeoutError.

+ Here is the call graph for this function:

◆ setPreferredPositioningMethods()

void QGeoPositionInfoSourceWinRT::setPreferredPositioningMethods ( PositioningMethods methods)
overridevirtual

Reimplemented from QGeoPositionInfoSource.

Definition at line 178 of file qgeopositioninfosource_winrt.cpp.

References d, methods, QGeoPositionInfoSource::preferredPositioningMethods, qCDebug, QGeoPositionInfoSource::SatellitePositioningMethods, QGeoPositionInfoSource::setPreferredPositioningMethods(), and Uninitialized.

Referenced by init().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setUpdateInterval()

void QGeoPositionInfoSourceWinRT::setUpdateInterval ( int msec)
overridevirtual

Reimplemented from QGeoPositionInfoSource.

Definition at line 207 of file qgeopositioninfosource_winrt.cpp.

References d, minimumUpdateInterval(), qCDebug, qErrnoWarning(), QGeoPositionInfoSource::setUpdateInterval(), Uninitialized, and QGeoPositionInfoSource::UnknownSourceError.

Referenced by init().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ startUpdates

void QGeoPositionInfoSourceWinRT::startUpdates ( )
overrideslot

Definition at line 249 of file qgeopositioninfosource_winrt.cpp.

References d, init(), QGeoPositionInfoSource::NoError, and qCDebug.

+ Here is the call graph for this function:

◆ stopUpdates

void QGeoPositionInfoSourceWinRT::stopUpdates ( )
overrideslot

Definition at line 267 of file qgeopositioninfosource_winrt.cpp.

References d, init(), and qCDebug.

+ Here is the call graph for this function:

◆ supportedPositioningMethods()

QGeoPositionInfoSource::PositioningMethods QGeoPositionInfoSourceWinRT::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
See also
supportedPositioningMethodsChanged(), setPreferredPositioningMethods()

Implements QGeoPositionInfoSource.

Definition at line 172 of file qgeopositioninfosource_winrt.cpp.

References QGeoPositionInfoSource::AllPositioningMethods, QGeoPositionInfoSource::NoPositioningMethods, and requestAccess().

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: