summaryrefslogtreecommitdiff
path: root/doc/src/examples/declarative-flickr.qdoc
blob: 29739c70b742b5ac6454ae80575c0193f191d761 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example declarative/flickr
    \title Flickr (QML)
    \ingroup qtlocation-examples

    \brief The Flickr example shows how to use the user's current location to
           fetch local content from a web service.

    This is a small example, illustrating one of the very core parts of the
    Qt Location API: the ability to retrieve and use the user's current
    geographic location.

    Key QML types shown in this example:
    \list
        \li \l{QtLocation5::PositionSource}{PositionSource}
        \li \l{XmlListModel}{XmlListModel}
    \endlist

    \image  qml-flickr-1.jpg

    \section2 Retrieving the Current Location

    Retrieving the user's current location is achieved using the PositionSource
    type. In this example, we instantiate the PositionSource as part of the
    GeoTab component (the floating "window" describing current location and
    status).

    \snippet examples/declarative/flickr/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 examples/declarative/flickr/flickrmobile/GeoTab.qml locatebutton-top
    \snippet examples/declarative/flickr/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 examples/declarative/flickr/flickrmobile/GeoTab.qml props

    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 location

    \snippet examples/declarative/flickr/flickrcommon/RestModel.qml restmodel

    This model data is then shown in a variety of Qt Quick views to produce
    the example application.

*/