summaryrefslogtreecommitdiff
path: root/src/location/doc/src/qtlocation-examples.qdoc
blob: 02938c0ebc9edacde4e96adb6258b0b93d9aaed2 (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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \group qtlocation-examples
    \title Qt Location Examples
    \brief Examples for the Qt Location module
    \ingroup all-examples
    \ingroup qtlocation

    These examples show a range of different uses for \l{Qt Location},
    such as displaying a map within a QML user interface, implementing basic routing and
    place search, as well as integrating positioning data types.

    These examples can work with any of the available geo services plugins. However, some plugins may
    require additional \l {QtLocation::PluginParameter}{plugin parameters} in order to function correctly.
    The default plugin used by these examples is \l {Qt Location Open Street Map Plugin}, which does not
    require any parameters. The \l {Qt Location Mapbox GL Plugin} was used for the screenshots and can also
    be used without any parameters, for development purposes, on the platforms it is available.
*/