Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 896

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.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" />
<!-- qgeomaprouteobject.cpp -->
  <title>Qt Mobility 1.2: QGeoMapRouteObject Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtlocation.html">QtLocation</a></li>
<li>QGeoMapRouteObject</li>
    </ul>
  </div>
</div>
<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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoMapRouteObject Class Reference</h1>
<!-- $$$QGeoMapRouteObject-brief -->
<p>The QGeoMapRouteObject class is a <a href="qgeomapobject.html">QGeoMapObject</a> used to draw a route on a map. <a href="#details">More...</a></p>
<!-- @@@QGeoMapRouteObject -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGeoMapRouteObject&gt;</span></pre><p><b>Inherits: </b><a href="qgeomapobject.html">QGeoMapObject</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qgeomaprouteobject-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="qgeomaprouteobject.html#detailLevel-prop">detailLevel</a></b> : quint32</li>
<li class="fn"><b><a href="qgeomaprouteobject.html#pen-prop">pen</a></b> : QPen</li>
<li class="fn"><b><a href="qgeomaprouteobject.html#route-prop">route</a></b> : QGeoRoute</li>
</ul>
<ul>
<li class="fn">6 properties inherited from <a href="qgeomapobject.html#properties">QGeoMapObject</a></li>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
</ul>
<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="qgeomaprouteobject.html#QGeoMapRouteObject">QGeoMapRouteObject</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#QGeoMapRouteObject-2">QGeoMapRouteObject</a></b> ( const QGeoRoute &amp; <i>route</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#dtor.QGeoMapRouteObject">~QGeoMapRouteObject</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> quint32 </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#detailLevel-prop">detailLevel</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPen </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#pen-prop">pen</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRoute </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#route-prop">route</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#detailLevel-prop">setDetailLevel</a></b> ( quint32 <i>detailLevel</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#pen-prop">setPen</a></b> ( const QPen &amp; <i>pen</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#route-prop">setRoute</a></b> ( const QGeoRoute &amp; <i>route</i> )</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QGeoMapObject::Type </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#type">type</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">15 public functions inherited from <a href="qgeomapobject.html#public-functions">QGeoMapObject</a></li>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#detailLevelChanged">detailLevelChanged</a></b> ( quint32 <i>detailLevel</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#penChanged">penChanged</a></b> ( const QPen &amp; <i>pen</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#routeChanged">routeChanged</a></b> ( const QGeoRoute &amp; <i>route</i> )</td></tr>
</table>
<ul>
<li class="fn">6 signals inherited from <a href="qgeomapobject.html#signals">QGeoMapObject</a></li>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">3 protected functions inherited from <a href="qgeomapobject.html#protected-functions">QGeoMapObject</a></li>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QGeoMapRouteObject-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoMapRouteObject class is a <a href="qgeomapobject.html">QGeoMapObject</a> used to draw a route on a map.</p>
<p>The route is specified by a <a href="qgeoroute.html">QGeoRoute</a> object.</p>
<p>The route might be quite detailed, and so to improve performance the detail level can be set with <a href="qgeomaprouteobject.html#detailLevel-prop">QGeoMapRouteObject::detailLevel</a>.</p>
<p>The route object draws the route as a series of lines with a minimum on-screen harmattan length equal to the detail level. This is done so that the small changes in direction of a road will be visible at high zoom levels but will not slow down the rendering at the lower zoom levels.</p>
</div>
<!-- @@@QGeoMapRouteObject -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$detailLevel-prop$$$detailLevel$$$setDetailLevelquint32$$$detailLevelChangedquint32 -->
<h3 class="fn"><a name="detailLevel-prop"></a><span class="name">detailLevel</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#quint32-typedef">quint32</a></span></h3>
<p>This property holds the level of detail used to draw this object.</p>
<p>A <a href="qgeoroute.html">QGeoRoute</a> instance can contain a large amount of information about the path taken by the route. This property is used as a hint to help reduce the amount of information that needs to be drawn on the map.</p>
<p>The path taken by the route is represented as a list of <a href="qgeocoordinate.html">QGeoCoordinate</a> instances. This route object will draw lines between these coordinates, but will skip members of the list until the manhattan distance between the start point and the end point of the line is at least <i>detailLevel</i>.</p>
<p>The default value of this property is 6.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> quint32 </td><td class="memItemRight bottomAlign"><span class="name"><b>detailLevel</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDetailLevel</b></span> ( quint32 <i>detailLevel</i> )</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qgeomaprouteobject.html#detailLevelChanged">detailLevelChanged</a></b></span> ( quint32 <i>detailLevel</i> )</td></tr>
</table>
<!-- @@@detailLevel -->
<!-- $$$pen-prop$$$pen$$$setPenconstQPen&$$$penChangedconstQPen& -->
<h3 class="fn"><a name="pen-prop"></a><span class="name">pen</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qpen.html">QPen</a></span></h3>
<p>This property holds the pen that will be used to draw this object.</p>
<p>The pen is used to draw the route.</p>
<p>The pen will be treated like a cosmetic pen, which means that the width of the pen will be independent of the zoom level of the map.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QPen </td><td class="memItemRight bottomAlign"><span class="name"><b>pen</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPen</b></span> ( const QPen &amp; <i>pen</i> )</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qgeomaprouteobject.html#penChanged">penChanged</a></b></span> ( const QPen &amp; <i>pen</i> )</td></tr>
</table>
<!-- @@@pen -->
<!-- $$$route-prop$$$route$$$setRouteconstQGeoRoute&$$$routeChangedconstQGeoRoute& -->
<h3 class="fn"><a name="route-prop"></a><span class="name">route</span> : <span class="type"><a href="qgeoroute.html">QGeoRoute</a></span></h3>
<p>This property holds the which will be displayed.</p>
<p>The default value of this property is an empty route.</p>
<p>If <a href="qgeoroute.html#path">QGeoRoute::path</a>() returns a list of less than 2 valid QGeoCoordinates then the route object will not be displayed.</p>
<p>This property was introduced in Qt Mobility 1.1.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QGeoRoute </td><td class="memItemRight bottomAlign"><span class="name"><b>route</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRoute</b></span> ( const QGeoRoute &amp; <i>route</i> )</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qgeomaprouteobject.html#routeChanged">routeChanged</a></b></span> ( const QGeoRoute &amp; <i>route</i> )</td></tr>
</table>
<!-- @@@route -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoMapRouteObject[overload1]$$$QGeoMapRouteObject -->
<h3 class="fn"><a name="QGeoMapRouteObject"></a>QGeoMapRouteObject::<span class="name">QGeoMapRouteObject</span> ()</h3>
<p>Constructs a new route object.</p>
<!-- @@@QGeoMapRouteObject -->
<!-- $$$QGeoMapRouteObject$$$QGeoMapRouteObjectconstQGeoRoute& -->
<h3 class="fn"><a name="QGeoMapRouteObject-2"></a>QGeoMapRouteObject::<span class="name">QGeoMapRouteObject</span> ( const <span class="type"><a href="qgeoroute.html">QGeoRoute</a></span> &amp; <i>route</i> )</h3>
<p>Constructs a new route object for the route <i>route</i>.</p>
<!-- @@@QGeoMapRouteObject -->
<!-- $$$~QGeoMapRouteObject[overload1]$$$~QGeoMapRouteObject -->
<h3 class="fn"><a name="dtor.QGeoMapRouteObject"></a>QGeoMapRouteObject::<span class="name">~QGeoMapRouteObject</span> ()</h3>
<p>Destroys this route object</p>
<!-- @@@~QGeoMapRouteObject -->
<!-- $$$detailLevelChanged[overload1]$$$detailLevelChangedquint32 -->
<h3 class="fn"><a name="detailLevelChanged"></a><span class="type">void</span> QGeoMapRouteObject::<span class="name">detailLevelChanged</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#quint32-typedef">quint32</a></span> <i>detailLevel</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the level of detail used to draw this route object has changed.</p>
<p>The new value is <i>detailLevel</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@detailLevelChanged -->
<!-- $$$penChanged[overload1]$$$penChangedconstQPen& -->
<h3 class="fn"><a name="penChanged"></a><span class="type">void</span> QGeoMapRouteObject::<span class="name">penChanged</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qpen.html">QPen</a></span> &amp; <i>pen</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the pen used to draw this route object has changed.</p>
<p>The new value is <i>pen</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@penChanged -->
<!-- $$$routeChanged[overload1]$$$routeChangedconstQGeoRoute& -->
<h3 class="fn"><a name="routeChanged"></a><span class="type">void</span> QGeoMapRouteObject::<span class="name">routeChanged</span> ( const <span class="type"><a href="qgeoroute.html">QGeoRoute</a></span> &amp; <i>route</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the route drawn by this route object has changed.</p>
<p>The new value is <i>route</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@routeChanged -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qgeomapobject.html#Type-enum">QGeoMapObject::Type</a></span> QGeoMapRouteObject::<span class="name">type</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qgeomapobject.html#type">QGeoMapObject::type</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@type -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used 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.</p>
</div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional