/usr/share/qt5/doc/qtlocation/qgeocodereply.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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | <?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" />
<!-- qgeocodereply.cpp -->
<title>QGeoCodeReply 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>QGeoCodeReply</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="#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">QGeoCodeReply Class</h1>
<!-- $$$QGeoCodeReply-brief -->
<p>The QGeoCodeReply class manages an operation started by an instance of <a href="qgeocodingmanager.html">QGeoCodingManager</a>. <a href="#details">More...</a></p>
<!-- @@@QGeoCodeReply -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QGeoCodeReply></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="qgeocodereply-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="qgeocodereply.html#Error-enum">Error</a></b> { NoError, EngineNotSetError, CommunicationError, ParseError, ..., 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="qgeocodereply.html#QGeoCodeReply">QGeoCodeReply</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="qgeocodereply.html#dtor.QGeoCodeReply">~QGeoCodeReply</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#abort">abort</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#errorString">errorString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#isFinished">isFinished</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#limit">limit</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QGeoLocation> </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#locations">locations</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#offset">offset</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoShape </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#viewport">viewport</a></b>() const</td></tr>
</table>
<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="qgeocodereply.html#error-2">error</a></b>(QGeoCodeReply::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="qgeocodereply.html#finished">finished</a></b>()</td></tr>
</table>
<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="qgeocodereply.html#QGeoCodeReply-2">QGeoCodeReply</a></b>(QObject *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#addLocation">addLocation</a></b>(const QGeoLocation &<i> location</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.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="qgeocodereply.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="qgeocodereply.html#setLimit">setLimit</a></b>(int<i> limit</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#setLocations">setLocations</a></b>(const QList<QGeoLocation> &<i> locations</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#setOffset">setOffset</a></b>(int<i> offset</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeocodereply.html#setViewport">setViewport</a></b>(const QGeoShape &<i> viewport</i>)</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGeoCodeReply-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoCodeReply class manages an operation started by an instance of <a href="qgeocodingmanager.html">QGeoCodingManager</a>.</p>
<p>Instances of QGeoCodeReply manage the state and results of these operations.</p>
<p>The <a href="qgeocodereply.html#isFinished">isFinished</a>(), <a href="qgeocodereply.html#error">error</a>() and <a href="qgeocodereply.html#errorString">errorString</a>() methods provide information on whether the operation has completed and if it completed successfully.</p>
<p>The <a href="qgeocodereply.html#finished">finished</a>() and error(<a href="qgeocodereply.html#Error-enum">QGeoCodeReply::Error</a>,QString) signals can be used to monitor the progress of the operation.</p>
<p>It is possible that a newly created QGeoCodeReply may be in a finished state, most commonly because an error has occurred. Since such an instance will never emit the <a href="qgeocodereply.html#finished">finished</a>() or error(<a href="qgeocodereply.html#Error-enum">QGeoCodeReply::Error</a>,QString) signals, it is important to check the result of <a href="qgeocodereply.html#isFinished">isFinished</a>() before making the connections to the signals. The documentation for <a href="qgeocodingmanager.html">QGeoCodingManager</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="qgeocodereply.html#locations">locations</a>().</p>
</div>
<!-- @@@QGeoCodeReply -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$NoError$$$EngineNotSetError$$$CommunicationError$$$ParseError$$$UnsupportedOptionError$$$CombinationError$$$UnknownError -->
<h3 class="fn"><a name="Error-enum"></a>enum QGeoCodeReply::<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>QGeoCodeReply::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No error has occurred.</td></tr>
<tr><td class="topAlign"><tt>QGeoCodeReply::EngineNotSetError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The geocoding manager that was used did not have a <a href="qgeocodingmanagerengine.html">QGeoCodingManagerEngine</a> instance associated with it.</td></tr>
<tr><td class="topAlign"><tt>QGeoCodeReply::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>QGeoCodeReply::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>QGeoCodeReply::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>QGeoCodeReply::CombinationError</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">An error occurred while results where being combined from multiple sources.</td></tr>
<tr><td class="topAlign"><tt>QGeoCodeReply::UnknownError</tt></td><td class="topAlign"><tt>6</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>
<!-- $$$QGeoCodeReply[overload1]$$$QGeoCodeReplyErrorconstQString&QObject* -->
<h3 class="fn"><a name="QGeoCodeReply"></a>QGeoCodeReply::<span class="name">QGeoCodeReply</span>(<span class="type"><a href="qgeocodereply.html#Error-enum">Error</a></span><i> error</i>, const <span class="type">QString</span> &<i> errorString</i>, <span class="type">QObject</span> *<i> parent</i> = 0)</h3>
<p>Constructs a geocode reply with a given <i>error</i> and <i>errorString</i> and the specified <i>parent</i>.</p>
<!-- @@@QGeoCodeReply -->
<!-- $$$QGeoCodeReply$$$QGeoCodeReplyQObject* -->
<h3 class="fn"><a name="QGeoCodeReply-2"></a>QGeoCodeReply::<span class="name">QGeoCodeReply</span>(<span class="type">QObject</span> *<i> parent</i> = 0)<tt> [protected]</tt></h3>
<p>Constructs a geocode reply with the specified <i>parent</i>.</p>
<!-- @@@QGeoCodeReply -->
<!-- $$$~QGeoCodeReply[overload1]$$$~QGeoCodeReply -->
<h3 class="fn"><a name="dtor.QGeoCodeReply"></a>QGeoCodeReply::<span class="name">~QGeoCodeReply</span>()<tt> [virtual]</tt></h3>
<p>Destroys this reply object.</p>
<!-- @@@~QGeoCodeReply -->
<!-- $$$abort[overload1]$$$abort -->
<h3 class="fn"><a name="abort"></a><span class="type">void</span> QGeoCodeReply::<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>
<!-- @@@abort -->
<!-- $$$addLocation[overload1]$$$addLocationconstQGeoLocation& -->
<h3 class="fn"><a name="addLocation"></a><span class="type">void</span> QGeoCodeReply::<span class="name">addLocation</span>(const <span class="type">QGeoLocation</span> &<i> location</i>)<tt> [protected]</tt></h3>
<p>Adds <i>location</i> to the list of locations in this reply.</p>
<!-- @@@addLocation -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn"><a name="error"></a><span class="type"><a href="qgeocodereply.html#Error-enum">Error</a></span> QGeoCodeReply::<span class="name">error</span>() const</h3>
<p>Returns the error state of this reply.</p>
<p>If the result is <a href="qgeocodereply.html#Error-enum">QGeoCodeReply::NoError</a> then no error has occurred.</p>
<p><b>See also </b><a href="qgeocodereply.html#setError">setError</a>().</p>
<!-- @@@error -->
<!-- $$$error$$$errorQGeoCodeReply::ErrorconstQString& -->
<h3 class="fn"><a name="error-2"></a><span class="type">void</span> QGeoCodeReply::<span class="name">error</span>(<span class="type"><a href="qgeocodereply.html#Error-enum">QGeoCodeReply::Error</a></span><i> error</i>, const <span class="type">QString</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="qgeocodereply.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="qgeocodingmanager.html#error">QGeoCodingManager::error</a>() will be emitted at the same time.</p>
<p><b>Note: </b>Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.</p><!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn"><a name="errorString"></a><span class="type">QString</span> QGeoCodeReply::<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="qgeocodereply.html#error">QGeoCodeReply::error</a>() is equal to <a href="qgeocodereply.html#Error-enum">QGeoCodeReply::NoError</a>.</p>
<!-- @@@errorString -->
<!-- $$$finished[overload1]$$$finished -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QGeoCodeReply::<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="qgeocodereply.html#error">error</a>() equals <a href="qgeocodereply.html#Error-enum">QGeoCodeReply::NoError</a> then the processing finished successfully.</p>
<p>This signal and <a href="qgeocodingmanager.html#finished">QGeoCodingManager::finished</a>() will be emitted at the same time.</p>
<p><b>Note: </b>Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.</p><p><b>See also </b><a href="qgeocodereply.html#setFinished">setFinished</a>().</p>
<!-- @@@finished -->
<!-- $$$isFinished[overload1]$$$isFinished -->
<h3 class="fn"><a name="isFinished"></a><span class="type">bool</span> QGeoCodeReply::<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>
<!-- @@@isFinished -->
<!-- $$$limit[overload1]$$$limit -->
<h3 class="fn"><a name="limit"></a><span class="type">int</span> QGeoCodeReply::<span class="name">limit</span>() const</h3>
<p>Returns the limit on the number of responses from each data source.</p>
<p>If no limit was set this function will return -1.</p>
<p>This may be more than <a href="qgeocodereply.html#locations">locations</a>().length() if the number of responses was less than the number requested.</p>
<p><b>See also </b><a href="qgeocodereply.html#setLimit">setLimit</a>().</p>
<!-- @@@limit -->
<!-- $$$locations[overload1]$$$locations -->
<h3 class="fn"><a name="locations"></a><span class="type">QList</span><<span class="type">QGeoLocation</span>> QGeoCodeReply::<span class="name">locations</span>() const</h3>
<p>Returns a list of locations.</p>
<p>The locations are the results of the operation corresponding to the <a href="qgeocodingmanager.html">QGeoCodingManager</a> function which created this reply.</p>
<p><b>See also </b><a href="qgeocodereply.html#setLocations">setLocations</a>().</p>
<!-- @@@locations -->
<!-- $$$offset[overload1]$$$offset -->
<h3 class="fn"><a name="offset"></a><span class="type">int</span> QGeoCodeReply::<span class="name">offset</span>() const</h3>
<p>Returns the offset into the entire result set at which to start fetching results.</p>
<p><b>See also </b><a href="qgeocodereply.html#setOffset">setOffset</a>().</p>
<!-- @@@offset -->
<!-- $$$setError[overload1]$$$setErrorErrorconstQString& -->
<h3 class="fn"><a name="setError"></a><span class="type">void</span> QGeoCodeReply::<span class="name">setError</span>(<span class="type"><a href="qgeocodereply.html#Error-enum">Error</a></span><i> error</i>, const <span class="type">QString</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 will also cause <a href="qgeocodereply.html#error">error</a>() and <a href="qgeocodereply.html#finished">finished</a>() signals to be emitted, in that order.</p>
<p><b>See also </b><a href="qgeocodereply.html#error">error</a>().</p>
<!-- @@@setError -->
<!-- $$$setFinished[overload1]$$$setFinishedbool -->
<h3 class="fn"><a name="setFinished"></a><span class="type">void</span> QGeoCodeReply::<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="qgeocodereply.html#finished">finished</a>() signal to be emitted.</p>
<p>If the operation completed successfully, <a href="qgeocodereply.html#setLocations">QGeoCodeReply::setLocations</a>() should be called before this function. If an error occurred, <a href="qgeocodereply.html#setError">QGeoCodeReply::setError</a>() should be used instead.</p>
<p><b>See also </b><a href="qgeocodereply.html#finished">finished</a>().</p>
<!-- @@@setFinished -->
<!-- $$$setLimit[overload1]$$$setLimitint -->
<h3 class="fn"><a name="setLimit"></a><span class="type">void</span> QGeoCodeReply::<span class="name">setLimit</span>(<span class="type">int</span><i> limit</i>)<tt> [protected]</tt></h3>
<p>Sets the limit on the number of responses from each data source to <i>limit</i>.</p>
<p>If <i>limit</i> is -1 then all available responses will be returned.</p>
<p><b>See also </b><a href="qgeocodereply.html#limit">limit</a>().</p>
<!-- @@@setLimit -->
<!-- $$$setLocations[overload1]$$$setLocationsconstQList<QGeoLocation>& -->
<h3 class="fn"><a name="setLocations"></a><span class="type">void</span> QGeoCodeReply::<span class="name">setLocations</span>(const <span class="type">QList</span><<span class="type">QGeoLocation</span>> &<i> locations</i>)<tt> [protected]</tt></h3>
<p>Sets the list of <i>locations</i> in the reply.</p>
<p><b>See also </b><a href="qgeocodereply.html#locations">locations</a>().</p>
<!-- @@@setLocations -->
<!-- $$$setOffset[overload1]$$$setOffsetint -->
<h3 class="fn"><a name="setOffset"></a><span class="type">void</span> QGeoCodeReply::<span class="name">setOffset</span>(<span class="type">int</span><i> offset</i>)<tt> [protected]</tt></h3>
<p>Sets the offset in the entire result set at which to start fetching result to <i>offset</i>.</p>
<p><b>See also </b><a href="qgeocodereply.html#offset">offset</a>().</p>
<!-- @@@setOffset -->
<!-- $$$setViewport[overload1]$$$setViewportconstQGeoShape& -->
<h3 class="fn"><a name="setViewport"></a><span class="type">void</span> QGeoCodeReply::<span class="name">setViewport</span>(const <span class="type">QGeoShape</span> &<i> viewport</i>)<tt> [protected]</tt></h3>
<p>Sets the viewport which contains the results to <i>viewport</i>.</p>
<p><b>See also </b><a href="qgeocodereply.html#viewport">viewport</a>().</p>
<!-- @@@setViewport -->
<!-- $$$viewport[overload1]$$$viewport -->
<h3 class="fn"><a name="viewport"></a><span class="type">QGeoShape</span> QGeoCodeReply::<span class="name">viewport</span>() const</h3>
<p>Returns the viewport which contains the results.</p>
<p>This function will return 0 if no viewport bias was specified in the <a href="qgeocodingmanager.html">QGeoCodingManager</a> function which created this reply.</p>
<p><b>See also </b><a href="qgeocodereply.html#setViewport">setViewport</a>().</p>
<!-- @@@viewport -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|