QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | Protected Attributes | List of all members
QgsPluginLayer Class Reference

Base class for plugin layers. More...

#include <qgspluginlayer.h>

Inheritance diagram for QgsPluginLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsPluginLayer (const QString &layerType, const QString &layerName=QString())
 
virtual QgsMapLayerRenderercreateMapRenderer (QgsRenderContext &rendererContext) override
 Return new instance of QgsMapLayerRenderer that will be used for rendering of given context. More...
 
virtual QgsLegendSymbologyList legendSymbologyItems (QSize iconSize)
 return a list of symbology items for the legend (defult implementation returns nothing) 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 &lyrname=QString::null, const QString &source=QString::null)
 Constructor. More...
 
virtual ~QgsMapLayer ()
 Destructor. More...
 
QString abstract () const
 Get the abstract of the layer used by QGIS Server in GetCapabilities request. More...
 
QString attribution () const
 Get the attribution of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
QString attributionUrl () const
 Get the attribution URL of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
QPainter::CompositionMode blendMode () const
 Returns the current blending mode for a layer. More...
 
Q_DECL_DEPRECATED QImagecacheImage ()
 
const QgsCoordinateReferenceSystemcrs () const
 Returns layer's spatial reference system. More...
 
QVariant customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const
 Read a custom property from layer. More...
 
QString dataUrl () const
 Get the DataUrl of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
QString dataUrlFormat () const
 Get the DataUrl format of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
virtual bool draw (QgsRenderContext &rendererContext)
 This is the method that does the actual work of drawing the layer onto a paint device. More...
 
virtual void drawLabels (QgsRenderContext &rendererContext)
 Draw labels. More...
 
virtual QgsError error () const
 Get current status error. More...
 
virtual void exportNamedStyle (QDomDocument &doc, QString &errorMsg)
 Export the properties of this layer as named style in a QDomDocument. More...
 
virtual void exportSldStyle (QDomDocument &doc, QString &errorMsg)
 Export the properties of this layer as SLD style in a QDomDocument. More...
 
virtual QgsRectangle extent ()
 Return the extent of the layer. More...
 
bool hasScaleBasedVisibility () const
 Returns whether scale based visibility is enabled for the layer. More...
 
QString id () const
 Get this layer's unique ID, this ID is used to access this layer from map layer registry. More...
 
virtual bool importNamedStyle (QDomDocument &doc, QString &errorMsg)
 Import the properties of this layer from a QDomDocument. More...
 
virtual bool isEditable () const
 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...
 
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 ()
 Return the status of the layer. More...
 
QString keywordList () const
 Get the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
 
virtual Q_DECL_DEPRECATED QString lastError ()
 
virtual Q_DECL_DEPRECATED QString lastErrorTitle ()
 
QgsMapLayerLegendlegend () const
 Can be null. More...
 
QString legendUrl () const
 
QString legendUrlFormat () const
 
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) More...
 
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) More...
 
virtual bool loadNamedStyleFromDb (const QString &db, const QString &theURI, QString &qml)
 
virtual QString loadSldStyle (const QString &theURI, bool &theResultFlag)
 
double maximumScale () const
 Returns the maximum scale denominator at which the layer is visible. More...
 
QString metadataUrl () const
 Get the metadata URL of the layer used by QGIS Server in GetCapabilities request MetadataUrl is a a link to the detailed, standardized metadata about the data. More...
 
QString metadataUrlFormat () const
 Get the metadata format of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates how the metadata is structured. More...
 
QString metadataUrlType () const
 Get the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. More...
 
double minimumScale () const
 Returns the minimum scale denominator at which the layer is visible. More...
 
QString name () const
 Get the display name of the layer. More...
 
virtual Q_DECL_DEPRECATED void onCacheImageDelete ()
 
QString originalName () const
 Get the original name of the layer. 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 QString &relativeBasePath=QString())
 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)
 Read the style for the current layer from the Dom node supplied. More...
 
virtual bool readSymbology (const QDomNode &node, QString &errorMessage)=0
 Read the symbology for the current layer from the Dom node supplied. More...
 
virtual void reload ()
 Synchronises with changes in the datasource. More...
 
void removeCustomProperty (const QString &key)
 Remove a custom property from layer. More...
 
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) More...
 
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) More...
 
virtual QString saveSldStyle (const QString &theURI, bool &theResultFlag)
 
void setAbstract (const QString &abstract)
 Set the abstract of the layer used by QGIS Server in GetCapabilities request. More...
 
void setAttribution (const QString &attrib)
 Set the attribution of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
void setAttributionUrl (const QString &attribUrl)
 Set the attribution URL of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
void setBlendMode (QPainter::CompositionMode blendMode)
 Set the blending mode used for rendering a layer. More...
 
Q_DECL_DEPRECATED void setCacheImage (QImage *)
 
void setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
 Sets layer's spatial reference system. More...
 
void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for layer. More...
 
void setDataUrl (const QString &dataUrl)
 Set the DataUrl of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
void setDataUrlFormat (const QString &dataUrlFormat)
 Set the DataUrl format of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
void setKeywordList (const QString &keywords)
 Set the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
 
Q_DECL_DEPRECATED void setLayerName (const QString &name)
 Set the display name of the layer. More...
 
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) More...
 
void setLegend (QgsMapLayerLegend *legend)
 Assign a legend controller to the map layer. More...
 
void setLegendUrl (const QString &legendUrl)
 
void setLegendUrlFormat (const QString &legendUrlFormat)
 
void setMetadataUrl (const QString &metaUrl)
 Set the metadata URL of the layer used by QGIS Server in GetCapabilities request MetadataUrl is a a link to the detailed, standardized metadata about the data. More...
 
void setMetadataUrlFormat (const QString &metaUrlFormat)
 Set the metadata format of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates how the metadata is structured. 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 setShortName (const QString &shortName)
 Set the short name of the layer used by QGIS Server to identify the layer. More...
 
virtual void setSubLayerVisibility (const QString &name, bool vis)
 Set the visibility of the given sublayer name. More...
 
void setTitle (const QString &title)
 Set the title of the layer used by QGIS Server in GetCapabilities request. More...
 
QString shortName () const
 Get 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...
 
QgsMapLayerStyleManagerstyleManager () const
 Get access to the layer's style manager. More...
 
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) More...
 
virtual QStringList subLayers () const
 Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS) More...
 
QString title () const
 Get the title of the layer used by QGIS Server in GetCapabilities request. More...
 
QgsMapLayer::LayerType type () const
 Get the type of the layer. More...
 
QUndoStackundoStack ()
 Return pointer to layer's undo stack. More...
 
QUndoStackundoStackStyles ()
 Return pointer to layer's style undo stack. More...
 
bool writeLayerXML (QDomElement &layerElement, QDomDocument &document, const QString &relativeBasePath=QString())
 Stores state in Dom node. More...
 
virtual bool writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage) const
 Write just the style information for the layer into the document. More...
 
virtual bool writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage) const =0
 Write the symbology for the layer into the docment provided. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Protected Attributes

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
 
QgsError mError
 Error. More...
 
QgsRectangle mExtent
 Extent of the layer. More...
 
QString mKeywordList
 
QString mLayerName
 Name of the layer - used for display. More...
 
QString mLayerOrigName
 Original name of the layer. More...
 
QString mLegendUrl
 WMS legend. More...
 
QString mLegendUrlFormat
 
QString mMetadataUrl
 MetadataUrl of the layer. More...
 
QString mMetadataUrlFormat
 
QString mMetadataUrlType
 
QString mShortName
 
QString mTitle
 
bool mValid
 Indicates if the layer is valid and can be drawn. More...
 

Additional Inherited Members

- Public Types inherited from QgsMapLayer
enum  LayerType { VectorLayer, RasterLayer, PluginLayer }
 Layers enum defining the types of layers that can be added to a map. More...
 
- Public Slots inherited from QgsMapLayer
Q_DECL_DEPRECATED void clearCacheImage ()
 Clear cached image. More...
 
void emitStyleChanged ()
 Triggers an emission of the styleChanged() signal. More...
 
virtual void invalidTransformInput ()
 Event handler for when a coordinate transform fails due to bad vertex error. More...
 
virtual QString metadata ()
 Obtain Metadata for this layer. More...
 
void setMaximumScale (double theMaxScale)
 Sets the maximum scale denominator at which the layer will be visible. More...
 
void setMinimumScale (double theMinScale)
 Sets the minimum scale denominator at which the layer will be visible. More...
 
void setScaleBasedVisibility (const bool enabled)
 Sets whether scale based visibility is enabled for the layer. More...
 
virtual QDateTime timestamp () const
 Time stamp of data source in the moment when data/metadata were loaded by provider. More...
 
Q_DECL_DEPRECATED void toggleScaleBasedVisibility (bool theVisibilityFlag)
 Accessor for the scale based visilibility flag. More...
 
void triggerRepaint ()
 Will advice the map canvas (and any other interested party) that this layer requires to be repainted. More...
 
- Signals inherited from QgsMapLayer
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 dataChanged ()
 Data of layer changed. More...
 
Q_DECL_DEPRECATED void drawingProgress (int theProgress, int theTotalSteps)
 
void layerCrsChanged ()
 Emit a signal that layer's CRS has been reset. More...
 
Q_DECL_DEPRECATED void layerNameChanged ()
 Emit a signal that the layer name has been changed. More...
 
void legendChanged ()
 Signal emitted when legend of the layer has changed. More...
 
void nameChanged ()
 Emitted when the name has been changed. More...
 
void recalculateExtents ()
 This is used to send a request that any mapcanvas using this layer update its extents. More...
 
void rendererChanged ()
 Signal emitted when renderer is changed. More...
 
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. More...
 
void screenUpdateRequested ()
 
void statusChanged (const QString &theStatus)
 Emit a signal with status (e.g. More...
 
void styleChanged ()
 Signal emitted whenever a change affects the layer's style. More...
 
- Static Public Member Functions inherited from QgsMapLayer
static QDomDocument asLayerDefinition (const QList< QgsMapLayer *> &layers, const QString &relativeBasePath=QString())
 Returns the given layer as a layer definition document Layer definitions store the data source as well as styling and custom properties. More...
 
static QString capitaliseLayerName (const QString &name)
 A convenience function to (un)capitalise the layer name. More...
 
static QList< QgsMapLayer * > fromLayerDefinition (QDomDocument &document, bool addToRegistry=false, bool addToLegend=false, const QString &relativeBasePath=QString())
 Creates a new layer from a layer defininition document. More...
 
static QList< QgsMapLayer * > fromLayerDefinitionFile (const QString &qlrfile)
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QgsMapLayer
void appendError (const QgsErrorMessage &theMessage)
 Add error message. More...
 
void readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith="")
 Read custom properties from project file. More...
 
void readStyleManager (const QDomNode &layerNode)
 Read style manager's configuration (if any). More...
 
virtual bool readXml (const QDomNode &layer_node)
 Called by readLayerXML(), used by children to read state specific to them from project files. More...
 
void setError (const QgsError &theError)
 Set error message. More...
 
void setValid (bool valid)
 Set whether layer is valid or not - should be used in constructor. 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). More...
 
virtual bool writeXml (QDomNode &layer_node, QDomDocument &document)
 Called by writeLayerXML(), used by children to write state specific to them to project files. More...
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QgsMapLayer
QString name
 Read property of QString layerName. More...
 
- Properties inherited from QObject
 objectName
 

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 30 of file qgspluginlayer.h.

Constructor & Destructor Documentation

◆ QgsPluginLayer()

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

Definition at line 20 of file qgspluginlayer.cpp.

Member Function Documentation

◆ createMapRenderer()

QgsMapLayerRenderer * QgsPluginLayer::createMapRenderer ( QgsRenderContext rendererContext)
overridevirtual

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

The default implementation returns map layer renderer which just calls draw(). This may work, but it is unsafe for multi-threaded rendering because of the run conditions that may happen (e.g. something is changed in the layer while it is being rendered).

Note
added in 2.4

Reimplemented from QgsMapLayer.

Definition at line 73 of file qgspluginlayer.cpp.

◆ legendSymbologyItems()

QgsLegendSymbologyList QgsPluginLayer::legendSymbologyItems ( QSize  iconSize)
virtual

return a list of symbology items for the legend (defult implementation returns nothing)

Note
Added in v2.1

Definition at line 42 of file qgspluginlayer.cpp.

◆ pluginLayerType()

QString QgsPluginLayer::pluginLayerType ( )

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

Definition at line 27 of file qgspluginlayer.cpp.

◆ setExtent()

void QgsPluginLayer::setExtent ( const QgsRectangle extent)
overridevirtual

Set extent of the layer.

Reimplemented from QgsMapLayer.

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

Note
added in 2.16

Definition at line 37 of file qgspluginlayer.cpp.

Member Data Documentation

◆ mPluginLayerType

QString QgsPluginLayer::mPluginLayerType
protected

Definition at line 65 of file qgspluginlayer.h.


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