QgsMapLayer Class Reference

Base class for all map layer types. More...

#include <qgsmaplayer.h>

Inheritance diagram for QgsMapLayer:

Collaboration diagram for QgsMapLayer:

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 ()
void	setMaximumScale (float theMaxScale)
	Accessor and mutator for the maximum scale denominator member.
float	maximumScale ()
void	toggleScaleBasedVisibility (bool theVisibilityFlag)
	Accessor and mutator for the scale based visilibility flag.
bool	hasScaleBasedVisibility ()
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

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
unsigned int	mTransparencyLevel
	Transparency level for this layer should be 0-255 (255 being opaque)
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.

Detailed Description

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.

Member Enumeration Documentation

enum QgsMapLayer::LayerType

Layers enum defining the types of layers that can be added to a map.

Enumerator:

VectorLayer
RasterLayer
PluginLayer

Definition at line 51 of file qgsmaplayer.h.

Constructor & Destructor Documentation

QgsMapLayer::QgsMapLayer	(	QgsMapLayer::LayerType	type = VectorLayer,
		QString	lyrname = QString::null,
		QString	source = QString::null
	)

Constructor.

Parameters

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.

QgsMapLayer::~QgsMapLayer ( )

virtual

Destructor.

Definition at line 80 of file qgsmaplayer.cpp.

References mCRS, and mpCacheImage.

QgsMapLayer::QgsMapLayer ( QgsMapLayer const &  )

private

private copy constructor - QgsMapLayer not copyable

Member Function Documentation

const QString& QgsMapLayer::abstract ( ) const

inline

Definition at line 97 of file qgsmaplayer.h.

void QgsMapLayer::appendError ( const QgsErrorMessage &  theMessage )

inlineprotected

Add error message.

Definition at line 466 of file qgsmaplayer.h.

Referenced by QgsRasterLayer::setDataProvider().

const QString& QgsMapLayer::attribution ( ) const

inline

Definition at line 110 of file qgsmaplayer.h.

Referenced by writeLayerXML().

const QString& QgsMapLayer::attributionUrl ( ) const

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

QImage* QgsMapLayer::cacheImage ( )

inline

Get the QImage used for caching render operations.

Note

This method was added in QGIS 1.4

Definition at line 365 of file qgsmaplayer.h.

Referenced by QgsMapRenderer::render().

QString QgsMapLayer::capitaliseLayerName ( const QString &  name )

static

A convenience function to (un)capitalise the layer name.

Definition at line 707 of file qgsmaplayer.cpp.

Referenced by QgsMapLayer(), and setLayerName().

void QgsMapLayer::clearCacheImage ( )

slot

Clear cached image added in 1.5.

Definition at line 1373 of file qgsmaplayer.cpp.

References setCacheImage().

void QgsMapLayer::connectNotify ( const char *  signal )

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.

Note

This was introduced in QGIS 1.4

Definition at line 676 of file qgsmaplayer.cpp.

References mCRS.

Referenced by QgsPalLabeling::addDiagramLayer(), QgsVectorLayerEditUtils::addTopologicalPoints(), QgsAtlasComposition::beginRender(), QgsGeometryAnalyzer::buffer(), QgsGeometryAnalyzer::centroids(), QgsGeometryAnalyzer::convexHull(), QgsOfflineEditing::copyVectorLayer(), QgsVectorFileWriter::createSymbolLayerTable(), QgsGeometryAnalyzer::dissolve(), QgsRasterLayer::draw(), QgsGeometryAnalyzer::eventLayer(), QgsVectorFileWriter::exportFeaturesSymbolLevels(), QgsGeometryAnalyzer::extent(), QgsMapToolIdentify::featureDerivedAttributes(), QgsComposerAttributeTable::getFeatureAttributes(), QgsVectorLayerImport::importLayer(), QgsOverlayAnalyzer::intersection(), QgsRasterLayer::metadata(), QgsVectorLayer::metadata(), QgsPalLabeling::prepareLayer(), QgsRasterCalculator::processCalculation(), QgsAttributeDialog::QgsAttributeDialog(), QgsHighlight::QgsHighlight(), QgsRasterLayer::readXml(), QgsMapRenderer::render(), QgsRasterLayer::setDataProvider(), QgsGeometryAnalyzer::simplify(), QgsVectorLayer::snapToGeometry(), QgsMapRenderer::splitLayersExtent(), QgsMapRenderer::tr(), 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.

Note

Added in v1.4

Definition at line 1268 of file qgsmaplayer.cpp.

References mCustomProperties.

Referenced by _readColor(), QgsMapToolIdentify::identifyRasterLayer(), QgsOfflineEditing::layerAdded(), QgsPalLayerSettings::readDataDefinedProperty(), QgsPalLayerSettings::readFromLayer(), QgsOfflineEditing::synchronize(), QgsPalLabeling::willUseLayer(), and QgsPalLayerSettings::writeDataDefinedPropertyMap().

void QgsMapLayer::dataChanged ( )

signal

data of layer changed added in 1.5

const QString& QgsMapLayer::dataUrl ( ) const

inline

Definition at line 104 of file qgsmaplayer.h.

Referenced by writeLayerXML().

const QString& QgsMapLayer::dataUrlFormat ( ) const

inline

Definition at line 106 of file qgsmaplayer.h.

Referenced by writeLayerXML().

bool QgsMapLayer::draw ( QgsRenderContext &  rendererContext )

virtual

This is the method that does the actual work of drawing the layer onto a paint device.

Parameters

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

void QgsMapLayer::drawingProgress ( int  theProgress, int  theTotalSteps  )

signal

Emit a signal to notify of a progress event.

Referenced by QgsRasterLayer::updateProgress().

void QgsMapLayer::drawLabels ( QgsRenderContext &  rendererContext )

virtual

Draw labels.

Todo:

to be removed: used only in vector layers

Reimplemented in QgsVectorLayer.

Definition at line 155 of file qgsmaplayer.cpp.

Referenced by QgsMapRenderer::render().

virtual QgsError QgsMapLayer::error ( ) const

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.

void QgsMapLayer::exportNamedStyle ( QDomDocument &  doc, QString &  errorMsg  )

virtual

Export the properties of this layer as named style in a QDomDocument.

Parameters

doc	the target QDomDocument
errorMsg	this QString will be initialized on error during the execution of writeSymbology

Definition at line 928 of file qgsmaplayer.cpp.

References hasScaleBasedVisibility(), maximumScale(), minimumScale(), QGis::QGIS_VERSION, tr, and writeSymbology().

Referenced by saveNamedStyle(), and QgsVectorLayer::saveStyleToDatabase().

void QgsMapLayer::exportSldStyle ( QDomDocument &  doc, QString &  errorMsg  )

virtual

Export the properties of this layer as SLD style in a QDomDocument.

Parameters

doc	the target QDomDocument
errorMsg	this QString will be initialized on error during the execution of writeSymbology

Definition at line 1100 of file qgsmaplayer.cpp.

References tr, and QgsVectorLayer::writeSld().

Referenced by saveSldStyle(), and QgsVectorLayer::saveStyleToDatabase().

QgsRectangle QgsMapLayer::extent ( )

virtual

Return the extent of the layer.

Reimplemented in QgsVectorLayer.

Definition at line 132 of file qgsmaplayer.cpp.

References mExtent.

Referenced by QgsRasterLayer::draw(), QgsMapToolIdentify::identifyRasterLayer(), QgsMapRenderer::render(), QgsPluginLayer::setExtent(), and QgsMapRenderer::updateFullExtent().

bool QgsMapLayer::hasScaleBasedVisibility ( )

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.

Note

added in 1.7

Definition at line 95 of file qgsmaplayer.cpp.

References mID.

Referenced by QgsPalLabeling::addDiagramLayer(), QgsLegendModel::addLayer(), QgsMapLayerRegistry::addMapLayers(), QgsLegendModel::addRasterLayerItems(), QgsAtlasComposition::beginRender(), QgsVectorLayerEditBuffer::commitChanges(), QgsComposerMap::containsAdvancedEffects(), QgsOfflineEditing::copyVectorLayer(), QgsAtlasComposition::endRender(), QgsMapToolIdentify::identify(), QgsPalLabeling::prepareLayer(), QgsAttributeDialog::QgsAttributeDialog(), QgsComposerAttributeTable::removeLayer(), QgsPluginLayerRegistry::removePluginLayerType(), QgsMapCanvas::setLayerSet(), QgsOfflineEditing::synchronize(), QgsRasterFormatSaveOptionsWidget::validateOptions(), QgsProject::write(), QgsHtmlAnnotationItem::writeXML(), QgsFormAnnotationItem::writeXML(), QgsComposerAttributeTable::writeXML(), and QgsAtlasComposition::writeXML().

void QgsMapLayer::invalidTransformInput ( )

virtualslot

Event handler for when a coordinate transform fails due to bad vertex error.

Definition at line 601 of file qgsmaplayer.cpp.

References QgsDebugMsg.

bool QgsMapLayer::isEditable ( ) const

virtual

True if the layer can be edited.

Reimplemented in QgsVectorLayer.

Definition at line 1363 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

Returns

True if the layer is valid and can be accessed

Definition at line 595 of file qgsmaplayer.cpp.

References mValid.

Referenced by QgsProject::addLayer(), QgsMapLayerRegistry::addMapLayers(), QgsOfflineEditing::copyVectorLayer(), QgsGeometryAnalyzer::eventLayer(), QgsOfflineEditing::synchronize(), and QgsProjectFileTransform::transform0110to1000().

const QString& QgsMapLayer::keywordList ( ) const

inline

Definition at line 100 of file qgsmaplayer.h.

Referenced by writeLayerXML().

QString QgsMapLayer::lastError ( )

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

QString QgsMapLayer::lastErrorTitle ( )

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

void QgsMapLayer::layerCrsChanged ( )

signal

Emit a signal that layer's CRS has been reset added in 1.4.

Referenced by setCrs().

void QgsMapLayer::layerNameChanged ( )

signal

Emit a signal that the layer name has been changed.

Referenced by setLayerName().

QString QgsMapLayer::loadDefaultStyle ( bool &  theResultFlag )

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)

Parameters

theResultFlag

a reference to a flag that will be set to false if we did not manage to load the default style.

Returns

a QString with any status messages

See Also

also loadNamedStyle ();

Definition at line 776 of file qgsmaplayer.cpp.

References loadNamedStyle(), and styleURI().

Referenced by QgsRasterLayer::QgsRasterLayer(), and QgsVectorLayer::QgsVectorLayer().

QString QgsMapLayer::loadNamedStyle ( const QString  theURI, bool &  theResultFlag  )

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)

Parameters

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.

Returns

a QString with any status messages

See Also

also loadDefaultStyle ();

Reimplemented in QgsVectorLayer.

Definition at line 825 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().

bool QgsMapLayer::loadNamedStyleFromDb ( const QString  db, const QString  theURI, QString &  qml  )

virtual

Definition at line 781 of file qgsmaplayer.cpp.

References QgsDebugMsg.

Referenced by loadNamedStyle().

QString QgsMapLayer::loadSldStyle ( const QString  theURI, bool &  theResultFlag  )

virtual

Definition at line 1195 of file qgsmaplayer.cpp.

References QgsDebugMsg, readSld(), and tr.

float QgsMapLayer::maximumScale ( )

slot

Definition at line 652 of file qgsmaplayer.cpp.

References mMaxScale.

Referenced by exportNamedStyle(), QgsAttributeTableFilterModel::generateListOfVisibleFeatures(), QgsMapToolIdentify::identifyVectorLayer(), QgsMapRenderer::render(), and writeLayerXML().

QString QgsMapLayer::metadata ( )

virtualslot

Obtain Metadata for this layer.

Reimplemented in QgsRasterLayer.

Definition at line 1378 of file qgsmaplayer.cpp.

const QString& QgsMapLayer::metadataUrl ( ) const

inline

Definition at line 116 of file qgsmaplayer.h.

Referenced by writeLayerXML().

const QString& QgsMapLayer::metadataUrlFormat ( ) const

inline

Definition at line 120 of file qgsmaplayer.h.

Referenced by writeLayerXML().

const QString& QgsMapLayer::metadataUrlType ( ) const

inline

Definition at line 118 of file qgsmaplayer.h.

Referenced by writeLayerXML().

float QgsMapLayer::minimumScale ( )

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.

Returns

the layer name

Definition at line 113 of file qgsmaplayer.cpp.

References mLayerName, and QgsDebugMsgLevel.

Referenced by QgsVectorLayer::addAttributeAlias(), QgsLegendModel::addLayer(), QgsVectorLayer::attributeAlias(), QgsVectorLayer::attributeEditorElementFromDomElement(), QgsVectorLayer::checkedState(), QgsOfflineEditing::copyVectorLayer(), QgsVectorLayer::countSymbolFeatures(), QgsVectorLayer::editType(), QgsVectorLayer::fieldEditable(), QgsVectorLayer::fieldNameIndex(), QgsMapToolIdentify::identify(), QgsMapToolIdentify::identifyRasterLayer(), QgsMapLayerRegistry::mapLayersByName(), QgsAttributeDialog::QgsAttributeDialog(), 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().

virtual void QgsMapLayer::onCacheImageDelete ( )

inlinevirtual

Is called when the cache image is being deleted.

Overwrite and use to clean up.

Note

added in 2.0

Definition at line 374 of file qgsmaplayer.h.

Referenced by setCacheImage().

QgsMapLayer& QgsMapLayer::operator= ( QgsMapLayer const &  )

private

private assign operator - QgsMapLayer not copyable

const QString& QgsMapLayer::originalName ( ) const

inline

Get the original name of the layer.

Note

added in 1.9

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 119 of file qgsmaplayer.cpp.

References mDataSource, and QgsDataSourceURI::removePassword().

Referenced by loadNamedStyle(), QgsVectorLayer::metadata(), and styleURI().

void QgsMapLayer::readCustomProperties ( const QDomNode &  layerNode, const QString &  keyStartsWith = ""  )

protected

Read custom properties from project file.

Added in v1.4

Parameters

layerNode	note to read from
keyStartsWith	reads only properties starting with the specified string (or all if the string is empty)

Definition at line 1278 of file qgsmaplayer.cpp.

References mCustomProperties.

Referenced by readLayerXML(), and QgsVectorLayer::readSymbology().

bool QgsMapLayer::readLayerXML

(

const QDomElement &

layerElement

)

sets state from Dom document

Parameters

layerElement

The Dom element corresponding to ``maplayer'' tag

Note

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

Returns

true if successful

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

virtual bool QgsMapLayer::readSld ( const QDomNode &  node, QString &  errorMessage  )

inlinevirtual

Reimplemented in QgsVectorLayer.

Definition at line 341 of file qgsmaplayer.h.

Referenced by loadSldStyle().

virtual bool QgsMapLayer::readSymbology ( const QDomNode &  node, QString &  errorMessage  )

pure virtual

Read the symbology for the current layer from the Dom node supplied.

Parameters

node	node that will contain the symbology definition for this layer.
errorMessage	reference to string that will be updated with any error messages

Returns

true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

Referenced by loadNamedStyle().

bool QgsMapLayer::readXml ( const QDomNode &  layer_node )

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

void QgsMapLayer::recalculateExtents ( )

signal

This is used to send a request that any mapcanvas using this layer update its extents.

Referenced by QgsVectorLayer::extent().

virtual void QgsMapLayer::reload ( )

inlinevirtual

Synchronises with changes in the datasource.

Note

added in version 1.6

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.

Note

Added in v1.4

Definition at line 1273 of file qgsmaplayer.cpp.

References mCustomProperties.

Referenced by QgsPalLayerSettings::readDataDefinedProperty(), and QgsPalLayerSettings::writeDataDefinedPropertyMap().

void QgsMapLayer::repaintRequested ( )

signal

This signal should be connected with the slot QgsMapCanvas::refresh()

Todo:

to be removed - GUI dependency

Referenced by QgsRasterLayer::triggerRepaint(), and QgsVectorLayer::triggerRepaint().

QString QgsMapLayer::saveDefaultStyle ( bool &  theResultFlag )

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)

Parameters

theResultFlag

a reference to a flag that will be set to false if we did not manage to save the default style.

Returns

a QString with any status messages

See Also

loadNamedStyle() and

saveNamedStyle()

Definition at line 958 of file qgsmaplayer.cpp.

References saveNamedStyle(), and styleURI().

QString QgsMapLayer::saveNamedStyle ( const QString  theURI, bool &  theResultFlag  )

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)

Parameters

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.

Returns

a QString with any status messages

See Also

saveDefaultStyle()

Definition at line 963 of file qgsmaplayer.cpp.

References exportNamedStyle(), QgsVectorLayer::providerType(), QgsApplication::qgisSettingsDirPath(), and tr.

Referenced by saveDefaultStyle().

QString QgsMapLayer::saveSldStyle ( const QString  theURI, bool &  theResultFlag  )

virtual

Definition at line 1138 of file qgsmaplayer.cpp.

References exportSldStyle(), QgsVectorLayer::providerType(), and tr.

void QgsMapLayer::screenUpdateRequested ( )

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

void QgsMapLayer::setAbstract ( const QString &  abstract )

inline

Definition at line 96 of file qgsmaplayer.h.

void QgsMapLayer::setAttribution ( const QString &  attrib )

inline

Definition at line 109 of file qgsmaplayer.h.

void QgsMapLayer::setAttributionUrl ( const QString &  attribUrl )

inline

Definition at line 111 of file qgsmaplayer.h.

void QgsMapLayer::setBlendMode

(

const QPainter::CompositionMode

blendMode

)

Write blend mode for layer.

Definition at line 138 of file qgsmaplayer.cpp.

References blendMode(), and mBlendMode.

Referenced by QgsRasterLayer::readSymbology(), and QgsVectorLayer::readSymbology().

void QgsMapLayer::setCacheImage

(

QImage *

thepImage

)

Set the QImage used for caching render operations.

Note

This method was added in QGIS 1.4

Definition at line 1349 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.

Note

emitSignal added in 1.4

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.

Note

Added in v1.4

Definition at line 1263 of file qgsmaplayer.cpp.

References mCustomProperties.

Referenced by _writeColor(), QgsOfflineEditing::copyVectorLayer(), QgsPalLayerSettings::readDataDefinedProperty(), QgsRasterLayer::setDataProvider(), QgsPalLayerSettings::writeDataDefinedPropertyMap(), and QgsPalLayerSettings::writeToLayer().

void QgsMapLayer::setDataUrl ( const QString &  dataUrl )

inline

Definition at line 103 of file qgsmaplayer.h.

void QgsMapLayer::setDataUrlFormat ( const QString &  dataUrlFormat )

inline

Definition at line 105 of file qgsmaplayer.h.

void QgsMapLayer::setError ( const QgsError &  theError )

inlineprotected

Set error message.

Definition at line 468 of file qgsmaplayer.h.

Referenced by QgsRasterLayer::setDataProvider().

void QgsMapLayer::setExtent ( const QgsRectangle &  rect )

protectedvirtual

Set the extent.

Reimplemented in QgsVectorLayer, and QgsPluginLayer.

Definition at line 1383 of file qgsmaplayer.cpp.

References mExtent.

Referenced by QgsRasterLayer::setDataProvider().

void QgsMapLayer::setKeywordList ( const QString &  keywords )

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.

Parameters

name	New name for the layer

Definition at line 101 of file qgsmaplayer.cpp.

References capitaliseLayerName(), layerNameChanged(), mLayerName, mLayerOrigName, name(), and QgsDebugMsg.

Referenced by readLayerXML(), QgsRasterLayer::setDataProvider(), and QgsVectorLayer::setDataProvider().

void QgsMapLayer::setLayerOrder ( const QStringList &  layers )

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.

void QgsMapLayer::setMaximumScale ( float  theMaxScale )

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

void QgsMapLayer::setMetadataUrl ( const QString &  metaUrl )

inline

Definition at line 115 of file qgsmaplayer.h.

void QgsMapLayer::setMetadataUrlFormat ( const QString &  metaUrlFormat )

inline

Definition at line 119 of file qgsmaplayer.h.

void QgsMapLayer::setMetadataUrlType ( const QString &  metaUrlType )

inline

Definition at line 117 of file qgsmaplayer.h.

void QgsMapLayer::setMinimumScale ( float  theMinScale )

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

void QgsMapLayer::setSubLayerVisibility ( QString  name, bool  vis  )

virtual

Set the visibility of the given sublayer name.

Reimplemented in QgsRasterLayer.

Definition at line 669 of file qgsmaplayer.cpp.

void QgsMapLayer::setTitle ( const QString &  title )

inline

Definition at line 93 of file qgsmaplayer.h.

void QgsMapLayer::setValid ( bool  valid )

protected

set whether layer is valid or not - should be used in constructor.

Note

added in v1.5

Definition at line 1368 of file qgsmaplayer.cpp.

References mValid.

QString const & QgsMapLayer::source

(

)

const

Returns the source for the layer.

Definition at line 127 of file qgsmaplayer.cpp.

References mDataSource.

Referenced by QgsOfflineEditing::committedFeaturesAdded(), QgsOfflineEditing::copyVectorLayer(), and writeLayerXML().

void QgsMapLayer::statusChanged ( QString  theStatus )

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

QString QgsMapLayer::styleURI ( )

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)

Returns

a QString with the style file name

See Also

also loadNamedStyle () and saveNamedStyle ();

Note

This method was added in QGIS 1.8

Definition at line 722 of file qgsmaplayer.cpp.

References publicSource().

Referenced by loadDefaultStyle(), and saveDefaultStyle().

QStringList QgsMapLayer::subLayers ( ) const

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.

virtual QDateTime QgsMapLayer::timestamp ( ) const

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

const QString& QgsMapLayer::title ( ) const

inline

Definition at line 94 of file qgsmaplayer.h.

Referenced by QgsLegendModel::addLayer(), QgsLegendModel::updateSymbolV2ItemText(), and writeLayerXML().

void QgsMapLayer::toggleScaleBasedVisibility ( bool  theVisibilityFlag )

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.

Returns

Integer matching a value in the QgsMapLayer::LayerType enum

Definition at line 89 of file qgsmaplayer.cpp.

References mLayerType.

Referenced by QgsLegendModel::addLayer(), 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 1257 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().

void QgsMapLayer::writeCustomProperties ( QDomNode &  layerNode, QDomDocument &  doc  ) const

protected

Write custom properties to project file.

Added in v1.4

Definition at line 1327 of file qgsmaplayer.cpp.

References mCustomProperties.

Referenced by writeLayerXML(), and QgsVectorLayer::writeSymbology().

bool QgsMapLayer::writeLayerXML	(	QDomElement &	layerElement,
		QDomDocument &	document
	)

stores state in Dom node

Parameters

layerElement	is a Dom element corresponding to ``maplayer'' tag
document	is a the dom document being written

Note

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

Returns

true if successful

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

virtual bool QgsMapLayer::writeSymbology ( QDomNode &  node, QDomDocument &  doc, QString &  errorMessage  ) const

pure virtual

Write the symbology for the layer into the docment provided.

Parameters

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

Returns

true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

Referenced by exportNamedStyle().

bool QgsMapLayer::writeXml ( QDomNode &  layer_node, QDomDocument &  document  )

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

Member Data Documentation

QString QgsMapLayer::mAbstract

protected

Description of the layer.

Definition at line 493 of file qgsmaplayer.h.

Referenced by readLayerXML().

QString QgsMapLayer::mAttribution

protected

Attribution of the layer.

Definition at line 501 of file qgsmaplayer.h.

Referenced by readLayerXML().

QString QgsMapLayer::mAttributionUrl

protected

Definition at line 502 of file qgsmaplayer.h.

Referenced by readLayerXML().

QPainter::CompositionMode QgsMapLayer::mBlendMode

private

Blend mode for the layer.

Definition at line 530 of file qgsmaplayer.h.

Referenced by blendMode(), and setBlendMode().

QgsCoordinateReferenceSystem* QgsMapLayer::mCRS

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

QMap<QString, QVariant> QgsMapLayer::mCustomProperties

private

Definition at line 545 of file qgsmaplayer.h.

Referenced by customProperty(), readCustomProperties(), removeCustomProperty(), setCustomProperty(), and writeCustomProperties().

QString QgsMapLayer::mDataSource

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

QString QgsMapLayer::mDataUrl

protected

DataUrl of the layer.

Definition at line 497 of file qgsmaplayer.h.

Referenced by readLayerXML().

QString QgsMapLayer::mDataUrlFormat

protected

Definition at line 498 of file qgsmaplayer.h.

Referenced by readLayerXML().

QgsError QgsMapLayer::mError

protected

Error.

Definition at line 510 of file qgsmaplayer.h.

QgsRectangle QgsMapLayer::mExtent

protected

Extent of the layer.

Definition at line 474 of file qgsmaplayer.h.

Referenced by extent(), QgsPluginLayer::setExtent(), and setExtent().

QString QgsMapLayer::mID

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

QString QgsMapLayer::mKeywordList

protected

Definition at line 494 of file qgsmaplayer.h.

Referenced by readLayerXML().

QString QgsMapLayer::mLayerName

protected

Name of the layer - used for display.

Definition at line 483 of file qgsmaplayer.h.

Referenced by name(), QgsMapLayer(), QgsRasterLayer::setDataProvider(), and setLayerName().

QString QgsMapLayer::mLayerOrigName

protected

Original name of the layer.

Note

added in 1.9

Definition at line 488 of file qgsmaplayer.h.

Referenced by QgsMapLayer(), and setLayerName().

QgsMapLayer::LayerType QgsMapLayer::mLayerType

private

Type of the layer (eg.

vector, raster)

Definition at line 527 of file qgsmaplayer.h.

Referenced by type().

float QgsMapLayer::mMaxScale

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

QString QgsMapLayer::mMetadataUrl

protected

MetadataUrl of the layer.

Definition at line 505 of file qgsmaplayer.h.

Referenced by readLayerXML().

QString QgsMapLayer::mMetadataUrlFormat

protected

Definition at line 507 of file qgsmaplayer.h.

Referenced by readLayerXML().

QString QgsMapLayer::mMetadataUrlType

protected

Definition at line 506 of file qgsmaplayer.h.

Referenced by readLayerXML().

float QgsMapLayer::mMinScale

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

QImage* QgsMapLayer::mpCacheImage

private

QImage for caching of rendering operations.

Note

This property was added in QGIS 1.4

Definition at line 549 of file qgsmaplayer.h.

Referenced by QgsMapLayer(), setCacheImage(), and ~QgsMapLayer().

bool QgsMapLayer::mScaleBasedVisibility

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

QString QgsMapLayer::mTag

private

Tag for embedding additional information.

Definition at line 533 of file qgsmaplayer.h.

QString QgsMapLayer::mTitle

protected

Definition at line 490 of file qgsmaplayer.h.

Referenced by readLayerXML().

unsigned int QgsMapLayer::mTransparencyLevel

protected

Transparency level for this layer should be 0-255 (255 being opaque)

Definition at line 471 of file qgsmaplayer.h.

Referenced by QgsRasterLayer::draw().

QUndoStack QgsMapLayer::mUndoStack

private

Collection of undoable operations for this layer.

Definition at line 543 of file qgsmaplayer.h.

Referenced by undoStack().

bool QgsMapLayer::mValid

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

---

The documentation for this class was generated from the following files:

• /tmp/buildd/qgis-2.0.1/src/core/qgsmaplayer.h
• /tmp/buildd/qgis-2.0.1/src/core/qgsmaplayer.cpp