summaryrefslogtreecommitdiff
path: root/src/location/doc/src/qtlocation-cpp.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/location/doc/src/qtlocation-cpp.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/location/doc/src/qtlocation-cpp.qdoc')
-rw-r--r--src/location/doc/src/qtlocation-cpp.qdoc25
1 files changed, 9 insertions, 16 deletions
diff --git a/src/location/doc/src/qtlocation-cpp.qdoc b/src/location/doc/src/qtlocation-cpp.qdoc
index c13360b5..0c0f946d 100644
--- a/src/location/doc/src/qtlocation-cpp.qdoc
+++ b/src/location/doc/src/qtlocation-cpp.qdoc
@@ -30,17 +30,16 @@
\title Qt Location C++ API
\brief Information about the Qt Location C++ API
-The Location API provides a library for location positioning, mapping and navigation.
+The Location API provides a library for mapping, navigation and place information.
\tableofcontents
-The Qt Location API provides the developer with a set of functions for determining
-the current location and using that information with maps and places of interest.
+The Qt Location API provides the developer with a set of functions to interact
+with maps, navigational data and places of interest. This is particularly useful
+when associated with current position information which can be retrieved via the
+\l QtPositioning module.
-Positioning information can be sourced from GPS satellites or a stream of data using
-NMEA formatted text. Once a position is acquired we can monitor the updated
-position to see if it moves into or out of a given region. With the Maps API
-we can associate the position with a map in various formats supplied by a backend.
+With the Maps API we can associate a position with a map in various formats supplied by a backend.
Then the Places API could be used to populate places on the Map or even
specify the current position as a place of interest and associate it with
an icon, contact details and other information.
@@ -50,25 +49,17 @@ Qt Location C++ API.
\table
\row
- \li \l {Positioning (C++)}{Location Positioning}
- \li Retrieving information about the current position.
- \row
\li \l {Maps and Navigation (C++)}{Maps and Navigation}
\li Displaying maps and finding routes.
\row
\li \l {Places (C++)} {Places}
\li Searching for and managing points of interest.
\row
- \li \l {Qt Location GeoServices}{Geoservices and Positioning Plugin Implementation}
+ \li \l {Qt Location GeoServices}{Geoservices Plugin Implementation}
\li Implement new geoservices and positioning plugins.
\endtable
-\section1 Positioning Classes
-
- \annotatedlist QtLocation-positioning
-
-
\section1 Geoservice Provider Classes
\annotatedlist QtLocation-common
@@ -76,6 +67,8 @@ Qt Location C++ API.
\section1 Maps and Navigation Classes
+Currently it is not possible to interact with maps data via C++. The only available interface is the \l {Maps and Navigation (QML)} API.
+
\annotatedlist QtLocation-maps
\annotatedlist QtLocation-routing