qtlocation-qml.qdoc

Go to the documentation of this file.

// Copyright (C) 2018 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
/*!
    \qmlmodule QtLocation \QtVer
    \title Qt Location QML Types
    \ingroup qmlmodules
    \brief Provides QML types for mapping and location information.
 
    \section1 Overview
 
    In short, the main QML types and their roles are as follows:
 
    \list
        \li The \l [QML] Place instances hold information about the
            destination and surrounding objects, including displayable
            representations.
        \li The \l [QML] Map enables the information contained in
            \l [QML] {Place} objects to be displayed, panned, zoomed,
            and so on.
        \li The \l [QML] route is be determined by a \e plugin, with each
            \l [QML] routeSegment holding the navigation instructions,
            guided by the continuously updated current \l [QML] Location.
    \endlist
 
    \section2 Plugins
 
    \l {Plugin}s supply the data required to calculate routes and navigation
    instructions, and they are typically tied to a specific location-based
    service. For example, a plugin may allow connecting to a service that
    provides geocoding and routing information, which can be consumed by the
    application.
 
    There may be various GeoServices plugins for various tasks, with some
    plugins providing more than one service. One QML \l Plugin instance must
    be created for each GeoService plugin. Plugins are required for routing
    and geocoding, maps, and places, however the default plugin handles all
    four of these services. A plugin may require online access or it may
    support on-board maps and data.
 
    \note Plugins may not provide features such as paging or relevance hints.
 
    \section2 Related Information
 
    The following links provide more information about maps and places:
 
    \table
        \row
            \li \l {Maps and Navigation (QML)}{Maps and Navigation}
            \li Displaying maps and finding routes
        \row
            \li \l {QML Places API} {Places}
            \li Searching for and managing points of interest
    \endtable
 
    \section1 Common QML Types
 
    \annotatedlist qml-QtLocation5-common
 
    \section1 Maps QML Types
 
    \annotatedlist qml-QtLocation5-maps
 
    \section1 Navigation and Routing QML Types
 
    \annotatedlist qml-QtLocation5-routing
 
    \section1 Geocoding QML Types
 
    \annotatedlist qml-QtLocation5-geocoding
 
    \section1 Places QML Types
 
    \annotatedlist qml-QtLocation5-places
 
    \section1 Alphabetical Listing of All QML Types
*/