/usr/share/qt5/doc/qtlocation/qml-qtlocation-route.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 | <?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" />
<!-- qdeclarativegeoroute.cpp -->
<title>Route | 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><a href="qtlocation-qmlmodule.html">QML Types</a></li>
<li>Route</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="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#example">Example</a></li>
</ul>
</div>
<h1 class="title">Route</h1>
<span class="subtitle"></span>
<!-- $$$Route-brief -->
<p>The Route type represents one geographical route. <a href="#details">More...</a></p>
<!-- @@@Route -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtLocation 5.0</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt Location 5.0</td></tr></table><ul>
<li><a href="qml-qtlocation-route-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtlocation-route.html#bounds-prop">bounds</a></b></b> : georectangle</li>
<li class="fn"><b><b><a href="qml-qtlocation-route.html#distance-prop">distance</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtlocation-route.html#path-prop">path</a></b></b> : QJSValue</li>
<li class="fn"><b><b><a href="qml-qtlocation-route.html#segments-prop">segments</a></b></b> : list<RouteSegment></li>
<li class="fn"><b><b><a href="qml-qtlocation-route.html#travelTime-prop">travelTime</a></b></b> : int</li>
</ul>
<!-- $$$Route-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>A Route type contains high level information about a route, such as the length the route, the estimated travel time for the route, and enough information to render a basic image of the route on a map.</p>
<p>The <a href="qgeoroute.html">QGeoRoute</a> object also contains a list of <a href="qml-qtlocation-routesegment.html">RouteSegment</a> objects which describe subsections of the route in greater detail.</p>
<p>The primary means of acquiring Route objects is <a href="qml-qtlocation-routemodel.html">RouteModel</a>.</p>
<a name="example"></a>
<h2>Example</h2>
<p>This example shows how to display a route's maneuvers in a ListView:</p>
<pre class="qml">import QtQuick 2.0
import QtLocation 5.0
<span class="type"><a href="qml-qtlocation-routemodel.html">RouteModel</a></span> {
<span class="name">id</span>: <span class="name">routeModel</span>
<span class="comment">// model initialization</span>
}
<span class="type">ListView</span> {
<span class="name">spacing</span>: <span class="number">10</span>
<span class="name">model</span>: <span class="name">routeModel</span>.<span class="name">status</span> <span class="operator">==</span> <span class="name">RouteModel</span>.<span class="name">Ready</span> ? <span class="name">routeModel</span>.<span class="name">get</span>(<span class="number">0</span>).<span class="name">segments</span> : <span class="number">null</span>
<span class="name">visible</span>: <span class="name">model</span> ? <span class="number">true</span> : <span class="number">false</span>
<span class="name">delegate</span>: <span class="name">Row</span> {
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>
<span class="name">spacing</span>: <span class="number">10</span>
property <span class="type">bool</span> <span class="name">hasManeuver</span> : <span class="name">modelData</span>.<span class="name">maneuver</span> <span class="operator">&&</span> <span class="name">modelData</span>.<span class="name">maneuver</span>.<span class="name">valid</span>
<span class="name">visible</span>: <span class="name">hasManeuver</span>
<span class="type">Text</span> { <span class="name">text</span>: (<span class="number">1</span> <span class="operator">+</span> <span class="name">index</span>) <span class="operator">+</span> <span class="string">"."</span> }
<span class="type">Text</span> {
<span class="name">text</span>: <span class="name">hasManeuver</span> ? <span class="name">modelData</span>.<span class="name">maneuver</span>.<span class="name">instructionText</span> : <span class="string">""</span>
}
}
}</pre>
<!-- @@@Route -->
<h2>Property Documentation</h2>
<!-- $$$bounds -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="bounds-prop"></a><span class="name">bounds</span> : <span class="type">georectangle</span></p></td></tr></table></div><div class="qmldoc"><p>Read-only property which holds a bounding box which encompasses the entire route.</p>
</div></div><!-- @@@bounds -->
<br/>
<!-- $$$distance -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="distance-prop"></a><span class="name">distance</span> : <span class="type">real</span></p></td></tr></table></div><div class="qmldoc"><p>Read-only property which holds distance covered by this route, in meters.</p>
</div></div><!-- @@@distance -->
<br/>
<!-- $$$path -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="path-prop"></a><span class="name">path</span> : <span class="type">QJSValue</span></p></td></tr></table></div><div class="qmldoc"><p>Read-only property which holds the geographical coordinates of this route. Coordinates are listed in the order in which they would be traversed by someone traveling along this segment of the route.</p>
<p>To access individual segments you can use standard list accessors: 'path.length' indicates the number of objects and 'path[index starting from zero]' gives the actual object.</p>
<p><b>See also </b>QtPositioning::coordinate.</p>
</div></div><!-- @@@path -->
<br/>
<!-- $$$segments -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="segments-prop"></a><span class="name">segments</span> : <span class="type">list</span><<span class="type"><a href="qml-qtlocation-routesegment.html">RouteSegment</a></span>></p></td></tr></table></div><div class="qmldoc"><p>Read-only property which holds the list of <a href="qml-qtlocation-routesegment.html">RouteSegment</a> objects of this route.</p>
<p>To access individual segments you can use standard list accessors: 'segments.length' indicates the number of objects and 'segments[index starting from zero]' gives the actual objects.</p>
<p><b>See also </b><a href="qml-qtlocation-routesegment.html">RouteSegment</a>.</p>
</div></div><!-- @@@segments -->
<br/>
<!-- $$$travelTime -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="travelTime-prop"></a><span class="name">travelTime</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Read-only property which holds the estimated amount of time it will take to traverse this route, in seconds.</p>
</div></div><!-- @@@travelTime -->
<br/>
</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>
|