~ubuntu-branches/ubuntu/quantal/qtmobility/quantal

« back to all changes in this revision

Viewing changes to doc/html/qgeomaprouteobject.html

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-16 16:18:07 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20101116161807-k2dzt2nyse975r3l
Tags: 1.1.0-0ubuntu1
* New upstream release
* Syncronise with Debian, no remaining changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
47
47
    </div>
48
48
    <div id="shortCut">
49
49
      <ul>
50
 
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1 BETA</a></span></li>
 
50
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1</a></span></li>
51
51
        <li class="shortCut-topleft-active"><a href="http://doc.qt.nokia.com">ALL VERSIONS        </a></li>
52
52
      </ul>
53
53
     </div>
164
164
</ul>
165
165
<ul>
166
166
<li class="fn">3 properties inherited from <a href="qgeomapobject.html#properties">QGeoMapObject</a></li>
 
167
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#properties">QObject</a></li>
167
168
</ul>
168
169
<hr />
169
170
<a name="public-functions"></a>
170
171
<h2>Public Functions</h2>
171
172
<table class="alignedsummary">
172
 
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#QGeoMapRouteObject">QGeoMapRouteObject</a></b> ( QGeoMapObject * <i>parent</i> = 0 )</td></tr>
173
 
<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>, QGeoMapObject * <i>parent</i> = 0 )</td></tr>
 
173
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#QGeoMapRouteObject">QGeoMapRouteObject</a></b> ()</td></tr>
 
174
<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>
174
175
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#dtor.QGeoMapRouteObject">~QGeoMapRouteObject</a></b> ()</td></tr>
175
176
<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>
176
177
<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>
179
180
<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>
180
181
<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>
181
182
</table>
 
183
<hr />
 
184
<a name="reimplemented-public-functions"></a>
 
185
<h2>Reimplemented Public Functions</h2>
 
186
<table class="alignedsummary">
 
187
<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>
 
188
</table>
182
189
<ul>
183
 
<li class="fn">14 public functions inherited from <a href="qgeomapobject.html#public-functions">QGeoMapObject</a></li>
 
190
<li class="fn">12 public functions inherited from <a href="qgeomapobject.html#public-functions">QGeoMapObject</a></li>
 
191
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-functions">QObject</a></li>
184
192
</ul>
185
193
<hr />
186
194
<a name="signals"></a>
192
200
</table>
193
201
<ul>
194
202
<li class="fn">3 signals inherited from <a href="qgeomapobject.html#signals">QGeoMapObject</a></li>
 
203
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#signals">QObject</a></li>
 
204
</ul>
 
205
<h3>Additional Inherited Members</h3>
 
206
<ul>
 
207
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-slots">QObject</a></li>
 
208
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-variables">QObject</a></li>
 
209
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#static-public-members">QObject</a></li>
 
210
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-functions">QObject</a></li>
 
211
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-variables">QObject</a></li>
195
212
</ul>
196
213
<a name="details"></a>
197
214
<hr />
205
222
<hr />
206
223
<div class="prop"/>
207
224
<h2>Property Documentation</h2>
208
 
<h3 class="fn"><a name="detailLevel-prop"></a>detailLevel : quint32</h3>
 
225
<h3 class="fn"><a name="detailLevel-prop"></a>detailLevel : <a href="http://qt.nokia.com/doc/4.6/qtglobal.html#quint32-typedef">quint32</a></h3>
209
226
<p>This property holds this property holds the level of detail used to draw this object.</p>
210
227
<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>
211
228
<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>
212
 
<p>The default value of this property is 20.</p>
 
229
<p>The default value of this property is 6.</p>
213
230
<p><b>Access functions:</b></p>
214
231
<table class="alignedsummary">
215
232
<tr><td class="memItemLeft topAlign rightAlign"> quint32 </td><td class="memItemRight bottomAlign"><b>detailLevel</b> () const</td></tr>
219
236
<table class="alignedsummary">
220
237
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeomaprouteobject.html#detailLevelChanged">detailLevelChanged</a></b> ( quint32 <i>detailLevel</i> )</td></tr>
221
238
</table>
222
 
<h3 class="fn"><a name="pen-prop"></a>pen : QPen</h3>
 
239
<h3 class="fn"><a name="pen-prop"></a>pen : <a href="http://qt.nokia.com/doc/4.6/qpen.html">QPen</a></h3>
223
240
<p>This property holds this property holds the pen that will be used to draw this object.</p>
224
241
<p>The pen is used to draw the route.</p>
225
242
<p>The pen will be treated as a cosmetic pen, which means that the width of the pen will be independent of the zoom level of the map.</p>
249
266
<hr />
250
267
<div class="func"/>
251
268
<h2>Member Function Documentation</h2>
252
 
<h3 class="fn"><a name="QGeoMapRouteObject"></a>QGeoMapRouteObject::QGeoMapRouteObject ( <a href="qgeomapobject.html">QGeoMapObject</a> * <i>parent</i> = 0 )</h3>
253
 
<p>Constructs a new route object with the parent <i>parent</i>.</p>
254
 
<h3 class="fn"><a name="QGeoMapRouteObject-2"></a>QGeoMapRouteObject::QGeoMapRouteObject ( const <a href="qgeoroute.html">QGeoRoute</a> &amp; <i>route</i>, <a href="qgeomapobject.html">QGeoMapObject</a> * <i>parent</i> = 0 )</h3>
255
 
<p>Constructs a new route object for the route <i>route</i> and with parent <i>parent</i>.</p>
 
269
<h3 class="fn"><a name="QGeoMapRouteObject"></a>QGeoMapRouteObject::QGeoMapRouteObject ()</h3>
 
270
<p>Constructs a new route object.</p>
 
271
<h3 class="fn"><a name="QGeoMapRouteObject-2"></a>QGeoMapRouteObject::QGeoMapRouteObject ( const <a href="qgeoroute.html">QGeoRoute</a> &amp; <i>route</i> )</h3>
 
272
<p>Constructs a new route object for the route <i>route</i>.</p>
256
273
<h3 class="fn"><a name="dtor.QGeoMapRouteObject"></a>QGeoMapRouteObject::~QGeoMapRouteObject ()</h3>
257
274
<p>Destroys this route object</p>
258
 
<h3 class="fn"><a name="detailLevelChanged"></a>void QGeoMapRouteObject::detailLevelChanged ( quint32 <i>detailLevel</i> )<tt> [signal]</tt></h3>
259
 
<h3 class="fn"><a name="penChanged"></a>void QGeoMapRouteObject::penChanged ( const QPen &amp; <i>pen</i> )<tt> [signal]</tt></h3>
 
275
<h3 class="fn"><a name="detailLevelChanged"></a>void QGeoMapRouteObject::detailLevelChanged ( <a href="http://qt.nokia.com/doc/4.6/qtglobal.html#quint32-typedef">quint32</a> <i>detailLevel</i> )<tt> [signal]</tt></h3>
 
276
<p>This signal is emitted when the level of detail used to draw this route object has changed.</p>
 
277
<p>The new value is <i>detailLevel</i>.</p>
 
278
<h3 class="fn"><a name="penChanged"></a>void QGeoMapRouteObject::penChanged ( const <a href="http://qt.nokia.com/doc/4.6/qpen.html">QPen</a> &amp; <i>pen</i> )<tt> [signal]</tt></h3>
 
279
<p>This signal is emitted when the pen used to draw this route object has changed.</p>
 
280
<p>The new value is <i>pen</i>.</p>
260
281
<h3 class="fn"><a name="routeChanged"></a>void QGeoMapRouteObject::routeChanged ( const <a href="qgeoroute.html">QGeoRoute</a> &amp; <i>route</i> )<tt> [signal]</tt></h3>
 
282
<p>This signal is emitted when the route drawn by this route object has changed.</p>
 
283
<p>The new value is <i>route</i>.</p>
 
284
<h3 class="fn"><a name="type"></a><a href="qgeomapobject.html#Type-enum">QGeoMapObject::Type</a> QGeoMapRouteObject::type () const<tt> [virtual]</tt></h3>
 
285
<p>Reimplemented from <a href="qgeomapobject.html#type">QGeoMapObject::type</a>().</p>
261
286
</div>
262
287
        <!-- /div -->
263
288
        <div class="feedback t_button">