summaryrefslogtreecommitdiff
path: root/src/location/doc/src/qml-maps.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/qml-maps.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/qml-maps.qdoc')
-rw-r--r--src/location/doc/src/qml-maps.qdoc33
1 files changed, 28 insertions, 5 deletions
diff --git a/src/location/doc/src/qml-maps.qdoc b/src/location/doc/src/qml-maps.qdoc
index 45cf82f4..f63cc5a4 100644
--- a/src/location/doc/src/qml-maps.qdoc
+++ b/src/location/doc/src/qml-maps.qdoc
@@ -53,15 +53,41 @@ Interaction with the added items, and the \l Map itself, is handled by \l MapMou
are added as children of the
\l {Maps and Navigation (QML)#Putting Objects on a Map (Map Overlay Objects)}{MapItems} or \l Map.
-\section2 Position
+\section2 Position on map
+All position APIs are part of the \l {QtPositioning} module.
The basic piece of position information is the \l {coordinate}. A
coordinate encapsulates data for the latitude, longitude and altitude of the location. Altitude is
in meters. It also has a method to determine distance to another
\l {coordinate}. The \l {coordinate} type may
-also be held within a \l {QtLocation5::Location}{Location} element, this will also have information
+also be held within a \l {QtPositioning5::Location}{Location} element, this will also have information
on a bounding box size to determine sufficient proximity to the location and a location address.
+
+Here is an example of a client that uses a \l{PositionSource}{position source}
+to center a \l{Map}{map} on the current position:
+
+\code
+ Rectangle {
+
+ import QtPositioning 5.0
+ import QtLocation 5.0
+ ...
+
+ map : Map {
+ // initialize map
+ ...
+ }
+
+ PositionSource {
+ onPositionChanged: {
+ // center the map on the current position
+ map.center = position.coordinate
+ }
+ }
+ }
+\endcode
+
\section2 Geocoding
\l {http://en.wikipedia.org/wiki/Geocoding}{Geocoding} is the derivation of
@@ -194,9 +220,6 @@ example, by implementing the \c onValueChanged handler to update the Map
\section1 Types
-\section3 Positioning
-\annotatedlist qml-QtLocation5-positioning
-
\section3 Maps
\annotatedlist qml-QtLocation5-maps