<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgeoroute.cpp -->
<title>QGeoRouteLeg Class | Qt Location 5.12.6</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.12</td><td ><a href="qtlocation-index.html">Qt Location</a></td><td ><a href="qtlocation-module.html">C++ Classes</a></td><td >QGeoRouteLeg</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtlocation-index.html">Qt 5.12.6 Reference Documentation</a></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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QGeoRouteLeg Class</h1>
<!-- $$$QGeoRouteLeg-brief -->
<p>The <a href="qgeorouteleg.html">QGeoRouteLeg</a> class represents a leg of a route, that is the portion of a route between one waypoint and the next. This is a subclass of <a href="qgeoroute.html">QGeoRoute</a>, exposing route leg specific API. <a href="#details">More...</a></p>
<!-- @@@QGeoRouteLeg -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QGeoRouteLeg></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += location</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qgeoroute.html">QGeoRoute</a></td></tr></table></div><ul>
<li><a href="qgeorouteleg-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#QGeoRouteLeg">QGeoRouteLeg</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#QGeoRouteLeg-1">QGeoRouteLeg</a></b>(const QGeoRouteLeg &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#dtor.QGeoRouteLeg">~QGeoRouteLeg</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#legIndex">legIndex</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRoute </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#overallRoute">overallRoute</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#setLegIndex">setLegIndex</a></b>(int <i>idx</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#setOverallRoute">setOverallRoute</a></b>(const QGeoRoute &<i>route</i>)</td></tr>
</table></div>
<ul>
<li class="fn">21 public functions inherited from <a href="qgeoroute.html#public-functions">QGeoRoute</a></li>
</ul>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeorouteleg.html#QGeoRouteLeg-2">QGeoRouteLeg</a></b>(const QExplicitlySharedDataPointer<QGeoRoutePrivate> &<i>dd</i>)</td></tr>
</table></div>
<ul>
<li class="fn">2 protected functions inherited from <a href="qgeoroute.html#protected-functions">QGeoRoute</a></li>
</ul>
<a name="details"></a>
<!-- $$$QGeoRouteLeg-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qgeorouteleg.html">QGeoRouteLeg</a> class represents a leg of a route, that is the portion of a route between one waypoint and the next. This is a subclass of <a href="qgeoroute.html">QGeoRoute</a>, exposing route leg specific API.</p>
<p><b>Note: </b><a href="qgeoroute.html#routeLegs">QGeoRoute::routeLegs</a> will return an empty list if called on a route leg.</p></div>
<p><b>See also </b><a href="qgeoroute.html">QGeoRoute</a>.</p>
<!-- @@@QGeoRouteLeg -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoRouteLeg[overload1]$$$QGeoRouteLeg -->
<h3 class="fn" id="QGeoRouteLeg"><a name="QGeoRouteLeg"></a>QGeoRouteLeg::<span class="name">QGeoRouteLeg</span>()</h3>
<p>Constructs a route leg object.</p>
<!-- @@@QGeoRouteLeg -->
<!-- $$$QGeoRouteLeg$$$QGeoRouteLegconstQGeoRouteLeg& -->
<h3 class="fn" id="QGeoRouteLeg-1"><a name="QGeoRouteLeg-1"></a>QGeoRouteLeg::<span class="name">QGeoRouteLeg</span>(const <span class="type"><a href="qgeorouteleg.html#QGeoRouteLeg">QGeoRouteLeg</a></span> &<i>other</i>)</h3>
<p>Constructs a route leg object from the contents of <i>other</i>.</p>
<!-- @@@QGeoRouteLeg -->
<!-- $$$QGeoRouteLeg$$$QGeoRouteLegconstQExplicitlySharedDataPointer<QGeoRoutePrivate>& -->
<h3 class="fn" id="QGeoRouteLeg-2"><a name="QGeoRouteLeg-2"></a><code>[protected] </code>QGeoRouteLeg::<span class="name">QGeoRouteLeg</span>(const <span class="type">QExplicitlySharedDataPointer</span><<span class="type">QGeoRoutePrivate</span>> &<i>dd</i>)</h3>
<p>Default constructs an instance of QGeoRouteLeg.</p><!-- @@@QGeoRouteLeg -->
<!-- $$$~QGeoRouteLeg[overload1]$$$~QGeoRouteLeg -->
<h3 class="fn" id="dtor.QGeoRouteLeg"><a name="dtor.QGeoRouteLeg"></a>QGeoRouteLeg::<span class="name">~QGeoRouteLeg</span>()</h3>
<p>Destroys this route object.</p>
<!-- @@@~QGeoRouteLeg -->
<!-- $$$legIndex[overload1]$$$legIndex -->
<h3 class="fn" id="legIndex"><a name="legIndex"></a><span class="type">int</span> QGeoRouteLeg::<span class="name">legIndex</span>() const</h3>
<p>Returns the index of this route leg inside the containing <a href="qgeoroute.html#routeLegs">QGeoRoute::routeLegs</a> list. Can be used to find the next legs.</p>
<p><b>See also </b><a href="qgeorouteleg.html#setLegIndex">setLegIndex</a>().</p>
<!-- @@@legIndex -->
<!-- $$$overallRoute[overload1]$$$overallRoute -->
<h3 class="fn" id="overallRoute"><a name="overallRoute"></a><span class="type"><a href="qgeoroute.html#QGeoRoute">QGeoRoute</a></span> QGeoRouteLeg::<span class="name">overallRoute</span>() const</h3>
<p>Returns the <i>route</i> that contains this route leg.</p>
<p><b>See also </b><a href="qgeorouteleg.html#setOverallRoute">setOverallRoute</a>().</p>
<!-- @@@overallRoute -->
<!-- $$$setLegIndex[overload1]$$$setLegIndexint -->
<h3 class="fn" id="setLegIndex"><a name="setLegIndex"></a><span class="type">void</span> QGeoRouteLeg::<span class="name">setLegIndex</span>(<span class="type">int</span> <i>idx</i>)</h3>
<p>Sets the route leg index to <i>idx</i>.</p>
<p><b>See also </b><a href="qgeorouteleg.html#legIndex">legIndex</a>().</p>
<!-- @@@setLegIndex -->
<!-- $$$setOverallRoute[overload1]$$$setOverallRouteconstQGeoRoute& -->
<h3 class="fn" id="setOverallRoute"><a name="setOverallRoute"></a><span class="type">void</span> QGeoRouteLeg::<span class="name">setOverallRoute</span>(const <span class="type"><a href="qgeoroute.html#QGeoRoute">QGeoRoute</a></span> &<i>route</i>)</h3>
<p>Sets the <i>route</i> that contains this route leg.</p>
<p><b>See also </b><a href="qgeorouteleg.html#overallRoute">overallRoute</a>().</p>
<!-- @@@setOverallRoute -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
