blob: 7d826e84b05af5cb7d8cf67639dca61ea82e6fda [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtPositioning module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qgeolocation.h"
#include "qgeolocation_p.h"
QT_USE_NAMESPACE
QGeoLocationPrivate::QGeoLocationPrivate()
: QSharedData()
{
}
QGeoLocationPrivate::QGeoLocationPrivate(const QGeoLocationPrivate &other)
: QSharedData()
{
this->address = other.address;
this->coordinate = other.coordinate;
this->viewport = other.viewport;
this->extendedAttributes = other.extendedAttributes;
}
QGeoLocationPrivate::~QGeoLocationPrivate()
{
}
bool QGeoLocationPrivate::operator==(const QGeoLocationPrivate &other) const
{
return (this->address == other.address
&& this->coordinate == other.coordinate
&& this->viewport == other.viewport
&& this->extendedAttributes == other.extendedAttributes);
}
bool QGeoLocationPrivate::isEmpty() const
{
return (address.isEmpty()
&& !coordinate.isValid()
&& viewport.isEmpty()
&& extendedAttributes.isEmpty());
}
/*!
\class QGeoLocation
\inmodule QtPositioning
\ingroup QtPositioning-positioning
\ingroup QtLocation-places
\ingroup QtLocation-places-data
\since 5.2
\brief The QGeoLocation class represents basic information about a location.
A QGeoLocation consists of a coordinate and corresponding address, along with an optional
bounding box which is the recommended region to be displayed when viewing the location.
*/
/*!
\fn bool QGeoLocation::operator!=(const QGeoLocation &other) const
Returns true if this location is not equal to \a other, otherwise returns false.
*/
/*!
Constructs an new location object.
*/
QGeoLocation::QGeoLocation()
: d(new QGeoLocationPrivate)
{
}
/*!
Constructs a copy of \a other
*/
QGeoLocation::QGeoLocation(const QGeoLocation &other)
:d(other.d)
{
}
/*!
Destroys the location object.
*/
QGeoLocation::~QGeoLocation()
{
}
/*!
Assigns \a other to this location and returns a reference to this location.
*/
QGeoLocation &QGeoLocation::operator =(const QGeoLocation &other)
{
if (this == &other)
return *this;
d = other.d;
return *this;
}
/*!
Returns true if this location is equal to \a other,
otherwise returns false.
*/
bool QGeoLocation::operator==(const QGeoLocation &other) const
{
return (*(d.constData()) == *(other.d.constData()));
}
/*!
Returns the address of the location.
*/
QGeoAddress QGeoLocation::address() const
{
return d->address;
}
/*!
Sets the \a address of the location.
*/
void QGeoLocation::setAddress(const QGeoAddress &address)
{
d->address = address;
}
/*!
Returns the coordinate of the location.
*/
QGeoCoordinate QGeoLocation::coordinate() const
{
return d->coordinate;
}
/*!
Sets the \a coordinate of the location.
*/
void QGeoLocation::setCoordinate(const QGeoCoordinate &coordinate)
{
d->coordinate = coordinate;
}
/*!
Returns a bounding box 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.
*/
QGeoRectangle QGeoLocation::boundingBox() const
{
return d->viewport;
}
/*!
Sets the \a boundingBox of the location.
*/
void QGeoLocation::setBoundingBox(const QGeoRectangle &boundingBox)
{
d->viewport = boundingBox;
}
/*!
Returns the extended attributes associated to this location.
Extended attributes are backend-dependent and can be location-dependent.
\since 5.13
*/
QVariantMap QGeoLocation::extendedAttributes() const
{
return d->extendedAttributes;
}
/*!
Sets the extended attributes of the location with the
parameters specified in \a data.
\since 5.13
*/
void QGeoLocation::setExtendedAttributes(const QVariantMap &data)
{
d->extendedAttributes = data;
}
/*!
Returns true if all fields of the location are 0; otherwise returns false.
*/
bool QGeoLocation::isEmpty() const
{
return d->isEmpty();
}