              
QGeoSearchReply Class ReferenceThe QGeoSearchReply class manages an operation started by an instance of QGeoSearchManager. More... #include <QGeoSearchReply> Inherits QObject. Public Types
Public Functions
Signals
Protected Functions
Additional Inherited Members
Detailed DescriptionThe 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(). Member Type Documentation
|
| 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. |
Member Function Documentation
QGeoSearchReply::QGeoSearchReply ( Error error, const QString & errorString, QObject * parent = 0 )
Constructs a search reply with a given error and errorString and the specified parent.
QGeoSearchReply::QGeoSearchReply ( QObject * parent = 0 ) [protected]
Constructs a search reply with the specified parent.
QGeoSearchReply::~QGeoSearchReply () [virtual]
Destroys this search reply object.
void QGeoSearchReply::abort () [virtual]
Cancels the operation immediately.
This will do nothing if the reply is finished.
void QGeoSearchReply::addPlace ( const QGeoPlace & place ) [protected]
Adds place to the list of places in this reply.
Error QGeoSearchReply::error () const
Returns the error state of this reply.
If the result is QGeoSearchReply::NoError then no error has occurred.
See also setError().
void QGeoSearchReply::error ( QGeoSearchReply::Error error, const QString & errorString = QString() ) [signal]
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.
QString QGeoSearchReply::errorString () const
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.
void QGeoSearchReply::finished () [signal]
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.
See also setFinished().
bool QGeoSearchReply::isFinished () const
Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.
int QGeoSearchReply::limit () const
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).
See also setLimit().
int QGeoSearchReply::offset () const
Returns the offset into the entire result set at which to start fetching results.
See also setOffset().
QList<QGeoPlace> QGeoSearchReply::places () const
Returns a list of places.
The places are the results of the operation corresponding to the QGeoSearchManager function which created this reply.
See also setPlaces().
void QGeoSearchReply::setError ( Error error, const QString & errorString ) [protected]
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.
See also error().
void QGeoSearchReply::setFinished ( bool finished ) [protected]
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.
See also finished().
void QGeoSearchReply::setLimit ( int limit ) [protected]
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().
void QGeoSearchReply::setOffset ( int offset ) [protected]
Sets the offset in the entire result set at which to start fetching result to offset.
See also offset().
void QGeoSearchReply::setPlaces ( const QList<QGeoPlace> & places ) [protected]
Sets the list of places in the reply.
See also places().
void QGeoSearchReply::setViewport ( QGeoBoundingArea * viewport ) [protected]
Sets the viewport which contains the results to viewport.
See also viewport().
QGeoBoundingArea * QGeoSearchReply::viewport () const
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.
See also setViewport().