summaryrefslogtreecommitdiff
path: root/src/imports/positioning/locationsingleton.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/imports/positioning/locationsingleton.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/imports/positioning/locationsingleton.cpp')
-rw-r--r--src/imports/positioning/locationsingleton.cpp163
1 files changed, 163 insertions, 0 deletions
diff --git a/src/imports/positioning/locationsingleton.cpp b/src/imports/positioning/locationsingleton.cpp
new file mode 100644
index 00000000..c44db946
--- /dev/null
+++ b/src/imports/positioning/locationsingleton.cpp
@@ -0,0 +1,163 @@
+/****************************************************************************
+**
+** 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 "locationsingleton.h"
+
+/*!
+ \qmltype QtPositioning
+ \instantiates LocationSingleton
+ \inqmlmodule QtPositioning 5.0
+
+ \brief The QtPositioning global object provides useful functions for working with location-based
+ types in QML.
+
+ \qml
+ import QtPositioning 5.0
+
+ Item {
+ property variant coordinate: QtPositioning.coordinate(-27.5, 153.1)
+ }
+ \endqml
+*/
+
+LocationSingleton::LocationSingleton(QObject *parent)
+: QObject(parent)
+{
+}
+
+/*!
+ \qmlmethod coordinate ::QtPositioning::coordinate()
+
+ Constructs an invalid coordinate.
+
+*/
+QGeoCoordinate LocationSingleton::coordinate() const
+{
+ return QGeoCoordinate();
+}
+
+/*!
+ \qmlmethod coordinate QtPositioning::coordinate(real latitude, real longitue, real altitude) const
+
+ Constructs a coordinate with the specified \a latitude, \a longitude and optional \a altitude.
+ Both \a latitude and \a longitude must be valid, otherwise an invalid coordinate is returned.
+
+ \sa {coordinate}
+*/
+QGeoCoordinate LocationSingleton::coordinate(double latitude, double longitude, double altitude) const
+{
+ return QGeoCoordinate(latitude, longitude, altitude);
+}
+
+/*!
+ \qmlmethod geoshape QtPositioning::shape() const
+
+ Constructs an invalid geoshape.
+
+ \sa {geoshape}
+*/
+QGeoShape LocationSingleton::shape() const
+{
+ return QGeoShape();
+}
+
+/*!
+ \qmlmethod georectangle QtPositioning::rectangle() const
+
+ Constructs an invalid georectangle.
+
+ \sa {georectangle}
+*/
+QGeoRectangle LocationSingleton::rectangle() const
+{
+ return QGeoRectangle();
+}
+
+/*!
+ \qmlmethod georectangle QtPositioning::rectangle(coordinate center, real width, real height) const
+
+ Constructs a georectangle centered at \a center with a width of \a width degrees and a hight of
+ \a height degrees.
+
+ \sa {georectangle}
+*/
+QGeoRectangle LocationSingleton::rectangle(const QGeoCoordinate &center,
+ double width, double height) const
+{
+ return QGeoRectangle(center, width, height);
+}
+
+/*!
+ \qmlmethod georectangle QtPositioning::rectangle(coordinate topLeft, coordinate bottomRight) const
+
+ Constructs a georectangle with its top left corner positioned at \a topLeft and its bottom
+ right corner positioned at \a {bottomLeft}.
+
+ \sa {georectangle}
+*/
+QGeoRectangle LocationSingleton::rectangle(const QGeoCoordinate &topLeft,
+ const QGeoCoordinate &bottomRight) const
+{
+ return QGeoRectangle(topLeft, bottomRight);
+}
+
+/*!
+ \qmlmethod geocircle QtPositioning::circle() const
+
+ Constructs an invalid geocircle.
+
+ \sa {geocircle}
+*/
+QGeoCircle LocationSingleton::circle() const
+{
+ return QGeoCircle();
+}
+
+/*!
+ \qmlmethod geocircle QtPositioning::circle(coordinate center, real radius) const
+
+ Constructs a geocircle centered at \a center with a radius of \a radius meters.
+*/
+QGeoCircle LocationSingleton::circle(const QGeoCoordinate &center, qreal radius) const
+{
+ return QGeoCircle(center, radius);
+}
+