Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QDeclarativePositionSource Class Reference

#include <qdeclarativepositionsource_p.h>

+ Inheritance diagram for QDeclarativePositionSource:
+ Collaboration diagram for QDeclarativePositionSource:

Public Types

enum  PositioningMethod { NoPositioningMethods = QGeoPositionInfoSource::NoPositioningMethods , SatellitePositioningMethods = QGeoPositionInfoSource::SatellitePositioningMethods , NonSatellitePositioningMethods = QGeoPositionInfoSource::NonSatellitePositioningMethods , AllPositioningMethods = QGeoPositionInfoSource::AllPositioningMethods }
 
enum  SourceError {
  AccessError = QGeoPositionInfoSource::AccessError , ClosedError = QGeoPositionInfoSource::ClosedError , UnknownSourceError = QGeoPositionInfoSource::UnknownSourceError , NoError = QGeoPositionInfoSource::NoError ,
  UpdateTimeoutError = QGeoPositionInfoSource::UpdateTimeoutError
}
 

Public Slots

void update (int timeout=0)
 \qmlmethod PositionSource::update(int timeout)
 
void start ()
 \qmlmethod PositionSource::start()
 
void stop ()
 \qmlmethod PositionSource::stop()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void positionChanged ()
 
void activeChanged ()
 
void updateIntervalChanged ()
 
void supportedPositioningMethodsChanged ()
 
void preferredPositioningMethodsChanged ()
 
void sourceErrorChanged ()
 
void nameChanged ()
 
void validityChanged ()
 
- 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

 QDeclarativePositionSource ()
 The PositionSource type provides the device's current position.
 
 ~QDeclarativePositionSource ()
 
void setUpdateInterval (int updateInterval)
 
void setActive (bool active)
 \qmlproperty bool PositionSource::active
 
void setPreferredPositioningMethods (PositioningMethods methods)
 \qmlproperty enumeration PositionSource::preferredPositioningMethods
 
QString name () const
 \qmlproperty string PositionSource::name
 
void setName (const QString &name)
 
int updateInterval () const
 \qmlproperty int PositionSource::updateInterval
 
bool isActive () const
 
bool isValid () const
 \qmlproperty bool PositionSource::valid
 
QDeclarativePositionposition ()
 
PositioningMethods supportedPositioningMethods () const
 \qmlproperty enumeration PositionSource::supportedPositioningMethods
 
PositioningMethods preferredPositioningMethods () const
 
SourceError sourceError () const
 \qmlproperty enumeration PositionSource::sourceError
 
QGeoPositionInfoSourcepositionSource () const
 
QQmlListProperty< QDeclarativePluginParameterparameters ()
 
QVariantMap parameterMap () const
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
 Q_REVISION (5, 14) Q_INVOKABLE bool setBackendProperty(const QString &name
 
 Q_REVISION (5, 14) Q_INVOKABLE QVariant backendProperty(const QString &name) const
 
QBindable< PositioningMethods > bindableSupportedPositioningMethods () const
 
QBindable< SourceErrorbindableSourceError () const
 
QBindable< bool > bindableIsValid () const
 
QBindable< QStringbindableName ()
 
QBindable< QDeclarativePosition * > bindablePosition () const
 
QBindable< bool > bindableActive ()
 
- 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Public Attributes

const QVariantvalue
 

Properties

QDeclarativePositionposition
 \qmlproperty Position PositionSource::position
 
bool active
 
bool valid
 
int updateInterval
 
PositioningMethods supportedPositioningMethods
 
PositioningMethods preferredPositioningMethods
 
SourceError sourceError
 
QString name
 
QQmlListProperty< QDeclarativePluginParameterparameters
 \qmlproperty list<PluginParameter> PositionSource::parameters \qmldefault
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

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

Detailed Description

Definition at line 32 of file qdeclarativepositionsource_p.h.

Member Enumeration Documentation

◆ PositioningMethod

Enumerator
NoPositioningMethods 
SatellitePositioningMethods 
NonSatellitePositioningMethods 
AllPositioningMethods 

Definition at line 60 of file qdeclarativepositionsource_p.h.

◆ SourceError

Enumerator
AccessError 
ClosedError 
UnknownSourceError 
NoError 
UpdateTimeoutError 

Definition at line 70 of file qdeclarativepositionsource_p.h.

Constructor & Destructor Documentation

◆ QDeclarativePositionSource()

QT_BEGIN_NAMESPACE QDeclarativePositionSource::QDeclarativePositionSource ( )

The PositionSource type provides the device's current position.

\qmltype PositionSource

! \nativetype QDeclarativePositionSource \inqmlmodule QtPositioning

Since
5.2

The PositionSource type provides information about the user device's current position. The position is available as a \l{Position} type, which contains all the standard parameters typically available from GPS and other similar systems, including longitude, latitude, speed and accuracy details.

As different position sources are available on different platforms and devices, these are categorized by their basic type (Satellite, NonSatellite, and AllPositioningMethods). The available methods for the current platform can be enumerated in the \l{supportedPositioningMethods} property.

To indicate which methods are suitable for your application, set the \l{preferredPositioningMethods} property. If the preferred methods are not available, the default source of location data for the platform will be chosen instead. If no default source is available (because none are installed for the runtime platform, or because it is disabled), the \l{valid} property will be set to false.

The \l updateInterval property can then be used to indicate how often your application wishes to receive position updates. The \l{start}(), \l{stop}() and \l{update}() methods can be used to control the operation of the PositionSource, as well as the \l{active} property, which when set is equivalent to calling \l{start}() or \l{stop}().

When the PositionSource is active, position updates can be retrieved either by simply using the \l{position} property in a binding (as the value of another item's property), or by providing an implementation of the {onPositionChanged} signal-handler.

Definition at line 149 of file qdeclarativepositionsource.cpp.

◆ ~QDeclarativePositionSource()

QDeclarativePositionSource::~QDeclarativePositionSource ( )

Definition at line 156 of file qdeclarativepositionsource.cpp.

Member Function Documentation

◆ activeChanged

& QDeclarativePositionSource::activeChanged ( )
signal

Definition at line 161 of file qdeclarativepositionsource_p.h.

◆ bindableActive()

QBindable< bool > QDeclarativePositionSource::bindableActive ( )

Definition at line 834 of file qdeclarativepositionsource.cpp.

◆ bindableIsValid()

QBindable< bool > QDeclarativePositionSource::bindableIsValid ( ) const

Definition at line 316 of file qdeclarativepositionsource.cpp.

◆ bindableName()

QBindable< QString > QDeclarativePositionSource::bindableName ( )

Definition at line 206 of file qdeclarativepositionsource.cpp.

◆ bindablePosition()

QBindable< QDeclarativePosition * > QDeclarativePositionSource::bindablePosition ( ) const

Definition at line 211 of file qdeclarativepositionsource.cpp.

◆ bindableSourceError()

QBindable< QDeclarativePositionSource::SourceError > QDeclarativePositionSource::bindableSourceError ( ) const

Definition at line 698 of file qdeclarativepositionsource.cpp.

◆ bindableSupportedPositioningMethods()

QBindable< QDeclarativePositionSource::PositioningMethods > QDeclarativePositionSource::bindableSupportedPositioningMethods ( ) const

Definition at line 464 of file qdeclarativepositionsource.cpp.

◆ classBegin()

void QDeclarativePositionSource::classBegin ( )
inlineoverridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 100 of file qdeclarativepositionsource_p.h.

◆ componentComplete()

void QDeclarativePositionSource::componentComplete ( )
overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 779 of file qdeclarativepositionsource.cpp.

◆ isActive()

bool QDeclarativePositionSource::isActive ( ) const

Definition at line 628 of file qdeclarativepositionsource.cpp.

◆ isValid()

bool QDeclarativePositionSource::isValid ( ) const

\qmlproperty bool PositionSource::valid

This property is true if the PositionSource object has acquired a valid backend plugin to provide data. If false, other methods on the PositionSource will have no effect.

Applications should check this property to determine whether positioning is available and enabled on the runtime platform, and react accordingly.

Definition at line 311 of file qdeclarativepositionsource.cpp.

◆ name()

QString QDeclarativePositionSource::name ( ) const

\qmlproperty string PositionSource::name

This property holds the unique internal name for the plugin currently providing position information.

Setting the property causes the PositionSource to use a particular positioning provider. If the PositionSource is active at the time that the name property is changed, it will become inactive. If the specified positioning provider cannot be loaded the position source will become invalid.

Changing the name property may cause the \l {updateInterval}, \l {supportedPositioningMethods} and \l {preferredPositioningMethods} properties to change as well.

Definition at line 178 of file qdeclarativepositionsource.cpp.

Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().

+ Here is the caller graph for this function:

◆ nameChanged

void QDeclarativePositionSource::nameChanged ( )
signal

◆ parameterMap()

QVariantMap QDeclarativePositionSource::parameterMap ( ) const

Definition at line 383 of file qdeclarativepositionsource.cpp.

◆ parameters()

QQmlListProperty< QDeclarativePluginParameter > QDeclarativePositionSource::parameters ( )

◆ position()

QDeclarativePosition * QDeclarativePositionSource::position ( )

◆ positionChanged

void QDeclarativePositionSource::positionChanged ( )
signal

◆ positionSource()

QGeoPositionInfoSource * QDeclarativePositionSource::positionSource ( ) const

Definition at line 703 of file qdeclarativepositionsource.cpp.

◆ preferredPositioningMethods()

QDeclarativePositionSource::PositioningMethods QDeclarativePositionSource::preferredPositioningMethods ( ) const

Definition at line 505 of file qdeclarativepositionsource.cpp.

◆ preferredPositioningMethodsChanged

void QDeclarativePositionSource::preferredPositioningMethodsChanged ( )
signal

◆ Q_REVISION() [1/2]

QDeclarativePositionSource::Q_REVISION ( 5 ,
14  ) const &

◆ Q_REVISION() [2/2]

QDeclarativePositionSource::Q_REVISION ( 5 ,
14  ) const &

◆ setActive()

void QDeclarativePositionSource::setActive ( bool active)

\qmlproperty bool PositionSource::active

This property indicates whether the position source is active. Setting this property to false equals calling \l stop, and setting this property true equals calling \l start.

See also
start, stop, update

Definition at line 608 of file qdeclarativepositionsource.cpp.

◆ setName()

void QDeclarativePositionSource::setName ( const QString & name)

Definition at line 183 of file qdeclarativepositionsource.cpp.

◆ setPreferredPositioningMethods()

void QDeclarativePositionSource::setPreferredPositioningMethods ( PositioningMethods methods)

\qmlproperty enumeration PositionSource::preferredPositioningMethods

This property holds the preferred positioning methods of the current source.

\list

  • PositionSource.NoPositioningMethods - No positioning method is preferred.
  • PositionSource.SatellitePositioningMethods - Satellite-based positioning methods such as GPS should be preferred.
  • PositionSource.NonSatellitePositioningMethods - Non-satellite-based methods should be preferred.
  • PositionSource.AllPositioningMethods - Any positioning methods are acceptable. \endlist

Definition at line 484 of file qdeclarativepositionsource.cpp.

◆ setUpdateInterval()

void QDeclarativePositionSource::setUpdateInterval ( int updateInterval)

Definition at line 396 of file qdeclarativepositionsource.cpp.

◆ sourceError()

QDeclarativePositionSource::SourceError QDeclarativePositionSource::sourceError ( ) const

\qmlproperty enumeration PositionSource::sourceError

This property holds the error which last occurred with the PositionSource.

\list

  • PositionSource.AccessError - The connection setup to the remote positioning backend failed because the application lacked the required privileges.
  • PositionSource.ClosedError - The positioning backend closed the connection, which happens for example in case the user is switching location services to off. As soon as the location service is re-enabled regular updates will resume.
  • PositionSource.NoError - No error has occurred.
  • PositionSource.UnknownSourceError - An unidentified error occurred.
  • PositionSource.UpdateTimeoutError - The current position could not be retrieved within the specified timeout, or this PositionSource determined that it will not be able to provide further regular updates. \endlist

Definition at line 692 of file qdeclarativepositionsource.cpp.

◆ sourceErrorChanged

void QDeclarativePositionSource::sourceErrorChanged ( )
signal

◆ start

void QDeclarativePositionSource::start ( )
slot

\qmlmethod PositionSource::start()

Requests updates from the location source. Uses \l updateInterval if set, default interval otherwise. If there is no source available, this method has no effect.

Note
Calling this method breaks the bindings of \l {PositionSource::}{active} property.
See also
stop, update, active

Definition at line 527 of file qdeclarativepositionsource.cpp.

◆ stop

void QDeclarativePositionSource::stop ( )
slot

\qmlmethod PositionSource::stop()

Stops updates from the location source. If there is no source available or it is not active, this method has no effect.

Note
Calling this method breaks the bindings of \l {PositionSource::}{active} property.
See also
start, update, active

Definition at line 583 of file qdeclarativepositionsource.cpp.

◆ supportedPositioningMethods()

QDeclarativePositionSource::PositioningMethods QDeclarativePositionSource::supportedPositioningMethods ( ) const

\qmlproperty enumeration PositionSource::supportedPositioningMethods

This property holds the supported positioning methods of the current source.

\list

  • PositionSource.NoPositioningMethods - No positioning methods supported (no source).
  • PositionSource.SatellitePositioningMethods - Satellite-based positioning methods such as GPS are supported.
  • PositionSource.NonSatellitePositioningMethods - Non-satellite-based methods are supported.
  • PositionSource.AllPositioningMethods - Both satellite-based and non-satellite positioning methods are supported. \endlist

Definition at line 448 of file qdeclarativepositionsource.cpp.

◆ supportedPositioningMethodsChanged

void QDeclarativePositionSource::supportedPositioningMethodsChanged ( )
signal

◆ update

void QDeclarativePositionSource::update ( int timeout = 0)
slot

\qmlmethod PositionSource::update(int timeout)

A convenience method to request single update from the location source. If there is no source available, this method has no effect.

If the position source is not active, it will be activated for as long as it takes to receive an update, or until the request times out. The request timeout period is source-specific.

The timeout is specified in milliseconds. If the timeout is zero (the default value), it defaults to a reasonable timeout period as appropriate for the source.

See also
start, stop, active

Definition at line 552 of file qdeclarativepositionsource.cpp.

◆ updateInterval()

int QDeclarativePositionSource::updateInterval ( ) const

\qmlproperty int PositionSource::updateInterval

This property holds the desired interval between updates (milliseconds).

See also
{QGeoPositionInfoSource::updateInterval()}

Definition at line 424 of file qdeclarativepositionsource.cpp.

◆ updateIntervalChanged

void QDeclarativePositionSource::updateIntervalChanged ( )
signal

◆ validityChanged

void QDeclarativePositionSource::validityChanged ( )
signal

Member Data Documentation

◆ value

const QVariant& QDeclarativePositionSource::value

Definition at line 103 of file qdeclarativepositionsource_p.h.

Property Documentation

◆ active

bool QDeclarativePositionSource::active
readwrite

Definition at line 40 of file qdeclarativepositionsource_p.h.

◆ name

QString QDeclarativePositionSource::name
readwrite

◆ parameters

QQmlListProperty< QDeclarativePluginParameter > QDeclarativePositionSource::parameters
read

\qmlproperty list<PluginParameter> PositionSource::parameters \qmldefault

This property holds the list of plugin parameters.

Since
QtPositioning 5.14

Definition at line 53 of file qdeclarativepositionsource_p.h.

◆ position

QDeclarativePosition * QDeclarativePositionSource::position
read

\qmlproperty Position PositionSource::position

This property holds the last known positional data. It is a read-only property.

The Position type has different positional member variables, whose validity can be checked with appropriate validity functions (for example sometimes an update does not have speed or altitude data).

However, whenever a {positionChanged} signal has been received, at least position::coordinate::latitude, position::coordinate::longitude, and position::timestamp can be assumed to be valid.

See also
start, stop, update

Definition at line 38 of file qdeclarativepositionsource_p.h.

◆ preferredPositioningMethods

PositioningMethods QDeclarativePositionSource::preferredPositioningMethods
readwrite

Definition at line 48 of file qdeclarativepositionsource_p.h.

◆ sourceError

SourceError QDeclarativePositionSource::sourceError
read

Definition at line 50 of file qdeclarativepositionsource_p.h.

◆ supportedPositioningMethods

PositioningMethods QDeclarativePositionSource::supportedPositioningMethods
read

Definition at line 45 of file qdeclarativepositionsource_p.h.

◆ updateInterval

int QDeclarativePositionSource::updateInterval
readwrite

Definition at line 43 of file qdeclarativepositionsource_p.h.

◆ valid

bool QDeclarativePositionSource::valid
read

Definition at line 42 of file qdeclarativepositionsource_p.h.


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