QgsPluginLayer Class Reference

Base class for plugin layers. More...

#include <qgspluginlayer.h>

Inheritance diagram for QgsPluginLayer:

Public Member Functions
	QgsPluginLayer (const QString &layerType, const QString &layerName=QString())
	~QgsPluginLayer () override
QgsPluginLayer *	clone () const override=0
	Returns a new instance equivalent to this one. More...
QgsDataProvider *	dataProvider () override
	Returns the layer's data provider. More...
const QgsDataProvider *	dataProvider () const override
	Returns the layer's data provider in a const-correct manner. More...
QString	pluginLayerType ()
	Return plugin layer type (the same as used in QgsPluginLayerRegistry) More...
void	setExtent (const QgsRectangle &extent) override
	Set extent of the layer. More...
void	setSource (const QString &source)
	Set source string. More...
Public Member Functions inherited from QgsMapLayer
	QgsMapLayer (QgsMapLayer::LayerType type=VectorLayer, const QString &name=QString(), const QString &source=QString())
	Constructor for QgsMapLayer. More...
	QgsMapLayer (QgsMapLayer const &)=delete
	QgsMapLayer cannot be copied. More...
	~QgsMapLayer () override
QString	abstract () const
	Returns the abstract of the layer used by QGIS Server in GetCapabilities request. More...
QString	attribution () const
	Returns the attribution of the layer used by QGIS Server in GetCapabilities request. More...
QString	attributionUrl () const
	Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request. More...
int	autoRefreshInterval () const
	Returns the auto refresh interval (in milliseconds). More...
QPainter::CompositionMode	blendMode () const
	Returns the current blending mode for a layer. More...
virtual QgsMapLayerRenderer *	createMapRenderer (QgsRenderContext &rendererContext)=0
	Return new instance of QgsMapLayerRenderer that will be used for rendering of given context. More...
QgsCoordinateReferenceSystem	crs () const
	Returns the layer's spatial reference system. More...
QVariant	customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const
	Read a custom property from layer. More...
QStringList	customPropertyKeys () const
	Returns list of all keys within custom properties. More...
QString	dataUrl () const
	Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request. More...
QString	dataUrlFormat () const
	Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More...
virtual QSet< QgsMapLayerDependency >	dependencies () const
	Gets the list of dependencies. More...
virtual QgsError	error () const
	Get current status error. More...
void	exportNamedMetadata (QDomDocument &doc, QString &errorMsg) const
	Export the current metadata of this layer as named metadata in a QDomDocument. More...
virtual void	exportNamedStyle (QDomDocument &doc, QString &errorMsg) const
	Export the properties of this layer as named style in a QDomDocument. More...
virtual void	exportSldStyle (QDomDocument &doc, QString &errorMsg) const
	Export the properties of this layer as SLD style in a QDomDocument. More...
virtual QgsRectangle	extent () const
	Returns the extent of the layer. More...
bool	hasAutoRefreshEnabled () const
	Returns true if auto refresh is enabled for the layer. More...
bool	hasScaleBasedVisibility () const
	Returns whether scale based visibility is enabled for the layer. More...
virtual QString	htmlMetadata () const
	Obtain a formatted HTML string containing assorted metadata for this layer. More...
QString	id () const
	Returns the layer's unique ID, which is used to access this layer from QgsProject. More...
bool	importNamedMetadata (QDomDocument &document, QString &errorMessage)
	Import the metadata of this layer from a QDomDocument. More...
virtual bool	importNamedStyle (QDomDocument &doc, QString &errorMsg)
	Import the properties of this layer from a QDomDocument. More...
virtual bool	isEditable () const
	Returns true if the layer can be edited. More...
bool	isInScaleRange (double scale) const
	Tests whether the layer should be visible at the specified scale. More...
bool	isRefreshOnNotifyEnabled () const
	Returns true if the refresh on provider nofification is enabled. More...
virtual bool	isSpatial () const
	Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. More...
bool	isValid () const
	Return the status of the layer. More...
QString	keywordList () const
	Returns the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
QgsMapLayerLegend *	legend () const
	Can be null. More...
QString	legendUrl () const
	Returns the URL for the layer's legend. More...
QString	legendUrlFormat () const
	Returns the format for a URL based layer legend. More...
QString	loadDefaultMetadata (bool &resultFlag)
	Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users metadata table in their personal qgis.db) More...
virtual QString	loadDefaultStyle (bool &resultFlag)
	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) More...
virtual QString	loadNamedMetadata (const QString &uri, bool &resultFlag)
	Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...
bool	loadNamedMetadataFromDatabase (const QString &db, const QString &uri, QString &qmd)
	Retrieve a named metadata for this layer from a sqlite database. More...
virtual QString	loadNamedStyle (const QString &uri, bool &resultFlag)
	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) More...
virtual bool	loadNamedStyleFromDatabase (const QString &db, const QString &uri, QString &qml)
	Retrieve a named style for this layer from a sqlite database. More...
virtual QString	loadSldStyle (const QString &uri, bool &resultFlag)
	Attempts to style the layer using the formatting from an SLD type file. More...
double	maximumScale () const
	Returns the maximum map scale (i.e. More...
virtual const QgsLayerMetadata &	metadata () const
	Returns a reference to the layer's metadata store. More...
virtual QString	metadataUri () const
	Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...
QString	metadataUrl () const
	Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. More...
QString	metadataUrlFormat () const
	Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. More...
QString	metadataUrlType () const
	Returns the metadata type of the layer used by QGIS Server in GetCapabilities request. More...
double	minimumScale () const
	Returns the minimum map scale (i.e. More...
QString	name () const
	Returns the display name of the layer. More...
QgsMapLayer &	operator= (QgsMapLayer const &)=delete
	QgsMapLayer cannot be copied. More...
QString	publicSource () const
	Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). More...
bool	readLayerXml (const QDomElement &layerElement, const QgsReadWriteContext &context)
	Sets state from Dom document. More...
bool	readOnly () const
	Returns if this layer is read only. More...
virtual bool	readSld (const QDomNode &node, QString &errorMessage)
virtual bool	readStyle (const QDomNode &node, QString &errorMessage, const QgsReadWriteContext &context)
	Read the style for the current layer from the Dom node supplied. More...
virtual bool	readSymbology (const QDomNode &node, QString &errorMessage, const QgsReadWriteContext &context)=0
	Read the symbology for the current layer from the Dom node supplied. More...
QString	refreshOnNotifyMessage () const
	Returns the message that should be notified by the provider to triggerRepaint. More...
virtual void	reload ()
	Synchronises with changes in the datasource. More...
void	removeCustomProperty (const QString &key)
	Remove a custom property from layer. More...
QgsAbstract3DRenderer *	renderer3D () const
	Returns 3D renderer associated with the layer. More...
virtual void	resolveReferences (QgsProject *project)
	Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. More...
virtual QString	saveDefaultMetadata (bool &resultFlag)
	Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...
virtual QString	saveDefaultStyle (bool &resultFlag)
	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) More...
QString	saveNamedMetadata (const QString &uri, bool &resultFlag)
	Save the current metadata of this layer as a named metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...
virtual QString	saveNamedStyle (const QString &uri, bool &resultFlag)
	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) More...
virtual QString	saveSldStyle (const QString &uri, bool &resultFlag) const
	Saves the properties of this layer to an SLD format file. More...
void	setAbstract (const QString &abstract)
	Sets the abstract of the layer used by QGIS Server in GetCapabilities request. More...
void	setAttribution (const QString &attrib)
	Sets the attribution of the layer used by QGIS Server in GetCapabilities request. More...
void	setAttributionUrl (const QString &attribUrl)
	Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request. More...
void	setAutoRefreshEnabled (bool enabled)
	Sets whether auto refresh is enabled for the layer. More...
void	setAutoRefreshInterval (int interval)
	Sets the auto refresh interval (in milliseconds) for the layer. More...
void	setBlendMode (QPainter::CompositionMode blendMode)
	Set the blending mode used for rendering a layer. More...
void	setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
	Sets layer's spatial reference system. More...
void	setCustomProperties (const QgsObjectCustomProperties &properties)
	Set custom properties for layer. More...
void	setCustomProperty (const QString &key, const QVariant &value)
	Set a custom property for layer. More...
void	setDataUrl (const QString &dataUrl)
	Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request. More...
void	setDataUrlFormat (const QString &dataUrlFormat)
	Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More...
void	setKeywordList (const QString &keywords)
	Sets the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
virtual void	setLayerOrder (const QStringList &layers)
	Reorders the previously selected sublayers of this layer from bottom to top. More...
void	setLegend (QgsMapLayerLegend *legend)
	Assign a legend controller to the map layer. More...
void	setLegendUrl (const QString &legendUrl)
	Sets the URL for the layer's legend. More...
void	setLegendUrlFormat (const QString &legendUrlFormat)
	Sets the format for a URL based layer legend. More...
virtual void	setMetadata (const QgsLayerMetadata &metadata)
	Sets the layer's metadata store. More...
void	setMetadataUrl (const QString &metaUrl)
	Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. More...
void	setMetadataUrlFormat (const QString &metaUrlFormat)
	Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. More...
void	setMetadataUrlType (const QString &metaUrlType)
	Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. More...
void	setName (const QString &name)
	Set the display name of the layer. More...
void	setRenderer3D (QgsAbstract3DRenderer *renderer)
	Sets 3D renderer for the layer. More...
void	setShortName (const QString &shortName)
	Sets the short name of the layer used by QGIS Server to identify the layer. More...
virtual void	setSubLayerVisibility (const QString &name, bool visible)
	Set the visibility of the given sublayer name. More...
void	setTitle (const QString &title)
	Sets the title of the layer used by QGIS Server in GetCapabilities request. More...
QString	shortName () const
	Returns the short name of the layer used by QGIS Server to identify the layer. More...
QString	source () const
	Returns the source for the layer. More...
QgsMapLayerStyleManager *	styleManager () const
	Get access to the layer's style manager. More...
virtual QString	styleURI () const
	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) More...
virtual QStringList	subLayers () const
	Returns the sublayers of this layer. More...
virtual QDateTime	timestamp () const
	Time stamp of data source in the moment when data/metadata were loaded by provider. More...
QString	title () const
	Returns the title of the layer used by QGIS Server in GetCapabilities request. More...
QgsMapLayer::LayerType	type () const
	Returns the type of the layer. More...
QUndoStack *	undoStack ()
	Return pointer to layer's undo stack. More...
QUndoStack *	undoStackStyles ()
	Return pointer to layer's style undo stack. More...
bool	writeLayerXml (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const
	Stores state in Dom node. More...
virtual bool	writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context) const
	Write just the style information for the layer into the document. More...
virtual bool	writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context) const =0
	Write the symbology for the layer into the docment provided. More...

Protected Attributes
QgsDataProvider *	mDataProvider
QString	mPluginLayerType
Protected Attributes inherited from QgsMapLayer
QString	mAbstract
	Description of the layer. More...
QString	mAttribution
	Attribution of the layer. More...
QString	mAttributionUrl
QString	mDataSource
	Data source description string, varies by layer type. More...
QString	mDataUrl
	DataUrl of the layer. More...
QString	mDataUrlFormat
QSet< QgsMapLayerDependency >	mDependencies
	List of layers that may modify this layer on modification. More...
QgsError	mError
	Error. More...
QgsRectangle	mExtent
	Extent of the layer. More...
bool	mIsRefreshOnNofifyEnabled = false
QString	mKeywordList
QString	mLayerName
	Name of the layer - used for display. More...
QString	mLegendUrl
	WMS legend. More...
QString	mLegendUrlFormat
QString	mMetadataUrl
	MetadataUrl of the layer. More...
QString	mMetadataUrlFormat
QString	mMetadataUrlType
QString	mRefreshOnNofifyMessage
QString	mShortName
QString	mTitle
bool	mValid = false
	Indicates if the layer is valid and can be drawn. More...

Additional Inherited Members
Public Types inherited from QgsMapLayer
enum	LayerType { VectorLayer, RasterLayer, PluginLayer }
	Types of layers that can be added to a map. More...
enum	PropertyType { Style = 0, Metadata }
	Maplayer has a style and a metadata property. More...
Public Slots inherited from QgsMapLayer
void	emitStyleChanged ()
	Triggers an emission of the styleChanged() signal. More...
virtual bool	setDependencies (const QSet< QgsMapLayerDependency > &layers)
	Sets the list of dependencies. More...
void	setMaximumScale (double scale)
	Sets the maximum map scale (i.e. More...
void	setMinimumScale (double scale)
	Sets the minimum map scale (i.e. More...
void	setRefreshOnNofifyMessage (const QString &message)
	Set the notification message that triggers repaine If refresh on notification is enabled, the notification will triggerRepaint only if the notification message is equal to. More...
void	setRefreshOnNotifyEnabled (bool enabled)
	Set whether provider notification is connected to triggerRepaint. More...
void	setScaleBasedVisibility (const bool enabled)
	Sets whether scale based visibility is enabled for the layer. More...
void	triggerRepaint (bool deferredUpdate=false)
	Will advise the map canvas (and any other interested party) that this layer requires to be repainted. More...
Signals inherited from QgsMapLayer
void	autoRefreshIntervalChanged (int interval)
	Emitted when the auto refresh interval changes. More...
void	blendModeChanged (QPainter::CompositionMode blendMode)
	Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() More...
void	configChanged ()
	Emitted whenever the configuration is changed. More...
void	crsChanged ()
	Emit a signal that layer's CRS has been reset. More...
void	dataChanged ()
	Data of layer changed. More...
void	dependenciesChanged ()
	Emitted when dependencies are changed. More...
void	legendChanged ()
	Signal emitted when legend of the layer has changed. More...
void	metadataChanged ()
	Emitted when the layer's metadata is changed. More...
void	nameChanged ()
	Emitted when the name has been changed. More...
void	recalculateExtents () const
	This is used to send a request that any mapcanvas using this layer update its extents. More...
void	renderer3DChanged ()
	Signal emitted when 3D renderer associated with the layer has changed. More...
void	rendererChanged ()
	Signal emitted when renderer is changed. More...
void	repaintRequested (bool deferredUpdate=false)
	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. More...
void	statusChanged (const QString &status)
	Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) More...
void	styleChanged ()
	Signal emitted whenever a change affects the layer's style. More...
void	willBeDeleted ()
	Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid state: the last chance for other pieces of code for some cleanup if they use the layer. More...
Static Public Member Functions inherited from QgsMapLayer
static QString	extensionPropertyType (PropertyType type)
	Returns the extension of a Property. More...
static QString	formatLayerName (const QString &name)
	A convenience function to capitalize and format a layer name. More...
Protected Member Functions inherited from QgsMapLayer
void	appendError (const QgsErrorMessage &error)
	Add error message. More...
void	clone (QgsMapLayer *layer) const
	Copies attributes like name, short name, ... More...
bool	hasDependencyCycle (const QSet< QgsMapLayerDependency > &layers) const
	Checks whether a new set of dependencies will introduce a cycle. More...
void	readCommonStyle (const QDomElement &layerElement, const QgsReadWriteContext &context)
	Read style data common to all layer types. More...
void	readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith=QString())
	Read custom properties from project file. More...
void	readStyleManager (const QDomNode &layerNode)
	Read style manager's configuration (if any). To be called by subclasses. More...
virtual bool	readXml (const QDomNode &layer_node, const QgsReadWriteContext &context)
	Called by readLayerXML(), used by children to read state specific to them from project files. More...
void	setError (const QgsError &error)
	Set error message. More...
void	setValid (bool valid)
	Set whether layer is valid or not - should be used in constructor. More...
void	writeCommonStyle (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const
	Write style data common to all layer types. More...
void	writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const
	Write custom properties to project file. More...
void	writeStyleManager (QDomNode &layerNode, QDomDocument &doc) const
	Write style manager's configuration (if exists). To be called by subclasses. More...
virtual bool	writeXml (QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context) const
	Called by writeLayerXML(), used by children to write state specific to them to project files. More...
Properties inherited from QgsMapLayer
int	autoRefreshInterval
QgsLayerMetadata	metadata
QString	name

Detailed Description

Base class for plugin layers.

These can be implemented by plugins and registered in QgsPluginLayerRegistry.

In order to be readable from project files, they should set these attributes in layer DOM node: "type" = "plugin" "name" = "your_layer_type"

Definition at line 31 of file qgspluginlayer.h.

Constructor & Destructor Documentation

QgsPluginLayer()

QgsPluginLayer::QgsPluginLayer	(	const QString &	layerType,
		const QString &	layerName = QString()
	)

Definition at line 21 of file qgspluginlayer.cpp.

~QgsPluginLayer()

QgsPluginLayer::~QgsPluginLayer ( )

override

Definition at line 28 of file qgspluginlayer.cpp.

Member Function Documentation

clone()

QgsPluginLayer* QgsPluginLayer::clone ( ) const

overridepure virtual

Returns a new instance equivalent to this one.

Returns

a new layer instance

Since

QGIS 3.0

Implements QgsMapLayer.

dataProvider() [1/2]

QgsDataProvider * QgsPluginLayer::dataProvider ( )

overridevirtual

Returns the layer's data provider.

Reimplemented from QgsMapLayer.

Definition at line 52 of file qgspluginlayer.cpp.

dataProvider() [2/2]

const QgsDataProvider * QgsPluginLayer::dataProvider ( ) const

overridevirtual

Returns the layer's data provider in a const-correct manner.

Note

not available in Python bindings

Reimplemented from QgsMapLayer.

Definition at line 57 of file qgspluginlayer.cpp.

pluginLayerType()

QString QgsPluginLayer::pluginLayerType

(

)

Return plugin layer type (the same as used in QgsPluginLayerRegistry)

Definition at line 36 of file qgspluginlayer.cpp.

setExtent()

void QgsPluginLayer::setExtent ( const QgsRectangle &  extent )

overridevirtual

Set extent of the layer.

Reimplemented from QgsMapLayer.

Definition at line 41 of file qgspluginlayer.cpp.

setSource()

void QgsPluginLayer::setSource

(

const QString &

source

)

Set source string.

This is used for example in layer tree to show tooltip.

Since

QGIS 2.16

Definition at line 47 of file qgspluginlayer.cpp.

Member Data Documentation

mDataProvider

QgsDataProvider* QgsPluginLayer::mDataProvider

protected

Definition at line 63 of file qgspluginlayer.h.

mPluginLayerType

QString QgsPluginLayer::mPluginLayerType

protected

Definition at line 62 of file qgspluginlayer.h.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/core/qgspluginlayer.h
• /tmp/buildd/qgis-3.0.2+14stretch/src/core/qgspluginlayer.cpp