QGeoCodeReply¶
The
QGeoCodeReply
class manages an operation started by an instance ofQGeoCodingManager
. More…
Synopsis¶
Functions¶
def
addLocation
(location)def
error
()def
errorString
()def
isFinished
()def
limit
()def
locations
()def
offset
()def
setError
(error, errorString)def
setFinished
(finished)def
setLimit
(limit)def
setLocations
(locations)def
setOffset
(offset)def
setViewport
(viewport)def
viewport
()
Virtual functions¶
def
abort
()
Signals¶
Detailed Description¶
Instances of
QGeoCodeReply
manage the state and results of these operations.The
isFinished()
,error()
anderrorString()
methods provide information on whether the operation has completed and if it completed successfully.The
finished()
and error(Error
,QString
) signals can be used to monitor the progress of the operation.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 thefinished()
or error(Error
,QString
) signals, it is important to check the result ofisFinished()
before making the connections to the signals. The documentation forQGeoCodingManager
demonstrates how this might be carried out.If the operation completes successfully the results will be able to be accessed with
locations()
.
- class PySide2.QtLocation.QGeoCodeReply(error, errorString[, parent=None])¶
PySide2.QtLocation.QGeoCodeReply([parent=None])
- param parent:
- param errorString:
str
- param error:
Constructs a geocode reply with a given
error
anderrorString
and the specifiedparent
.Constructs a geocode reply with the specified
parent
.
- PySide2.QtLocation.QGeoCodeReply.Error¶
Describes an error which prevented the completion of the operation.
Constant
Description
QGeoCodeReply.NoError
No error has occurred.
QGeoCodeReply.EngineNotSetError
The geocoding manager that was used did not have a
QGeoCodingManagerEngine
instance associated with it.QGeoCodeReply.CommunicationError
An error occurred while communicating with the service provider.
QGeoCodeReply.ParseError
The response from the service provider was in an unrecognizable format.
QGeoCodeReply.UnsupportedOptionError
The requested operation or one of the options for the operation are not supported by the service provider.
QGeoCodeReply.CombinationError
An error occurred while results where being combined from multiple sources.
QGeoCodeReply.UnknownError
An error occurred which does not fit into any of the other categories.
- PySide2.QtLocation.QGeoCodeReply.abort()¶
Cancels the operation immediately.
This will do nothing if the reply is finished.
See also
- PySide2.QtLocation.QGeoCodeReply.aborted()¶
- PySide2.QtLocation.QGeoCodeReply.addLocation(location)¶
- Parameters:
location –
PySide2.QtPositioning.QGeoLocation
Adds
location
to the list of locations in this reply.
- PySide2.QtLocation.QGeoCodeReply.error()¶
- Return type:
Returns the error state of this reply.
If the result is
NoError
then no error has occurred.See also
- PySide2.QtLocation.QGeoCodeReply.error(error[, errorString=""])
- Parameters:
error –
Error
errorString – str
- PySide2.QtLocation.QGeoCodeReply.errorString()¶
- Return type:
str
Returns the textual representation of the error state of this reply.
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.
To determine whether an error has occurred, check to see if
error()
is equal toNoError
.
- PySide2.QtLocation.QGeoCodeReply.finished()¶
- PySide2.QtLocation.QGeoCodeReply.isFinished()¶
- Return type:
bool
Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.
- PySide2.QtLocation.QGeoCodeReply.limit()¶
- Return type:
int
Returns the limit on the number of responses from each data source.
If no limit was set this function will return -1.
This may be more than
locations()
. length() if the number of responses was less than the number requested.See also
- PySide2.QtLocation.QGeoCodeReply.locations()¶
- Return type:
Returns a list of locations.
The locations are the results of the operation corresponding to the
QGeoCodingManager
function which created this reply.See also
- PySide2.QtLocation.QGeoCodeReply.offset()¶
- Return type:
int
Returns the offset into the entire result set at which to start fetching results.
See also
- PySide2.QtLocation.QGeoCodeReply.setError(error, errorString)¶
- Parameters:
error –
Error
errorString – str
Sets the error state of this reply to
error
and the textual representation of the error toerrorString
.This will also cause
error()
andfinished()
signals to be emitted, in that order.See also
- PySide2.QtLocation.QGeoCodeReply.setFinished(finished)¶
- Parameters:
finished – bool
Sets whether or not this reply has finished to
finished
.If
finished
is true, this will cause thefinished()
signal to be emitted.If the operation completed successfully,
setLocations()
should be called before this function. If an error occurred,setError()
should be used instead.See also
- PySide2.QtLocation.QGeoCodeReply.setLimit(limit)¶
- Parameters:
limit – int
Sets the limit on the number of responses from each data source to
limit
.If
limit
is -1 then all available responses will be returned.See also
- PySide2.QtLocation.QGeoCodeReply.setLocations(locations)¶
- Parameters:
locations –
Sets the list of
locations
in the reply.See also
- PySide2.QtLocation.QGeoCodeReply.setOffset(offset)¶
- Parameters:
offset – int
Sets the offset in the entire result set at which to start fetching result to
offset
.See also
- PySide2.QtLocation.QGeoCodeReply.setViewport(viewport)¶
- Parameters:
viewport –
PySide2.QtPositioning.QGeoShape
Sets the viewport which contains the results to
viewport
.See also
- PySide2.QtLocation.QGeoCodeReply.viewport()¶
- Return type:
Returns the viewport which contains the results.
This function will return 0 if no viewport bias was specified in the
QGeoCodingManager
function which created this reply.See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. 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.