QGeoLocation Class

The QGeoLocation class represents basic information about a location. More...

Header: #include <QGeoLocation>

Public Functions

QGeoLocation()
QGeoLocation(const QGeoLocation &other)
QGeoLocation(QGeoLocation &&other)
~QGeoLocation()
QGeoAddress address() const
QGeoShape boundingShape() const
QGeoCoordinate coordinate() const
QVariantMap extendedAttributes() const
bool isEmpty() const
void setAddress(const QGeoAddress &address)
void setBoundingShape(const QGeoShape &boundingShape)
void setCoordinate(const QGeoCoordinate &coordinate)
void setExtendedAttributes(const QVariantMap &data)
QGeoLocation &operator=(const QGeoLocation &other)
QGeoLocation &operator=(QGeoLocation &&other)
int qHash(const QGeoLocation &location, int seed = 0)
bool operator!=(const QGeoLocation &lhs, const QGeoLocation &rhs)
bool operator==(const QGeoLocation &lhs, const QGeoLocation &rhs)

Detailed Description

\inmoduleQtPositioning \ingroup QtPositioning-positioning \ingroup QtLocation-places \ingroup QtLocation-places-data \since 5.2

A QGeoLocation consists of a coordinate and corresponding address, along with an optional bounding shape, which is the recommended region to be displayed when viewing the location.

Member Function Documentation

QGeoLocation::QGeoLocation()

Constructs an new location object.

QGeoLocation::QGeoLocation(const QGeoLocation &other)

Constructs a copy of other

[constexpr noexcept] QGeoLocation::QGeoLocation(QGeoLocation &&other)

\since6.2

Constructs a geo location object by moving from other.

Note: The moved-from QGeoLocation object can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.

[noexcept] QGeoLocation::~QGeoLocation()

Destroys the location object.

QGeoAddress QGeoLocation::address() const

Returns the address of the location.

See also setAddress().

QGeoShape QGeoLocation::boundingShape() const

\since6.2

Returns a bounding shape which represents the recommended region to display when viewing this 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 method was introduced in Qt6 instead of boundingBox() method. It returns a QGeoShape instead of a QGeoRectangle. Use QGeoShape::boundingGeoRectangle() to obtain a bounding QGeoRectangle for the shape.

See also setBoundingShape().

QGeoCoordinate QGeoLocation::coordinate() const

Returns the coordinate of the location.

See also setCoordinate().

QVariantMap QGeoLocation::extendedAttributes() const

Returns the extended attributes associated to this location. Extended attributes are backend-dependent and can be location-dependent.

\since5.13

See also setExtendedAttributes().

bool QGeoLocation::isEmpty() const

Returns true if the location coordinate is invalid, and all the other location fields are empty. Otherwise returns false.

void QGeoLocation::setAddress(const QGeoAddress &address)

Sets the address of the location.

See also address().

void QGeoLocation::setBoundingShape(const QGeoShape &boundingShape)

\since6.2

Sets the boundingShape of the location.

See also boundingShape().

void QGeoLocation::setCoordinate(const QGeoCoordinate &coordinate)

Sets the coordinate of the location.

See also coordinate().

void QGeoLocation::setExtendedAttributes(const QVariantMap &data)

Sets the extended attributes of the location with the parameters specified in data.

\since5.13

See also extendedAttributes().

QGeoLocation &QGeoLocation::operator=(const QGeoLocation &other)

Assigns other to this location and returns a reference to this location.

[noexcept] QGeoLocation &QGeoLocation::operator=(QGeoLocation &&other)

\since6.2

Move-assings other to this location and returns a reference to this location.

Note: The moved-from QGeoLocation object can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.

Related Non-Members

[noexcept] int qHash(const QGeoLocation &location, int seed = 0)

Returns the hash value for the location, using seed for the calculation.

Note: The hash does not take extended attributes into account. This means that two geo location objects that differ only in the extended attributes will provide similar hashes.

bool operator!=(const QGeoLocation &lhs, const QGeoLocation &rhs)

Returns true if the lhs location is not equal to rhs, otherwise returns false.

bool operator==(const QGeoLocation &lhs, const QGeoLocation &rhs)

Returns true if the lhs location is equal to rhs, otherwise returns false.