summaryrefslogtreecommitdiff
path: root/examples/positioning/geoflickr
diff options
context:
space:
mode:
Diffstat (limited to 'examples/positioning/geoflickr')
-rw-r--r--examples/positioning/geoflickr/doc/images/qml-flickr-1.jpgbin0 -> 66794 bytes
-rw-r--r--examples/positioning/geoflickr/doc/src/geoflickr.qdoc87
2 files changed, 87 insertions, 0 deletions
diff --git a/examples/positioning/geoflickr/doc/images/qml-flickr-1.jpg b/examples/positioning/geoflickr/doc/images/qml-flickr-1.jpg
new file mode 100644
index 00000000..42514ff0
--- /dev/null
+++ b/examples/positioning/geoflickr/doc/images/qml-flickr-1.jpg
Binary files differ
diff --git a/examples/positioning/geoflickr/doc/src/geoflickr.qdoc b/examples/positioning/geoflickr/doc/src/geoflickr.qdoc
new file mode 100644
index 00000000..6d043d4d
--- /dev/null
+++ b/examples/positioning/geoflickr/doc/src/geoflickr.qdoc
@@ -0,0 +1,87 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 geoflickr
+ \title GeoFlickr (QML)
+ \ingroup qtpositioning-examples
+
+ \brief The GeoFlickr example shows how to use the user's current position to
+ fetch local content from a web service.
+
+ This is a small example, illustrating one of the very core parts of the
+ \l{Qt Positioning} API: the ability to retrieve and use the user's current
+ geographic position.
+
+ Key QML types shown in this example:
+ \list
+ \li \l{QtPositioning::PositionSource}{PositionSource}
+ \li \l{XmlListModel}{XmlListModel}
+ \endlist
+
+ \image qml-flickr-1.jpg
+
+ \include examples-run.qdocinc
+
+ \section1 Retrieving the Current Position
+
+ Retrieving the user's current position is achieved using the PositionSource
+ type. In this example, we instantiate the PositionSource as part of the
+ GeoTab component (the floating "window" describing current position and
+ status).
+
+ \snippet geoflickr/flickrmobile/GeoTab.qml possrc
+
+ When the "Locate and update" button is pressed, we first interrogate the
+ PositionSource to check if it has an available backend for positioning
+ data. If it does not, we fall back to using a pre-recorded NMEA log
+ for demonstration. We then instruct the PositionSource to update.
+
+ \snippet geoflickr/flickrmobile/GeoTab.qml locatebutton-top
+ \snippet geoflickr/flickrmobile/GeoTab.qml locatebutton-clicked
+
+ To share the new position data with the rest of the application, we use
+ properties that we have created on the GeoTab component:
+
+ \snippet geoflickr/flickrmobile/GeoTab.qml props
+
+ \section1 Using the Current Position
+
+ The longitude and latitude values retrieved here are eventually set on
+ in properties on the RestModel component. The RestModel is an XmlListModel,
+ which retrieves XML data from a URL and creates a data model by performing
+ XPath queries on it.
+
+ In this case, it retrieves data from the Flickr REST API online, based on
+ our current position
+
+ \snippet geoflickr/flickrcommon/RestModel.qml restmodel
+
+ This model data is then shown in a variety of Qt Quick views to produce
+ the example application.
+
+*/