summaryrefslogtreecommitdiff
path: root/src/location/doc/src/qtlocation-cpp.qdoc
blob: 82ac766ecb918d6a00cc0b4a1df9bcc1cb9d20a9 (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
84
85
86
87
88
89
/****************************************************************************
**
** 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$
**
****************************************************************************/

/*!
\page qtlocation-cpp.html
\title Qt Location C++ API
\brief Information about the Qt Location C++ API

The Location API provides a library for mapping, navigation and place information.

\tableofcontents

The Qt Location API provides the developer with a set of functions to interact
with maps, navigational data and places of interest. This is particularly useful
when associated with current position information which can be retrieved via the
\l QtPositioning module.

With the Maps API we can associate a position with a map in various formats supplied by a backend.
Then the Places API could be used to populate places on the Map or even
specify the current position as a place of interest and associate it with
an icon, contact details and other information.

The following table provides links to more detailed information on sections of the
Qt Location C++ API.

\table
    \row
        \li \l {Maps and Navigation (C++)}{Maps and Navigation}
        \li Displaying maps and finding routes.
    \row
        \li \l {Places (C++)} {Places}
        \li Searching for and managing points of interest.
    \row
        \li \l {Qt Location GeoServices}{Geoservices Plugin Implementation}
        \li Implement new geoservices and positioning plugins.
\endtable


\section1 Geoservice Provider Classes

    \annotatedlist QtLocation-common


\section1 Maps and Navigation Classes

Currently it is not possible to interact with maps data via C++. The only available interface is the \l {Maps and Navigation (QML)} API.

    \annotatedlist QtLocation-maps

    \annotatedlist QtLocation-routing

    \annotatedlist QtLocation-geocoding


\section1 Places Classes

    \annotatedlist QtLocation-places


\section1 Geoservices and Positioning Plugin Classes

    \annotatedlist QtLocation-impl

*/