QGeoMapData Class Reference

Member Function Documentation

QGeoMapData::QGeoMapData ( QGeoMappingManagerEngine * engine )

Constructs a new map data object, which makes use of the functionality provided by engine.

QGeoMapData::~QGeoMapData () [virtual]

Destroys this map data object.

void QGeoMapData::addMapObject ( QGeoMapObject * mapObject )

Adds mapObject to the list of map objects managed by this map.

The children objects are drawn in order of the QGeoMapObject::zValue() value. Children objects having the same z value will be drawn in the order they were added.

The map will take ownership of the mapObject.

void QGeoMapData::addMapOverlay ( QGeoMapOverlay * overlay )

Adds overlay to the list of map overlays associated with this map.

The overlays will be drawn in the order in which they were added.

The map will take ownership of overlay.

void QGeoMapData::centerChanged ( const QGeoCoordinate & coordinate ) [signal]

This signal is emitted when the center of the map has changed.

The new value is coordinate.

void QGeoMapData::clearMapObjects ()

Clears the map objects associated with this map.

The map objects will be deleted.

void QGeoMapData::clearMapOverlays ()

Clears the map overlays associated with this map.

The map overlays will be deleted.

void QGeoMapData::connectivityModeChanged ( QGraphicsGeoMap::ConnectivityMode connectivityMode ) [signal]

This signal is emitted when the connectivity mode used to fetch the map data has changed.

The new value is connectivityMode.

QGeoMapObject * QGeoMapData::containerObject () [protected]

Returns the QGeoMapObject which acts as the parent to all QGeoMapObject instances which are added to the map by the user.

QPointF QGeoMapData::coordinateToScreenPosition ( const QGeoCoordinate & coordinate ) const [pure virtual]

Returns the position on the screen at which coordinate is displayed.

An invalid QPointF will be returned if coordinate is invalid or is not within the current viewport.

QGeoMapObjectInfo * QGeoMapData::createMapObjectInfo ( QGeoMapObject * object ) [virtual protected]

Creates a QGeoMapObjectInfo instance which implements the behaviours of the map object object which are specific to this QGeoMapData.

The default implementation returns 0.

QGeoMappingManagerEngine * QGeoMapData::engine () const [protected]

Returns the mapping engine that this map data object is associated with.

void QGeoMapData::fitInViewport ( const QGeoBoundingBox & bounds, bool preserveViewportCenter = false ) [pure virtual]

Attempts to fit the bounding box bounds into the viewport of the map.

This method will change the zoom level to the maximum zoom level such that all of bounds is visible within the resulting viewport.

If preserveViewportCenter is false the map will be centered on the bounding box bounds before the zoom level is changed, otherwise the center of the map will not be changed.

void QGeoMapData::init () [virtual]

This function is run after the QGeoMapData instance has been constructed.

Any subclasses which override this function should make sure that QGeoMapData::init() is called within the body of the overridding function.

QList<QGeoMapObject *> QGeoMapData::mapObjects () const

Returns the map objects associated with this map.

QList<QGeoMapObject *> QGeoMapData::mapObjectsAtScreenPosition ( const QPointF & screenPosition ) const [virtual]

Returns the list of visible map objects managed by this map which contain the point screenPosition within their boundaries.

QList<QGeoMapObject *> QGeoMapData::mapObjectsInScreenRect ( const QRectF & screenRect ) const [virtual]

Returns the list of visible map objects managed by this map which are displayed at least partially within the on screen rectangle screenRect.

QList<QGeoMapObject *> QGeoMapData::mapObjectsInViewport () const [virtual]

Returns the list of visible map objects manager by this widget which are displayed at least partially within the viewport of the map.

QList<QGeoMapOverlay *> QGeoMapData::mapOverlays () const

Returns the map overlays associated with this map.

void QGeoMapData::mapTypeChanged ( QGraphicsGeoMap::MapType mapType ) [signal]

This signal is emitted when the type of the map has changes.

The value is mapType.

void QGeoMapData::paint ( QPainter * painter, const QStyleOptionGraphicsItem * option ) [virtual]

Paints the map and everything associated with it on painter, using the options option.

This will paint the map with paintMap(), then the map overlays with QGeoMapOverlay::paint(), then the map objects with paintObjects(), and finally paintProviderNotices().

void QGeoMapData::paintMap ( QPainter * painter, const QStyleOptionGraphicsItem * option ) [virtual protected]

Paints the map on painter, using the options option.

The map overlays, map objects and the provider notices (such as copyright and powered by notices) are painted in separate methods, which are combined in the paint() method.

The default implementation does not paint anything.

void QGeoMapData::paintObjects ( QPainter * painter, const QStyleOptionGraphicsItem * option ) [virtual protected]

Paints the map objects on painter, using the options option.

The default implementation does not paint anything.

void QGeoMapData::paintProviderNotices ( QPainter * painter, const QStyleOptionGraphicsItem * option ) [virtual protected]

Paints the provider notices on painter, using the options option.

The provider notices are things like the copyright and powered by notices.

The provider may not want the client developers to be able to move the notices from their standard positions and so we have not provided API support for specifying the position of the notices at this time.

If support for hinting at the position of the notices is to be provided by plugin parameters, the suggested parameter keys are "mapping.notices.copyright.alignment" and "mapping.notices.poweredby.alignment", with type Qt::Alignment.

The default implementation does not paint anything.

void QGeoMapData::pan ( int dx, int dy ) [virtual]

Pans the map view dx pixels in the x direction and dy pixels in the y direction.

The x and y axes are specified in Graphics View Framework coordinates. By default this will mean that positive values of dx move the viewed area to the right and that positive values of dy move the viewed area down.

Subclasses should call QGeoMapData::setCenter() when the pan has completed.

void QGeoMapData::removeMapObject ( QGeoMapObject * mapObject )

Removes mapObject from the list of map objects managed by this map. The map will release ownership of the mapObject.

void QGeoMapData::removeMapOverlay ( QGeoMapOverlay * overlay )

Removes overlay from the list of map overlays associated with this map.

The map will release ownership of overlay.

QGeoCoordinate QGeoMapData::screenPositionToCoordinate ( const QPointF & screenPosition ) const [pure virtual]

Returns the coordinate corresponding to the point in the viewport at screenPosition.

An invalid QGeoCoordinate will be returned if screenPosition is invalid or is not within the current viewport.

void QGeoMapData::setBlockPropertyChangeSignals ( bool block ) [protected]

Sets whether changes to properties will trigger their corresponding signals to block.

By default the QGeoMapData implementations of the property functions are used which cause the property notification signals to be emitted immediately.

Calling this function with block set to false will prevent these signals from being called, which will allow a subclass to defer the emission of the signal until a later time.

If this function needs to be called it should be used as soon as possible, preferably in the constructor of the QGeoMapData subclass.

void QGeoMapData::updateMapDisplay ( const QRectF & target = QRectF() ) [signal]

This signal is emitted when the region target of the window which contains the map needs to be updated.

If target is empty then the entire map will be updated.

QGeoBoundingBox QGeoMapData::viewport () const [pure virtual]

Returns a bounding box corresponding to the physical area displayed in the viewport of the map.

The bounding box which is returned is defined by the upper left and lower right corners of the visible area of the map.

void QGeoMapData::windowSizeChanged ( const QSizeF & windowSize ) [signal]

This signal is emitted when the size of the window which contains the map has changed.

The new value is windowSize.

void QGeoMapData::zoomLevelChanged ( qreal zoomLevel ) [signal]

This signal is emitted when the zoom level of the map has changed.

The new value is zoomLevel.