<?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" />
<!-- qgeoroutereply.cpp -->
<title>Qt Mobility 1.2: QGeoRouteReply 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>QGeoRouteReply</li>
</ul>
</div>
</div>
<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="#signals">Signals</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>
<h1 class="title">QGeoRouteReply Class Reference</h1>
<!-- $$$QGeoRouteReply-brief -->
<p>The QGeoRouteReply class manages an operation started by an instance of <a href="qgeoroutingmanager.html">QGeoRoutingManager</a>. <a href="#details">More...</a></p>
<!-- @@@QGeoRouteReply -->
<pre class="cpp"> <span class="preprocessor">#include <QGeoRouteReply></span></pre><p><b>Inherits: </b><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qgeoroutereply-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="qgeoroutereply.html#Error-enum">Error</a></b> { NoError, EngineNotSetError, CommunicationError, ParseError, UnsupportedOptionError, UnknownError }</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="qgeoroutereply.html#QGeoRouteReply">QGeoRouteReply</a></b> ( Error <i>error</i>, const QString & <i>errorString</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#dtor.QGeoRouteReply">~QGeoRouteReply</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#abort">abort</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#error">error</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#errorString">errorString</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#isFinished">isFinished</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteRequest </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#request">request</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QGeoRoute> </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#routes">routes</a></b> () const</td></tr>
</table>
<ul>
<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="qgeoroutereply.html#error-2">error</a></b> ( QGeoRouteReply::Error <i>error</i>, const QString & <i>errorString</i> = QString() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#finished">finished</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#QGeoRouteReply-2">QGeoRouteReply</a></b> ( const QGeoRouteRequest & <i>request</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#setError">setError</a></b> ( Error <i>error</i>, const QString & <i>errorString</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#setFinished">setFinished</a></b> ( bool <i>finished</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutereply.html#setRoutes">setRoutes</a></b> ( const QList<QGeoRoute> & <i>routes</i> )</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<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">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>
<!-- $$$QGeoRouteReply-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoRouteReply class manages an operation started by an instance of <a href="qgeoroutingmanager.html">QGeoRoutingManager</a>.</p>
<p>Instances of QGeoRouteReply manage the state and results of these operations.</p>
<p>The <a href="qgeoroutereply.html#isFinished">isFinished</a>(), <a href="qgeoroutereply.html#error">error</a>() and <a href="qgeoroutereply.html#errorString">errorString</a>() methods provide information on whether the operation has completed and if it completed successfully.</p>
<p>The <a href="qgeoroutereply.html#finished">finished</a>() and error(<a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::Error</a>,<a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a>) signals can be used to monitor the progress of the operation.</p>
<p>It is possible that a newly created QGeoRouteReply may be in a finished state, most commonly because an error has occurred. Since such an instance will never emit the <a href="qgeoroutereply.html#finished">finished</a>() or error(<a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::Error</a>,<a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a>) signals, it is important to check the result of <a href="qgeoroutereply.html#isFinished">isFinished</a>() before making the connections to the signals. The documentation for <a href="qgeoroutingmanager.html">QGeoRoutingManager</a> demonstrates how this might be carried out.</p>
<p>If the operation completes successfully the results will be able to be accessed with <a href="qgeoroutereply.html#routes">routes</a>().</p>
</div>
<!-- @@@QGeoRouteReply -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$NoError$$$EngineNotSetError$$$CommunicationError$$$ParseError$$$UnsupportedOptionError$$$UnknownError -->
<h3 class="fn"><a name="Error-enum"></a>enum QGeoRouteReply::<span class="name">Error</span></h3>
<p>Describes an error which prevented the completion of the operation.</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>QGeoRouteReply::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No error has occurred.</td></tr>
<tr><td class="topAlign"><tt>QGeoRouteReply::EngineNotSetError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The routing manager that was used did not have a <a href="qgeoroutingmanagerengine.html">QGeoRoutingManagerEngine</a> instance associated with it.</td></tr>
<tr><td class="topAlign"><tt>QGeoRouteReply::CommunicationError</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">An error occurred while communicating with the service provider.</td></tr>
<tr><td class="topAlign"><tt>QGeoRouteReply::ParseError</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The response from the service provider was in an unrecognizable format.</td></tr>
<tr><td class="topAlign"><tt>QGeoRouteReply::UnsupportedOptionError</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The requested operation or one of the options for the operation are not supported by the service provider.</td></tr>
<tr><td class="topAlign"><tt>QGeoRouteReply::UnknownError</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">An error occurred which does not fit into any of the other categories.</td></tr>
</table>
<!-- @@@Error -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoRouteReply[overload1]$$$QGeoRouteReplyErrorconstQString&QObject* -->
<h3 class="fn"><a name="QGeoRouteReply"></a>QGeoRouteReply::<span class="name">QGeoRouteReply</span> ( <span class="type"><a href="qgeoroutereply.html#Error-enum">Error</a></span> <i>error</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>errorString</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a route reply with a given <i>error</i> and <i>errorString</i> and the specified <i>parent</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QGeoRouteReply -->
<!-- $$$QGeoRouteReply$$$QGeoRouteReplyconstQGeoRouteRequest&QObject* -->
<h3 class="fn"><a name="QGeoRouteReply-2"></a>QGeoRouteReply::<span class="name">QGeoRouteReply</span> ( const <span class="type"><a href="qgeorouterequest.html">QGeoRouteRequest</a></span> & <i>request</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )<tt> [protected]</tt></h3>
<p>Constructs a route reply object based on <i>request</i>, with the specified <i>parent</i>.</p>
<!-- @@@QGeoRouteReply -->
<!-- $$$~QGeoRouteReply[overload1]$$$~QGeoRouteReply -->
<h3 class="fn"><a name="dtor.QGeoRouteReply"></a>QGeoRouteReply::<span class="name">~QGeoRouteReply</span> ()<tt> [virtual]</tt></h3>
<p>Destroys this route reply object.</p>
<!-- @@@~QGeoRouteReply -->
<!-- $$$abort[overload1]$$$abort -->
<h3 class="fn"><a name="abort"></a><span class="type">void</span> QGeoRouteReply::<span class="name">abort</span> ()<tt> [virtual]</tt></h3>
<p>Cancels the operation immediately.</p>
<p>This will do nothing if the reply is finished.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@abort -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn"><a name="error"></a><span class="type"><a href="qgeoroutereply.html#Error-enum">Error</a></span> QGeoRouteReply::<span class="name">error</span> () const</h3>
<p>Returns the error state of this reply.</p>
<p>If the result is <a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::NoError</a> then no error has occurred.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutereply.html#setError">setError</a>().</p>
<!-- @@@error -->
<!-- $$$error$$$errorQGeoRouteReply::ErrorconstQString& -->
<h3 class="fn"><a name="error-2"></a><span class="type">void</span> QGeoRouteReply::<span class="name">error</span> ( <span class="type"><a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::Error</a></span> <i>error</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>errorString</i> = QString() )<tt> [signal]</tt></h3>
<p>This signal is emitted when an error has been detected in the processing of this reply. The <a href="qgeoroutereply.html#finished">finished</a>() signal will probably follow.</p>
<p>The error will be described by the error code <i>error</i>. If <i>errorString</i> is not empty it will contain a textual description of the error.</p>
<p>This signal and <a href="qgeoroutingmanager.html#error">QGeoRoutingManager::error</a>() will be emitted at the same time.</p>
<p><b>Note:</b> Do no delete this reply object in the slot connected to this signal. Use <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>() instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn"><a name="errorString"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QGeoRouteReply::<span class="name">errorString</span> () const</h3>
<p>Returns the textual representation of the error state of this reply.</p>
<p>If no error has occurred this will return an empty string. It is possible that an error occurred which has no associated textual representation, in which case this will also return an empty string.</p>
<p>To determine whether an error has occurred, check to see if <a href="qgeoroutereply.html#error">QGeoRouteReply::error</a>() is equal to <a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::NoError</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@errorString -->
<!-- $$$finished[overload1]$$$finished -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QGeoRouteReply::<span class="name">finished</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when this reply has finished processing.</p>
<p>If <a href="qgeoroutereply.html#error">error</a>() equals <a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::NoError</a> then the processing finished successfully.</p>
<p>This signal and <a href="qgeoroutingmanager.html#finished">QGeoRoutingManager::finished</a>() will be emitted at the same time.</p>
<p><b>Note:</b> Do no delete this reply object in the slot connected to this signal. Use <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>() instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutereply.html#setFinished">setFinished</a>().</p>
<!-- @@@finished -->
<!-- $$$isFinished[overload1]$$$isFinished -->
<h3 class="fn"><a name="isFinished"></a><span class="type">bool</span> QGeoRouteReply::<span class="name">isFinished</span> () const</h3>
<p>Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@isFinished -->
<!-- $$$request[overload1]$$$request -->
<h3 class="fn"><a name="request"></a><span class="type"><a href="qgeorouterequest.html">QGeoRouteRequest</a></span> QGeoRouteReply::<span class="name">request</span> () const</h3>
<p>Returns the route request which specified the route.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@request -->
<!-- $$$routes[overload1]$$$routes -->
<h3 class="fn"><a name="routes"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qgeoroute.html">QGeoRoute</a></span>> QGeoRouteReply::<span class="name">routes</span> () const</h3>
<p>Returns the list of routes which were requested.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutereply.html#setRoutes">setRoutes</a>().</p>
<!-- @@@routes -->
<!-- $$$setError[overload1]$$$setErrorErrorconstQString& -->
<h3 class="fn"><a name="setError"></a><span class="type">void</span> QGeoRouteReply::<span class="name">setError</span> ( <span class="type"><a href="qgeoroutereply.html#Error-enum">Error</a></span> <i>error</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>errorString</i> )<tt> [protected]</tt></h3>
<p>Sets the error state of this reply to <i>error</i> and the textual representation of the error to <i>errorString</i>.</p>
<p>This wil also cause <a href="qgeoroutereply.html#error">error</a>() and <a href="qgeoroutereply.html#finished">finished</a>() signals to be emitted, in that order.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutereply.html#error">error</a>().</p>
<!-- @@@setError -->
<!-- $$$setFinished[overload1]$$$setFinishedbool -->
<h3 class="fn"><a name="setFinished"></a><span class="type">void</span> QGeoRouteReply::<span class="name">setFinished</span> ( <span class="type">bool</span> <i>finished</i> )<tt> [protected]</tt></h3>
<p>Sets whether or not this reply has finished to <i>finished</i>.</p>
<p>If <i>finished</i> is true, this will cause the <a href="qgeoroutereply.html#finished">finished</a>() signal to be emitted.</p>
<p>If the operation completed successfully, <a href="qgeoroutereply.html#setRoutes">QGeoRouteReply::setRoutes</a>() should be called before this function. If an error occurred, <a href="qgeoroutereply.html#setError">QGeoRouteReply::setError</a>() should be used instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutereply.html#finished">finished</a>().</p>
<!-- @@@setFinished -->
<!-- $$$setRoutes[overload1]$$$setRoutesconstQList<QGeoRoute>& -->
<h3 class="fn"><a name="setRoutes"></a><span class="type">void</span> QGeoRouteReply::<span class="name">setRoutes</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qgeoroute.html">QGeoRoute</a></span>> & <i>routes</i> )<tt> [protected]</tt></h3>
<p>Sets the list of routes in the reply to <i>routes</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutereply.html#routes">routes</a>().</p>
<!-- @@@setRoutes -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
910
