Qt Mobility Reference Documentation

QGeoSearchReply Class Reference

The QGeoSearchReply class manages an operation started by an instance of QGeoSearchManager. More...

 #include <QGeoSearchReply>

Public Types

enum Error { NoError, EngineNotSetError, CommunicationError, ParseError, UnsupportedOptionError, UnknownError }

Public Functions

QGeoSearchReply ( Error error, const QString & errorString, QObject * parent = 0 )
virtual ~QGeoSearchReply ()
QGeoBoundingBox bounds () const
Error error () const
QString errorString () const
bool isFinished () const
QList<QGeoPlace> places () const

Public Slots

virtual void abort ()

Signals

void error ( QGeoSearchReply::Error error, const QString & errorString = QString() )
void finished ()

Protected Functions

QGeoSearchReply ( QObject * parent = 0 )
void addPlace ( const QGeoPlace & place )
void setBounds ( const QGeoBoundingBox & bounds )
void setError ( Error error, const QString & errorString )
void setFinished ( bool finished )
void setPlaces ( const QList<QGeoPlace> & places )

Detailed Description

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

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

enum QGeoSearchReply::Error

Describes an error which prevented the completion of the operation.

ConstantValueDescription
QGeoSearchReply::NoError0No error has occurred.
QGeoSearchReply::EngineNotSetError1The search manager that was used did not have a QGeoSearchManagerEngine instance associated with it.
QGeoSearchReply::CommunicationError2An error occurred while communicating with the service provider.
QGeoSearchReply::ParseError3The response from the service provider was in an unrecognizable format.
QGeoSearchReply::UnsupportedOptionError4The requested operation or one of the options for the operation are not supported by the service provider.
QGeoSearchReply::UnknownError5An 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 slot]

Cancels the operation.

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.

QGeoBoundingBox QGeoSearchReply::bounds () const

Returns the viewport which contains the results.

This function will return an invalid QGeoBoundingBox if no viewport bias was specified in the QGeoSearchManager function which created this reply.

See also setBounds().

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.

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::setBounds ( const QGeoBoundingBox & bounds ) [protected]

Sets the viewport which contains the results to bounds.

See also bounds().

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 occured, QGeoSearchReply::setError() should be used instead.

See also finished().

void QGeoSearchReply::setPlaces ( const QList<QGeoPlace> & places ) [protected]

Sets the list of places in the reply.

See also places().


Copyright © 2009-2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.1.0