summaryrefslogtreecommitdiff
path: root/src/positioning/doc/src/qtpositioning.qdoc
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/doc/src/qtpositioning.qdoc
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/doc/src/qtpositioning.qdoc')
-rw-r--r--src/positioning/doc/src/qtpositioning.qdoc124
1 files changed, 124 insertions, 0 deletions
diff --git a/src/positioning/doc/src/qtpositioning.qdoc b/src/positioning/doc/src/qtpositioning.qdoc
new file mode 100644
index 00000000..95b3fecc
--- /dev/null
+++ b/src/positioning/doc/src/qtpositioning.qdoc
@@ -0,0 +1,124 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+
+
+/*!
+ \module QtPositioning
+ \title Qt Positioning C++ Classes
+ \ingroup modules
+ \qtvariable location
+
+ \brief The Positioning module provides positioning information via QML and C++ interfaces.
+
+ To load the Qt Positioning module, add the following statement to your .qml files
+
+ \code
+ import QtPositioning 5.0
+ \endcode
+
+ For C++ projects include the header appropriate for the current use case,
+ for example applications using routes may use
+
+ \code #include <QGeoCoordinate> \endcode
+
+ The .pro file should have the \e positioning keyword added
+
+ \code QT += positioning \endcode
+
+
+ See more in the \l{Qt Positioning}{Qt Positioning Overview}.
+
+*/
+
+
+
+/*!
+\page qtpositioning-index.html
+\title Qt Positioning
+\brief The Qt Positioning API provides positioning information via QML and C++ interfaces.
+\ingroup technology-apis
+
+The Qt Positioning API provides positioning information via QML and C++ interfaces.
+
+\section1 Overview
+
+The Qt Positioning API gives developers the ability to determine a position by
+using a variety of possible sources, including satellite, or wifi, or text file,
+and so on. That information can then be used to for example determine a position
+on a map. In addition satellite information can be retrieved and area based monitoring
+can be performed.
+
+\section1 Getting Started
+
+To load the Qt Positioning module, add the following statement to your .qml files
+
+\code
+ import QtPositioning 5.0
+\endcode
+
+For C++ projects include the header appropriate for the current use case,
+for example applications using routes may use
+
+\code #include <QGeoCoordinate> \endcode
+
+The .pro file should have the \e positioning keyword added
+
+\code QT += positioning \endcode
+
+\section1 Related information
+\section2 Overview
+
+Positioning includes all the functionality necessary to find and work with geographic
+coordinates. It can use a variety of external sources of information, including GPS. This
+provides us with a coordinate and altitude for the device with additional features
+such as speed and direction. This provides the fundamental location information used in the API.
+
+\section2 References
+\table
+\row
+ \li Positioning introduction:
+ \li \l{Positioning (QML)}{for QML}
+ \li \l{Positioning (C++)}{for C++}
+\row
+ \li API references:
+ \li \l {Qt Positioning QML Types}{for QML}
+ \li \l {Qt Positioning C++ Classes}{for C++}
+\row
+ \li Position plugins:
+ \li \l {Qt Positioning service plugins}
+\endtable
+
+\section2 Examples
+
+\list
+ \li \l {Flickr (QML)}
+ \li \l {Log File Position Source (C++)}
+ \li \l {Weather Info (C++/QML)}
+\endlist
+*/