summaryrefslogtreecommitdiff
path: root/src/location/doc/src/qtlocation-cpp.qdoc
blob: c13360b5598de84e5faae6277e36783ab30f0b00 (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
90
91
92
93
94
95
96
/****************************************************************************
**
** Copyright (C) 2013 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$
**
****************************************************************************/

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

The Location API provides a library for location positioning, mapping and navigation.

\tableofcontents

The Qt Location API provides the developer with a set of functions for determining
the current location and using that information with maps and places of interest.

Positioning information can be sourced from GPS satellites or a stream of data using
NMEA formatted text. Once a position is acquired we can monitor the updated
position to see if it moves into or out of a given region. With the Maps API
we can associate the 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 {Positioning (C++)}{Location Positioning}
        \li Retrieving information about the current position.
    \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 and Positioning Plugin Implementation}
        \li Implement new geoservices and positioning plugins.
\endtable


\section1 Positioning Classes

    \annotatedlist QtLocation-positioning


\section1 Geoservice Provider Classes

    \annotatedlist QtLocation-common


\section1 Maps and Navigation Classes

    \annotatedlist QtLocation-maps

    \annotatedlist QtLocation-routing

    \annotatedlist QtLocation-geocoding


\section1 Places Classes

    \annotatedlist QtLocation-places


\section1 Geoservices and Positioning Plugin Classes

    \annotatedlist QtLocation-impl

*/