The QGeoSearchReply class manages an operation started by an instance of QGeoSearchManager. More...
#include <QGeoSearchReply>Inherits: QObject.
This class was introduced in Qt Mobility 1.1.
| enum | Error { NoError, EngineNotSetError, CommunicationError, ParseError, ..., UnknownError } |
| QGeoSearchReply ( Error error, const QString & errorString, QObject * parent = 0 ) | |
| virtual | ~QGeoSearchReply () |
| virtual void | abort () |
| Error | error () const |
| QString | errorString () const |
| bool | isFinished () const |
| int | limit () const |
| int | offset () const |
| QList<QGeoPlace> | places () const |
| QGeoBoundingArea * | viewport () const |
| void | error ( QGeoSearchReply::Error error, const QString & errorString = QString() ) |
| void | finished () |
| QGeoSearchReply ( QObject * parent = 0 ) | |
| void | addPlace ( const QGeoPlace & place ) |
| void | setError ( Error error, const QString & errorString ) |
| void | setFinished ( bool finished ) |
| void | setLimit ( int limit ) |
| void | setOffset ( int offset ) |
| void | setPlaces ( const QList<QGeoPlace> & places ) |
| void | setViewport ( QGeoBoundingArea * viewport ) |
The QGeoSearchReply class manages an operation started by an instance of QGeoSearchManager.
Instances of QGeoSearchReply 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 error(QGeoSearchReply::Error,QString) signals can be used to monitor the progress of the operation.
It is possible that a newly created QGeoSearchReply may be in a finished state, most commonly because an error has occurred. Since such an instance will never emit the finished() or error(QGeoSearchReply::Error,QString) signals, it is important to check the result of isFinished() before making the connections to the signals. The documentation for QGeoSearchManager demonstrates how this might be carried out.
If the operation completes successfully the results will be able to be accessed with places().
Describes an error which prevented the completion of the operation.
| Constant | Value | Description |
|---|---|---|
| QGeoSearchReply::NoError | 0 | No error has occurred. |
| QGeoSearchReply::EngineNotSetError | 1 | The search manager that was used did not have a QGeoSearchManagerEngine instance associated with it. |
| QGeoSearchReply::CommunicationError | 2 | An error occurred while communicating with the service provider. |
| QGeoSearchReply::ParseError | 3 | The response from the service provider was in an unrecognizable format. |
| QGeoSearchReply::UnsupportedOptionError | 4 | The requested operation or one of the options for the operation are not supported by the service provider. |
| QGeoSearchReply::CombinationError | 5 | An error occurred while results where being combined from multiple sources. |
| QGeoSearchReply::UnknownError | 6 | An error occurred which does not fit into any of the other categories. |
Constructs a search reply with a given error and errorString and the specified parent.
This function was introduced in Qt Mobility 1.1.
Constructs a search reply with the specified parent.
Destroys this search reply object.
Cancels the operation immediately.
This will do nothing if the reply is finished.
This function was introduced in Qt Mobility 1.1.
Adds place to the list of places in this reply.
This function was introduced in Qt Mobility 1.1.
Returns the error state of this reply.
If the result is QGeoSearchReply::NoError then no error has occurred.
This function was introduced in Qt Mobility 1.1.
See also setError().
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 QGeoSearchManager::error() will be emitted at the same time.
Note: Do no delete this reply object in the slot connected to this signal. Use deleteLater() instead.
This function was introduced in Qt Mobility 1.1.
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 QGeoSearchReply::error() is equal to QGeoSearchReply::NoError.
This function was introduced in Qt Mobility 1.1.
This signal is emitted when this reply has finished processing.
If error() equals QGeoSearchReply::NoError then the processing finished successfully.
This signal and QGeoSearchManager::finished() will be emitted at the same time.
Note: Do no delete this reply object in the slot connected to this signal. Use deleteLater() instead.
This function was introduced in Qt Mobility 1.1.
See also setFinished().
Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.
This function was introduced in Qt Mobility 1.1.
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 places().length() if the number of responses was less than the number requested.
If QGeoSearchManager::search() is used along with QGeoSearchManager::setAdditionalLandmarkManagers the number of results can be as high as limit * (1 + number of additional landmark managers).
This function was introduced in Qt Mobility 1.1.
See also setLimit().
Returns the offset into the entire result set at which to start fetching results.
This function was introduced in Qt Mobility 1.1.
See also setOffset().
Returns a list of places.
The places are the results of the operation corresponding to the QGeoSearchManager function which created this reply.
This function was introduced in Qt Mobility 1.1.
See also setPlaces().
Sets the error state of this reply to error and the textual representation of the error to errorString.
This wil also cause error() and finished() signals to be emitted, in that order.
This function was introduced in Qt Mobility 1.1.
See also error().
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, QGeoSearchReply::setPlaces() should be called before this function. If an error occurred, QGeoSearchReply::setError() should be used instead.
This function was introduced in Qt Mobility 1.1.
See also finished().
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.
This function was introduced in Qt Mobility 1.1.
See also limit().
Sets the offset in the entire result set at which to start fetching result to offset.
This function was introduced in Qt Mobility 1.1.
See also offset().
Sets the list of places in the reply.
This function was introduced in Qt Mobility 1.1.
See also places().
Sets the viewport which contains the results to viewport.
This function was introduced in Qt Mobility 1.1.
See also viewport().
Returns the viewport which contains the results.
This function will return 0 if no viewport bias was specified in the QGeoSearchManager function which created this reply.
This function was introduced in Qt Mobility 1.1.
See also setViewport().