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... | |
| const QgsDataProvider * | dataProvider () const override |
Returns the layer's data provider in a const-correct manner, it may be nullptr. More... | |
| QgsDataProvider * | dataProvider () override |
Returns the layer's data provider, it may be nullptr. More... | |
| QString | pluginLayerType () |
| Returns plugin layer type (the same as used in QgsPluginLayerRegistry) More... | |
| void | setExtent (const QgsRectangle &extent) override |
| Sets extent of the layer. More... | |
| void | setSource (const QString &source) |
| Set source string. More... | |
 Public Member Functions inherited from QgsMapLayer | |
| QgsMapLayer (QgsMapLayer const &)=delete | |
| QgsMapLayer cannot be copied. More... | |
| QgsMapLayer (QgsMapLayerType type=QgsMapLayerType::VectorLayer, const QString &name=QString(), const QString &source=QString()) | |
| Constructor for QgsMapLayer. More... | |
| ~QgsMapLayer () override | |
| QString | abstract () const |
| Returns the abstract of the layer used by QGIS Server in GetCapabilities request. More... | |
| virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
| Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer. 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 QgsMapLayer * | clone () const =0 |
| Returns a new instance equivalent to this one except for the id which is still unique. More... | |
| virtual QgsMapLayerRenderer * | createMapRenderer (QgsRenderContext &rendererContext)=0 |
| Returns 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... | |
| template<class T > | |
| T | customEnumProperty (const QString &key, const T &defaultValue) |
| Returns the property value for a property based on an enum. More... | |
| template<class T > | |
| T | customFlagProperty (const QString &key, const T &defaultValue) |
| Returns the property value for a property based on a flag. More... | |
| const QgsObjectCustomProperties & | customProperties () const |
| Read all custom properties from layer. More... | |
| Q_INVOKABLE QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
| Read a custom property from layer. More... | |
| Q_INVOKABLE QStringList | customPropertyKeys () const |
| Returns list of all keys within custom properties. More... | |
| virtual Q_INVOKABLE QgsDataProvider * | dataProvider () |
Returns the layer's data provider, it may be nullptr. More... | |
| virtual const QgsDataProvider * | dataProvider () const |
Returns the layer's data provider in a const-correct manner, it may be nullptr. 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 QgsMapLayerElevationProperties * | elevationProperties () |
| Returns the layer's elevation properties. More... | |
| virtual QgsError | error () const |
| Gets 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 QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) 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... | |
| QgsMapLayer::LayerFlags | flags () const |
| Returns the flags for this 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, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
| 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 | isModified () const |
Returns true if the layer has been modified since last commit/save. 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... | |
| virtual bool | isTemporary () const |
Returns true if the layer is considered a temporary layer. More... | |
| bool | isValid () const |
| Returns 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 nullptr. More... | |
| QString | legendPlaceholderImage () const |
| Returns path to the placeholder image or an empty string if a generated legend is shown. 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 | 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, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
| 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... | |
| Q_DECL_DEPRECATED QString | metadataUrl () const |
| Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. More... | |
| Q_DECL_DEPRECATED QString | metadataUrlFormat () const |
| Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. More... | |
| Q_DECL_DEPRECATED 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... | |
| virtual double | opacity () const |
| Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More... | |
| QgsMapLayer & | operator= (QgsMapLayer const &)=delete |
| QgsMapLayer cannot be copied. More... | |
| QString | originalXmlProperties () const |
| Returns the XML properties of the original layer as they were when the layer was first read from the project file. More... | |
| virtual Qgis::MapLayerProperties | properties () const |
| Returns the map layer properties of this layer. More... | |
| QString | providerType () const |
| Returns the provider type (provider key) for this 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, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags()) |
| 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, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) |
| Read the style for the current layer from the DOM node supplied. More... | |
| virtual bool | readSymbology (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)=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 Q_INVOKABLE 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 Q_DECL_DEPRECATED 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 | saveDefaultStyle (bool &resultFlag, StyleCategories categories) |
| 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, StyleCategories categories=AllStyleCategories) |
| 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... | |
| QgsMapLayerServerProperties * | serverProperties () |
| Returns QGIS Server Properties for the map layer. More... | |
| const QgsMapLayerServerProperties * | serverProperties () const |
| Returns QGIS Server Properties const for the map layer. 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... | |
| template<class T > | |
| void | setCustomEnumProperty (const QString &key, const T &value) |
| Set the value of a property based on an enum. More... | |
| template<class T > | |
| void | setCustomFlagProperty (const QString &key, const T &value) |
| Set the value of a property based on a flag. More... | |
| void | setCustomProperties (const QgsObjectCustomProperties &properties) |
| Set custom properties for layer. More... | |
| Q_INVOKABLE void | setCustomProperty (const QString &key, const QVariant &value) |
| Set a custom property for layer. More... | |
| void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false) |
| Updates the data source of the layer. More... | |
| void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag=false) |
| Updates the data source of the layer. More... | |
| void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags) |
| Updates the data source of the 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 | setFlags (QgsMapLayer::LayerFlags flags) |
| Returns the flags for this layer. 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 | setLegendPlaceholderImage (const QString &imgPath) |
| Set placeholder image for legend. 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... | |
| Q_DECL_DEPRECATED void | setMetadataUrl (const QString &metaUrl) |
| Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. More... | |
| Q_DECL_DEPRECATED void | setMetadataUrlFormat (const QString &metaUrlFormat) |
| Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. More... | |
| Q_DECL_DEPRECATED 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... | |
| virtual void | setOpacity (double opacity) |
| Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More... | |
| void | setOriginalXmlProperties (const QString &originalXmlProperties) |
| Sets the original XML properties for the layer to originalXmlProperties. 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 |
| Gets 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 bool | supportsEditing () const |
| Returns whether the layer supports editing or not. More... | |
| virtual QgsMapLayerTemporalProperties * | temporalProperties () |
| Returns the layer's temporal properties. 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... | |
| QgsCoordinateTransformContext | transformContext () const |
| Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider. More... | |
| QgsMapLayerType | type () const |
| Returns the type of the layer. More... | |
| QUndoStack * | undoStack () |
| Returns pointer to layer's undo stack. More... | |
| QUndoStack * | undoStackStyles () |
| Returns pointer to layer's style undo stack. More... | |
| QgsRectangle | wgs84Extent (bool forceRecalculate=false) const |
| Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata. 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, StyleCategories categories=AllStyleCategories) const |
| Write just the symbology information for the layer into the document. More... | |
| virtual bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const =0 |
| Write the style for the layer into the document 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 |
| int | mBlockStyleChangedSignal = 0 |
| If non-zero, the styleChanged signal should not be emitted. More... | |
| 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... | |
| bool | mIsRefreshOnNofifyEnabled = false |
| QString | mKeywordList |
| QString | mLayerName |
| Name of the layer - used for display. More... | |
| double | mLayerOpacity = 1.0 |
| Layer opacity. More... | |
| QString | mLegendUrl |
| WMS legend. More... | |
| QString | mLegendUrlFormat |
| QString | mProviderKey |
| Data provider key (name of the data provider) More... | |
| QgsMapLayer::ReadFlags | mReadFlags = QgsMapLayer::ReadFlags() |
| Read flags. It's up to the subclass to respect these when restoring state from XML. More... | |
| QString | mRefreshOnNofifyMessage |
| QString | mShortName |
| bool | mShouldValidateCrs = true |
true if the layer's CRS should be validated and invalid CRSes are not permitted. More... | |
| 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 | LayerFlag { Identifiable = 1 << 0 , Removable = 1 << 1 , Searchable = 1 << 2 , Private = 1 << 3 } |
| Flags for the map layer. More... | |
| enum | PropertyType { Style = 0 , Metadata } |
| Maplayer has a style and a metadata property. More... | |
| enum | ReadFlag { FlagDontResolveLayers = 1 << 0 , FlagTrustLayerMetadata = 1 << 1 , FlagReadExtentFromXml = 1 << 2 , FlagForceReadOnly = 1 << 3 } |
| Flags which control project read behavior. More... | |
| enum | StyleCategory { LayerConfiguration = 1 << 0 , Symbology = 1 << 1 , Symbology3D = 1 << 2 , Labeling = 1 << 3 , Fields = 1 << 4 , Forms = 1 << 5 , Actions = 1 << 6 , MapTips = 1 << 7 , Diagrams = 1 << 8 , AttributeTable = 1 << 9 , Rendering = 1 << 10 , CustomProperties = 1 << 11 , GeometryOptions = 1 << 12 , Relations = 1 << 13 , Temporal = 1 << 14 , Legend = 1 << 15 , Elevation = 1 << 16 , Notes = 1 << 17 , AllStyleCategories } |
| Categories of style to distinguish appropriate sections for import/export. More... | |
| Public Slots inherited from QgsMapLayer | |
| void | emitStyleChanged () |
| Triggers an emission of the styleChanged() signal. More... | |
| QgsProject * | project () const |
| Returns the parent project if this map layer is added to a project. 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 repaint 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 (bool enabled) |
| Sets whether scale based visibility is enabled for the layer. More... | |
| virtual void | setTransformContext (const QgsCoordinateTransformContext &transformContext)=0 |
| Sets the coordinate transform context to transformContext. More... | |
| void | trigger3DUpdate () |
| Will advise any 3D maps that this layer requires to be updated in the scene. 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 | beforeResolveReferences (QgsProject *project) |
| Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved. 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 | customPropertyChanged (const QString &key) |
| Emitted when a custom property of the layer has been changed or removed. More... | |
| void | dataChanged () |
| Data of layer changed. More... | |
| void | dataSourceChanged () |
| Emitted whenever the layer's data source has been changed. More... | |
| void | dependenciesChanged () |
| Emitted when dependencies are changed. More... | |
| void | editingStarted () |
| Emitted when editing on this layer has started. More... | |
| void | editingStopped () |
| Emitted when edited changes have been successfully written to the data provider. More... | |
| void | flagsChanged () |
| Emitted when layer's flags have been modified. More... | |
| void | isValidChanged () |
| Emitted when the validity of this layer changed. More... | |
| void | layerModified () |
| Emitted when modifications has been done on layer. 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 | opacityChanged (double opacity) |
| Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque). 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 | request3DUpdate () |
| Signal emitted when a layer requires an update in any 3D maps. 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 | styleLoaded (QgsMapLayer::StyleCategories categories) |
| Emitted when a style has been loaded. 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... | |
| static QString | generateId (const QString &layerName) |
| Generates an unique identifier for this layer, the generate ID is prefixed by layerName. 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, ... into another layer. More... | |
| QString | crsHtmlMetadata () const |
| Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method. More... | |
| virtual QString | decodedSource (const QString &source, const QString &dataProvider, const QgsReadWriteContext &context) const |
| Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files. More... | |
| virtual QString | encodedSource (const QString &source, const QgsReadWriteContext &context) const |
| Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files. More... | |
| QString | generalHtmlMetadata () const |
| Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() method. More... | |
| Q_DECL_DEPRECATED bool | hasDependencyCycle (const QSet< QgsMapLayerDependency > &) const |
Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return false, because circular dependencies are now correctly managed. More... | |
| void | invalidateWgs84Extent () |
| Invalidates the WGS84 extent. More... | |
| void | readCommonStyle (const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) |
| 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, QgsReadWriteContext &context) |
| Called by readLayerXML(), used by children to read state specific to them from project files. More... | |
| void | setError (const QgsError &error) |
| Sets error message. More... | |
| virtual void | setExtent (const QgsRectangle &rect) |
| Sets the extent. More... | |
| void | setProviderType (const QString &providerType) |
| Sets the providerType (provider key) More... | |
| void | setValid (bool valid) |
| Sets whether layer is valid or not. More... | |
| void | writeCommonStyle (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) 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 |
| QgsCoordinateReferenceSystem | crs |
| bool | isValid |
| QgsLayerMetadata | metadata |
| QString | name |
| double | opacity |
| QgsMapLayerType | type |
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()
|
override |
Definition at line 28 of file qgspluginlayer.cpp.
Member Function Documentation
◆ clone()
|
overridepure virtual |
Returns a new instance equivalent to this one.
- Returns
- a new layer instance
- Since
- QGIS 3.0
Implements QgsMapLayer.
◆ dataProvider() [1/2]
|
overridevirtual |
Returns the layer's data provider in a const-correct manner, it may be nullptr.
- Note
- not available in Python bindings
Reimplemented from QgsMapLayer.
Definition at line 57 of file qgspluginlayer.cpp.
◆ dataProvider() [2/2]
|
overridevirtual |
Returns the layer's data provider, it may be nullptr.
Reimplemented from QgsMapLayer.
Definition at line 52 of file qgspluginlayer.cpp.
◆ pluginLayerType()
| QString QgsPluginLayer::pluginLayerType | ( | ) |
Returns plugin layer type (the same as used in QgsPluginLayerRegistry)
Definition at line 36 of file qgspluginlayer.cpp.
◆ setExtent()
|
overridevirtual |
Sets 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
|
protected |
Definition at line 71 of file qgspluginlayer.h.
◆ mPluginLayerType
|
protected |
Definition at line 70 of file qgspluginlayer.h.
The documentation for this class was generated from the following files:
- /build/qgis-3.28.0+99sid/src/core/qgspluginlayer.h
- /build/qgis-3.28.0+99sid/src/core/qgspluginlayer.cpp
