<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtlocation-qml.qdoc -->
<title>Qt Location QML Types | Qt Location 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtlocation-index.html">Qt Location</a></td><td >Qt Location QML Types</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#overview">Overview</a></li>
<li class="level1"><a href="#common-qml-types">Common QML Types</a></li>
<li class="level1"><a href="#maps-qml-types">Maps QML Types</a></li>
<li class="level1"><a href="#navigation-and-routing-qml-types">Navigation and Routing QML Types</a></li>
<li class="level1"><a href="#geocoding-qml-types">Geocoding QML Types</a></li>
<li class="level1"><a href="#places-qml-types">Places QML Types</a></li>
<li class="level1"><a href="#alphabetical-listing-of-all-qml-types">Alphabetical Listing of All QML Types</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Location QML Types</h1>
<span class="subtitle"></span>
<!-- $$$QtLocation-description -->
<div class="descr"> <a name="details"></a>
<a name="overview"></a>
<h2 id="overview">Overview</h2>
<p>Provided that a position has been obtained, this module can add a <a href="qml-qtlocation-map.html">Map</a> with Places of Interest (POI) and <a href="qml-qtlocation-place.html">Places</a>. The user can be made aware of nearby features and related information, displayed graphically. Features on the <a href="qml-qtlocation-map.html">Map</a> can be places of business, entertainment, and so on. They may include paths, roads, or forms of transport, enabling navigation optimization and assistance.</p>
<p>To perform navigation we need <a href="qml-qtlocation-route.html">Route</a>s from start to destination. These routes are made up of segments, where each <a href="qml-qtlocation-routesegment.html">RouteSegment</a> can be considered a navigation subtask: drive 100 meters, turn left. The beginning and end of each segment is a <i>waypoint</i>, that is, one part of our journey.</p>
<p>A typical use case for the API is a user looking for a particular type of place, say a restaurant. The user could enter a search string into the map application and respond to a list or display of results for restaurants "near" the device. The application could then be used to navigate to the restaurant using an optimized route that is aware of features in the environment that can help or hinder the journey. The navigation then proceeds with the user's progress monitored by means of the current Location. In the context of this API the map application would be aware of the location and size of various places and the location of the user. Plugins would supply the data required by the application to determine routes and navigation instructions. The <a href="qml-qtlocation-place.html">Place</a> types would hold information about the destination and surrounding objects including displayable representations. The <a href="qml-qtlocation-map.html">Map</a> type would enable this information to be displayed, panned, zoomed and so on. The <a href="qml-qtlocation-route.html">Route</a> would be determined by a plugin with each <a href="qml-qtlocation-routesegment.html">RouteSegment</a> holding the navigation instructions guided by the updated current Location.</p>
<p><a href="location-places-qml.html#plugin">Plugin</a>s are a means of specifying which location-based service to use. For example, a plugin may allow connection to a provider's 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 <a href="location-places-qml.html#plugin">Plugin</a> must be created for each required GeoService plugin. Plugins are required for maps, routing and geocoding, and places, however the default plugin handles all four of these services. A plugin may require online access or may support on-board maps and data.</p>
<p><b>Note: </b>Plugins may not provide features such as paging or relevance hints.</p><p>The following links provide more detailed information about maps and places:</p>
<div class="table"><table class="generic">
<tr valign="top" class="odd"><td ><a href="location-maps-qml.html">Maps and Navigation</a></td><td >Displaying maps and finding routes.</td></tr>
<tr valign="top" class="even"><td ><a href="location-places-qml.html">Places</a></td><td >Searching for and managing points of interest.</td></tr>
</table></div>
<a name="common-qml-types"></a>
<h2 id="common-qml-types">Common QML Types</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-plugin.html">Plugin</a></p></td><td class="tblDescr"><p>Type describes a Location based services plugin</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-pluginparameter.html">PluginParameter</a></p></td><td class="tblDescr"><p>Type describes a parameter to a Plugin</p></td></tr>
</table></div>
<a name="maps-qml-types"></a>
<h2 id="maps-qml-types">Maps QML Types</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapcircle.html">MapCircle</a></p></td><td class="tblDescr"><p>Type displays a geographic circle on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-map.html">Map</a></p></td><td class="tblDescr"><p>Type displays a map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapcopyrightnotice.html">MapCopyrightNotice</a></p></td><td class="tblDescr"><p>Item displays the current valid copyright notice for a Map element</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapitemgroup.html">MapItemGroup</a></p></td><td class="tblDescr"><p>Type is a container for map items</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapitemview.html">MapItemView</a></p></td><td class="tblDescr"><p>Used to populate Map from a model</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapparameter.html">MapParameter</a></p></td><td class="tblDescr"><p>Type represents a parameter for a Map element. This type provides a mean to specify plugin-dependent optional parameters for a map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapquickitem.html">MapQuickItem</a></p></td><td class="tblDescr"><p>Type displays an arbitrary Qt Quick object on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-maptype.html">MapType</a></p></td><td class="tblDescr"><p>Type holds information about a map type</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolygon.html">MapPolygon</a></p></td><td class="tblDescr"><p>Type displays a polygon on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolyline.html">MapPolyline</a></p></td><td class="tblDescr"><p>Type displays a polyline on a map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-maprectangle.html">MapRectangle</a></p></td><td class="tblDescr"><p>Type displays a rectangle on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-maproute.html">MapRoute</a></p></td><td class="tblDescr"><p>Type displays a Route on a Map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a></p></td><td class="tblDescr"><p>Type provides Map gesture interaction</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappinchevent.html">MapPinchEvent</a></p></td><td class="tblDescr"><p>Type provides basic information about pinch event</p></td></tr>
</table></div>
<a name="navigation-and-routing-qml-types"></a>
<h2 id="navigation-and-routing-qml-types">Navigation and Routing QML Types</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a></p></td><td class="tblDescr"><p>Type represents the information relevant to the point at which two RouteSegments meet</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-route.html">Route</a></p></td><td class="tblDescr"><p>Type represents one geographical route</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-routemodel.html">RouteModel</a></p></td><td class="tblDescr"><p>Type provides access to routes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-routequery.html">RouteQuery</a></p></td><td class="tblDescr"><p>Type is used to provide query parameters to a RouteModel</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-routesegment.html">RouteSegment</a></p></td><td class="tblDescr"><p>Type represents a segment of a Route</p></td></tr>
</table></div>
<a name="geocoding-qml-types"></a>
<h2 id="geocoding-qml-types">Geocoding QML Types</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-geocodemodel.html">GeocodeModel</a></p></td><td class="tblDescr"><p>Type provides support for searching operations related to geographic information</p></td></tr>
</table></div>
<a name="places-qml-types"></a>
<h2 id="places-qml-types">Places QML Types</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-category.html">Category</a></p></td><td class="tblDescr"><p>Type represents a category that a Place can be associated with</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-contactdetail.html">ContactDetail</a></p></td><td class="tblDescr"><p>Type holds a contact detail such as a phone number or a website address</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-contactdetails.html">ContactDetails</a></p></td><td class="tblDescr"><p>Type holds contact details for a Place</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-place.html">Place</a></p></td><td class="tblDescr"><p>Type represents a location that is a position of interest</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-extendedattributes.html">ExtendedAttributes</a></p></td><td class="tblDescr"><p>Type holds additional data about a Place</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-placeattribute.html">PlaceAttribute</a></p></td><td class="tblDescr"><p>Type holds generic place attribute information</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-editorialmodel.html">EditorialModel</a></p></td><td class="tblDescr"><p>Type provides a model of place editorials</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-icon.html">Icon</a></p></td><td class="tblDescr"><p>Type represents an icon image source which can have multiple sizes</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-imagemodel.html">ImageModel</a></p></td><td class="tblDescr"><p>Type provides a model of place images</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-user.html">User</a></p></td><td class="tblDescr"><p>Type identifies a user who contributed a particular Place content item</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-ratings.html">Ratings</a></p></td><td class="tblDescr"><p>Type holds place rating information</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-reviewmodel.html">ReviewModel</a></p></td><td class="tblDescr"><p>Provides access to reviews of a Place</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-placesearchmodel.html">PlaceSearchModel</a></p></td><td class="tblDescr"><p>Provides access to place search results</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-placesearchsuggestionmodel.html">PlaceSearchSuggestionModel</a></p></td><td class="tblDescr"><p>Provides access to search term suggestions</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-supplier.html">Supplier</a></p></td><td class="tblDescr"><p>Holds data regarding the supplier of a place, a place's image, review, or editorial</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-categorymodel.html">CategoryModel</a></p></td><td class="tblDescr"><p>Type provides a model of the categories supported by a Plugin</p></td></tr>
</table></div>
<a name="alphabetical-listing-of-all-qml-types"></a>
<h2 id="alphabetical-listing-of-all-qml-types">Alphabetical Listing of All QML Types</h2>
</div>
<!-- @@@QtLocation -->
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapcircle.html">MapCircle</a></p></td><td class="tblDescr"><p>Type displays a geographic circle on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-geocodemodel.html">GeocodeModel</a></p></td><td class="tblDescr"><p>Type provides support for searching operations related to geographic information</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a></p></td><td class="tblDescr"><p>Type represents the information relevant to the point at which two RouteSegments meet</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-map.html">Map</a></p></td><td class="tblDescr"><p>Type displays a map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapcopyrightnotice.html">MapCopyrightNotice</a></p></td><td class="tblDescr"><p>Item displays the current valid copyright notice for a Map element</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapitemgroup.html">MapItemGroup</a></p></td><td class="tblDescr"><p>Type is a container for map items</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapitemview.html">MapItemView</a></p></td><td class="tblDescr"><p>Used to populate Map from a model</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapparameter.html">MapParameter</a></p></td><td class="tblDescr"><p>Type represents a parameter for a Map element. This type provides a mean to specify plugin-dependent optional parameters for a map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapquickitem.html">MapQuickItem</a></p></td><td class="tblDescr"><p>Type displays an arbitrary Qt Quick object on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-maptype.html">MapType</a></p></td><td class="tblDescr"><p>Type holds information about a map type</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-route.html">Route</a></p></td><td class="tblDescr"><p>Type represents one geographical route</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-routemodel.html">RouteModel</a></p></td><td class="tblDescr"><p>Type provides access to routes</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-routequery.html">RouteQuery</a></p></td><td class="tblDescr"><p>Type is used to provide query parameters to a RouteModel</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-routesegment.html">RouteSegment</a></p></td><td class="tblDescr"><p>Type represents a segment of a Route</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-plugin.html">Plugin</a></p></td><td class="tblDescr"><p>Type describes a Location based services plugin</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-pluginparameter.html">PluginParameter</a></p></td><td class="tblDescr"><p>Type describes a parameter to a Plugin</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolygon.html">MapPolygon</a></p></td><td class="tblDescr"><p>Type displays a polygon on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolyline.html">MapPolyline</a></p></td><td class="tblDescr"><p>Type displays a polyline on a map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-maprectangle.html">MapRectangle</a></p></td><td class="tblDescr"><p>Type displays a rectangle on a Map</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-maproute.html">MapRoute</a></p></td><td class="tblDescr"><p>Type displays a Route on a Map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a></p></td><td class="tblDescr"><p>Type provides Map gesture interaction</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappinchevent.html">MapPinchEvent</a></p></td><td class="tblDescr"><p>Type provides basic information about pinch event</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-category.html">Category</a></p></td><td class="tblDescr"><p>Type represents a category that a Place can be associated with</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-contactdetail.html">ContactDetail</a></p></td><td class="tblDescr"><p>Type holds a contact detail such as a phone number or a website address</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-contactdetails.html">ContactDetails</a></p></td><td class="tblDescr"><p>Type holds contact details for a Place</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-place.html">Place</a></p></td><td class="tblDescr"><p>Type represents a location that is a position of interest</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-extendedattributes.html">ExtendedAttributes</a></p></td><td class="tblDescr"><p>Type holds additional data about a Place</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-placeattribute.html">PlaceAttribute</a></p></td><td class="tblDescr"><p>Type holds generic place attribute information</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-editorialmodel.html">EditorialModel</a></p></td><td class="tblDescr"><p>Type provides a model of place editorials</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-icon.html">Icon</a></p></td><td class="tblDescr"><p>Type represents an icon image source which can have multiple sizes</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-imagemodel.html">ImageModel</a></p></td><td class="tblDescr"><p>Type provides a model of place images</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-user.html">User</a></p></td><td class="tblDescr"><p>Type identifies a user who contributed a particular Place content item</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-ratings.html">Ratings</a></p></td><td class="tblDescr"><p>Type holds place rating information</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-reviewmodel.html">ReviewModel</a></p></td><td class="tblDescr"><p>Provides access to reviews of a Place</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-placesearchmodel.html">PlaceSearchModel</a></p></td><td class="tblDescr"><p>Provides access to place search results</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-placesearchsuggestionmodel.html">PlaceSearchSuggestionModel</a></p></td><td class="tblDescr"><p>Provides access to search term suggestions</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-supplier.html">Supplier</a></p></td><td class="tblDescr"><p>Holds data regarding the supplier of a place, a place's image, review, or editorial</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-categorymodel.html">CategoryModel</a></p></td><td class="tblDescr"><p>Type provides a model of the categories supported by a Plugin</p></td></tr>
</table></div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
ed56237261fa5ad3d1f8082a5fac7e2e
>
files
>
317
