QGIS API Documentation
2.2.0-Valmiera
|
Base class for all map layer types. More...
#include <qgsmaplayer.h>
Public Types | |
enum | LayerType { VectorLayer, RasterLayer, PluginLayer } |
Layers enum defining the types of layers that can be added to a map. More... |
Public Slots | |
virtual void | invalidTransformInput () |
Event handler for when a coordinate transform fails due to bad vertex error. | |
void | setMinimumScale (float theMinScale) |
Accessor and mutator for the minimum scale denominator member. | |
float | minimumScale () const |
void | setMaximumScale (float theMaxScale) |
Accessor and mutator for the maximum scale denominator member. | |
float | maximumScale () const |
void | toggleScaleBasedVisibility (bool theVisibilityFlag) |
Accessor and mutator for the scale based visilibility flag. | |
bool | hasScaleBasedVisibility () const |
void | clearCacheImage () |
Clear cached image added in 1.5. | |
virtual QString | metadata () |
Obtain Metadata for this layer. | |
virtual QDateTime | timestamp () const |
Time stamp of data source in the moment when data/metadata were loaded by provider. |
Signals | |
void | drawingProgress (int theProgress, int theTotalSteps) |
Emit a signal to notify of a progress event. | |
void | statusChanged (QString theStatus) |
Emit a signal with status (e.g. | |
void | layerNameChanged () |
Emit a signal that the layer name has been changed. | |
void | layerCrsChanged () |
Emit a signal that layer's CRS has been reset added in 1.4. | |
void | repaintRequested () |
This signal should be connected with the slot QgsMapCanvas::refresh() | |
void | screenUpdateRequested () |
The layer emits this signal when a screen update is requested. | |
void | recalculateExtents () |
This is used to send a request that any mapcanvas using this layer update its extents. | |
void | dataChanged () |
data of layer changed added in 1.5 | |
void | blendModeChanged (const QPainter::CompositionMode &blendMode) |
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() |
Public Member Functions | |
QgsMapLayer (QgsMapLayer::LayerType type=VectorLayer, QString lyrname=QString::null, QString source=QString::null) | |
Constructor. | |
virtual | ~QgsMapLayer () |
Destructor. | |
QgsMapLayer::LayerType | type () const |
Get the type of the layer. | |
QString | id () const |
Get this layer's unique ID, this ID is used to access this layer from map layer registry. | |
void | setLayerName (const QString &name) |
Set the display name of the layer. | |
const QString & | name () const |
Get the display name of the layer. | |
const QString & | originalName () const |
Get the original name of the layer. | |
void | setTitle (const QString &title) |
const QString & | title () const |
void | setAbstract (const QString &abstract) |
const QString & | abstract () const |
void | setKeywordList (const QString &keywords) |
const QString & | keywordList () const |
void | setDataUrl (const QString &dataUrl) |
const QString & | dataUrl () const |
void | setDataUrlFormat (const QString &dataUrlFormat) |
const QString & | dataUrlFormat () const |
void | setAttribution (const QString &attrib) |
const QString & | attribution () const |
void | setAttributionUrl (const QString &attribUrl) |
const QString & | attributionUrl () const |
void | setMetadataUrl (const QString &metaUrl) |
const QString & | metadataUrl () const |
void | setMetadataUrlType (const QString &metaUrlType) |
const QString & | metadataUrlType () const |
void | setMetadataUrlFormat (const QString &metaUrlFormat) |
const QString & | metadataUrlFormat () const |
void | setBlendMode (const QPainter::CompositionMode &blendMode) |
Write blend mode for layer. | |
QPainter::CompositionMode | blendMode () const |
Read blend mode for layer. | |
virtual void | reload () |
Synchronises with changes in the datasource. | |
virtual bool | draw (QgsRenderContext &rendererContext) |
This is the method that does the actual work of drawing the layer onto a paint device. | |
virtual void | drawLabels (QgsRenderContext &rendererContext) |
Draw labels. | |
virtual QgsRectangle | extent () |
Return the extent of the layer. | |
bool | isValid () |
QString | publicSource () const |
const QString & | source () const |
Returns the source for the layer. | |
virtual QStringList | subLayers () const |
Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS) | |
virtual void | setLayerOrder (const QStringList &layers) |
Reorders the previously selected sublayers of this layer from bottom to top (Useful for providers that manage their own layers, such as WMS) | |
virtual void | setSubLayerVisibility (QString name, bool vis) |
Set the visibility of the given sublayer name. | |
virtual bool | isEditable () const |
True if the layer can be edited. | |
bool | readLayerXML (const QDomElement &layerElement) |
sets state from Dom document | |
bool | writeLayerXML (QDomElement &layerElement, QDomDocument &document) |
stores state in Dom node | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for layer. | |
QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
Read a custom property from layer. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from layer. | |
virtual QString | lastErrorTitle () |
If an operation returns 0 (e.g. | |
virtual QString | lastError () |
If an operation returns 0 (e.g. | |
virtual QgsError | error () const |
Get current status error. | |
const QgsCoordinateReferenceSystem & | crs () const |
Returns layer's spatial reference system. | |
void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
Sets layer's spatial reference system. | |
virtual QString | styleURI () |
Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
virtual QString | loadDefaultStyle (bool &theResultFlag) |
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
virtual QString | loadNamedStyle (const QString &theURI, bool &theResultFlag) |
Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
virtual bool | loadNamedStyleFromDb (const QString &db, const QString &theURI, QString &qml) |
virtual void | exportNamedStyle (QDomDocument &doc, QString &errorMsg) |
Export the properties of this layer as named style in a QDomDocument. | |
virtual void | exportSldStyle (QDomDocument &doc, QString &errorMsg) |
Export the properties of this layer as SLD style in a QDomDocument. | |
virtual QString | saveDefaultStyle (bool &theResultFlag) |
Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
virtual QString | saveNamedStyle (const QString &theURI, bool &theResultFlag) |
Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
virtual QString | saveSldStyle (const QString &theURI, bool &theResultFlag) |
virtual QString | loadSldStyle (const QString &theURI, bool &theResultFlag) |
virtual bool | readSld (const QDomNode &node, QString &errorMessage) |
virtual bool | readSymbology (const QDomNode &node, QString &errorMessage)=0 |
Read the symbology for the current layer from the Dom node supplied. | |
virtual bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage) const =0 |
Write the symbology for the layer into the docment provided. | |
QUndoStack * | undoStack () |
Return pointer to layer's undo stack. | |
QImage * | cacheImage () |
Get the QImage used for caching render operations. | |
void | setCacheImage (QImage *thepImage) |
Set the QImage used for caching render operations. | |
virtual void | onCacheImageDelete () |
Is called when the cache image is being deleted. |
Static Public Member Functions | |
static QString | capitaliseLayerName (const QString &name) |
A convenience function to (un)capitalise the layer name. |
Protected Member Functions | |
virtual void | setExtent (const QgsRectangle &rect) |
Set the extent. | |
void | setValid (bool valid) |
set whether layer is valid or not - should be used in constructor. | |
virtual bool | readXml (const QDomNode &layer_node) |
called by readLayerXML(), used by children to read state specific to them from project files. | |
virtual bool | writeXml (QDomNode &layer_node, QDomDocument &document) |
called by writeLayerXML(), used by children to write state specific to them to project files. | |
void | readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith="") |
Read custom properties from project file. | |
void | writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const |
Write custom properties to project file. | |
void | connectNotify (const char *signal) |
debugging member - invoked when a connect() is made to this object | |
void | appendError (const QgsErrorMessage &theMessage) |
Add error message. | |
void | setError (const QgsError &theError) |
Set error message. |
Protected Attributes | |
QgsRectangle | mExtent |
Extent of the layer. | |
bool | mValid |
Indicates if the layer is valid and can be drawn. | |
QString | mDataSource |
data source description string, varies by layer type | |
QString | mLayerName |
Name of the layer - used for display. | |
QString | mLayerOrigName |
Original name of the layer. | |
QString | mTitle |
QString | mAbstract |
Description of the layer. | |
QString | mKeywordList |
QString | mDataUrl |
DataUrl of the layer. | |
QString | mDataUrlFormat |
QString | mAttribution |
Attribution of the layer. | |
QString | mAttributionUrl |
QString | mMetadataUrl |
MetadataUrl of the layer. | |
QString | mMetadataUrlType |
QString | mMetadataUrlFormat |
QgsError | mError |
Error. |
Private Member Functions | |
QgsMapLayer (QgsMapLayer const &) | |
private copy constructor - QgsMapLayer not copyable | |
QgsMapLayer & | operator= (QgsMapLayer const &) |
private assign operator - QgsMapLayer not copyable |
Private Attributes | |
QgsCoordinateReferenceSystem * | mCRS |
layer's spatial reference system. | |
QString | mID |
Unique ID of this layer - used to refer to this layer in map layer registry. | |
QgsMapLayer::LayerType | mLayerType |
Type of the layer (eg. | |
QPainter::CompositionMode | mBlendMode |
Blend mode for the layer. | |
QString | mTag |
Tag for embedding additional information. | |
float | mMinScale |
Minimum scale denominator at which this layer should be displayed. | |
float | mMaxScale |
Maximum scale denominator at which this layer should be displayed. | |
bool | mScaleBasedVisibility |
A flag that tells us whether to use the above vars to restrict layer visibility. | |
QUndoStack | mUndoStack |
Collection of undoable operations for this layer. | |
QMap< QString, QVariant > | mCustomProperties |
QImage * | mpCacheImage |
QImage for caching of rendering operations. |
Base class for all map layer types.
This is the base class for all map layer types (vector, raster).
Definition at line 45 of file qgsmaplayer.h.
Layers enum defining the types of layers that can be added to a map.
Definition at line 51 of file qgsmaplayer.h.
QgsMapLayer::QgsMapLayer | ( | QgsMapLayer::LayerType | type = VectorLayer , |
QString | lyrname = QString::null , |
||
QString | source = QString::null |
||
) |
Constructor.
type | Type of layer as defined in QgsMapLayer::LayerType enum |
lyrname | Display Name of the layer |
source | datasource of layer |
Definition at line 44 of file qgsmaplayer.cpp.
References capitaliseLayerName(), mCRS, mID, mLayerName, mLayerOrigName, mMaxScale, mMinScale, mpCacheImage, mScaleBasedVisibility, and QgsDebugMsg.
|
virtual |
|
private |
private copy constructor - QgsMapLayer not copyable
|
inline |
Definition at line 97 of file qgsmaplayer.h.
|
inlineprotected |
Add error message.
Definition at line 469 of file qgsmaplayer.h.
Referenced by QgsRasterLayer::setDataProvider().
|
inline |
Definition at line 110 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
inline |
Definition at line 112 of file qgsmaplayer.h.
Referenced by writeLayerXML().
QPainter::CompositionMode QgsMapLayer::blendMode | ( | ) | const |
Read blend mode for layer.
Definition at line 144 of file qgsmaplayer.cpp.
References mBlendMode.
Referenced by QgsComposerMap::containsAdvancedEffects(), QgsMapRenderer::render(), setBlendMode(), QgsRasterLayer::writeSymbology(), and QgsVectorLayer::writeSymbology().
|
signal |
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode()
Referenced by setBlendMode().
|
inline |
Get the QImage used for caching render operations.
Definition at line 365 of file qgsmaplayer.h.
Referenced by QgsMapRenderer::render().
|
static |
A convenience function to (un)capitalise the layer name.
Definition at line 695 of file qgsmaplayer.cpp.
Referenced by QgsMapLayer(), and setLayerName().
|
slot |
Clear cached image added in 1.5.
Definition at line 1361 of file qgsmaplayer.cpp.
References setCacheImage().
|
protected |
debugging member - invoked when a connect() is made to this object
Definition at line 618 of file qgsmaplayer.cpp.
References QgsDebugMsgLevel.
const QgsCoordinateReferenceSystem & QgsMapLayer::crs | ( | ) | const |
Returns layer's spatial reference system.
Definition at line 676 of file qgsmaplayer.cpp.
References mCRS.
Referenced by QgsVectorLayerEditUtils::addTopologicalPoints(), QgsAttributeEditorContext::adjustForLayer(), QgsGeometryAnalyzer::buffer(), QgsGeometryAnalyzer::centroids(), QgsAtlasComposition::computeExtent(), QgsGeometryAnalyzer::convexHull(), QgsOfflineEditing::copyVectorLayer(), QgsPointSample::createRandomPoints(), QgsTransectSample::createSample(), QgsVectorFileWriter::createSymbolLayerTable(), QgsGeometryAnalyzer::dissolve(), QgsRasterLayer::draw(), QgsGeometryAnalyzer::eventLayer(), QgsVectorFileWriter::exportFeaturesSymbolLevels(), QgsGeometryAnalyzer::extent(), QgsMapToolIdentify::featureDerivedAttributes(), QgsComposerAttributeTable::getFeatureAttributes(), QgsVectorLayerImport::importLayer(), QgsOverlayAnalyzer::intersection(), QgsRasterLayer::metadata(), QgsVectorLayer::metadata(), QgsRasterCalculator::processCalculation(), QgsRasterLayer::readXml(), QgsRasterLayer::setDataProvider(), QgsGeometryAnalyzer::simplify(), QgsVectorLayer::snapToGeometry(), QgsMapRenderer::splitLayersExtent(), QgsMapRenderer::transformation(), and QgsVectorFileWriter::writeAsVectorFormat().
QVariant QgsMapLayer::customProperty | ( | const QString & | value, |
const QVariant & | defaultValue = QVariant() |
||
) | const |
Read a custom property from layer.
Properties are stored in a map and saved in project file.
Definition at line 1256 of file qgsmaplayer.cpp.
References mCustomProperties.
Referenced by _readColor(), QgsMapToolIdentify::identifyRasterLayer(), QgsOfflineEditing::layerAdded(), QgsPalLayerSettings::readDataDefinedProperty(), QgsPalLayerSettings::readFromLayer(), QgsOfflineEditing::synchronize(), QgsPalLabeling::willUseLayer(), and QgsPalLayerSettings::writeDataDefinedPropertyMap().
|
signal |
data of layer changed added in 1.5
|
inline |
Definition at line 104 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
inline |
Definition at line 106 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
virtual |
This is the method that does the actual work of drawing the layer onto a paint device.
rendererContext | describes the extents, resolumon etc. that should be used when rendering the layer. |
Reimplemented in QgsVectorLayer, and QgsRasterLayer.
Definition at line 149 of file qgsmaplayer.cpp.
Referenced by QgsMapRenderer::render().
|
signal |
Emit a signal to notify of a progress event.
Referenced by QgsRasterLayer::updateProgress().
|
virtual |
Draw labels.
Reimplemented in QgsVectorLayer.
Definition at line 155 of file qgsmaplayer.cpp.
Referenced by QgsMapRenderer::render().
|
inlinevirtual |
Get current status error.
This error describes some principal problem for which layer cannot work and thus is not valid. It is not last error after accessing data by draw() etc.
Definition at line 245 of file qgsmaplayer.h.
|
virtual |
Export the properties of this layer as named style in a QDomDocument.
doc | the target QDomDocument |
errorMsg | this QString will be initialized on error during the execution of writeSymbology |
Definition at line 916 of file qgsmaplayer.cpp.
References hasScaleBasedVisibility(), maximumScale(), minimumScale(), QGis::QGIS_VERSION, tr, and writeSymbology().
Referenced by saveNamedStyle(), and QgsVectorLayer::saveStyleToDatabase().
|
virtual |
Export the properties of this layer as SLD style in a QDomDocument.
doc | the target QDomDocument |
errorMsg | this QString will be initialized on error during the execution of writeSymbology |
Definition at line 1088 of file qgsmaplayer.cpp.
References tr, and QgsVectorLayer::writeSld().
Referenced by saveSldStyle(), and QgsVectorLayer::saveStyleToDatabase().
|
virtual |
Return the extent of the layer.
Reimplemented in QgsVectorLayer.
Definition at line 131 of file qgsmaplayer.cpp.
References mExtent.
Referenced by QgsRasterLayer::draw(), QgsMapToolIdentify::identifyRasterLayer(), QgsMapRenderer::render(), QgsPluginLayer::setExtent(), and QgsMapRenderer::updateFullExtent().
|
slot |
Definition at line 631 of file qgsmaplayer.cpp.
References mScaleBasedVisibility.
Referenced by exportNamedStyle(), QgsMapToolIdentify::identifyVectorLayer(), QgsMapRenderer::render(), and writeLayerXML().
QString QgsMapLayer::id | ( | ) | const |
Get this layer's unique ID, this ID is used to access this layer from map layer registry.
Get this layer's unique ID.
Definition at line 94 of file qgsmaplayer.cpp.
References mID.
Referenced by QgsPalLabeling::addDiagramLayer(), QgsLegendModel::addLayer(), QgsRelationAddDlg::addLayers(), QgsMapLayerRegistry::addMapLayers(), QgsLegendModel::addRasterLayerItems(), QgsVectorLayerEditBuffer::commitChanges(), QgsComposerMap::containsAdvancedEffects(), QgsOfflineEditing::copyVectorLayer(), QgsMapCanvas::getDatumTransformInfo(), QgsMapToolIdentify::identify(), QgsAttributeDialog::init(), QgsComposerMap::layersToRender(), QgsPalLabeling::prepareLayer(), QgsComposerAttributeTable::removeLayer(), QgsPluginLayerRegistry::removePluginLayerType(), QgsMapCanvas::setLayerSet(), QgsOfflineEditing::synchronize(), QgsMapRenderer::transformation(), QgsRasterFormatSaveOptionsWidget::validateOptions(), QgsProject::write(), QgsFormAnnotationItem::writeXML(), QgsHtmlAnnotationItem::writeXML(), QgsComposerAttributeTable::writeXML(), and QgsAtlasComposition::writeXML().
|
virtualslot |
Event handler for when a coordinate transform fails due to bad vertex error.
Definition at line 601 of file qgsmaplayer.cpp.
References QgsDebugMsg.
|
virtual |
True if the layer can be edited.
Reimplemented in QgsVectorLayer.
Definition at line 1351 of file qgsmaplayer.cpp.
bool QgsMapLayer::isValid | ( | ) |
Return the status of the layer. An invalid layer is one which has a bad datasource or other problem. Child classes set this flag when intialized
Definition at line 595 of file qgsmaplayer.cpp.
References mValid.
Referenced by QgsProject::addLayer(), QgsMapLayerRegistry::addMapLayers(), QgsOfflineEditing::copyVectorLayer(), QgsTransectSample::createSample(), QgsGeometryAnalyzer::eventLayer(), QgsOfflineEditing::synchronize(), and QgsProjectFileTransform::transform0110to1000().
|
inline |
Definition at line 100 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
virtual |
If an operation returns 0 (e.g.
draw()), this function returns the text of the error associated with the failure. Interactive users of this provider can then, for example, call a QMessageBox to display the contents.
Reimplemented in QgsRasterLayer.
Definition at line 613 of file qgsmaplayer.cpp.
Referenced by QgsMapCanvas::showError().
|
virtual |
If an operation returns 0 (e.g.
draw()), this function returns the text of the error associated with the failure. Interactive users of this provider can then, for example, call a QMessageBox to display the contents.
Reimplemented in QgsRasterLayer.
Definition at line 608 of file qgsmaplayer.cpp.
Referenced by QgsMapCanvas::showError().
|
signal |
Emit a signal that layer's CRS has been reset added in 1.4.
Referenced by setCrs().
|
signal |
Emit a signal that the layer name has been changed.
Referenced by setLayerName().
|
virtual |
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
theResultFlag | a reference to a flag that will be set to false if we did not manage to load the default style. |
Definition at line 764 of file qgsmaplayer.cpp.
References loadNamedStyle(), and styleURI().
Referenced by QgsRasterLayer::QgsRasterLayer(), and QgsVectorLayer::QgsVectorLayer().
|
virtual |
Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
theURI | - the file name or other URI for the style file. First an attempt will be made to see if this is a file and load that, if that fails the qgis.db styles table will be consulted to see if there is a style who's key matches the URI. |
theResultFlag | a reference to a flag that will be set to false if we did not manage to load the default style. |
Reimplemented in QgsVectorLayer.
Definition at line 813 of file qgsmaplayer.cpp.
References QgsProject::instance(), loadNamedStyleFromDb(), QgsApplication::pkgDataPath(), publicSource(), QGis::QGIS_VERSION, QgsApplication::qgisSettingsDirPath(), QgsDebugMsg, readSymbology(), setMaximumScale(), setMinimumScale(), toggleScaleBasedVisibility(), tr, and QgsLogger::warning().
Referenced by loadDefaultStyle().
|
virtual |
Definition at line 769 of file qgsmaplayer.cpp.
References QgsDebugMsg.
Referenced by loadNamedStyle().
|
virtual |
Definition at line 1183 of file qgsmaplayer.cpp.
References QgsDebugMsg, readSld(), and tr.
|
slot |
Definition at line 652 of file qgsmaplayer.cpp.
References mMaxScale.
Referenced by exportNamedStyle(), QgsAttributeTableFilterModel::generateListOfVisibleFeatures(), QgsMapToolIdentify::identifyVectorLayer(), QgsMapRenderer::render(), and writeLayerXML().
|
virtualslot |
Obtain Metadata for this layer.
Reimplemented in QgsVectorLayer, and QgsRasterLayer.
Definition at line 1366 of file qgsmaplayer.cpp.
|
inline |
Definition at line 116 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
inline |
Definition at line 120 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
inline |
Definition at line 118 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
slot |
Definition at line 641 of file qgsmaplayer.cpp.
References mMinScale.
Referenced by exportNamedStyle(), QgsMapToolIdentify::identifyVectorLayer(), QgsMapRenderer::render(), and writeLayerXML().
QString const & QgsMapLayer::name | ( | ) | const |
Get the display name of the layer.
Read property of QString layerName.
Definition at line 112 of file qgsmaplayer.cpp.
References mLayerName, and QgsDebugMsgLevel.
Referenced by QgsVectorLayer::addAttributeAlias(), QgsLegendModel::addLayer(), QgsRelationAddDlg::addLayers(), QgsRelationManagerDialog::addRelation(), QgsVectorLayer::attributeAlias(), QgsVectorLayer::attributeEditorElementFromDomElement(), QgsVectorLayer::checkedState(), QgsOfflineEditing::copyVectorLayer(), QgsVectorLayer::countSymbolFeatures(), QgsVectorLayer::editType(), QgsVectorLayer::fieldEditable(), QgsVectorLayer::fieldNameIndex(), QgsMapCanvas::getDatumTransformInfo(), QgsMapToolIdentify::identify(), QgsMapToolIdentify::identifyRasterLayer(), QgsAttributeDialog::init(), QgsMapLayerRegistry::mapLayersByName(), QgsQueryBuilder::QgsQueryBuilder(), QgsSearchQueryBuilder::QgsSearchQueryBuilder(), QgsVectorLayer::readSymbology(), QgsMapRenderer::render(), QgsVectorLayer::setCheckedState(), setCrs(), QgsRasterLayer::setDataProvider(), QgsVectorLayer::setDataProvider(), QgsVectorLayer::setEditType(), QgsVectorLayer::setFieldEditable(), QgsVectorLayer::setLabelOnTop(), setLayerName(), QgsMapCanvas::showError(), QgsOfflineEditing::synchronize(), QgsVectorLayerJoinBuffer::updateFields(), QgsMapRenderer::updateFullExtent(), QgsLegendModel::updateLayerItemText(), QgsLegendModel::updateSymbolV2ItemText(), QgsFeatureRendererV2::writeSld(), and QgsVectorLayer::writeSld().
|
inlinevirtual |
Is called when the cache image is being deleted.
Overwrite and use to clean up.
Definition at line 374 of file qgsmaplayer.h.
Referenced by setCacheImage().
|
private |
private assign operator - QgsMapLayer not copyable
|
inline |
Get the original name of the layer.
Definition at line 91 of file qgsmaplayer.h.
Referenced by writeLayerXML().
QString QgsMapLayer::publicSource | ( | ) | const |
Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). This function should be used when displaying the source name for general viewing.
Definition at line 118 of file qgsmaplayer.cpp.
References mDataSource, and QgsDataSourceURI::removePassword().
Referenced by loadNamedStyle(), QgsVectorLayer::metadata(), and styleURI().
|
protected |
Read custom properties from project file.
Added in v1.4
layerNode | note to read from |
keyStartsWith | reads only properties starting with the specified string (or all if the string is empty) |
Definition at line 1266 of file qgsmaplayer.cpp.
References mCustomProperties.
Referenced by readLayerXML(), and QgsVectorLayer::readSymbology().
bool QgsMapLayer::readLayerXML | ( | const QDomElement & | layerElement | ) |
sets state from Dom document
layerElement | The Dom element corresponding to ``maplayer'' tag |
The Dom node corresponds to a Dom document project file XML element read by QgsProject.
This, in turn, calls readXml(), which is over-rideable by sub-classes so that they can read their own specific state from the given Dom node.
Invoked by QgsProject::read().
Definition at line 160 of file qgsmaplayer.cpp.
References QgsCoordinateReferenceSystem::customSrsValidation(), QgsDataSourceURI::database(), QgsDataSourceURI::encodedUri(), file, QgsProject::instance(), mAbstract, mAttribution, mAttributionUrl, mCRS, mDataSource, mDataUrl, mDataUrlFormat, mID, mKeywordList, mMetadataUrl, mMetadataUrlFormat, mMetadataUrlType, mTitle, QgsDebugMsg, readCustomProperties(), QgsProject::readPath(), QgsCoordinateReferenceSystem::readXML(), readXml(), QgsCoordinateReferenceSystem::setCustomSrsValidation(), QgsDataSourceURI::setDatabase(), setLayerName(), setMaximumScale(), setMinimumScale(), QgsDataSourceURI::setParam(), QgsCoordinateReferenceSystem::setValidationHint(), toggleScaleBasedVisibility(), tr, QgsDataSourceURI::uri(), and QgsCoordinateReferenceSystem::validate().
Referenced by QgsProject::addLayer(), and QgsProjectFileTransform::transform1800to1900().
|
inlinevirtual |
Reimplemented in QgsVectorLayer.
Definition at line 341 of file qgsmaplayer.h.
Referenced by loadSldStyle().
|
pure virtual |
Read the symbology for the current layer from the Dom node supplied.
node | node that will contain the symbology definition for this layer. |
errorMessage | reference to string that will be updated with any error messages |
Implemented in QgsVectorLayer, and QgsRasterLayer.
Referenced by loadNamedStyle().
|
protectedvirtual |
called by readLayerXML(), used by children to read state specific to them from project files.
Reimplemented in QgsVectorLayer, and QgsRasterLayer.
Definition at line 416 of file qgsmaplayer.cpp.
Referenced by readLayerXML().
|
signal |
This is used to send a request that any mapcanvas using this layer update its extents.
Referenced by QgsVectorLayer::extent().
|
inlinevirtual |
Synchronises with changes in the datasource.
Reimplemented in QgsVectorLayer, and QgsRasterLayer.
Definition at line 129 of file qgsmaplayer.h.
Referenced by QgsMapLayerRegistry::reloadAllLayers().
void QgsMapLayer::removeCustomProperty | ( | const QString & | key | ) |
Remove a custom property from layer.
Properties are stored in a map and saved in project file.
Definition at line 1261 of file qgsmaplayer.cpp.
References mCustomProperties.
Referenced by QgsPalLayerSettings::readDataDefinedProperty(), and QgsPalLayerSettings::writeDataDefinedPropertyMap().
|
signal |
This signal should be connected with the slot QgsMapCanvas::refresh()
Referenced by QgsRasterLayer::triggerRepaint(), and QgsVectorLayer::triggerRepaint().
|
virtual |
Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
theResultFlag | a reference to a flag that will be set to false if we did not manage to save the default style. |
Definition at line 946 of file qgsmaplayer.cpp.
References saveNamedStyle(), and styleURI().
|
virtual |
Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
theURI | the file name or other URI for the style file. First an attempt will be made to see if this is a file and save to that, if that fails the qgis.db styles table will be used to create a style entry who's key matches the URI. |
theResultFlag | a reference to a flag that will be set to false if we did not manage to save the default style. |
Definition at line 951 of file qgsmaplayer.cpp.
References exportNamedStyle(), QgsVectorLayer::providerType(), QgsApplication::qgisSettingsDirPath(), and tr.
Referenced by saveDefaultStyle().
|
virtual |
Definition at line 1126 of file qgsmaplayer.cpp.
References exportSldStyle(), QgsVectorLayer::providerType(), and tr.
|
signal |
The layer emits this signal when a screen update is requested.
This signal should be connected with the slot QgsMapCanvas::updateMap()
Referenced by QgsVectorLayer::drawRendererV2().
|
inline |
Definition at line 96 of file qgsmaplayer.h.
|
inline |
Definition at line 109 of file qgsmaplayer.h.
|
inline |
Definition at line 111 of file qgsmaplayer.h.
void QgsMapLayer::setBlendMode | ( | const QPainter::CompositionMode & | blendMode | ) |
Write blend mode for layer.
Definition at line 137 of file qgsmaplayer.cpp.
References blendMode(), blendModeChanged(), and mBlendMode.
Referenced by QgsRasterLayer::readSymbology(), and QgsVectorLayer::readSymbology().
void QgsMapLayer::setCacheImage | ( | QImage * | thepImage | ) |
Set the QImage used for caching render operations.
Definition at line 1337 of file qgsmaplayer.cpp.
References mpCacheImage, onCacheImageDelete(), and QgsDebugMsg.
Referenced by clearCacheImage(), QgsVectorLayer::commitChanges(), QgsVectorLayer::deleteSelectedFeatures(), QgsVectorLayer::deselect(), QgsVectorLayer::modifySelection(), QgsMapRenderer::render(), QgsVectorLayer::rollBack(), QgsVectorLayer::select(), QgsVectorLayer::setSelectedFeatures(), and QgsVectorLayer::setSubsetString().
void QgsMapLayer::setCrs | ( | const QgsCoordinateReferenceSystem & | srs, |
bool | emitSignal = true |
||
) |
Sets layer's spatial reference system.
Definition at line 681 of file qgsmaplayer.cpp.
References QgsCoordinateReferenceSystem::isValid(), layerCrsChanged(), mCRS, name(), QgsCoordinateReferenceSystem::setValidationHint(), tr, and QgsCoordinateReferenceSystem::validate().
Referenced by QgsVectorLayer::setCoordinateSystem(), and QgsRasterLayer::setDataProvider().
void QgsMapLayer::setCustomProperty | ( | const QString & | key, |
const QVariant & | value | ||
) |
Set a custom property for layer.
Properties are stored in a map and saved in project file.
Definition at line 1251 of file qgsmaplayer.cpp.
References mCustomProperties.
Referenced by _writeColor(), QgsOfflineEditing::copyVectorLayer(), QgsPalLayerSettings::readDataDefinedProperty(), QgsVectorLayer::readSldLabeling(), QgsRasterLayer::setDataProvider(), QgsPalLayerSettings::writeDataDefinedPropertyMap(), and QgsPalLayerSettings::writeToLayer().
|
inline |
Definition at line 103 of file qgsmaplayer.h.
|
inline |
Definition at line 105 of file qgsmaplayer.h.
|
inlineprotected |
Set error message.
Definition at line 471 of file qgsmaplayer.h.
Referenced by QgsRasterLayer::setDataProvider().
|
protectedvirtual |
Set the extent.
Reimplemented in QgsVectorLayer, and QgsPluginLayer.
Definition at line 1371 of file qgsmaplayer.cpp.
References mExtent.
Referenced by QgsRasterLayer::setDataProvider().
|
inline |
Definition at line 99 of file qgsmaplayer.h.
void QgsMapLayer::setLayerName | ( | const QString & | name | ) |
Set the display name of the layer.
Write property of QString layerName.
name | New name for the layer |
Definition at line 100 of file qgsmaplayer.cpp.
References capitaliseLayerName(), layerNameChanged(), mLayerName, mLayerOrigName, name(), and QgsDebugMsg.
Referenced by readLayerXML(), QgsRasterLayer::setDataProvider(), and QgsVectorLayer::setDataProvider().
|
virtual |
Reorders the previously selected sublayers of this layer from bottom to top (Useful for providers that manage their own layers, such as WMS)
Reimplemented in QgsRasterLayer.
Definition at line 663 of file qgsmaplayer.cpp.
|
slot |
Accessor and mutator for the maximum scale denominator member.
Definition at line 647 of file qgsmaplayer.cpp.
References mMaxScale.
Referenced by QgsVectorLayer::applyNamedStyle(), loadNamedStyle(), and readLayerXML().
|
inline |
Definition at line 115 of file qgsmaplayer.h.
|
inline |
Definition at line 119 of file qgsmaplayer.h.
|
inline |
Definition at line 117 of file qgsmaplayer.h.
|
slot |
Accessor and mutator for the minimum scale denominator member.
Definition at line 636 of file qgsmaplayer.cpp.
References mMinScale.
Referenced by QgsVectorLayer::applyNamedStyle(), loadNamedStyle(), and readLayerXML().
|
virtual |
Set the visibility of the given sublayer name.
Reimplemented in QgsRasterLayer.
Definition at line 669 of file qgsmaplayer.cpp.
|
inline |
Definition at line 93 of file qgsmaplayer.h.
|
protected |
set whether layer is valid or not - should be used in constructor.
Definition at line 1356 of file qgsmaplayer.cpp.
References mValid.
QString const & QgsMapLayer::source | ( | ) | const |
Returns the source for the layer.
Definition at line 126 of file qgsmaplayer.cpp.
References mDataSource.
Referenced by QgsOfflineEditing::committedFeaturesAdded(), QgsOfflineEditing::copyVectorLayer(), and writeLayerXML().
|
signal |
Emit a signal with status (e.g.
to be caught by QgisApp and display a msg on status bar)
Referenced by QgsRasterLayer::QgsRasterLayer(), QgsRasterLayer::setDataProvider(), and QgsRasterLayer::showStatusMessage().
|
virtual |
Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
Definition at line 710 of file qgsmaplayer.cpp.
References publicSource().
Referenced by loadDefaultStyle(), and saveDefaultStyle().
|
virtual |
Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS)
Reimplemented in QgsRasterLayer.
Definition at line 658 of file qgsmaplayer.cpp.
|
inlinevirtualslot |
Time stamp of data source in the moment when data/metadata were loaded by provider.
Reimplemented in QgsRasterLayer.
Definition at line 401 of file qgsmaplayer.h.
Referenced by writeLayerXML().
|
inline |
Definition at line 94 of file qgsmaplayer.h.
Referenced by QgsLegendModel::addLayer(), QgsLegendModel::updateSymbolV2ItemText(), and writeLayerXML().
|
slot |
Accessor and mutator for the scale based visilibility flag.
Definition at line 626 of file qgsmaplayer.cpp.
References mScaleBasedVisibility.
Referenced by QgsVectorLayer::applyNamedStyle(), loadNamedStyle(), and readLayerXML().
QgsMapLayer::LayerType QgsMapLayer::type | ( | ) | const |
Get the type of the layer.
Definition at line 88 of file qgsmaplayer.cpp.
References mLayerType.
Referenced by QgsLegendModel::addLayer(), QgsMapLayerAction::canRunUsingLayer(), QgsRelation::createFromXML(), QgsVectorLayer::geometryType(), QgsMapToolIdentify::identifyLayer(), QgsVectorLayer::metadata(), QgsRasterLayer::readXml(), QgsPluginLayerRegistry::removePluginLayerType(), QgsMapRenderer::render(), and QgsVectorLayer::setEditType().
QUndoStack * QgsMapLayer::undoStack | ( | ) |
Return pointer to layer's undo stack.
Definition at line 1245 of file qgsmaplayer.cpp.
References mUndoStack.
Referenced by QgsVectorLayerEditBuffer::addAttribute(), QgsVectorLayerEditBuffer::addFeature(), QgsVectorLayer::beginEditCommand(), QgsVectorLayerEditBuffer::changeAttributeValue(), QgsVectorLayerEditBuffer::changeGeometry(), QgsVectorLayer::commitChanges(), QgsVectorLayerEditBuffer::deleteAttribute(), QgsVectorLayerEditBuffer::deleteFeature(), QgsVectorLayer::destroyEditCommand(), QgsVectorLayer::endEditCommand(), QgsVectorLayerEditBuffer::isModified(), QgsVectorLayerEditBuffer::QgsVectorLayerEditBuffer(), QgsVectorLayerEditBuffer::rollBack(), and QgsVectorLayer::rollBack().
|
protected |
Write custom properties to project file.
Added in v1.4
Definition at line 1315 of file qgsmaplayer.cpp.
References mCustomProperties.
Referenced by writeLayerXML(), and QgsVectorLayer::writeSymbology().
bool QgsMapLayer::writeLayerXML | ( | QDomElement & | layerElement, |
QDomDocument & | document | ||
) |
stores state in Dom node
layerElement | is a Dom element corresponding to ``maplayer'' tag |
document | is a the dom document being written |
The Dom node corresponds to a Dom document project file XML element to be written by QgsProject.
This, in turn, calls writeXml(), which is over-rideable by sub-classes so that they can write their own specific state to the given Dom node.
Invoked by QgsProject::write().
Definition at line 426 of file qgsmaplayer.cpp.
References attribution(), attributionUrl(), QgsDataSourceURI::database(), dataUrl(), dataUrlFormat(), hasScaleBasedVisibility(), QgsDataSourceURI::host(), QgsProject::instance(), keywordList(), maximumScale(), mCRS, metadataUrl(), metadataUrlFormat(), metadataUrlType(), minimumScale(), originalName(), QgsDataSourceURI::password(), QgsDataSourceURI::port(), QgsVectorLayer::providerType(), QgsDataSourceURI::setConnection(), source(), timestamp(), title(), QgsDataSourceURI::uri(), QgsDataSourceURI::username(), writeCustomProperties(), QgsProject::writePath(), QgsCoordinateReferenceSystem::writeXML(), and writeXml().
Referenced by QgsProject::write().
|
pure virtual |
Write the symbology for the layer into the docment provided.
node | the node that will have the style element added to it. |
doc | the document that will have the QDomNode added. |
errorMessage | reference to string that will be updated with any error messages |
Implemented in QgsVectorLayer, and QgsRasterLayer.
Referenced by exportNamedStyle().
|
protectedvirtual |
called by writeLayerXML(), used by children to write state specific to them to project files.
Reimplemented in QgsVectorLayer, and QgsRasterLayer.
Definition at line 583 of file qgsmaplayer.cpp.
Referenced by writeLayerXML().
|
protected |
Description of the layer.
Definition at line 493 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
protected |
Attribution of the layer.
Definition at line 501 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
protected |
Definition at line 502 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
private |
Blend mode for the layer.
Definition at line 530 of file qgsmaplayer.h.
Referenced by blendMode(), and setBlendMode().
|
private |
layer's spatial reference system.
private to make sure setCrs must be used and layerCrsChanged() is emitted
Definition at line 515 of file qgsmaplayer.h.
Referenced by crs(), QgsMapLayer(), readLayerXML(), setCrs(), writeLayerXML(), and ~QgsMapLayer().
|
private |
Definition at line 545 of file qgsmaplayer.h.
Referenced by customProperty(), readCustomProperties(), removeCustomProperty(), setCustomProperty(), and writeCustomProperties().
|
protected |
data source description string, varies by layer type
Definition at line 480 of file qgsmaplayer.h.
Referenced by QgsVectorLayer::getStyleFromDatabase(), QgsVectorLayer::listStylesInDatabase(), QgsVectorLayer::loadNamedStyle(), publicSource(), readLayerXML(), QgsRasterLayer::readXml(), QgsVectorLayer::readXml(), QgsVectorLayer::saveStyleToDatabase(), QgsRasterLayer::setDataProvider(), QgsVectorLayer::setDataProvider(), QgsVectorLayer::setSubsetString(), and source().
|
protected |
|
protected |
Definition at line 498 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
protected |
Error.
Definition at line 510 of file qgsmaplayer.h.
|
protected |
Extent of the layer.
Definition at line 474 of file qgsmaplayer.h.
Referenced by extent(), QgsPluginLayer::setExtent(), and setExtent().
|
private |
Unique ID of this layer - used to refer to this layer in map layer registry.
Definition at line 524 of file qgsmaplayer.h.
Referenced by id(), QgsMapLayer(), and readLayerXML().
|
protected |
Definition at line 494 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
protected |
Name of the layer - used for display.
Definition at line 483 of file qgsmaplayer.h.
Referenced by name(), QgsMapLayer(), QgsRasterLayer::setDataProvider(), and setLayerName().
|
protected |
Original name of the layer.
Definition at line 488 of file qgsmaplayer.h.
Referenced by QgsMapLayer(), and setLayerName().
|
private |
Type of the layer (eg.
vector, raster)
Definition at line 527 of file qgsmaplayer.h.
Referenced by type().
|
private |
Maximum scale denominator at which this layer should be displayed.
Definition at line 538 of file qgsmaplayer.h.
Referenced by maximumScale(), QgsMapLayer(), and setMaximumScale().
|
protected |
MetadataUrl of the layer.
Definition at line 505 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
protected |
Definition at line 507 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
protected |
Definition at line 506 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
private |
Minimum scale denominator at which this layer should be displayed.
Definition at line 536 of file qgsmaplayer.h.
Referenced by minimumScale(), QgsMapLayer(), and setMinimumScale().
|
private |
QImage for caching of rendering operations.
Definition at line 549 of file qgsmaplayer.h.
Referenced by QgsMapLayer(), setCacheImage(), and ~QgsMapLayer().
|
private |
A flag that tells us whether to use the above vars to restrict layer visibility.
Definition at line 540 of file qgsmaplayer.h.
Referenced by hasScaleBasedVisibility(), QgsMapLayer(), and toggleScaleBasedVisibility().
|
private |
Tag for embedding additional information.
Definition at line 533 of file qgsmaplayer.h.
|
protected |
Definition at line 490 of file qgsmaplayer.h.
Referenced by readLayerXML().
|
private |
Collection of undoable operations for this layer.
Definition at line 543 of file qgsmaplayer.h.
Referenced by undoStack().
|
protected |
Indicates if the layer is valid and can be drawn.
Definition at line 477 of file qgsmaplayer.h.
Referenced by QgsRasterLayer::closeDataProvider(), isValid(), QgsRasterLayer::QgsRasterLayer(), QgsVectorLayer::QgsVectorLayer(), QgsRasterLayer::readXml(), QgsVectorLayer::readXml(), QgsRasterLayer::setDataProvider(), QgsVectorLayer::setDataProvider(), setValid(), QgsRasterLayer::update(), QgsRasterLayer::~QgsRasterLayer(), and QgsVectorLayer::~QgsVectorLayer().