/usr/share/qt5/doc/qtlocation/qml-qtlocation-routemaneuver.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 | <?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" />
<!-- qdeclarativegeomaneuver.cpp -->
<title>RouteManeuver | 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>RouteManeuver</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">RouteManeuver</h1>
<span class="subtitle"></span>
<!-- $$$RouteManeuver-brief -->
<p>The RouteManeuver type represents the information relevant to the point at which two RouteSegments meet. <a href="#details">More...</a></p>
<!-- @@@RouteManeuver -->
<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-routemaneuver-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-routemaneuver.html#direction-prop">direction</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#distanceToNextInstruction-prop">distanceToNextInstruction</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#instructionText-prop">instructionText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#position-prop">position</a></b></b> : coordinate</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#timeToNextInstruction-prop">timeToNextInstruction</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#valid-prop">valid</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#waypoint-prop">waypoint</a></b></b> : coordinate</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#waypointValid-prop">waypointValid</a></b></b> : bool</li>
</ul>
<!-- $$$RouteManeuver-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p><a href="qml-qtlocation-routesegment.html">RouteSegment</a> instances can be thought of as edges on a routing graph, with RouteManeuver instances as optional labels attached to the vertices of the graph.</p>
<p>The most interesting information held in a RouteManeuver instance is normally the textual navigation to provide and the position at which to provide it, accessible by <a href="qml-qtlocation-routemaneuver.html#instructionText-prop">instructionText</a> and <a href="qml-qtlocation-routemaneuver.html#position-prop">position</a> respectively.</p>
<a name="example"></a>
<h2>Example</h2>
<p>The following QML snippet demonstrates how to print information about a route maneuver:</p>
<pre class="qml">import QtQuick 2.0
import QtLocation 5.0
<span class="type">Text</span> {
<span class="name">text</span>: <span class="string">"Distance till next maneuver: "</span> <span class="operator">+</span> <span class="name">routeManeuver</span>.<span class="name">distanceToNextInstruction</span> <span class="operator">+</span> <span class="string">" meters, estimated time: "</span> <span class="operator">+</span> <span class="name">routeManeuver</span>.<span class="name">timeToNextInstruction</span> <span class="operator">+</span> <span class="string">" seconds."</span>
}</pre>
<!-- @@@RouteManeuver -->
<h2>Property Documentation</h2>
<!-- $$$direction -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="direction-prop"></a><span class="name">direction</span> : <span class="type">enumeration</span></p></td></tr></table></div><div class="qmldoc"><p>Describes the change in direction associated with the instruction text that is associated with a <a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.</p>
<ul>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.NoDirection - There is no direction associated with the instruction text</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionForward - The instruction indicates that the direction of travel does not need to change</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionBearRight - The instruction indicates that the direction of travel should bear to the right</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionLightRight - The instruction indicates that a light turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionRight - The instruction indicates that a turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionHardRight - The instruction indicates that a hard turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionUTurnRight - The instruction indicates that a u-turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionUTurnLeft - The instruction indicates that a u-turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionHardLeft - The instruction indicates that a hard turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionLeft - The instruction indicates that a turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionLightLeft - The instruction indicates that a light turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionBearLeft - The instruction indicates that the direction of travel should bear to the left</li>
</ul>
</div></div><!-- @@@direction -->
<br/>
<!-- $$$distanceToNextInstruction -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="distanceToNextInstruction-prop"></a><span class="name">distanceToNextInstruction</span> : <span class="type">real</span></p></td></tr></table></div><div class="qmldoc"><p>This read-only property holds the distance, in meters, between the point at which the associated instruction was issued and the point that the next instruction should be issued.</p>
</div></div><!-- @@@distanceToNextInstruction -->
<br/>
<!-- $$$instructionText -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="instructionText-prop"></a><span class="name">instructionText</span> : <span class="type">string</span></p></td></tr></table></div><div class="qmldoc"><p>This read-only property holds textual navigation instruction.</p>
</div></div><!-- @@@instructionText -->
<br/>
<!-- $$$position -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="position-prop"></a><span class="name">position</span> : <span class="type">coordinate</span></p></td></tr></table></div><div class="qmldoc"><p>This read-only property holds where the <a href="qml-qtlocation-routemaneuver.html#instructionText-prop">instructionText</a> should be displayed.</p>
</div></div><!-- @@@position -->
<br/>
<!-- $$$timeToNextInstruction -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="timeToNextInstruction-prop"></a><span class="name">timeToNextInstruction</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>This read-only property holds the estimated time it will take to travel from the point at which the associated instruction was issued and the point that the next instruction should be issued, in seconds.</p>
</div></div><!-- @@@timeToNextInstruction -->
<br/>
<!-- $$$valid -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="valid-prop"></a><span class="name">valid</span> : <span class="type">bool</span></p></td></tr></table></div><div class="qmldoc"><p>This read-only property holds whether this maneuver is valid or not.</p>
<p>Invalid maneuvers are used when there is no information that needs to be attached to the endpoint of a <a href="qgeoroutesegment.html">QGeoRouteSegment</a> instance.</p>
</div></div><!-- @@@valid -->
<br/>
<!-- $$$waypoint -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="waypoint-prop"></a><span class="name">waypoint</span> : <span class="type">coordinate</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the waypoint associated with this maneuver. All maneuvers do not have a waypoint associated with them, this can be checked with <a href="qml-qtlocation-routemaneuver.html#waypointValid-prop">waypointValid</a>.</p>
</div></div><!-- @@@waypoint -->
<br/>
<!-- $$$waypointValid -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="waypointValid-prop"></a><span class="name">waypointValid</span> : <span class="type">bool</span></p></td></tr></table></div><div class="qmldoc"><p>This read-only property holds whether this <a href="qml-qtlocation-routemaneuver.html#waypoint-prop">waypoint</a>, associated with this maneuver, is valid or not.</p>
</div></div><!-- @@@waypointValid -->
<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>
|