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
Public Types | Public Slots | Signals | Public Member Functions | Properties | List of all members
QDeclarativeSatelliteSource Class Reference

#include <qdeclarativesatellitesource_p.h>

+ Inheritance diagram for QDeclarativeSatelliteSource:
+ Collaboration diagram for QDeclarativeSatelliteSource:

Public Types

enum  SourceError {
  AccessError = QGeoSatelliteInfoSource::AccessError , ClosedError = QGeoSatelliteInfoSource::ClosedError , NoError = QGeoSatelliteInfoSource::NoError , UnknownSourceError = QGeoSatelliteInfoSource::UnknownSourceError ,
  UpdateTimeoutError = QGeoSatelliteInfoSource::UpdateTimeoutError
}
 

Public Slots

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

Signals

void activeChanged ()
 
void validityChanged ()
 
void updateIntervalChanged ()
 
void sourceErrorChanged ()
 
void nameChanged ()
 
void satellitesInUseChanged ()
 
void satellitesInViewChanged ()
 
- 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

 QDeclarativeSatelliteSource ()
 \qmltype SatelliteSource \inqmlmodule QtPositioning
 
 ~QDeclarativeSatelliteSource ()
 
bool isActive () const
 \qmlproperty bool SatelliteSource::active
 
bool isValid () const
 \qmlproperty bool SatelliteSource::valid \readonly
 
int updateInterval () const
 \qmlproperty int SatelliteSource::updateInterval
 
SourceError sourceError () const
 \qmlproperty enumeration SatelliteSource::sourceError \readonly
 
QString name () const
 \qmlproperty string SatelliteSource::name
 
QQmlListProperty< QDeclarativePluginParameter > parameters ()
 
QList< QGeoSatelliteInfo > satellitesInUse () const
 \qmlproperty list<geoSatelliteInfo> SatelliteSource::satellitesInUse \readonly
 
QList< QGeoSatelliteInfo > satellitesInView () const
 \qmlproperty list<geoSatelliteInfo> SatelliteSource::satellitesInView \readonly
 
void setUpdateInterval (int updateInterval)
 
void setActive (bool active)
 
void setName (const QString &name)
 
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_INVOKABLE bool setBackendProperty (const QString &name, const QVariant &value)
 \qmlmethod bool SatelliteSource::setBackendProperty(string name, var value)
 
Q_INVOKABLE QVariant backendProperty (const QString &name) const
 \qmlmethod var SatelliteSource::backendProperty(string name)
 
- 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Properties

bool active
 
bool valid
 
int updateInterval
 
SourceError sourceError
 
QString name
 
QQmlListProperty< QDeclarativePluginParameter > parameters
 \qmlproperty list<PluginParameter> SatelliteSource::parameters \readonly \qmldefault
 
QList< QGeoSatelliteInfo > satellitesInUse
 
QList< QGeoSatelliteInfo > satellitesInView
 
- 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
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
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 30 of file qdeclarativesatellitesource_p.h.

Member Enumeration Documentation

◆ SourceError

enum QDeclarativeSatelliteSource::SourceError
Enumerator
AccessError 
ClosedError 
NoError 
UnknownSourceError 
UpdateTimeoutError 

Definition at line 52 of file qdeclarativesatellitesource_p.h.

Constructor & Destructor Documentation

◆ QDeclarativeSatelliteSource()

QT_BEGIN_NAMESPACE QDeclarativeSatelliteSource::QDeclarativeSatelliteSource ( )

\qmltype SatelliteSource \inqmlmodule QtPositioning

Since
6.5

The SatelliteSource class provides the satellite information.

The SatelliteSource class provides information about satellites in use and satellites in view. This class is a QML representation of \l QGeoSatelliteInfoSource.

Like its C++ equivalent, the class supports different plugins. Use the \l name property to specify the name of the plugin to be used, and provide \l {PluginParameter}s, if required. If the \l name property is not set, a default plugin will be used. See \l {Qt Positioning Plugins} for more information on the available plugins.

Use the \l valid property to check the SatelliteSource state.

Use the \l updateInterval property to indicate how often your application wants to receive the satellite information updates. The \l start(), \l stop() and \l update() methods can be used to control the operation of the SatelliteSource, as well as the \l active property, which when set is equivalent to calling \l start() or \l stop().

When the SatelliteSource is active, satellite information updates can be retrieved using the \l satellitesInView and \l satellitesInUse properties.

If an error happens during satellite information updates, use the \l sourceError property to get the actual error code.

Definition at line 66 of file qdeclarativesatellitesource.cpp.

◆ ~QDeclarativeSatelliteSource()

QDeclarativeSatelliteSource::~QDeclarativeSatelliteSource ( )
default

Member Function Documentation

◆ activeChanged

void QDeclarativeSatelliteSource::activeChanged ( )
signal

Referenced by stop().

+ Here is the caller graph for this function:

◆ backendProperty()

QVariant QDeclarativeSatelliteSource::backendProperty ( const QString & name) const

\qmlmethod var SatelliteSource::backendProperty(string name)

Returns the value of the backend-specific property named name, if present. Otherwise, including if called on an uninitialized SatelliteSource, the return value will be invalid.

Definition at line 283 of file qdeclarativesatellitesource.cpp.

◆ classBegin()

void QDeclarativeSatelliteSource::classBegin ( )
inlineoverridevirtual

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

Implements QQmlParserStatus.

Definition at line 78 of file qdeclarativesatellitesource_p.h.

◆ componentComplete()

void QDeclarativeSatelliteSource::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 245 of file qdeclarativesatellitesource.cpp.

References QObject::connect(), QDeclarativePluginParameter::initialized(), and Qt::SingleShotConnection.

+ Here is the call graph for this function:

◆ isActive()

bool QDeclarativeSatelliteSource::isActive ( ) const

\qmlproperty bool SatelliteSource::active

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

See also
start, stop, update

Definition at line 84 of file qdeclarativesatellitesource.cpp.

◆ isValid()

bool QDeclarativeSatelliteSource::isValid ( ) const

\qmlproperty bool SatelliteSource::valid \readonly

This property is true if the SatelliteSource object has acquired a valid backend plugin to provide data, and false otherwise.

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

Definition at line 100 of file qdeclarativesatellitesource.cpp.

◆ name()

QString QDeclarativeSatelliteSource::name ( ) const

\qmlproperty string SatelliteSource::name

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

Setting the property causes the SatelliteSource to use a particular backend plugin. If the SatelliteSource is active at the time that the name property is changed, it will become inactive. If the specified backend cannot be loaded the satellite source will become invalid.

Changing the name property may cause the \l updateInterval property to change as well.

Definition at line 154 of file qdeclarativesatellitesource.cpp.

◆ nameChanged

void QDeclarativeSatelliteSource::nameChanged ( )
signal

Referenced by setName().

+ Here is the caller graph for this function:

◆ parameters()

QQmlListProperty< QDeclarativePluginParameter > QDeclarativeSatelliteSource::parameters ( )

◆ satellitesInUse()

QList< QGeoSatelliteInfo > QDeclarativeSatelliteSource::satellitesInUse ( ) const

\qmlproperty list<geoSatelliteInfo> SatelliteSource::satellitesInUse \readonly

This property holds the list of satellites that are currently in use. These are the satellites that are used to get a "fix" - that is, those used to determine the current position.

Definition at line 185 of file qdeclarativesatellitesource.cpp.

◆ satellitesInUseChanged

void QDeclarativeSatelliteSource::satellitesInUseChanged ( )
signal

◆ satellitesInView()

QList< QGeoSatelliteInfo > QDeclarativeSatelliteSource::satellitesInView ( ) const

\qmlproperty list<geoSatelliteInfo> SatelliteSource::satellitesInView \readonly

This property holds the list of satellites that are currently in view.

Definition at line 196 of file qdeclarativesatellitesource.cpp.

◆ satellitesInViewChanged

void QDeclarativeSatelliteSource::satellitesInViewChanged ( )
signal

◆ setActive()

void QDeclarativeSatelliteSource::setActive ( bool active)

Definition at line 221 of file qdeclarativesatellitesource.cpp.

References active, start(), and stop().

+ Here is the call graph for this function:

◆ setBackendProperty()

bool QDeclarativeSatelliteSource::setBackendProperty ( const QString & name,
const QVariant & value )

\qmlmethod bool SatelliteSource::setBackendProperty(string name, var value)

Sets the backend-specific property named name to value. Returns true on success, false otherwise, including if called on an uninitialized SatelliteSource.

Definition at line 269 of file qdeclarativesatellitesource.cpp.

◆ setName()

void QDeclarativeSatelliteSource::setName ( const QString & name)

Definition at line 232 of file qdeclarativesatellitesource.cpp.

References emit, name, and nameChanged().

+ Here is the call graph for this function:

◆ setUpdateInterval()

void QDeclarativeSatelliteSource::setUpdateInterval ( int updateInterval)

Definition at line 201 of file qdeclarativesatellitesource.cpp.

References emit, updateInterval, and updateIntervalChanged().

+ Here is the call graph for this function:

◆ sourceError()

QDeclarativeSatelliteSource::SourceError QDeclarativeSatelliteSource::sourceError ( ) const

\qmlproperty enumeration SatelliteSource::sourceError \readonly

This property holds the error which last occurred with the backend data provider.

\list

  • SatelliteSource.AccessError - The connection setup to the satellite backend failed because the application lacked the required privileges.
  • SatelliteSource.ClosedError - The satellite backend closed the connection, which happens for example in case the user is switching location services to off.
  • SatelliteSource.NoError - No error has occurred.
  • SatelliteSource.UnknownSourceError - An unidentified error occurred.
  • SatelliteSource.UpdateTimeoutError - The satellite information could not be retrieved within the specified timeout. \endlist

Definition at line 135 of file qdeclarativesatellitesource.cpp.

◆ sourceErrorChanged

void QDeclarativeSatelliteSource::sourceErrorChanged ( )
signal

◆ start

void QDeclarativeSatelliteSource::start ( )
slot

\qmlmethod SatelliteSource::start()

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

See also
stop, update, active

Definition at line 323 of file qdeclarativesatellitesource.cpp.

Referenced by setActive().

+ Here is the caller graph for this function:

◆ stop

void QDeclarativeSatelliteSource::stop ( )
slot

\qmlmethod SatelliteSource::stop()

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

See also
start, update, active

Definition at line 339 of file qdeclarativesatellitesource.cpp.

References activeChanged(), and emit.

Referenced by setActive().

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

◆ update

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

\qmlmethod SatelliteSource::update(int timeout = 0)

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

If the satellite 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 plugin-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 304 of file qdeclarativesatellitesource.cpp.

◆ updateInterval()

int QDeclarativeSatelliteSource::updateInterval ( ) const

\qmlproperty int SatelliteSource::updateInterval

This property holds the desired interval between updates in milliseconds.

Definition at line 110 of file qdeclarativesatellitesource.cpp.

◆ updateIntervalChanged

void QDeclarativeSatelliteSource::updateIntervalChanged ( )
signal

Referenced by setUpdateInterval().

+ Here is the caller graph for this function:

◆ validityChanged

void QDeclarativeSatelliteSource::validityChanged ( )
signal

Property Documentation

◆ active

bool QDeclarativeSatelliteSource::active
readwrite

Definition at line 36 of file qdeclarativesatellitesource_p.h.

Referenced by setActive().

◆ name

QString QDeclarativeSatelliteSource::name
readwrite

Definition at line 41 of file qdeclarativesatellitesource_p.h.

Referenced by setName().

◆ parameters

QQmlListProperty< QDeclarativePluginParameter > QDeclarativeSatelliteSource::parameters
read

\qmlproperty list<PluginParameter> SatelliteSource::parameters \readonly \qmldefault

This property holds the list of plugin parameters.

See also
PluginParameter

Definition at line 42 of file qdeclarativesatellitesource_p.h.

◆ satellitesInUse

QList<QGeoSatelliteInfo> QDeclarativeSatelliteSource::satellitesInUse
read

Definition at line 43 of file qdeclarativesatellitesource_p.h.

◆ satellitesInView

QList<QGeoSatelliteInfo> QDeclarativeSatelliteSource::satellitesInView
read

Definition at line 45 of file qdeclarativesatellitesource_p.h.

◆ sourceError

SourceError QDeclarativeSatelliteSource::sourceError
read

Definition at line 40 of file qdeclarativesatellitesource_p.h.

◆ updateInterval

int QDeclarativeSatelliteSource::updateInterval
readwrite

Definition at line 38 of file qdeclarativesatellitesource_p.h.

Referenced by setUpdateInterval().

◆ valid

bool QDeclarativeSatelliteSource::valid
read

Definition at line 37 of file qdeclarativesatellitesource_p.h.

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