MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QGeoTiledMapReply Class Reference

The QGeoTiledMapReply class manages a tile fetch operation started by an instance of QGeoTiledManagerEngine. More...

 #include <QGeoTiledMapReply>

Inherits: QObject.

This class was introduced in Qt Mobility 1.1.

Public Types

enum Error { NoError, CommunicationError, ParseError, UnknownError }

Public Functions

QGeoTiledMapReply ( const QGeoTiledMapRequest & request, QObject * parent = 0 )
QGeoTiledMapReply ( Error error, const QString & errorString, QObject * parent = 0 )
virtual ~QGeoTiledMapReply ()
virtual void abort ()
Error error () const
QString errorString () const
bool isCached () const
bool isFinished () const
QByteArray mapImageData () const
QString mapImageFormat () const
QGeoTiledMapRequest request () const
  • 29 public functions inherited from QObject

Signals

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

Protected Functions

void setCached ( bool cached )
void setError ( Error error, const QString & errorString )
void setFinished ( bool finished )
void setMapImageData ( const QByteArray & data )
void setMapImageFormat ( const QString & format )
  • 7 protected functions inherited from QObject

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 4 static public members inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QGeoTiledMapReply class manages a tile fetch operation started by an instance of QGeoTiledManagerEngine.

Instances of QGeoTiledMapReply 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(QGeoTiledMapReply::Error,QString) signals can be used to monitor the progress of the operation.

It is possible that a newly created QGeoTiledMapReply may be in a finished state, most commonly because an error has occurred. Since such an instance will never emit the finished() or error(QGeoTiledMapReply::Error,QString) signals, it is important to check the result of isFinished() before making the connections to the signals.

If the operation completes successfully the results will be able to be accessed with mapImageData() and mapImageFormat().

Member Type Documentation

enum QGeoTiledMapReply::Error

Describes an error which prevented the completion of the operation.

Constant Value Description
QGeoTiledMapReply::NoError 0 No error has occurred.
QGeoTiledMapReply::CommunicationError 1 An error occurred while communicating with the service provider.
QGeoTiledMapReply::ParseError 2 The response from the service provider was in an unrecognizable format. supported by the service provider.
QGeoTiledMapReply::UnknownError 3 An error occurred which does not fit into any of the other categories.

Member Function Documentation

QGeoTiledMapReply::QGeoTiledMapReply ( const QGeoTiledMapRequest & request, QObject * parent = 0 )

Constructs a tiled map reply object based on request, with parent parent.

This function was introduced in Qt Mobility 1.1.

QGeoTiledMapReply::QGeoTiledMapReply ( Error error, const QString & errorString, QObject * parent = 0 )

Constructs a tiled map reply object with a given error and errorString and the specified parent.

This function was introduced in Qt Mobility 1.1.

QGeoTiledMapReply::~QGeoTiledMapReply () [virtual]

Destroys this tiled map reply object.

void QGeoTiledMapReply::abort () [virtual]

Cancels the operation immediately.

This will do nothing if the reply is finished.

This function was introduced in Qt Mobility 1.1.

Error QGeoTiledMapReply::error () const

Returns the error state of this reply.

If the result is QGeoTiledMapReply::NoError then no error has occurred.

This function was introduced in Qt Mobility 1.1.

See also setError().

void QGeoTiledMapReply::error ( QGeoTiledMapReply::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.

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.

QString QGeoTiledMapReply::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 QGeoTiledMapReply::error() is equal to QGeoTiledMapReply::NoError.

This function was introduced in Qt Mobility 1.1.

void QGeoTiledMapReply::finished () [signal]

This signal is emitted when this reply has finished processing.

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

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().

bool QGeoTiledMapReply::isCached () const

Returns whether the reply is coming from a cache.

This function was introduced in Qt Mobility 1.1.

bool QGeoTiledMapReply::isFinished () const

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.

QByteArray QGeoTiledMapReply::mapImageData () const

Returns the tile image data.

This function was introduced in Qt Mobility 1.1.

See also setMapImageData().

QString QGeoTiledMapReply::mapImageFormat () const

Returns the format of the tile image.

This function was introduced in Qt Mobility 1.1.

See also setMapImageFormat().

QGeoTiledMapRequest QGeoTiledMapReply::request () const

Returns the request which corresponds to this reply.

This function was introduced in Qt Mobility 1.1.

void QGeoTiledMapReply::setCached ( bool cached ) [protected]

Sets whether the reply is coming from a cache to cached.

This function was introduced in Qt Mobility 1.1.

See also isCached().

void QGeoTiledMapReply::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.

This function was introduced in Qt Mobility 1.1.

See also error().

void QGeoTiledMapReply::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, QGeoTiledMapReply::setMapImageData() and QGeoTiledMapReply::setTiledMapFormat() should be called before this function. If an error occurred, QGeoTiledMapReply::setError() should be used instead.

This function was introduced in Qt Mobility 1.1.

See also finished().

void QGeoTiledMapReply::setMapImageData ( const QByteArray & data ) [protected]

Sets the tile image data to data.

This function was introduced in Qt Mobility 1.1.

See also mapImageData().

void QGeoTiledMapReply::setMapImageFormat ( const QString & format ) [protected]

Sets the format of the tile image to format.

This function was introduced in Qt Mobility 1.1.

See also mapImageFormat().

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.