1// Copyright (C) 2018 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
5 \qmlmodule QtLocation \QtVer
6 \title Qt Location QML Types
8 \brief Provides QML types for mapping and location information.
12 In short, the main QML types and their roles are as follows:
15 \li The \l [QML] Place instances hold information about the
16 destination and surrounding objects, including displayable
18 \li The \l [QML] Map enables the information contained in
19 \l [QML] {Place} objects to be displayed, panned, zoomed,
21 \li The \l [QML] route is be determined by a \e plugin, with each
22 \l [QML] routeSegment holding the navigation instructions,
23 guided by the continuously updated current \l [QML] Location.
28 \l {Plugin}s supply the data required to calculate routes and navigation
29 instructions, and they are typically tied to a specific location-based
30 service. For example, a plugin may allow connecting to a service that
31 provides geocoding and routing information, which can be consumed by the
34 There may be various GeoServices plugins for various tasks, with some
35 plugins providing more than one service. One QML \l Plugin instance must
36 be created for each GeoService plugin. Plugins are required for routing
37 and geocoding, maps, and places, however the default plugin handles all
38 four of these services. A plugin may require online access or it may
39 support on-board maps and data.
41 \note Plugins may not provide features such as paging or relevance hints.
43 \section2 Related Information
45 The following links provide more information about maps and places:
49 \li \l {Maps and Navigation (QML)}{Maps and Navigation}
50 \li Displaying maps and finding routes
52 \li \l {QML Places API} {Places}
53 \li Searching for and managing points of interest
56 \section1 Common QML Types
58 \annotatedlist qml-QtLocation5-common
60 \section1 Maps QML Types
62 \annotatedlist qml-QtLocation5-maps
64 \section1 Navigation and Routing QML Types
66 \annotatedlist qml-QtLocation5-routing
68 \section1 Geocoding QML Types
70 \annotatedlist qml-QtLocation5-geocoding
72 \section1 Places QML Types
74 \annotatedlist qml-QtLocation5-places
76 \section1 Alphabetical Listing of All QML Types