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
QDeclarativeGeoLocation Class Reference

#include <qdeclarativegeolocation_p.h>

+ Inheritance diagram for QDeclarativeGeoLocation:
+ Collaboration diagram for QDeclarativeGeoLocation:

Public Member Functions

 QDeclarativeGeoLocation (QObject *parent=0)
 \qmltype Location \inqmlmodule QtPositioning
 
 QDeclarativeGeoLocation (const QGeoLocation &src, QObject *parent=0)
 
 ~QDeclarativeGeoLocation ()
 
QGeoLocation location () const
 
void setLocation (const QGeoLocation &src)
 \qmlproperty QGeoLocation QtPositioning::Location::location
 
QDeclarativeGeoAddressaddress () const
 
void setAddress (QDeclarativeGeoAddress *address)
 \qmlproperty Address QtPositioning::Location::address
 
QBindable< QDeclarativeGeoAddress * > bindableAddress ()
 
QGeoCoordinate coordinate () const
 
void setCoordinate (const QGeoCoordinate coordinate)
 \qmlproperty coordinate QtPositioning::Location::coordinate
 
QBindable< QGeoCoordinatebindableCoordinate ()
 
QGeoShape boundingShape () const
 
void setBoundingShape (const QGeoShape &boundingShape)
 
QBindable< QGeoShapebindableBoundingShape ()
 
QVariantMap extendedAttributes () const
 
void setExtendedAttributes (const QVariantMap &attributes)
 
QBindable< QVariantMapbindableExtendedAttributes ()
 
- 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.
 

Properties

QGeoLocation location
 
QDeclarativeGeoAddressaddress
 
QGeoCoordinate coordinate
 
QGeoShape boundingShape
 
QVariantMap extendedAttributes
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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 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 28 of file qdeclarativegeolocation_p.h.

Constructor & Destructor Documentation

◆ QDeclarativeGeoLocation() [1/2]

QT_BEGIN_NAMESPACE QDeclarativeGeoLocation::QDeclarativeGeoLocation ( QObject * parent = 0)
explicit

\qmltype Location \inqmlmodule QtPositioning

Since
5.2

The Location type holds location data.

Location types represent a geographic "location", in a human sense. This consists of a specific \l {coordinate}, an \l {address} and a \l {boundingShape}{bounding shape}. The \l {boundingShape}{bounding shape} represents the recommended region to display when viewing this location.

The Location type is most commonly seen as the contents of a search model such as the GeocodeModel. When a GeocodeModel returns the list of locations found for a given query, it represents these as Location objects.

Definition at line 51 of file qdeclarativegeolocation.cpp.

◆ QDeclarativeGeoLocation() [2/2]

QDeclarativeGeoLocation::QDeclarativeGeoLocation ( const QGeoLocation & src,
QObject * parent = 0 )
explicit

Definition at line 58 of file qdeclarativegeolocation.cpp.

◆ ~QDeclarativeGeoLocation()

QDeclarativeGeoLocation::~QDeclarativeGeoLocation ( )

Definition at line 64 of file qdeclarativegeolocation.cpp.

Member Function Documentation

◆ address()

QDeclarativeGeoAddress * QDeclarativeGeoLocation::address ( ) const

Definition at line 142 of file qdeclarativegeolocation.cpp.

◆ bindableAddress()

QBindable< QDeclarativeGeoAddress * > QDeclarativeGeoLocation::bindableAddress ( )

Definition at line 137 of file qdeclarativegeolocation.cpp.

◆ bindableBoundingShape()

QBindable< QGeoShape > QDeclarativeGeoLocation::bindableBoundingShape ( )

Definition at line 198 of file qdeclarativegeolocation.cpp.

◆ bindableCoordinate()

QBindable< QGeoCoordinate > QDeclarativeGeoLocation::bindableCoordinate ( )

Definition at line 160 of file qdeclarativegeolocation.cpp.

◆ bindableExtendedAttributes()

QBindable< QVariantMap > QDeclarativeGeoLocation::bindableExtendedAttributes ( )

Definition at line 213 of file qdeclarativegeolocation.cpp.

◆ boundingShape()

QGeoShape QDeclarativeGeoLocation::boundingShape ( ) const

Definition at line 218 of file qdeclarativegeolocation.cpp.

◆ coordinate()

QGeoCoordinate QDeclarativeGeoLocation::coordinate ( ) const

Definition at line 165 of file qdeclarativegeolocation.cpp.

◆ extendedAttributes()

QVariantMap QDeclarativeGeoLocation::extendedAttributes ( ) const

Definition at line 203 of file qdeclarativegeolocation.cpp.

◆ location()

QGeoLocation QDeclarativeGeoLocation::location ( ) const

Definition at line 105 of file qdeclarativegeolocation.cpp.

References QGeoLocation::setAddress().

+ Here is the call graph for this function:

◆ setAddress()

void QDeclarativeGeoLocation::setAddress ( QDeclarativeGeoAddress * address)

\qmlproperty Address QtPositioning::Location::address

This property holds the address of the location which can be use to retrieve address details of the location.

Definition at line 120 of file qdeclarativegeolocation.cpp.

◆ setBoundingShape()

void QDeclarativeGeoLocation::setBoundingShape ( const QGeoShape & boundingShape)
Since
QtPositioning 6.2

\qmlproperty geoshape QtPositioning::Location::boundingShape

This property holds the recommended region to use when displaying the location. For example, a building's location may have a region centered around the building, but the region is large enough to show it's immediate surrounding geographical context.

Note
This property's changed() signal is currently emitted only if the whole object changes, not if only the contents of the object change.
This property was introduced in Qt6 instead of boundingBox property. It returns a \l geoshape instead of a \l georectangle. Use \l QGeoShape::boundingGeoRectangle() to obtain a bounding \l georectangle for the shape.

If you need to convert the returned shape to a specific type, use the type property of \l geoshape together with convenience methods from \l [QML]{QtPositioning} like \l {QtPositioning::shapeToRectangle}{QtPositioning.shapeToRectangle()}.

Definition at line 193 of file qdeclarativegeolocation.cpp.

References boundingShape.

Referenced by setLocation().

+ Here is the caller graph for this function:

◆ setCoordinate()

void QDeclarativeGeoLocation::setCoordinate ( const QGeoCoordinate coordinate)

\qmlproperty coordinate QtPositioning::Location::coordinate

This property holds the exact geographical coordinate of the location which can be used to retrieve the latitude, longitude and altitude of the location.

Note
this property's changed() signal is currently emitted only if the whole object changes, not if only the contents of the object change.

Definition at line 155 of file qdeclarativegeolocation.cpp.

References coordinate.

Referenced by setLocation().

+ Here is the caller graph for this function:

◆ setExtendedAttributes()

void QDeclarativeGeoLocation::setExtendedAttributes ( const QVariantMap & attributes)

Definition at line 208 of file qdeclarativegeolocation.cpp.

Referenced by setLocation().

+ Here is the caller graph for this function:

◆ setLocation()

void QDeclarativeGeoLocation::setLocation ( const QGeoLocation & src)

\qmlproperty QGeoLocation QtPositioning::Location::location

For details on how to use this property to interface between C++ and QML see "\l {Location - QGeoLocation} {Interfaces between C++ and QML Code}".

Note
This property updates the whole geo location information, so using it will result in breaking of all the bindings for all other properties.

Definition at line 91 of file qdeclarativegeolocation.cpp.

References setBoundingShape(), setCoordinate(), and setExtendedAttributes().

Referenced by QDeclarativePlace::setPlace().

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

Property Documentation

◆ address

QDeclarativeGeoAddress * QDeclarativeGeoLocation::address
readwrite

Definition at line 35 of file qdeclarativegeolocation_p.h.

◆ boundingShape

QGeoShape QDeclarativeGeoLocation::boundingShape
readwrite

Definition at line 39 of file qdeclarativegeolocation_p.h.

Referenced by setBoundingShape().

◆ coordinate

QGeoCoordinate QDeclarativeGeoLocation::coordinate
readwrite

Definition at line 37 of file qdeclarativegeolocation_p.h.

Referenced by setCoordinate().

◆ extendedAttributes

QVariantMap QDeclarativeGeoLocation::extendedAttributes
readwrite

Definition at line 41 of file qdeclarativegeolocation_p.h.

◆ location

QGeoLocation QDeclarativeGeoLocation::location
readwrite

Definition at line 34 of file qdeclarativegeolocation_p.h.

Referenced by QDeclarativePlace::place().


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