summaryrefslogtreecommitdiff
path: root/src/positioning/qdeclarativegeolocation.cpp
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2013-08-16 10:02:13 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-09-02 14:30:40 +0200
commitd35d28017d731dba9e2a4f2622d2cec97e724e55 (patch)
treefd1fbbaeb20c641ca868a424f3ee051c7c6c3a28 /src/positioning/qdeclarativegeolocation.cpp
parentea5f625ab90406d7407bc961b90b3993230dd03a (diff)
downloadqtlocation-d35d28017d731dba9e2a4f2622d2cec97e724e55.tar.gz
Split QtLocation into QtPositioning and QtLocation
QtPositioning is not dependent on any gui component and mostly covers everything around the retrieval of position information. QtLocation covers place, map and navigation APIs. Several documentation issues were fixed during the process. Change-Id: I98e2a53065549a2fc43f93a75b4f65b5bc884c92 Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Diffstat (limited to 'src/positioning/qdeclarativegeolocation.cpp')
-rw-r--r--src/positioning/qdeclarativegeolocation.cpp192
1 files changed, 192 insertions, 0 deletions
diff --git a/src/positioning/qdeclarativegeolocation.cpp b/src/positioning/qdeclarativegeolocation.cpp
new file mode 100644
index 00000000..95ba3113
--- /dev/null
+++ b/src/positioning/qdeclarativegeolocation.cpp
@@ -0,0 +1,192 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qdeclarativegeolocation_p.h"
+
+QT_USE_NAMESPACE
+
+/*!
+ \qmltype Location
+ \instantiates QDeclarativeGeoLocation
+ \inqmlmodule QtPositioning 5.0
+ \since Qt Positioning 5.0
+
+ \brief 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 {boundingBox}{bounding box}.
+ The \l {boundingBox}{bounding box} 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.
+
+ \section2 Example Usage
+
+ The following example shows a simple Location object being declared:
+
+ \code
+ Location {
+ coordinate {
+ latitude: -27.3
+ longitude: 153.1
+ }
+ address: Address {
+ ...
+ }
+ }
+ \endcode
+*/
+
+QDeclarativeGeoLocation::QDeclarativeGeoLocation(QObject *parent)
+: QObject(parent), m_address(0)
+
+{
+ setLocation(QGeoLocation());
+}
+
+QDeclarativeGeoLocation::QDeclarativeGeoLocation(const QGeoLocation &src, QObject *parent)
+: QObject(parent), m_address(0)
+{
+ setLocation(src);
+}
+
+QDeclarativeGeoLocation::~QDeclarativeGeoLocation()
+{
+}
+
+/*!
+ \qmlproperty QGeoLocation QtPositioning::Location::location
+
+ For details on how to use this property to interface between C++ and QML see
+ "\l {positioning-cpp-qml.html#location} {Interfaces between C++ and QML Code}".
+*/
+void QDeclarativeGeoLocation::setLocation(const QGeoLocation &src)
+{
+ if (m_address && m_address->parent() == this) {
+ m_address->setAddress(src.address());
+ } else if (!m_address || m_address->parent() != this) {
+ m_address = new QDeclarativeGeoAddress(src.address(), this);
+ emit addressChanged();
+ }
+
+ setCoordinate(src.coordinate());
+ setBoundingBox(src.boundingBox());
+}
+
+QGeoLocation QDeclarativeGeoLocation::location() const
+{
+ QGeoLocation retValue;
+ retValue.setAddress(m_address ? m_address->address() : QGeoAddress());
+ retValue.setCoordinate(m_coordinate);
+ retValue.setBoundingBox(m_boundingBox);
+ return retValue;
+}
+
+/*!
+ \qmlproperty Address QtPositioning::Location::address
+
+ This property holds the address of the location which can be use to retrieve address details of the location.
+*/
+void QDeclarativeGeoLocation::setAddress(QDeclarativeGeoAddress *address)
+{
+ if (m_address == address)
+ return;
+
+ if (m_address && m_address->parent() == this)
+ delete m_address;
+
+ m_address = address;
+ emit addressChanged();
+}
+
+QDeclarativeGeoAddress *QDeclarativeGeoLocation::address() const
+{
+ return m_address;
+}
+
+/*!
+ \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.
+*/
+void QDeclarativeGeoLocation::setCoordinate(const QGeoCoordinate coordinate)
+{
+ if (m_coordinate == coordinate)
+ return;
+
+ m_coordinate = coordinate;
+ emit coordinateChanged();
+}
+
+QGeoCoordinate QDeclarativeGeoLocation::coordinate() const
+{
+ return m_coordinate;
+}
+
+/*!
+ \qmlproperty georectangle QtPositioning::Location::boundingBox
+
+ 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.
+*/
+void QDeclarativeGeoLocation::setBoundingBox(const QGeoRectangle &boundingBox)
+{
+ if (m_boundingBox == boundingBox)
+ return;
+
+ m_boundingBox = boundingBox;
+ emit boundingBoxChanged();
+}
+
+QGeoRectangle QDeclarativeGeoLocation::boundingBox() const
+{
+ return m_boundingBox;
+}