QGIS API Documentation  2.99.0-Master (f867b65)
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
QgsMapLayer Class Referenceabstract

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

#include <qgsmaplayer.h>

Inheritance diagram for QgsMapLayer:
Inheritance graph
[legend]

Public Types

enum  LayerType { VectorLayer, RasterLayer, PluginLayer }
 Types of layers that can be added to a map. More...
 

Public Slots

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

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

Public Member Functions

 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...
 
virtual ~QgsMapLayer ()
 
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 QgsMapLayerclone () const =0
 Returns a new instance equivalent to this one except for the id which is still unique. More...
 
virtual QgsMapLayerRenderercreateMapRenderer (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...
 
virtual QgsDataProviderdataProvider ()
 Returns the layer's data provider. More...
 
virtual const QgsDataProviderdataProvider () const
 Returns the layer's data provider in a const-correct manner. 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< QgsMapLayerDependencydependencies () const
 Gets the list of dependencies. More...
 
virtual QgsError error () const
 Get current status error. 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...
 
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...
 
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...
 
QgsMapLayerLegendlegend () 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...
 
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 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 QgsLayerMetadatametadata () const
 Returns a reference to the layer's metadata store. 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...
 
QgsMapLayeroperator= (QgsMapLayer const &)=delete
 QgsMapLayer cannot be copied. More...
 
QString originalName () const
 Returns 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 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...
 
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 &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...
 
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 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...
 
QgsMapLayerStyleManagerstyleManager () 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...
 

Static Public Member Functions

static QString capitalizeLayerName (const QString &name)
 A convenience function to (un)capitalize the layer name. More...
 

Protected Member Functions

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 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...
 
virtual void setExtent (const QgsRectangle &rect)
 Set the extent. 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). 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...
 

Protected Attributes

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< QgsMapLayerDependencymDependencies
 List of layers that may modify this layer on modification. More...
 
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...
 

Properties

int autoRefreshInterval
 
QgsLayerMetadata metadata
 
QString name
 

Detailed Description

Base class for all map layer types.

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

Definition at line 54 of file qgsmaplayer.h.

Member Enumeration Documentation

◆ LayerType

Types of layers that can be added to a map.

Enumerator
VectorLayer 
RasterLayer 
PluginLayer 

Definition at line 92 of file qgsmaplayer.h.

Constructor & Destructor Documentation

◆ QgsMapLayer() [1/2]

QgsMapLayer::QgsMapLayer ( QgsMapLayer::LayerType  type = VectorLayer,
const QString &  name = QString(),
const QString &  source = QString() 
)

Constructor for QgsMapLayer.

Parameters
typelayer type
namedisplay name for the layer
sourcedatasource of layer

Definition at line 52 of file qgsmaplayer.cpp.

◆ ~QgsMapLayer()

QgsMapLayer::~QgsMapLayer ( )
virtual

Definition at line 90 of file qgsmaplayer.cpp.

◆ QgsMapLayer() [2/2]

QgsMapLayer::QgsMapLayer ( QgsMapLayer const &  )
delete

QgsMapLayer cannot be copied.

Member Function Documentation

◆ abstract()

QString QgsMapLayer::abstract ( ) const
inline

Returns the abstract of the layer used by QGIS Server in GetCapabilities request.

Returns
the layer abstract
See also
setAbstract()

Definition at line 193 of file qgsmaplayer.h.

◆ appendError()

void QgsMapLayer::appendError ( const QgsErrorMessage error)
inlineprotected

Add error message.

Definition at line 980 of file qgsmaplayer.h.

◆ attribution()

QString QgsMapLayer::attribution ( ) const
inline

Returns the attribution of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

Returns
the layer attribution
See also
setAttribution()

Definition at line 259 of file qgsmaplayer.h.

◆ attributionUrl()

QString QgsMapLayer::attributionUrl ( ) const
inline

Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

Returns
the layer attribution URL
See also
setAttributionUrl()

Definition at line 275 of file qgsmaplayer.h.

◆ autoRefreshInterval()

int QgsMapLayer::autoRefreshInterval ( ) const

Returns the auto refresh interval (in milliseconds).

Note that auto refresh is only active when hasAutoRefreshEnabled() is true.

Since
QGIS 3.0
See also
autoRefreshEnabled()
setAutoRefreshInterval()

◆ autoRefreshIntervalChanged

void QgsMapLayer::autoRefreshIntervalChanged ( int  interval)
signal

Emitted when the auto refresh interval changes.

See also
setAutoRefreshInterval()
Since
QGIS 3.0

◆ blendMode()

QPainter::CompositionMode QgsMapLayer::blendMode ( ) const

Returns the current blending mode for a layer.

See also
setBlendMode()

Definition at line 196 of file qgsmaplayer.cpp.

◆ blendModeChanged

void QgsMapLayer::blendModeChanged ( QPainter::CompositionMode  blendMode)
signal

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

◆ capitalizeLayerName()

QString QgsMapLayer::capitalizeLayerName ( const QString &  name)
static

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

Definition at line 996 of file qgsmaplayer.cpp.

◆ clone() [1/2]

virtual QgsMapLayer* QgsMapLayer::clone ( ) const
pure virtual

Returns a new instance equivalent to this one except for the id which is still unique.

Returns
a new layer instance
Since
QGIS 3.0

Implemented in QgsVectorLayer, QgsRasterLayer, and QgsPluginLayer.

◆ clone() [2/2]

void QgsMapLayer::clone ( QgsMapLayer layer) const
protected

Copies attributes like name, short name, ...

into another layer.

Parameters
layerThe copy recipient
Since
QGIS 3.0

Definition at line 96 of file qgsmaplayer.cpp.

◆ configChanged

void QgsMapLayer::configChanged ( )
signal

Emitted whenever the configuration is changed.

The project listens to this signal to be marked as dirty.

◆ createMapRenderer()

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

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

Since
QGIS 2.4

Implemented in QgsVectorLayer, and QgsRasterLayer.

◆ crs()

QgsCoordinateReferenceSystem QgsMapLayer::crs ( ) const

Returns the layer's spatial reference system.

Since
QGIS 1.4

Definition at line 977 of file qgsmaplayer.cpp.

◆ crsChanged

void QgsMapLayer::crsChanged ( )
signal

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

◆ customProperty()

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.

See also
setCustomProperty()

Definition at line 1622 of file qgsmaplayer.cpp.

◆ customPropertyKeys()

QStringList QgsMapLayer::customPropertyKeys ( ) const

Returns list of all keys within custom properties.

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

See also
customProperty()
Since
QGIS 3.0

Definition at line 1607 of file qgsmaplayer.cpp.

◆ dataChanged

void QgsMapLayer::dataChanged ( )
signal

Data of layer changed.

◆ dataProvider() [1/2]

QgsDataProvider * QgsMapLayer::dataProvider ( )
virtual

Returns the layer's data provider.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 156 of file qgsmaplayer.cpp.

◆ dataProvider() [2/2]

const QgsDataProvider * QgsMapLayer::dataProvider ( ) const
virtual

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

Note
not available in Python bindings

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 161 of file qgsmaplayer.cpp.

◆ dataUrl()

QString QgsMapLayer::dataUrl ( ) const
inline

Returns 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.

Returns
the layer DataUrl
See also
setDataUrl()

Definition at line 225 of file qgsmaplayer.h.

◆ dataUrlFormat()

QString QgsMapLayer::dataUrlFormat ( ) const
inline

Returns 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.

Returns
the layer DataUrl format
See also
setDataUrlFormat()

Definition at line 241 of file qgsmaplayer.h.

◆ dependencies()

QSet< QgsMapLayerDependency > QgsMapLayer::dependencies ( ) const
virtual

Gets the list of dependencies.

This includes data dependencies set by the user (

See also
setDataDependencies) as well as dependencies given by the provider
Returns
a set of QgsMapLayerDependency
Since
QGIS 3.0

Reimplemented in QgsVectorLayer.

Definition at line 1760 of file qgsmaplayer.cpp.

◆ dependenciesChanged

void QgsMapLayer::dependenciesChanged ( )
signal

Emitted when dependencies are changed.

◆ emitStyleChanged

void QgsMapLayer::emitStyleChanged ( )
slot

Triggers an emission of the styleChanged() signal.

Since
QGIS 2.16

Definition at line 1700 of file qgsmaplayer.cpp.

◆ error()

QgsError QgsMapLayer::error ( ) const
virtual

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

◆ exportNamedStyle()

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

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

Parameters
docthe target QDomDocument
errorMsgthis QString will be initialized on error during the execution of writeSymbology

Definition at line 1217 of file qgsmaplayer.cpp.

◆ exportSldStyle()

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

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

Parameters
docthe target QDomDocument
errorMsgthis QString will be initialized on error during the execution of writeSymbology

Definition at line 1408 of file qgsmaplayer.cpp.

◆ extent()

QgsRectangle QgsMapLayer::extent ( ) const
virtual

Returns the extent of the layer.

Reimplemented in QgsVectorLayer.

Definition at line 184 of file qgsmaplayer.cpp.

◆ hasAutoRefreshEnabled()

bool QgsMapLayer::hasAutoRefreshEnabled ( ) const

Returns true if auto refresh is enabled for the layer.

Since
QGIS 3.0
See also
autoRefreshInterval()
setAutoRefreshEnabled()

Definition at line 894 of file qgsmaplayer.cpp.

◆ hasDependencyCycle()

bool QgsMapLayer::hasDependencyCycle ( const QSet< QgsMapLayerDependency > &  layers) const
protected

Checks whether a new set of dependencies will introduce a cycle.

Definition at line 1749 of file qgsmaplayer.cpp.

◆ hasScaleBasedVisibility()

bool QgsMapLayer::hasScaleBasedVisibility ( ) const

Returns whether scale based visibility is enabled for the layer.

Returns
true if scale based visibility is enabled
See also
minimumScale()
maximumScale()
setScaleBasedVisibility()
isInScaleRange()

Definition at line 889 of file qgsmaplayer.cpp.

◆ htmlMetadata()

QString QgsMapLayer::htmlMetadata ( ) const
virtual

Obtain a formatted HTML string containing assorted metadata for this layer.

Since
QGIS 3.0

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 1690 of file qgsmaplayer.cpp.

◆ id()

QString QgsMapLayer::id ( ) const

Returns the layer's unique ID, which is used to access this layer from QgsProject.

Definition at line 133 of file qgsmaplayer.cpp.

◆ importNamedStyle()

bool QgsMapLayer::importNamedStyle ( QDomDocument &  doc,
QString &  errorMsg 
)
virtual

Import the properties of this layer from a QDomDocument.

Parameters
docsource QDomDocument
errorMsgthis QString will be initialized on error during the execution of readSymbology
Returns
true on success
Since
QGIS 2.8

Definition at line 1169 of file qgsmaplayer.cpp.

◆ isEditable()

bool QgsMapLayer::isEditable ( ) const
virtual

Returns true if the layer can be edited.

Reimplemented in QgsVectorLayer.

Definition at line 1639 of file qgsmaplayer.cpp.

◆ isInScaleRange()

bool QgsMapLayer::isInScaleRange ( double  scale) const

Tests whether the layer should be visible at the specified scale.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

Returns
true if the layer is visible at the given scale.
Since
QGIS 2.16
See also
minimumScale()
maximumScale()
hasScaleBasedVisibility()

Definition at line 882 of file qgsmaplayer.cpp.

◆ isSpatial()

bool QgsMapLayer::isSpatial ( ) const
virtual

Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it.

Since
QGIS 2.16

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 1644 of file qgsmaplayer.cpp.

◆ isValid()

bool QgsMapLayer::isValid ( ) const

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 initialized.

Returns
true if the layer is valid and can be accessed

Definition at line 869 of file qgsmaplayer.cpp.

◆ keywordList()

QString QgsMapLayer::keywordList ( ) const
inline

Returns the keyword list of the layer used by QGIS Server in GetCapabilities request.

Returns
the layer keyword list
See also
setKeywordList()

Definition at line 207 of file qgsmaplayer.h.

◆ legend()

QgsMapLayerLegend * QgsMapLayer::legend ( ) const

Can be null.

Since
QGIS 2.6

Definition at line 1668 of file qgsmaplayer.cpp.

◆ legendChanged

void QgsMapLayer::legendChanged ( )
signal

Signal emitted when legend of the layer has changed.

Since
QGIS 2.6

◆ legendUrl()

QString QgsMapLayer::legendUrl ( ) const
inline

Returns the URL for the layer's legend.

Definition at line 647 of file qgsmaplayer.h.

◆ legendUrlFormat()

QString QgsMapLayer::legendUrlFormat ( ) const
inline

Returns the format for a URL based layer legend.

Definition at line 657 of file qgsmaplayer.h.

◆ loadDefaultStyle()

QString QgsMapLayer::loadDefaultStyle ( bool &  resultFlag)
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
resultFlaga 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 1063 of file qgsmaplayer.cpp.

◆ loadNamedStyle()

QString QgsMapLayer::loadNamedStyle ( const QString &  uri,
bool &  resultFlag 
)
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
uri- 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.
resultFlaga 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 1113 of file qgsmaplayer.cpp.

◆ loadNamedStyleFromDatabase()

bool QgsMapLayer::loadNamedStyleFromDatabase ( const QString &  db,
const QString &  uri,
QString &  qml 
)
virtual

Retrieve a named style for this layer from a sqlite database.

Parameters
dbpath to sqlite database
uriuri for table
qmlwill be set to QML style content from database
Returns
true if style was successfully loaded

Definition at line 1068 of file qgsmaplayer.cpp.

◆ loadSldStyle()

QString QgsMapLayer::loadSldStyle ( const QString &  uri,
bool &  resultFlag 
)
virtual

Attempts to style the layer using the formatting from an SLD type file.

Parameters
uriuri of source SLD file
resultFlaga reference to a flag that will be set to false if the SLD file could not be loaded
Returns
a string with any status or error messages
See also
saveSldStyle()

Definition at line 1517 of file qgsmaplayer.cpp.

◆ maximumScale()

double QgsMapLayer::maximumScale ( ) const

Returns the maximum map scale (i.e.

most "zoomed in" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.

Note
Scale based visibility is only used if setScaleBasedVisibility() is set to true.
See also
setMaximumScale()
minimumScale()
hasScaleBasedVisibility()
isInScaleRange()

Definition at line 938 of file qgsmaplayer.cpp.

◆ metadata()

virtual const QgsLayerMetadata& QgsMapLayer::metadata ( ) const
virtual

Returns a reference to the layer's metadata store.

Since
QGIS 3.0
See also
setMetadata()
metadataChanged()

◆ metadataChanged

void QgsMapLayer::metadataChanged ( )
signal

Emitted when the layer's metadata is changed.

See also
setMetadata()
metadata()
Since
QGIS 3.0

◆ metadataUrl()

QString QgsMapLayer::metadataUrl ( ) const
inline

Returns 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.

Returns
the layer metadata URL
See also
setMetadataUrl()

Definition at line 293 of file qgsmaplayer.h.

◆ metadataUrlFormat()

QString QgsMapLayer::metadataUrlFormat ( ) const
inline

Returns the metadata format of the layer used by QGIS Server in GetCapabilities request.

MetadataUrlType indicates how the metadata is structured.

Returns
the layer metadata format
See also
setMetadataUrlFormat()

Definition at line 325 of file qgsmaplayer.h.

◆ metadataUrlType()

QString QgsMapLayer::metadataUrlType ( ) const
inline

Returns the metadata type of the layer used by QGIS Server in GetCapabilities request.

MetadataUrlType indicates the standard to which the metadata complies.

Returns
the layer metadata type
See also
setMetadataUrlType()

Definition at line 309 of file qgsmaplayer.h.

◆ minimumScale()

double QgsMapLayer::minimumScale ( ) const

Returns the minimum map scale (i.e.

most "zoomed out" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.

Note
Scale based visibility is only used if setScaleBasedVisibility() is set to true.
See also
setMinimumScale()
maximumScale()
hasScaleBasedVisibility()
isInScaleRange()

Definition at line 954 of file qgsmaplayer.cpp.

◆ name()

QString QgsMapLayer::name ( ) const

Returns the display name of the layer.

Returns
the layer name
See also
setName()

◆ nameChanged

void QgsMapLayer::nameChanged ( )
signal

Emitted when the name has been changed.

Since
QGIS 2.16

◆ operator=()

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

QgsMapLayer cannot be copied.

◆ originalName()

QString QgsMapLayer::originalName ( ) const

Returns the original name of the layer.

Definition at line 166 of file qgsmaplayer.cpp.

◆ publicSource()

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.

See also
source()

Definition at line 171 of file qgsmaplayer.cpp.

◆ readCustomProperties()

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

Read custom properties from project file.

Parameters
layerNodenote to read from
keyStartsWithreads only properties starting with the specified string (or all if the string is empty)

Definition at line 840 of file qgsmaplayer.cpp.

◆ readLayerXml()

bool QgsMapLayer::readLayerXml ( const QDomElement &  layerElement,
const QgsReadWriteContext context 
)

Sets state from Dom document.

Parameters
layerElementThe Dom element corresponding to ``maplayer'' tag
contextwriting context (e.g. for conversion between relative and absolute paths)
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 202 of file qgsmaplayer.cpp.

◆ readOnly()

bool QgsMapLayer::readOnly ( ) const
inline

Returns if this layer is read only.

Definition at line 339 of file qgsmaplayer.h.

◆ readSld()

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

Reimplemented in QgsVectorLayer.

Definition at line 588 of file qgsmaplayer.h.

◆ readStyle()

bool QgsMapLayer::readStyle ( const QDomNode &  node,
QString &  errorMessage,
const QgsReadWriteContext context 
)
virtual

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

Parameters
nodenode that will contain the style definition for this layer.
errorMessagereference to string that will be updated with any error messages
contextreading context (used for transform from relative to absolute paths)
Returns
true in case of success.
Since
QGIS 2.16
Note
To be implemented in subclasses. Default implementation does nothing and returns false.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 1578 of file qgsmaplayer.cpp.

◆ readStyleManager()

void QgsMapLayer::readStyleManager ( const QDomNode &  layerNode)
protected

Read style manager's configuration (if any). To be called by subclasses.

Definition at line 850 of file qgsmaplayer.cpp.

◆ readSymbology()

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

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

Parameters
nodenode that will contain the symbology definition for this layer.
errorMessagereference to string that will be updated with any error messages
contextreading context (used for transform from relative to absolute paths)
Returns
true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

◆ readXml()

bool QgsMapLayer::readXml ( const QDomNode &  layer_node,
const QgsReadWriteContext context 
)
protectedvirtual

Called by readLayerXML(), used by children to read state specific to them from project files.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 560 of file qgsmaplayer.cpp.

◆ recalculateExtents

void QgsMapLayer::recalculateExtents ( ) const
signal

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

◆ reload()

virtual void QgsMapLayer::reload ( )
inlinevirtual

Synchronises with changes in the datasource.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 343 of file qgsmaplayer.h.

◆ removeCustomProperty()

void QgsMapLayer::removeCustomProperty ( const QString &  key)

Remove a custom property from layer.

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

See also
setCustomProperty()

Definition at line 1627 of file qgsmaplayer.cpp.

◆ rendererChanged

void QgsMapLayer::rendererChanged ( )
signal

Signal emitted when renderer is changed.

See also
styleChanged()

◆ repaintRequested

void QgsMapLayer::repaintRequested ( bool  deferredUpdate = false)
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.

If deferredUpdate is true then the layer will only be repainted when the canvas is next re-rendered, and will not trigger any canvas redraws itself.

◆ saveDefaultStyle()

QString QgsMapLayer::saveDefaultStyle ( bool &  resultFlag)
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
resultFlaga 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 1258 of file qgsmaplayer.cpp.

◆ saveNamedStyle()

QString QgsMapLayer::saveNamedStyle ( const QString &  uri,
bool &  resultFlag 
)
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
urithe 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.
resultFlaga 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 1263 of file qgsmaplayer.cpp.

◆ saveSldStyle()

QString QgsMapLayer::saveSldStyle ( const QString &  uri,
bool &  resultFlag 
) const
virtual

Saves the properties of this layer to an SLD format file.

Parameters
uriuri of destination for exported SLD file.
resultFlaga reference to a flag that will be set to false if the SLD file could not be generated
Returns
a string with any status or error messages
See also
loadSldStyle()

Definition at line 1452 of file qgsmaplayer.cpp.

◆ setAbstract()

void QgsMapLayer::setAbstract ( const QString &  abstract)
inline

Sets the abstract of the layer used by QGIS Server in GetCapabilities request.

Returns
the layer abstract
See also
abstract()

Definition at line 186 of file qgsmaplayer.h.

◆ setAttribution()

void QgsMapLayer::setAttribution ( const QString &  attrib)
inline

Sets the attribution of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

Returns
the layer attribution
See also
attribution()

Definition at line 251 of file qgsmaplayer.h.

◆ setAttributionUrl()

void QgsMapLayer::setAttributionUrl ( const QString &  attribUrl)
inline

Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

Returns
the layer attribution URL
See also
attributionUrl()

Definition at line 267 of file qgsmaplayer.h.

◆ setAutoRefreshEnabled()

void QgsMapLayer::setAutoRefreshEnabled ( bool  enabled)

Sets whether auto refresh is enabled for the layer.

Since
QGIS 3.0
See also
hasAutoRefreshEnabled()
setAutoRefreshInterval()

Definition at line 918 of file qgsmaplayer.cpp.

◆ setAutoRefreshInterval()

void QgsMapLayer::setAutoRefreshInterval ( int  interval)

Sets the auto refresh interval (in milliseconds) for the layer.

This will cause the layer to be automatically redrawn on a matching interval. Note that auto refresh must be enabled by calling setAutoRefreshEnabled().

Note that auto refresh triggers deferred repaints of the layer. Any map canvas must be refreshed separately in order to view the refreshed layer.

Since
QGIS 3.0
See also
autoRefreshInterval()
setAutoRefreshEnabled()

Definition at line 904 of file qgsmaplayer.cpp.

◆ setBlendMode()

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

Set the blending mode used for rendering a layer.

Parameters
blendModenew blending mode
See also
blendMode()

Definition at line 189 of file qgsmaplayer.cpp.

◆ setCrs()

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

Sets layer's spatial reference system.

Definition at line 982 of file qgsmaplayer.cpp.

◆ setCustomProperties()

void QgsMapLayer::setCustomProperties ( const QgsObjectCustomProperties properties)

Set custom properties for layer.

Current properties are dropped.

Since
QGIS 3.0

Definition at line 1617 of file qgsmaplayer.cpp.

◆ setCustomProperty()

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.

See also
customProperty()
removeCustomProperty()

Definition at line 1612 of file qgsmaplayer.cpp.

◆ setDataUrl()

void QgsMapLayer::setDataUrl ( const QString &  dataUrl)
inline

Sets 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.

Returns
the layer DataUrl
See also
dataUrl()

Definition at line 217 of file qgsmaplayer.h.

◆ setDataUrlFormat()

void QgsMapLayer::setDataUrlFormat ( const QString &  dataUrlFormat)
inline

Sets 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.

Returns
the layer DataUrl format
See also
dataUrlFormat()

Definition at line 233 of file qgsmaplayer.h.

◆ setDependencies

bool QgsMapLayer::setDependencies ( const QSet< QgsMapLayerDependency > &  layers)
virtualslot

Sets the list of dependencies.

See also
dependencies()
Parameters
layersset of QgsMapLayerDependency. Only user-defined dependencies will be added
Returns
false if a dependency cycle has been detected
Since
QGIS 3.0

Reimplemented in QgsVectorLayer.

Definition at line 1765 of file qgsmaplayer.cpp.

◆ setError()

void QgsMapLayer::setError ( const QgsError error)
inlineprotected

Set error message.

Definition at line 982 of file qgsmaplayer.h.

◆ setExtent()

void QgsMapLayer::setExtent ( const QgsRectangle rect)
protectedvirtual

Set the extent.

Reimplemented in QgsVectorLayer, and QgsPluginLayer.

Definition at line 1705 of file qgsmaplayer.cpp.

◆ setKeywordList()

void QgsMapLayer::setKeywordList ( const QString &  keywords)
inline

Sets the keyword list of the layer used by QGIS Server in GetCapabilities request.

Returns
the layer keyword list
See also
keywordList()

Definition at line 200 of file qgsmaplayer.h.

◆ setLayerOrder()

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

◆ setLegend()

void QgsMapLayer::setLegend ( QgsMapLayerLegend legend)

Assign a legend controller to the map layer.

The object will be responsible for providing legend items.

Parameters
legendTakes ownership of the object. Can be null pointer
Since
QGIS 2.6

Definition at line 1654 of file qgsmaplayer.cpp.

◆ setLegendUrl()

void QgsMapLayer::setLegendUrl ( const QString &  legendUrl)
inline

Sets the URL for the layer's legend.

Definition at line 642 of file qgsmaplayer.h.

◆ setLegendUrlFormat()

void QgsMapLayer::setLegendUrlFormat ( const QString &  legendUrlFormat)
inline

Sets the format for a URL based layer legend.

Definition at line 652 of file qgsmaplayer.h.

◆ setMaximumScale

void QgsMapLayer::setMaximumScale ( double  scale)
slot

Sets the maximum map scale (i.e.

most "zoomed in" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.

Note
Scale based visibility is only used if setScaleBasedVisibility() is set to true.
See also
maximumScale()
setMinimumScale()
setScaleBasedVisibility()

Definition at line 933 of file qgsmaplayer.cpp.

◆ setMetadata()

void QgsMapLayer::setMetadata ( const QgsLayerMetadata metadata)
virtual

Sets the layer's metadata store.

Since
QGIS 3.0
See also
metadata()
metadataChanged()

Definition at line 1683 of file qgsmaplayer.cpp.

◆ setMetadataUrl()

void QgsMapLayer::setMetadataUrl ( const QString &  metaUrl)
inline

Sets 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.

Returns
the layer metadata URL
See also
metadataUrl()

Definition at line 285 of file qgsmaplayer.h.

◆ setMetadataUrlFormat()

void QgsMapLayer::setMetadataUrlFormat ( const QString &  metaUrlFormat)
inline

Sets the metadata format of the layer used by QGIS Server in GetCapabilities request.

MetadataUrlType indicates how the metadata is structured.

Returns
the layer metadata format
See also
metadataUrlFormat()

Definition at line 317 of file qgsmaplayer.h.

◆ setMetadataUrlType()

void QgsMapLayer::setMetadataUrlType ( const QString &  metaUrlType)
inline

Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies.

Returns
the layer metadata type
See also
metadataUrlType()

Definition at line 301 of file qgsmaplayer.h.

◆ setMinimumScale

void QgsMapLayer::setMinimumScale ( double  scale)
slot

Sets the minimum map scale (i.e.

most "zoomed out" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.

Note
Scale based visibility is only used if setScaleBasedVisibility() is set to true.
See also
minimumScale()
setMaximumScale()
setScaleBasedVisibility()

Definition at line 944 of file qgsmaplayer.cpp.

◆ setName()

void QgsMapLayer::setName ( const QString &  name)

Set the display name of the layer.

Since
QGIS 2.16
See also
name()

Definition at line 138 of file qgsmaplayer.cpp.

◆ setScaleBasedVisibility

void QgsMapLayer::setScaleBasedVisibility ( const bool  enabled)
slot

Sets whether scale based visibility is enabled for the layer.

Parameters
enabledset to true to enable scale based visibility
See also
setMinimumScale
setMaximumScale
scaleBasedVisibility

Definition at line 949 of file qgsmaplayer.cpp.

◆ setShortName()

void QgsMapLayer::setShortName ( const QString &  shortName)
inline

Sets the short name of the layer used by QGIS Server to identify the layer.

Returns
the layer short name
See also
shortName()

Definition at line 160 of file qgsmaplayer.h.

◆ setSubLayerVisibility()

void QgsMapLayer::setSubLayerVisibility ( const QString &  name,
bool  visible 
)
virtual

Set the visibility of the given sublayer name.

Parameters
namesublayer name
visiblesublayer visibility

Reimplemented in QgsRasterLayer.

Definition at line 970 of file qgsmaplayer.cpp.

◆ setTitle()

void QgsMapLayer::setTitle ( const QString &  title)
inline

Sets the title of the layer used by QGIS Server in GetCapabilities request.

See also
title()

Definition at line 172 of file qgsmaplayer.h.

◆ setValid()

void QgsMapLayer::setValid ( bool  valid)
protected

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

Definition at line 1649 of file qgsmaplayer.cpp.

◆ shortName()

QString QgsMapLayer::shortName ( ) const
inline

Returns the short name of the layer used by QGIS Server to identify the layer.

See also
setShortName()

Definition at line 166 of file qgsmaplayer.h.

◆ source()

QString QgsMapLayer::source ( ) const

Returns the source for the layer.

This source may contain usernames, passwords and other sensitive information.

See also
publicSource()

Definition at line 179 of file qgsmaplayer.cpp.

◆ statusChanged

void QgsMapLayer::statusChanged ( const QString &  status)
signal

Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar)

◆ styleChanged

void QgsMapLayer::styleChanged ( )
signal

Signal emitted whenever a change affects the layer's style.

Ie this may be triggered by renderer changes, label style changes, or other style changes such as blend mode or layer opacity changes.

Since
QGIS 2.16
See also
rendererChanged()

◆ styleManager()

QgsMapLayerStyleManager * QgsMapLayer::styleManager ( ) const

Get access to the layer's style manager.

Style manager allows switching between multiple styles.

Since
QGIS 2.8

Definition at line 1673 of file qgsmaplayer.cpp.

◆ styleURI()

QString QgsMapLayer::styleURI ( ) const
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 ();

Definition at line 1011 of file qgsmaplayer.cpp.

◆ subLayers()

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

◆ timestamp()

QDateTime QgsMapLayer::timestamp ( ) const
virtual

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

Reimplemented in QgsRasterLayer.

Definition at line 1695 of file qgsmaplayer.cpp.

◆ title()

QString QgsMapLayer::title ( ) const
inline

Returns the title of the layer used by QGIS Server in GetCapabilities request.

Returns
the layer title
See also
setTitle()

Definition at line 179 of file qgsmaplayer.h.

◆ triggerRepaint

void QgsMapLayer::triggerRepaint ( bool  deferredUpdate = false)
slot

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

Will emit a repaintRequested() signal. If deferredUpdate is true then the layer will only be repainted when the canvas is next re-rendered, and will not trigger any canvas redraws itself.

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

Definition at line 1678 of file qgsmaplayer.cpp.

◆ type()

QgsMapLayer::LayerType QgsMapLayer::type ( ) const

Returns the type of the layer.

Definition at line 128 of file qgsmaplayer.cpp.

◆ undoStack()

QUndoStack * QgsMapLayer::undoStack ( )

Return pointer to layer's undo stack.

Definition at line 1596 of file qgsmaplayer.cpp.

◆ undoStackStyles()

QUndoStack * QgsMapLayer::undoStackStyles ( )

Return pointer to layer's style undo stack.

Since
QGIS 2.16

Definition at line 1601 of file qgsmaplayer.cpp.

◆ willBeDeleted

void QgsMapLayer::willBeDeleted ( )
signal

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.

Since
QGIS 3.0

◆ writeCustomProperties()

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

Write custom properties to project file.

Definition at line 845 of file qgsmaplayer.cpp.

◆ writeLayerXml()

bool QgsMapLayer::writeLayerXml ( QDomElement &  layerElement,
QDomDocument &  document,
const QgsReadWriteContext context 
) const

Stores state in Dom node.

Parameters
layerElementis a Dom element corresponding to ``maplayer'' tag
documentis a the dom document being written
contextreading context (e.g. for conversion between relative and absolute 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

Definition at line 571 of file qgsmaplayer.cpp.

◆ writeStyle()

bool QgsMapLayer::writeStyle ( QDomNode &  node,
QDomDocument &  doc,
QString &  errorMessage,
const QgsReadWriteContext context 
) const
virtual

Write just the style information for the layer into the document.

Parameters
nodethe node that will have the style element added to it.
docthe document that will have the QDomNode added.
errorMessagereference to string that will be updated with any error messages
contextwriting context (used for transform from absolute to relative paths)
Returns
true in case of success.
Since
QGIS 2.16
Note
To be implemented in subclasses. Default implementation does nothing and returns false.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 1586 of file qgsmaplayer.cpp.

◆ writeStyleManager()

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

Write style manager's configuration (if exists). To be called by subclasses.

Definition at line 859 of file qgsmaplayer.cpp.

◆ writeSymbology()

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

Write the symbology for the layer into the docment provided.

Parameters
nodethe node that will have the style element added to it.
docthe document that will have the QDomNode added.
errorMessagereference to string that will be updated with any error messages
contextwriting context (used for transform from absolute to relative paths)
Returns
true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

◆ writeXml()

bool QgsMapLayer::writeXml ( QDomNode &  layer_node,
QDomDocument &  document,
const QgsReadWriteContext context 
) const
protectedvirtual

Called by writeLayerXML(), used by children to write state specific to them to project files.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 829 of file qgsmaplayer.cpp.

Member Data Documentation

◆ mAbstract

QString QgsMapLayer::mAbstract
protected

Description of the layer.

Definition at line 1004 of file qgsmaplayer.h.

◆ mAttribution

QString QgsMapLayer::mAttribution
protected

Attribution of the layer.

Definition at line 1012 of file qgsmaplayer.h.

◆ mAttributionUrl

QString QgsMapLayer::mAttributionUrl
protected

Definition at line 1013 of file qgsmaplayer.h.

◆ mDataSource

QString QgsMapLayer::mDataSource
protected

Data source description string, varies by layer type.

Definition at line 991 of file qgsmaplayer.h.

◆ mDataUrl

QString QgsMapLayer::mDataUrl
protected

DataUrl of the layer.

Definition at line 1008 of file qgsmaplayer.h.

◆ mDataUrlFormat

QString QgsMapLayer::mDataUrlFormat
protected

Definition at line 1009 of file qgsmaplayer.h.

◆ mDependencies

QSet<QgsMapLayerDependency> QgsMapLayer::mDependencies
protected

List of layers that may modify this layer on modification.

Definition at line 1028 of file qgsmaplayer.h.

◆ mError

QgsError QgsMapLayer::mError
protected

Error.

Definition at line 1025 of file qgsmaplayer.h.

◆ mExtent

QgsRectangle QgsMapLayer::mExtent
mutableprotected

Extent of the layer.

Definition at line 985 of file qgsmaplayer.h.

◆ mKeywordList

QString QgsMapLayer::mKeywordList
protected

Definition at line 1005 of file qgsmaplayer.h.

◆ mLayerName

QString QgsMapLayer::mLayerName
protected

Name of the layer - used for display.

Definition at line 994 of file qgsmaplayer.h.

◆ mLayerOrigName

QString QgsMapLayer::mLayerOrigName
protected

Original name of the layer.

Definition at line 998 of file qgsmaplayer.h.

◆ mLegendUrl

QString QgsMapLayer::mLegendUrl
protected

WMS legend.

Definition at line 1021 of file qgsmaplayer.h.

◆ mLegendUrlFormat

QString QgsMapLayer::mLegendUrlFormat
protected

Definition at line 1022 of file qgsmaplayer.h.

◆ mMetadataUrl

QString QgsMapLayer::mMetadataUrl
protected

MetadataUrl of the layer.

Definition at line 1016 of file qgsmaplayer.h.

◆ mMetadataUrlFormat

QString QgsMapLayer::mMetadataUrlFormat
protected

Definition at line 1018 of file qgsmaplayer.h.

◆ mMetadataUrlType

QString QgsMapLayer::mMetadataUrlType
protected

Definition at line 1017 of file qgsmaplayer.h.

◆ mShortName

QString QgsMapLayer::mShortName
protected

Definition at line 1000 of file qgsmaplayer.h.

◆ mTitle

QString QgsMapLayer::mTitle
protected

Definition at line 1001 of file qgsmaplayer.h.

◆ mValid

bool QgsMapLayer::mValid
protected

Indicates if the layer is valid and can be drawn.

Definition at line 988 of file qgsmaplayer.h.

Property Documentation

◆ autoRefreshInterval

int QgsMapLayer::autoRefreshInterval
readwrite

Definition at line 59 of file qgsmaplayer.h.

◆ metadata

const QgsLayerMetadata & QgsMapLayer::metadata
readwrite

Definition at line 60 of file qgsmaplayer.h.

◆ name

QString QgsMapLayer::name
readwrite

Definition at line 58 of file qgsmaplayer.h.


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