Quantum GIS API Documentation
1.7.4
|
This class tracks map layers that are currently loaded and provides a means to fetch a pointer to a map layer and delete it. More...
#include <qgsmaplayerregistry.h>
Signals | |
void | layerWillBeRemoved (QString theLayerId) |
emitted when a layer is removed from the registry connected to main map canvas and overview map canvas remove() | |
void | layerWasAdded (QgsMapLayer *theMapLayer) |
emitted when a layer is added to the registry connected to main map canvas and overview map canvas addLayer() | |
void | removedAll () |
emitted when ALL layers are removed at once This could have been implemented by iteratively signalling layerWillBeRemoved() for each layer as it is removed. | |
Public Member Functions | |
int | count () |
~QgsMapLayerRegistry () | |
QgsMapLayer * | mapLayer (QString theLayerId) |
Retrieve a pointer to a loaded plugin by id. | |
QMap< QString, QgsMapLayer * > & | mapLayers () |
Retrieve the mapLayers collection (mainly intended for use by projectio) | |
QgsMapLayer * | addMapLayer (QgsMapLayer *theMapLayer, bool theEmitSignal=true) |
Add a layer to the map of loaded layers. | |
void | removeMapLayer (QString theLayerId, bool theEmitSignal=true) |
Remove a layer from qgis. | |
void | removeAllMapLayers () |
Remove all registered layers. | |
void | clearAllLayerCaches () |
void | reloadAllLayers () |
Reload all provider data caches (currently used for WFS and WMS providers) | |
Static Public Member Functions | |
static QgsMapLayerRegistry * | instance () |
Returns the instance pointer, creating the object on the first call. | |
Protected Member Functions | |
QgsMapLayerRegistry (QObject *parent=0) | |
protected constructor | |
Private Member Functions | |
void | connectNotify (const char *signal) |
debugging member invoked when a connect() is made to this object | |
Private Attributes | |
QMap< QString, QgsMapLayer * > | mMapLayers |
Static Private Attributes | |
static QgsMapLayerRegistry * | mInstance = 0 |
This class tracks map layers that are currently loaded and provides a means to fetch a pointer to a map layer and delete it.
Definition at line 35 of file qgsmaplayerregistry.h.
Definition at line 47 of file qgsmaplayerregistry.cpp.
References removeAllMapLayers().
QgsMapLayerRegistry::QgsMapLayerRegistry | ( | QObject * | parent = 0 | ) | [protected] |
protected constructor
Definition at line 42 of file qgsmaplayerregistry.cpp.
Referenced by instance().
QgsMapLayer * QgsMapLayerRegistry::addMapLayer | ( | QgsMapLayer * | theMapLayer, |
bool | theEmitSignal = true |
||
) |
Add a layer to the map of loaded layers.
As a side-effect QgsProject is made dirty.
Emits signal that layer has been added only if theEmitSignal is true (by default). Not emitting signal is useful when you want to use registry also for layers which won't be used in main map canvas but will be used in a special one
Definition at line 66 of file qgsmaplayerregistry.cpp.
References QgsMapLayer::id(), QgsMapLayer::isValid(), layerWasAdded(), mMapLayers, and QgsDebugMsg.
Definition at line 121 of file qgsmaplayerregistry.cpp.
References mMapLayers.
Referenced by QgsMapRenderer::render().
void QgsMapLayerRegistry::connectNotify | ( | const char * | signal | ) | [private] |
debugging member invoked when a connect() is made to this object
Definition at line 151 of file qgsmaplayerregistry.cpp.
int QgsMapLayerRegistry::count | ( | ) |
Return the number of registered layers.
Definition at line 53 of file qgsmaplayerregistry.cpp.
References mMapLayers.
QgsMapLayerRegistry * QgsMapLayerRegistry::instance | ( | ) | [static] |
Returns the instance pointer, creating the object on the first call.
Definition at line 29 of file qgsmaplayerregistry.cpp.
References mInstance, and QgsMapLayerRegistry().
Referenced by QgsVectorLayerJoinBuffer::addJoinedFeatureAttributes(), QgsVectorLayer::addJoinedFeatureAttributes(), QgsGeometry::avoidIntersections(), QgsVectorLayerJoinBuffer::cacheJoinLayer(), QgsComposerMap::connectUpdateSlot(), QgsComposerMap::containsWMSLayer(), QgsComposerLegend::drawLayerItem(), QgsApplication::exitQgis(), QgsApplication::initQgis(), QgsVectorLayerJoinBuffer::joinForFieldIndex(), QgsMapCanvas::layer(), QgsMapCanvas::layers(), QgsVectorLayer::maximumValue(), QgsVectorLayer::minimumValue(), QgsQuickPrint::printMap(), QgsComposerAttributeTable::QgsComposerAttributeTable(), QgsLegendModel::QgsLegendModel(), QgsVectorLayer::QgsVectorLayer(), QgsFormAnnotationItem::readXML(), QgsComposerAttributeTable::readXML(), QgsComposerSymbolItem::readXML(), QgsVectorLayerJoinBuffer::removeJoin(), QgsMapRenderer::render(), QgsQuickPrint::scalePointSymbols(), QgsQuickPrint::scaleTextLabels(), QgsVectorLayerJoinBuffer::select(), QgsLegendModel::setAutoUpdate(), QgsVectorLayer::setDataProvider(), QgsLegendModel::setLayerSet(), QgsMapCanvasSnapper::snapToBackgroundLayers(), QgsComposerMap::syncLayerSet(), QgsVectorLayer::uniqueValues(), QgsVectorLayerJoinBuffer::updateFeatureAttributes(), QgsVectorLayerJoinBuffer::updateFieldMap(), QgsMapRenderer::updateFullExtent(), and QgsLegendModel::updateLayer().
void QgsMapLayerRegistry::layerWasAdded | ( | QgsMapLayer * | theMapLayer | ) | [signal] |
emitted when a layer is added to the registry connected to main map canvas and overview map canvas addLayer()
Referenced by addMapLayer().
void QgsMapLayerRegistry::layerWillBeRemoved | ( | QString | theLayerId | ) | [signal] |
emitted when a layer is removed from the registry connected to main map canvas and overview map canvas remove()
Referenced by removeAllMapLayers(), and removeMapLayer().
QgsMapLayer * QgsMapLayerRegistry::mapLayer | ( | QString | theLayerId | ) |
Retrieve a pointer to a loaded plugin by id.
Definition at line 58 of file qgsmaplayerregistry.cpp.
References mMapLayers.
Referenced by QgsVectorLayerJoinBuffer::addJoinedFeatureAttributes(), QgsVectorLayer::addJoinedFeatureAttributes(), QgsGeometry::avoidIntersections(), QgsVectorLayerJoinBuffer::cacheJoinLayer(), QgsComposerMap::containsWMSLayer(), QgsComposerLegend::drawLayerItem(), QgsVectorLayerJoinBuffer::joinForFieldIndex(), QgsMapCanvas::layer(), QgsMapCanvas::layers(), QgsVectorLayer::maximumValue(), QgsVectorLayer::minimumValue(), QgsQuickPrint::printMap(), QgsFormAnnotationItem::readXML(), QgsComposerAttributeTable::readXML(), QgsComposerSymbolItem::readXML(), QgsVectorLayerJoinBuffer::removeJoin(), QgsMapRenderer::render(), QgsQuickPrint::scalePointSymbols(), QgsQuickPrint::scaleTextLabels(), QgsVectorLayerJoinBuffer::select(), QgsLegendModel::setLayerSet(), QgsMapCanvasSnapper::snapToBackgroundLayers(), QgsVectorLayer::uniqueValues(), QgsVectorLayerJoinBuffer::updateFeatureAttributes(), QgsVectorLayerJoinBuffer::updateFieldMap(), QgsMapRenderer::updateFullExtent(), and QgsLegendModel::updateLayer().
QMap< QString, QgsMapLayer * > & QgsMapLayerRegistry::mapLayers | ( | ) |
Retrieve the mapLayers collection (mainly intended for use by projectio)
Definition at line 144 of file qgsmaplayerregistry.cpp.
References mMapLayers.
Referenced by QgsComposerAttributeTable::QgsComposerAttributeTable(), QgsVectorLayer::setDataProvider(), and QgsComposerMap::syncLayerSet().
void QgsMapLayerRegistry::reloadAllLayers | ( | ) |
Reload all provider data caches (currently used for WFS and WMS providers)
Definition at line 131 of file qgsmaplayerregistry.cpp.
References mMapLayers, and QgsMapLayer::reload().
Remove all registered layers.
Definition at line 102 of file qgsmaplayerregistry.cpp.
References layerWillBeRemoved(), mMapLayers, and removedAll().
Referenced by ~QgsMapLayerRegistry().
void QgsMapLayerRegistry::removedAll | ( | ) | [signal] |
emitted when ALL layers are removed at once This could have been implemented by iteratively signalling layerWillBeRemoved() for each layer as it is removed.
However, this generally causes a cascade of effects that are unnecessary if we're ultimately removing all layers. E.g., removing the legend item corresponding to the layer. Why bother doing that when you're just going to clear everything anyway?
Referenced by removeAllMapLayers().
void QgsMapLayerRegistry::removeMapLayer | ( | QString | theLayerId, |
bool | theEmitSignal = true |
||
) |
Remove a layer from qgis.
Definition at line 94 of file qgsmaplayerregistry.cpp.
References layerWillBeRemoved(), and mMapLayers.
QgsMapLayerRegistry * QgsMapLayerRegistry::mInstance = 0 [static, private] |
Definition at line 126 of file qgsmaplayerregistry.h.
Referenced by instance().
QMap<QString, QgsMapLayer*> QgsMapLayerRegistry::mMapLayers [private] |
Definition at line 128 of file qgsmaplayerregistry.h.
Referenced by addMapLayer(), clearAllLayerCaches(), count(), mapLayer(), mapLayers(), reloadAllLayers(), removeAllMapLayers(), and removeMapLayer().