QGeoSearchReply
Since: 1.1
#include <QtLocationSubset/QGeoSearchReply>
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().
Overview
Public Types Index
Public Functions Index
| 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 |
Protected Functions Index
| 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) |
Signals Index
Public Types
Describes an error which prevented the completion of the operation.
NoError No error has occurred. EngineNotSetError The search manager that was used did not have a QGeoSearchManagerEngine instance associated with it. CommunicationError An error occurred while communicating with the service provider. ParseError The response from the service provider was in an unrecognizable format. UnsupportedOptionError The requested operation or one of the options for the operation are not supported by the service provider. CombinationError An error occurred while results were being combined from multiple sources. UnknownError An error occurred which does not fit into any of the other categories.
- NoError
- EngineNotSetError
- CommunicationError
- ParseError
- UnsupportedOptionError
- CombinationError
- UnknownError
Public Functions
Constructs a search reply with a given error and errorString and the specified parent.
virtual
Destructor.
virtual void
Cancels the operation immediately.
This will do nothing if the reply is finished.
Error
Returns the error state of this reply.
If the result is QGeoSearchReply::NoError then no error has occurred.
QString
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.
bool
Returns true if the operation completed successfully or encountered an error which caused the operation to come to a halt.
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 places().length() if the number of responses was less than the number requested.
int
Returns the offset into the entire result set at which to start fetching results.
QList< QGeoPlace >
Returns a list of places.
The places are the results of the operation corresponding to the QGeoSearchManager function which created this reply.
QGeoBoundingArea *
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.
Protected Functions
Constructs a search reply with the specified parent.
void
Adds place to the list of places in this reply.
void
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.
void
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.
void
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.
void
Sets the offset in the entire result set at which to start fetching result to offset.
void
Sets the list of places in the reply.
void
Sets the viewport which contains the results to viewport.
Signals
void
This signal is emitted when an error has been detected in the processing of this reply.
Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.
void
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.
Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.
© 2013 Digia Plc and/or its subsidiaries. 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.
Documentation sources may be obtained from www.qt-project.org.
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. Privacy Policy