PySide6.QtLocation.QGeoCodeReply

class QGeoCodeReply

The QGeoCodeReply class manages an operation started by an instance of QGeoCodingManager . More…

Synopsis

Methods

• def __init__()

• def addLocation()

• def error()

• def errorString()

• def isFinished()

• def limit()

• def locations()

• def offset()

• def setError()

• def setFinished()

• def setLimit()

• def setLocations()

• def setOffset()

• def setViewport()

• def viewport()

Virtual methods

• def abort()

Signals

• def aborted()

• def errorOccurred()

• def finished()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Instances of QGeoCodeReply manage the state and results of these operations.

The isFinished() , error() and errorString() methods provide information on whether the operation has completed and if it completed successfully.

The finished() and errorOccurred ( 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 the finished() or errorOccurred ( Error ,QString) signals, it is important to check the result of isFinished() before making the connections to the signals. The documentation for QGeoCodingManager demonstrates how this might be carried out.

If the operation completes successfully the results will be able to be accessed with locations() .

class 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.

__init__([parent=None])

Parameters:

parent – QObject

Constructs a geocode reply with the specified parent.

__init__(error, errorString[, parent=None])

Parameters:

• error – Error

• errorString – str

• parent – QObject

Constructs a geocode reply with a given error and errorString and the specified parent.

abort()

Cancels the operation immediately.

This will do nothing if the reply is finished.

See also

aborted()

aborted()

This signal is emitted when the operation has been cancelled.

See also

abort()

addLocation(location)

Parameters:

location – QGeoLocation

Adds location to the list of locations in this reply.

error()

Return type:

Error

Returns the error state of this reply.

If the result is NoError then no error has occurred.

See also

setError()

errorOccurred(error[, errorString=""])

Parameters:

• error – Error

• errorString – str

This signal is emitted when an error has been detected in the processing of this reply. The finished() signal will probably follow.

The error will be described by the error code error. If errorString is not empty it will contain a textual description of the error.

This signal and errorOccurred() will be emitted at the same time.

Note

Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

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 to NoError .

finished()

This signal is emitted when this reply has finished processing.

If error() equals NoError then the processing finished successfully.

This signal and finished() will be emitted at the same time.

Note

Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

See also

setFinished()

isFinished()

Return type:

bool

Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.

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

setLimit()

locations()

Return type:

.list of QGeoLocation

Returns a list of locations.

The locations are the results of the operation corresponding to the QGeoCodingManager function which created this reply.

See also

setLocations()

offset()

Return type:

int

Returns the offset into the entire result set at which to start fetching results.

See also

setOffset()

setError(error, errorString)

Parameters:

• error – Error

• errorString – str

Sets the error state of this reply to error and the textual representation of the error to errorString.

This will also cause errorOccurred() and finished() signals to be emitted, in that order.

See also

error()

setFinished(finished)

Parameters:

finished – bool

Sets whether or not this reply has finished to finished.

If finished is true, this will cause the finished() 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

finished()

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

limit()

setLocations(locations)

Parameters:

locations – .list of QGeoLocation

Sets the list of locations in the reply.

See also

locations()

setOffset(offset)

Parameters:

offset – int

Sets the offset in the entire result set at which to start fetching result to offset.

See also

offset()

setViewport(viewport)

Parameters:

viewport – QGeoShape

Sets the viewport which contains the results to viewport.

See also

viewport()

viewport()

Return type:

QGeoShape

Returns the viewport which contains the results.

This function will return None if no viewport bias was specified in the QGeoCodingManager function which created this reply.

See also

setViewport()