/usr/share/qt5/doc/qtlocation/qtlocation-qmlmodule.html is in qtlocation5-doc-html 5.2.1-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtlocation-qml.qdoc -->
<title>Qt Location QML Types | QtLocation 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtlocation-index.html">Qt Location</a></li>
<li>Qt Location QML Types</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#overview">Overview</a></li>
<li class="level2"><a href="#location-qml-concepts">Location QML Concepts</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>
<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>Overview</h2>
<p>The identifying string for this module is <i>QtLocation</i>. To use include the following import statement in the QML file.</p>
<pre class="qml">import QtLocation 5.0</pre>
<a name="location-qml-concepts"></a>
<h3>Location QML Concepts</h3>
<p>Provided that a position has been obtained this module can add a <a href="qml-qtlocation-map.html">Map</a> with positions of interest 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> may be places of business, entertainment and so on. They may include paths, roads, or forms of transport leading so that navigation optimization and assistance are possible.</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. Each <a href="qml-qtlocation-routesegment.html">RouteSegment</a> can be considered a navigation sub-task: 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 used 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="qml-qtlocation-plugin.html">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 handles geocoding and routing that the API and application can use. There may be various GeoServices plugins for various tasks with some plugins providing more than one service. One QML <a href="qml-qtlocation-plugin.html">Plugin</a> should be created for each required GeoService plugin. Plugins are required for maps, routing and geocoding, however the default plugin handles all three of these services. A plugin may require online access or may support on-board maps and data. The default "nokia" plugin only supports online use. The connection would be managed by QNetworkInfo and QNetworkConfigurationManager.</p>
<p><b>Note: </b>: Plugins may not provide various features such as paging or relevance hints. Since plugins may be supplied by other providers, support for these aspects is dependent on the provider's implementation.</p><p>The following table provides links to more detailed information on sections of the Qt Location QML API.</p>
<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>
<a name="common-qml-types"></a>
<h2>Common QML Types</h2>
<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>The Plugin 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>The PluginParameter type describes a parameter to a Plugin.</p></td></tr>
</table>
<a name="maps-qml-types"></a>
<h2>Maps QML Types</h2>
<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>The MapCircle 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>The Map type displays a map.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappinchevent.html">MapPinchEvent</a></p></td><td class="tblDescr"><p>MapPinchEvent type provides basic information about pinch event.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a></p></td><td class="tblDescr"><p>The MapGestureArea type provides Map gesture interaction.</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>The MapItemView is used to populate Map from a model.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapmousearea.html">MapMouseArea</a></p></td><td class="tblDescr"><p>The MapMouseArea item enables simple mouse handling.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapmouseevent.html">MapMouseEvent</a></p></td><td class="tblDescr"><p>The MapMouseEvent object provides information about a mouse event.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapquickitem.html">MapQuickItem</a></p></td><td class="tblDescr"><p>The MapQuickItem type displays an arbitrary Qt Quick object on a Map.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-maptype.html">MapType</a></p></td><td class="tblDescr"><p>The MapType type holds information about a map type.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolygon.html">MapPolygon</a></p></td><td class="tblDescr"><p>The MapPolygon type displays a polygon on a Map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolyline.html">MapPolyline</a></p></td><td class="tblDescr"><p>The MapPolyline type displays a polyline on a map.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-maprectangle.html">MapRectangle</a></p></td><td class="tblDescr"><p>The MapRectangle type displays a rectangle on a Map.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-maproute.html">MapRoute</a></p></td><td class="tblDescr"><p>The MapRoute type displays a Route on a Map.</p></td></tr>
</table>
<a name="navigation-and-routing-qml-types"></a>
<h2>Navigation and Routing QML Types</h2>
<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>The RouteManeuver 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>The Route 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>The RouteModel 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>The RouteQuery 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>The RouteSegment type represents a segment of a Route.</p></td></tr>
</table>
<a name="geocoding-qml-types"></a>
<h2>Geocoding QML Types</h2>
<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>The GeocodeModel type provides support for searching operations related to geographic information.</p></td></tr>
</table>
<a name="places-qml-types"></a>
<h2>Places QML Types</h2>
<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>The Category 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-contactdetails.html">ContactDetails</a></p></td><td class="tblDescr"><p>The ContactDetails type holds contact details for a Place.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-contactdetail.html">ContactDetail</a></p></td><td class="tblDescr"><p>The ContactDetail type holds a contact detail such as a phone number or a website address.</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>The Place 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>The ExtendedAttributes 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>The PlaceAttribute 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>The EditorialModel 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>The Icon 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>The ImageModel 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>The User 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>The Ratings 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>The CategoryModel type provides a model of the categories supported by a Plugin.</p></td></tr>
</table>
<a name="alphabetical-listing-of-all-qml-types"></a>
<h2>Alphabetical Listing of all QML Types</h2>
</div>
<!-- @@@QtLocation -->
<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>The Category 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-contactdetails.html">ContactDetails</a></p></td><td class="tblDescr"><p>The ContactDetails type holds contact details for a Place.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-contactdetail.html">ContactDetail</a></p></td><td class="tblDescr"><p>The ContactDetail type holds a contact detail such as a phone number or a website address.</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>The Place 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>The ExtendedAttributes 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>The PlaceAttribute 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>The EditorialModel 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>The Icon 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>The ImageModel 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>The User 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>The Ratings 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>The CategoryModel type provides a model of the categories supported by a Plugin.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapcircle.html">MapCircle</a></p></td><td class="tblDescr"><p>The MapCircle 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>The GeocodeModel 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>The RouteManeuver 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>The Map type displays a map.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappinchevent.html">MapPinchEvent</a></p></td><td class="tblDescr"><p>MapPinchEvent type provides basic information about pinch event.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapgesturearea.html">MapGestureArea</a></p></td><td class="tblDescr"><p>The MapGestureArea type provides Map gesture interaction.</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>The MapItemView is used to populate Map from a model.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapmousearea.html">MapMouseArea</a></p></td><td class="tblDescr"><p>The MapMouseArea item enables simple mouse handling.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapmouseevent.html">MapMouseEvent</a></p></td><td class="tblDescr"><p>The MapMouseEvent object provides information about a mouse event.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mapquickitem.html">MapQuickItem</a></p></td><td class="tblDescr"><p>The MapQuickItem type displays an arbitrary Qt Quick object on a Map.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-maptype.html">MapType</a></p></td><td class="tblDescr"><p>The MapType type holds information about a map type.</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>The Route 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>The RouteModel 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>The RouteQuery 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>The RouteSegment type represents a segment of a Route.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-plugin.html">Plugin</a></p></td><td class="tblDescr"><p>The Plugin type describes a Location based services plugin.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-pluginparameter.html">PluginParameter</a></p></td><td class="tblDescr"><p>The PluginParameter type describes a parameter to a Plugin.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolygon.html">MapPolygon</a></p></td><td class="tblDescr"><p>The MapPolygon type displays a polygon on a Map</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-mappolyline.html">MapPolyline</a></p></td><td class="tblDescr"><p>The MapPolyline type displays a polyline on a map.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtlocation-maprectangle.html">MapRectangle</a></p></td><td class="tblDescr"><p>The MapRectangle type displays a rectangle on a Map.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtlocation-maproute.html">MapRoute</a></p></td><td class="tblDescr"><p>The MapRoute type displays a Route on a Map.</p></td></tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|