Add new Satellite Information example

[ChangeLog][QtPositioning] New SatelliteInfo example
added. The example displays the signal strength of surrounding satellites.
The example employs a demo mode on those platforms which don't provide
satellite information

Change-Id: I573266c7a4429c0d2f1bcdfeb01af52ad02efba7
Reviewed-by: Aaron McCarthy <mccarthy.aaron@gmail.com>
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>

2 files changed, 74 insertions, 0 deletions

diff --git a/src/positioning/doc/src/examples/satelliteinfo.qdoc b/src/positioning/doc/src/examples/satelliteinfo.qdoc
new file mode 100644
index 00000000..1edb8f6c
--- /dev/null
+++ b/src/positioning/doc/src/examples/satelliteinfo.qdoc
@@ -0,0 +1,73 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 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$
+**
+****************************************************************************/
+
+/*!
+    \example satelliteinfo
+    \title SatelliteInfo (C++/QML)
+
+    \brief The SatelliteInfo example shows how the available satellites
+    at the user's current position and marks the satellites
+    currently contributing to the GPS fix as pink.
+
+    \ingroup qtpositioning-examples
+
+    Key Qt Positioning classes used in this example:
+
+    \list
+    \li \l{QGeoSatelliteInfo}
+    \li \l{QGeoSatelliteInfoSource}
+    \endlist
+
+    \image ../images/example-satelliteinfo.png
+
+    The example displays the signal strength of all satellites in view. Any satellite
+    that is currently used to calculate the GPS fix has been marked pink. The number at
+    the bottom of each signal bar is the individual satellite identifier.
+
+    The application operates in three different modes:
+
+    \table
+        \header
+            \li Application mode
+            \li Description
+        \row
+            \li running
+            \li The application continuously queries the system for satellite updates. When new data
+                is available it will be displayed.
+        \row
+            \li stopped
+            \li The application stops updating the satellite information.
+        \row
+            \li single
+            \li The application makes a single update request with a timeout of 10s. The display
+                remains empty until the request was answered by the system.
+    \endtable
+
+    If the platform does not provide satellite information the application automatically
+    switches into a demo mode whereby it continuously switches between predefined
+    sets of satellite data.
+*/
diff --git a/src/positioning/doc/src/qtpositioning.qdoc b/src/positioning/doc/src/qtpositioning.qdoc
index ea353942..091b8c77 100644
--- a/src/positioning/doc/src/qtpositioning.qdoc
+++ b/src/positioning/doc/src/qtpositioning.qdoc
@@ -115,6 +115,7 @@ such as speed and direction. This provides the fundamental location information
 \list
     \li \l {Flickr (QML)}
     \li \l {Log File Position Source (C++)}
+    \li \l {SatelliteInfo (C++/QML)}
     \li \l {Weather Info (C++/QML)}
 \endlist
 */