qtlocation5-doc-html 5.2.1-1ubuntu2 / usr / share / qt5 / doc / qtlocation / qgeomaneuver.html

This file is indexed.

/usr/share/qt5/doc/qtlocation/qgeomaneuver.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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<?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" />
<!-- qgeomaneuver.cpp -->
  <title>QGeoManeuver Class | 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-module.html">C++ Classes</a></li>
<li>QGeoManeuver</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="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoManeuver Class</h1>
<!-- $$$QGeoManeuver-brief -->
<p>The QGeoManeuver class represents the information relevant to the point at which two QGeoRouteSegments meet. <a href="#details">More...</a></p>
<!-- @@@QGeoManeuver -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include &lt;QGeoManeuver&gt;</span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += location</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="qgeomaneuver-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#InstructionDirection-enum">InstructionDirection</a></b> { NoDirection, DirectionForward, DirectionBearRight, DirectionLightRight, ..., DirectionBearLeft }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#QGeoManeuver">QGeoManeuver</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#QGeoManeuver-2">QGeoManeuver</a></b>(const QGeoManeuver &amp;<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#dtor.QGeoManeuver">~QGeoManeuver</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> InstructionDirection </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#direction">direction</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#distanceToNextInstruction">distanceToNextInstruction</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#instructionText">instructionText</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#position">position</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#setDirection">setDirection</a></b>(InstructionDirection<i> direction</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#setDistanceToNextInstruction">setDistanceToNextInstruction</a></b>(qreal<i> distance</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#setInstructionText">setInstructionText</a></b>(const QString &amp;<i> instructionText</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#setPosition">setPosition</a></b>(const QGeoCoordinate &amp;<i> position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#setTimeToNextInstruction">setTimeToNextInstruction</a></b>(int<i> secs</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#setWaypoint">setWaypoint</a></b>(const QGeoCoordinate &amp;<i> coordinate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#timeToNextInstruction">timeToNextInstruction</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#waypoint">waypoint</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#operator-not-eq">operator!=</a></b>(const QGeoManeuver &amp;<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoManeuver &amp; </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#operator-eq">operator=</a></b>(const QGeoManeuver &amp;<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeomaneuver.html#operator-eq-eq">operator==</a></b>(const QGeoManeuver &amp;<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGeoManeuver-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoManeuver class represents the information relevant to the point at which two QGeoRouteSegments meet.</p>
<p><a href="qgeoroutesegment.html">QGeoRouteSegment</a> instances can be thought of as edges on a routing graph, with QGeoManeuver instances as optional labels attached to the vertices of the graph.</p>
<p>The most interesting information help in a QGeoManeuver instance is normally the textual navigation to provide and the position at which to provide it, accessible by <a href="qgeomaneuver.html#instructionText">instructionText</a>() and <a href="qgeomaneuver.html#position">position</a>() respectively.</p>
<p>It is also possible to determine if a routing waypoint has been passed by checking if <a href="qgeomaneuver.html#waypoint">waypoint</a>() returns a valid QGeoCoordinate.</p>
</div>
<!-- @@@QGeoManeuver -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$InstructionDirection$$$NoDirection$$$DirectionForward$$$DirectionBearRight$$$DirectionLightRight$$$DirectionRight$$$DirectionHardRight$$$DirectionUTurnRight$$$DirectionUTurnLeft$$$DirectionHardLeft$$$DirectionLeft$$$DirectionLightLeft$$$DirectionBearLeft -->
<h3 class="fn"><a name="InstructionDirection-enum"></a>enum QGeoManeuver::<span class="name">InstructionDirection</span></h3>
<p>Describes the change in direction associated with the instruction text that is associated with a QGeoManaeuver.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::NoDirection</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">There is no direction associated with the instruction text.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionForward</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The instruction indicates that the direction of travel does not need to change.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionBearRight</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The instruction indicates that the direction of travel should bear to the right.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionLightRight</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The instruction indicates that a light turn to the right is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionRight</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The instruction indicates that a turn to the right is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionHardRight</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The instruction indicates that a hard turn to the right is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionUTurnRight</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">The instruction indicates that a u-turn to the right is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionUTurnLeft</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">The instruction indicates that a u-turn to the left is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionHardLeft</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">The instruction indicates that a hard turn to the left is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionLeft</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">The instruction indicates that a turn to the left is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionLightLeft</tt></td><td class="topAlign"><tt>10</tt></td><td class="topAlign">The instruction indicates that a light turn to the left is required.</td></tr>
<tr><td class="topAlign"><tt>QGeoManeuver::DirectionBearLeft</tt></td><td class="topAlign"><tt>11</tt></td><td class="topAlign">The instruction indicates that the direction of travel should bear to the left.</td></tr>
</table>
<!-- @@@InstructionDirection -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoManeuver[overload1]$$$QGeoManeuver -->
<h3 class="fn"><a name="QGeoManeuver"></a>QGeoManeuver::<span class="name">QGeoManeuver</span>()</h3>
<p>Constructs a invalid maneuver object.</p>
<p>The maneuver will remain invalid until one of <a href="qgeomaneuver.html#setPosition">setPosition</a>(), <a href="qgeomaneuver.html#setInstructionText">setInstructionText</a>(), <a href="qgeomaneuver.html#setDirection">setDirection</a>(), <a href="qgeomaneuver.html#setTimeToNextInstruction">setTimeToNextInstruction</a>(), <a href="qgeomaneuver.html#setDistanceToNextInstruction">setDistanceToNextInstruction</a>() or <a href="qgeomaneuver.html#setWaypoint">setWaypoint</a>() is called.</p>
<!-- @@@QGeoManeuver -->
<!-- $$$QGeoManeuver$$$QGeoManeuverconstQGeoManeuver& -->
<h3 class="fn"><a name="QGeoManeuver-2"></a>QGeoManeuver::<span class="name">QGeoManeuver</span>(const <span class="type">QGeoManeuver</span> &amp;<i> other</i>)</h3>
<p>Constructs a maneuver object from the contents of <i>other</i>.</p>
<!-- @@@QGeoManeuver -->
<!-- $$$~QGeoManeuver[overload1]$$$~QGeoManeuver -->
<h3 class="fn"><a name="dtor.QGeoManeuver"></a>QGeoManeuver::<span class="name">~QGeoManeuver</span>()</h3>
<p>Destroys this maneuver object.</p>
<!-- @@@~QGeoManeuver -->
<!-- $$$direction[overload1]$$$direction -->
<h3 class="fn"><a name="direction"></a><span class="type"><a href="qgeomaneuver.html#InstructionDirection-enum">InstructionDirection</a></span> QGeoManeuver::<span class="name">direction</span>() const</h3>
<p>Returns the direction associated with the associated instruction.</p>
<p><b>See also </b><a href="qgeomaneuver.html#setDirection">setDirection</a>().</p>
<!-- @@@direction -->
<!-- $$$distanceToNextInstruction[overload1]$$$distanceToNextInstruction -->
<h3 class="fn"><a name="distanceToNextInstruction"></a><span class="type">qreal</span> QGeoManeuver::<span class="name">distanceToNextInstruction</span>() const</h3>
<p>Returns 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>
<p><b>See also </b><a href="qgeomaneuver.html#setDistanceToNextInstruction">setDistanceToNextInstruction</a>().</p>
<!-- @@@distanceToNextInstruction -->
<!-- $$$instructionText[overload1]$$$instructionText -->
<h3 class="fn"><a name="instructionText"></a><span class="type">QString</span> QGeoManeuver::<span class="name">instructionText</span>() const</h3>
<p>Returns the textual navigation instructions.</p>
<p><b>See also </b><a href="qgeomaneuver.html#setInstructionText">setInstructionText</a>().</p>
<!-- @@@instructionText -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QGeoManeuver::<span class="name">isValid</span>() const</h3>
<p>Returns 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>
<!-- @@@isValid -->
<!-- $$$position[overload1]$$$position -->
<h3 class="fn"><a name="position"></a><span class="type">QGeoCoordinate</span> QGeoManeuver::<span class="name">position</span>() const</h3>
<p>Returns the position where <a href="qgeomaneuver.html#instructionText">instructionText</a>() should be displayed.</p>
<p><b>See also </b><a href="qgeomaneuver.html#setPosition">setPosition</a>().</p>
<!-- @@@position -->
<!-- $$$setDirection[overload1]$$$setDirectionInstructionDirection -->
<h3 class="fn"><a name="setDirection"></a><span class="type">void</span> QGeoManeuver::<span class="name">setDirection</span>(<span class="type"><a href="qgeomaneuver.html#InstructionDirection-enum">InstructionDirection</a></span><i> direction</i>)</h3>
<p>Sets the direction associated with the associated instruction to <i>direction</i>.</p>
<p><b>See also </b><a href="qgeomaneuver.html#direction">direction</a>().</p>
<!-- @@@setDirection -->
<!-- $$$setDistanceToNextInstruction[overload1]$$$setDistanceToNextInstructionqreal -->
<h3 class="fn"><a name="setDistanceToNextInstruction"></a><span class="type">void</span> QGeoManeuver::<span class="name">setDistanceToNextInstruction</span>(<span class="type">qreal</span><i> distance</i>)</h3>
<p>Sets the distance, in meters, between the point at which the associated instruction was issued and the point that the next instruction should be issued to <i>distance</i>.</p>
<p><b>See also </b><a href="qgeomaneuver.html#distanceToNextInstruction">distanceToNextInstruction</a>().</p>
<!-- @@@setDistanceToNextInstruction -->
<!-- $$$setInstructionText[overload1]$$$setInstructionTextconstQString& -->
<h3 class="fn"><a name="setInstructionText"></a><span class="type">void</span> QGeoManeuver::<span class="name">setInstructionText</span>(const <span class="type">QString</span> &amp;<i> instructionText</i>)</h3>
<p>Sets the textual navigation instructions to <i>instructionText</i>.</p>
<p><b>See also </b><a href="qgeomaneuver.html#instructionText">instructionText</a>().</p>
<!-- @@@setInstructionText -->
<!-- $$$setPosition[overload1]$$$setPositionconstQGeoCoordinate& -->
<h3 class="fn"><a name="setPosition"></a><span class="type">void</span> QGeoManeuver::<span class="name">setPosition</span>(const <span class="type">QGeoCoordinate</span> &amp;<i> position</i>)</h3>
<p>Sets the position where <a href="qgeomaneuver.html#instructionText">instructionText</a>() should be displayed to <i>position</i>.</p>
<p><b>See also </b><a href="qgeomaneuver.html#position">position</a>().</p>
<!-- @@@setPosition -->
<!-- $$$setTimeToNextInstruction[overload1]$$$setTimeToNextInstructionint -->
<h3 class="fn"><a name="setTimeToNextInstruction"></a><span class="type">void</span> QGeoManeuver::<span class="name">setTimeToNextInstruction</span>(<span class="type">int</span><i> secs</i>)</h3>
<p>Sets 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, to <i>secs</i>.</p>
<p><b>See also </b><a href="qgeomaneuver.html#timeToNextInstruction">timeToNextInstruction</a>().</p>
<!-- @@@setTimeToNextInstruction -->
<!-- $$$setWaypoint[overload1]$$$setWaypointconstQGeoCoordinate& -->
<h3 class="fn"><a name="setWaypoint"></a><span class="type">void</span> QGeoManeuver::<span class="name">setWaypoint</span>(const <span class="type">QGeoCoordinate</span> &amp;<i> coordinate</i>)</h3>
<p>Sets the waypoint associated with this maneuver to <i>coordinate</i>.</p>
<p><b>See also </b><a href="qgeomaneuver.html#waypoint">waypoint</a>().</p>
<!-- @@@setWaypoint -->
<!-- $$$timeToNextInstruction[overload1]$$$timeToNextInstruction -->
<h3 class="fn"><a name="timeToNextInstruction"></a><span class="type">int</span> QGeoManeuver::<span class="name">timeToNextInstruction</span>() const</h3>
<p>Returns 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>
<p><b>See also </b><a href="qgeomaneuver.html#setTimeToNextInstruction">setTimeToNextInstruction</a>().</p>
<!-- @@@timeToNextInstruction -->
<!-- $$$waypoint[overload1]$$$waypoint -->
<h3 class="fn"><a name="waypoint"></a><span class="type">QGeoCoordinate</span> QGeoManeuver::<span class="name">waypoint</span>() const</h3>
<p>Returns the waypoint associated with this maneuver.</p>
<p>If there is not waypoint associated with this maneuver an invalid QGeoCoordinate will be returned.</p>
<p><b>See also </b><a href="qgeomaneuver.html#setWaypoint">setWaypoint</a>().</p>
<!-- @@@waypoint -->
<!-- $$$operator!=[overload1]$$$operator!=constQGeoManeuver& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QGeoManeuver::<span class="name">operator!=</span>(const <span class="type">QGeoManeuver</span> &amp;<i> other</i>) const</h3>
<p>Returns whether this maneuver is not equal to <i>other</i>.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGeoManeuver& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QGeoManeuver</span> &amp; QGeoManeuver::<span class="name">operator=</span>(const <span class="type">QGeoManeuver</span> &amp;<i> other</i>)</h3>
<p>Assigns <i>other</i> to this maneuver object and then returns a reference to this maneuver object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGeoManeuver& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QGeoManeuver::<span class="name">operator==</span>(const <span class="type">QGeoManeuver</span> &amp;<i> other</i>) const</h3>
<p>Returns whether this maneuver is equal to <i>other</i>.</p>
<!-- @@@operator== -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>

APT Browse - Built by Thomas Orozco.