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

#include <qgsmaplayer.h>

Inheritance 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 () 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
Q_DECL_DEPRECATED void	clearCacheImage ()
	Clear cached image.
void	triggerRepaint ()
	Will advice the map canvas (and any other interested party) that this layer requires to be repainted.
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)
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.
void	repaintRequested ()
	By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself.
void	screenUpdateRequested ()
void	recalculateExtents ()
	This is used to send a request that any mapcanvas using this layer update its extents.
void	dataChanged ()
	data of layer changed
void	blendModeChanged (const QPainter::CompositionMode &blendMode)
	Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode()
void	rendererChanged ()
	Signal emitted when renderer is changed.
void	legendChanged ()
	Signal emitted when legend of the layer has changed.

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 QgsMapLayerRenderer *	createMapRenderer (QgsRenderContext &rendererContext)
	Return new instance of QgsMapLayerRenderer that will be used for rendering of given context.
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, QString relativeBasePath=QString::null)
	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 Q_DECL_DEPRECATED QString	lastErrorTitle ()
virtual Q_DECL_DEPRECATED QString	lastError ()
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.
void	setLegendUrl (const QString &legendUrl)
const QString &	legendUrl () const
void	setLegendUrlFormat (const QString &legendUrlFormat)
const QString &	legendUrlFormat () const
Q_DECL_DEPRECATED QImage *	cacheImage ()
Q_DECL_DEPRECATED void	setCacheImage (QImage *)
virtual Q_DECL_DEPRECATED void	onCacheImageDelete ()
void	setLegend (QgsMapLayerLegend *legend)
	Assign a legend controller to the map layer.
QgsMapLayerLegend *	legend () const
	Can be null.

Static Public Member Functions
static QDomDocument	asLayerDefinition (QList< QgsMapLayer * > layers, QString relativeBasePath=QString::null)
	Returns the given layer as a layer definition document Layer definitions store the data source as well as styling and custom properties.
static QList< QgsMapLayer * >	fromLayerDefinition (QDomDocument &document)
	Creates a new layer from a layer defininition document.
static QList< QgsMapLayer * >	fromLayerDefinitionFile (const QString qlrfile)
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
QString	mLegendUrl
	WMS legend.
QString	mLegendUrlFormat
QgsError	mError
	Error.

Detailed Description

Base class for all map layer types.

This is the base class for all map layer types (vector, raster).

Member Enumeration Documentation

enum QgsMapLayer::LayerType

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

Enumerator:

VectorLayer
RasterLayer
PluginLayer

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

QgsMapLayer::~QgsMapLayer ( )

virtual

Destructor.

Member Function Documentation

const QString& QgsMapLayer::abstract ( ) const

inline

void QgsMapLayer::appendError ( const QgsErrorMessage & theMessage )

inlineprotected

Add error message.

QDomDocument QgsMapLayer::asLayerDefinition	(	QList< QgsMapLayer * >	layers,
		QString	relativeBasePath = `QString::null`
	)

static

Returns the given layer as a layer definition document Layer definitions store the data source as well as styling and custom properties.

Layer definitions can be used to load a layer and styling all from a single file.

const QString& QgsMapLayer::attribution ( ) const

inline

const QString& QgsMapLayer::attributionUrl ( ) const

inline

QPainter::CompositionMode QgsMapLayer::blendMode ( ) const

Read blend mode for layer.

void QgsMapLayer::blendModeChanged ( const QPainter::CompositionMode & blendMode )

signal

Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode()

Q_DECL_DEPRECATED QImage* QgsMapLayer::cacheImage ( )

inline

Deprecated:: since 2.4 - returns NULL

QString QgsMapLayer::capitaliseLayerName ( const QString & name )

static

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

void QgsMapLayer::clearCacheImage ( )

slot

Clear cached image.

Deprecated:: in 2.4 - use triggerRepaint() - caches automatically listen to repaintRequested() signal to invalidate the cached image

void QgsMapLayer::connectNotify ( const char * signal )

protected

debugging member - invoked when a connect() is made to this object

virtual QgsMapLayerRenderer* QgsMapLayer::createMapRenderer ( QgsRenderContext & rendererContext )

inlinevirtual

Return new instance of QgsMapLayerRenderer that will be used for rendering of given context.

Note: added in 2.4

Reimplemented in QgsVectorLayer, QgsRasterLayer, and QgsPluginLayer.

const QgsCoordinateReferenceSystem & QgsMapLayer::crs ( ) const

Returns layer's spatial reference system.

Note: This was introduced in QGIS 1.4

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.

void QgsMapLayer::dataChanged ( )

signal

data of layer changed

const QString& QgsMapLayer::dataUrl ( ) const

inline

const QString& QgsMapLayer::dataUrlFormat ( ) const

inline

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.

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

signal

Deprecated:: in 2.4 - not emitted anymore

void QgsMapLayer::drawLabels ( QgsRenderContext & rendererContext )

virtual

Draw labels.

Todo:: to be removed: used only in vector layers

Reimplemented in QgsVectorLayer.

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.

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

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

QgsRectangle QgsMapLayer::extent ( )

virtual

Return the extent of the layer.

Reimplemented in QgsVectorLayer.

QList< QgsMapLayer * > QgsMapLayer::fromLayerDefinition ( QDomDocument & document )

static

Creates a new layer from a layer defininition document.

QList< QgsMapLayer * > QgsMapLayer::fromLayerDefinitionFile ( const QString qlrfile )

static

bool QgsMapLayer::hasScaleBasedVisibility ( ) const

slot

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.

void QgsMapLayer::invalidTransformInput ( )

virtualslot

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

bool QgsMapLayer::isEditable ( ) const

virtual

True if the layer can be edited.

Reimplemented in QgsVectorLayer.

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

const QString& QgsMapLayer::keywordList ( ) const

inline

QString QgsMapLayer::lastError ( )

virtual

Deprecated:: since 2.4 - returns empty string

QString QgsMapLayer::lastErrorTitle ( )

virtual

Deprecated:: since 2.4 - returns empty string

void QgsMapLayer::layerCrsChanged ( )

signal

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

void QgsMapLayer::layerNameChanged ( )

signal

Emit a signal that the layer name has been changed.

QgsMapLayerLegend * QgsMapLayer::legend ( ) const

Can be null.

Note: added in 2.6

void QgsMapLayer::legendChanged ( )

signal

Signal emitted when legend of the layer has changed.

Note: added in 2.6

const QString& QgsMapLayer::legendUrl ( ) const

inline

const QString& QgsMapLayer::legendUrlFormat ( ) const

inline

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

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.

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

virtual

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

virtual

float QgsMapLayer::maximumScale ( ) const

slot

QString QgsMapLayer::metadata ( )

virtualslot

Obtain Metadata for this layer.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

const QString& QgsMapLayer::metadataUrl ( ) const

inline

const QString& QgsMapLayer::metadataUrlFormat ( ) const

inline

const QString& QgsMapLayer::metadataUrlType ( ) const

inline

float QgsMapLayer::minimumScale ( ) const

slot

QString const & QgsMapLayer::name ( ) const

Get the display name of the layer.

Read property of QString layerName.

Returns: the layer name

virtual Q_DECL_DEPRECATED void QgsMapLayer::onCacheImageDelete ( )

inlinevirtual

Deprecated:: since 2.4 - does nothing

const QString& QgsMapLayer::originalName ( ) const

inline

Get the original name of the layer.

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.

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

protected

Read custom properties from project file.

Parameters

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

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

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

inlinevirtual

Reimplemented in QgsVectorLayer.

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.

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.

void QgsMapLayer::recalculateExtents ( )

signal

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

virtual void QgsMapLayer::reload ( )

inlinevirtual

Synchronises with changes in the datasource.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

void QgsMapLayer::removeCustomProperty ( const QString & key )

Remove a custom property from layer.

Properties are stored in a map and saved in project file.

void QgsMapLayer::rendererChanged ( )

signal

Signal emitted when renderer is changed.

void QgsMapLayer::repaintRequested ( )

signal

By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself.

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

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

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

virtual

void QgsMapLayer::screenUpdateRequested ( )

signal

Note: Deprecated in 2.4 and not emitted anymore

void QgsMapLayer::setAbstract ( const QString & abstract )

inline

void QgsMapLayer::setAttribution ( const QString & attrib )

inline

void QgsMapLayer::setAttributionUrl ( const QString & attribUrl )

inline

void QgsMapLayer::setBlendMode ( const QPainter::CompositionMode & blendMode )

Write blend mode for layer.

void QgsMapLayer::setCacheImage ( QImage * )

Deprecated:: since 2.4 - caches listen to repaintRequested() signal to invalidate the cached image

void QgsMapLayer::setCrs	(	const QgsCoordinateReferenceSystem &	srs,
		bool	emitSignal = `true`
	)

Sets layer's spatial reference system.

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.

void QgsMapLayer::setDataUrl ( const QString & dataUrl )

inline

void QgsMapLayer::setDataUrlFormat ( const QString & dataUrlFormat )

inline

void QgsMapLayer::setError ( const QgsError & theError )

inlineprotected

Set error message.

void QgsMapLayer::setExtent ( const QgsRectangle & rect )

protectedvirtual

Set the extent.

Reimplemented in QgsVectorLayer, and QgsPluginLayer.

void QgsMapLayer::setKeywordList ( const QString & keywords )

inline

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

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.

void QgsMapLayer::setLegend ( QgsMapLayerLegend * legend )

Assign a legend controller to the map layer.

The object will be responsible for providing legend items.

Parameters

legend Takes ownership of the object. Can be null pointer

Note: added in 2.6

void QgsMapLayer::setLegendUrl ( const QString & legendUrl )

inline

void QgsMapLayer::setLegendUrlFormat ( const QString & legendUrlFormat )

inline

void QgsMapLayer::setMaximumScale ( float theMaxScale )

slot

Accessor and mutator for the maximum scale denominator member.

void QgsMapLayer::setMetadataUrl ( const QString & metaUrl )

inline

void QgsMapLayer::setMetadataUrlFormat ( const QString & metaUrlFormat )

inline

void QgsMapLayer::setMetadataUrlType ( const QString & metaUrlType )

inline

void QgsMapLayer::setMinimumScale ( float theMinScale )

slot

Accessor and mutator for the minimum scale denominator member.

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

virtual

Set the visibility of the given sublayer name.

Reimplemented in QgsRasterLayer.

void QgsMapLayer::setTitle ( const QString & title )

inline

void QgsMapLayer::setValid ( bool valid )

protected

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

QString const & QgsMapLayer::source ( ) const

Returns the source for the layer.

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)

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

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.

virtual QDateTime QgsMapLayer::timestamp ( ) const

inlinevirtualslot

Time stamp of data source in the moment when data/metadata were loaded by provider.

Reimplemented in QgsRasterLayer.

const QString& QgsMapLayer::title ( ) const

inline

void QgsMapLayer::toggleScaleBasedVisibility ( bool theVisibilityFlag )

slot

Accessor and mutator for the scale based visilibility flag.

void QgsMapLayer::triggerRepaint ( )

slot

Will advice the map canvas (and any other interested party) that this layer requires to be repainted.

Will emit a repaintRequested() signal.

Note: in 2.6 function moved from vector/raster subclasses to QgsMapLayer

QgsMapLayer::LayerType QgsMapLayer::type ( ) const

Get the type of the layer.

Returns: Integer matching a value in the QgsMapLayer::LayerType enum

QUndoStack * QgsMapLayer::undoStack ( )

Return pointer to layer's undo stack.

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

protected

Write custom properties to project file.

bool QgsMapLayer::writeLayerXML	(	QDomElement &	layerElement,
		QDomDocument &	document,
		QString	relativeBasePath = `QString::null`
	)

stores state in Dom node

Parameters

layerElement	is a Dom element corresponding to ``maplayer'' tag
document	is a the dom document being written
relativeBasePath	base path for relative paths

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

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.

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.

Member Data Documentation

QString QgsMapLayer::mAbstract

protected

Description of the layer.

QString QgsMapLayer::mAttribution

protected

Attribution of the layer.

QString QgsMapLayer::mAttributionUrl

protected

QString QgsMapLayer::mDataSource

protected

data source description string, varies by layer type

QString QgsMapLayer::mDataUrl

protected

DataUrl of the layer.

QString QgsMapLayer::mDataUrlFormat

protected

QgsError QgsMapLayer::mError

protected

Error.

QgsRectangle QgsMapLayer::mExtent

protected

Extent of the layer.

QString QgsMapLayer::mKeywordList

protected

QString QgsMapLayer::mLayerName

protected

Name of the layer - used for display.

QString QgsMapLayer::mLayerOrigName

protected

Original name of the layer.

QString QgsMapLayer::mLegendUrl

protected

WMS legend.

QString QgsMapLayer::mLegendUrlFormat

protected

QString QgsMapLayer::mMetadataUrl

protected

MetadataUrl of the layer.

QString QgsMapLayer::mMetadataUrlFormat

protected

QString QgsMapLayer::mMetadataUrlType

protected

QString QgsMapLayer::mTitle

protected

bool QgsMapLayer::mValid

protected

Indicates if the layer is valid and can be drawn.

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

/tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgsmaplayer.h
/tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgsmaplayer.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation