|
QGIS API Documentation
2.2.0-Valmiera
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
QGIS API Documentation
2.2.0-Valmiera
|
Base class for plugin layers. More...
#include <qgspluginlayer.h>
Public Member Functions | |
| QgsPluginLayer (QString layerType, QString layerName=QString()) | |
| QString | pluginLayerType () |
| return plugin layer type (the same as used in QgsPluginLayerRegistry) | |
| void | setExtent (const QgsRectangle &extent) |
| Set the extent. | |
| virtual QgsLegendSymbologyList | legendSymbologyItems (const QSize &iconSize) |
| return a list of symbology items for the legend (defult implementation returns nothing) | |
 Public Member Functions inherited from QgsMapLayer | |
| QgsMapLayer (QgsMapLayer::LayerType type=VectorLayer, QString lyrname=QString::null, QString source=QString::null) | |
| Constructor. | |
| virtual | ~QgsMapLayer () |
| Destructor. | |
| QgsMapLayer::LayerType | type () const |
| Get the type of the layer. | |
| QString | id () const |
| Get this layer's unique ID, this ID is used to access this layer from map layer registry. | |
| void | setLayerName (const QString &name) |
| Set the display name of the layer. | |
| const QString & | name () const |
| Get the display name of the layer. | |
| const QString & | originalName () const |
| Get the original name of the layer. | |
| void | setTitle (const QString &title) |
| const QString & | title () const |
| void | setAbstract (const QString &abstract) |
| const QString & | abstract () const |
| void | setKeywordList (const QString &keywords) |
| const QString & | keywordList () const |
| void | setDataUrl (const QString &dataUrl) |
| const QString & | dataUrl () const |
| void | setDataUrlFormat (const QString &dataUrlFormat) |
| const QString & | dataUrlFormat () const |
| void | setAttribution (const QString &attrib) |
| const QString & | attribution () const |
| void | setAttributionUrl (const QString &attribUrl) |
| const QString & | attributionUrl () const |
| void | setMetadataUrl (const QString &metaUrl) |
| const QString & | metadataUrl () const |
| void | setMetadataUrlType (const QString &metaUrlType) |
| const QString & | metadataUrlType () const |
| void | setMetadataUrlFormat (const QString &metaUrlFormat) |
| const QString & | metadataUrlFormat () const |
| void | setBlendMode (const QPainter::CompositionMode &blendMode) |
| Write blend mode for layer. | |
| QPainter::CompositionMode | blendMode () const |
| Read blend mode for layer. | |
| virtual void | reload () |
| Synchronises with changes in the datasource. | |
| virtual bool | draw (QgsRenderContext &rendererContext) |
| This is the method that does the actual work of drawing the layer onto a paint device. | |
| virtual void | drawLabels (QgsRenderContext &rendererContext) |
| Draw labels. | |
| virtual QgsRectangle | extent () |
| Return the extent of the layer. | |
| bool | isValid () |
| QString | publicSource () const |
| const QString & | source () const |
| Returns the source for the layer. | |
| virtual QStringList | subLayers () const |
| Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS) | |
| virtual void | setLayerOrder (const QStringList &layers) |
| Reorders the previously selected sublayers of this layer from bottom to top (Useful for providers that manage their own layers, such as WMS) | |
| virtual void | setSubLayerVisibility (QString name, bool vis) |
| Set the visibility of the given sublayer name. | |
| virtual bool | isEditable () const |
| True if the layer can be edited. | |
| bool | readLayerXML (const QDomElement &layerElement) |
| sets state from Dom document | |
| bool | writeLayerXML (QDomElement &layerElement, QDomDocument &document) |
| stores state in Dom node | |
| void | setCustomProperty (const QString &key, const QVariant &value) |
| Set a custom property for layer. | |
| QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
| Read a custom property from layer. | |
| void | removeCustomProperty (const QString &key) |
| Remove a custom property from layer. | |
| virtual QString | lastErrorTitle () |
| If an operation returns 0 (e.g. | |
| virtual QString | lastError () |
| If an operation returns 0 (e.g. | |
| virtual QgsError | error () const |
| Get current status error. | |
| const QgsCoordinateReferenceSystem & | crs () const |
| Returns layer's spatial reference system. | |
| void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
| Sets layer's spatial reference system. | |
| virtual QString | styleURI () |
| Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual QString | loadDefaultStyle (bool &theResultFlag) |
| Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual QString | loadNamedStyle (const QString &theURI, bool &theResultFlag) |
| Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual bool | loadNamedStyleFromDb (const QString &db, const QString &theURI, QString &qml) |
| virtual void | exportNamedStyle (QDomDocument &doc, QString &errorMsg) |
| Export the properties of this layer as named style in a QDomDocument. | |
| virtual void | exportSldStyle (QDomDocument &doc, QString &errorMsg) |
| Export the properties of this layer as SLD style in a QDomDocument. | |
| virtual QString | saveDefaultStyle (bool &theResultFlag) |
| Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual QString | saveNamedStyle (const QString &theURI, bool &theResultFlag) |
| Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual QString | saveSldStyle (const QString &theURI, bool &theResultFlag) |
| virtual QString | loadSldStyle (const QString &theURI, bool &theResultFlag) |
| virtual bool | readSld (const QDomNode &node, QString &errorMessage) |
| virtual bool | readSymbology (const QDomNode &node, QString &errorMessage)=0 |
| Read the symbology for the current layer from the Dom node supplied. | |
| virtual bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage) const =0 |
| Write the symbology for the layer into the docment provided. | |
| QUndoStack * | undoStack () |
| Return pointer to layer's undo stack. | |
| QImage * | cacheImage () |
| Get the QImage used for caching render operations. | |
| void | setCacheImage (QImage *thepImage) |
| Set the QImage used for caching render operations. | |
| virtual void | onCacheImageDelete () |
| Is called when the cache image is being deleted. | |
Protected Attributes | |
| QString | mPluginLayerType |
| Protected Attributes inherited from QgsMapLayer | |
| QgsRectangle | mExtent |
| Extent of the layer. | |
| bool | mValid |
| Indicates if the layer is valid and can be drawn. | |
| QString | mDataSource |
| data source description string, varies by layer type | |
| QString | mLayerName |
| Name of the layer - used for display. | |
| QString | mLayerOrigName |
| Original name of the layer. | |
| QString | mTitle |
| QString | mAbstract |
| Description of the layer. | |
| QString | mKeywordList |
| QString | mDataUrl |
| DataUrl of the layer. | |
| QString | mDataUrlFormat |
| QString | mAttribution |
| Attribution of the layer. | |
| QString | mAttributionUrl |
| QString | mMetadataUrl |
| MetadataUrl of the layer. | |
| QString | mMetadataUrlType |
| QString | mMetadataUrlFormat |
| QgsError | mError |
| Error. | |
Additional Inherited Members | |
| Public Types inherited from QgsMapLayer | |
| enum | LayerType { VectorLayer, RasterLayer, PluginLayer } |
| Layers enum defining the types of layers that can be added to a map. More... | |
| Public Slots inherited from QgsMapLayer | |
| virtual void | invalidTransformInput () |
| Event handler for when a coordinate transform fails due to bad vertex error. | |
| void | setMinimumScale (float theMinScale) |
| Accessor and mutator for the minimum scale denominator member. | |
| float | minimumScale () const |
| void | setMaximumScale (float theMaxScale) |
| Accessor and mutator for the maximum scale denominator member. | |
| float | maximumScale () const |
| void | toggleScaleBasedVisibility (bool theVisibilityFlag) |
| Accessor and mutator for the scale based visilibility flag. | |
| bool | hasScaleBasedVisibility () const |
| void | clearCacheImage () |
| Clear cached image added in 1.5. | |
| virtual QString | metadata () |
| Obtain Metadata for this layer. | |
| virtual QDateTime | timestamp () const |
| Time stamp of data source in the moment when data/metadata were loaded by provider. | |
| Signals inherited from QgsMapLayer | |
| void | drawingProgress (int theProgress, int theTotalSteps) |
| Emit a signal to notify of a progress event. | |
| void | statusChanged (QString theStatus) |
| Emit a signal with status (e.g. | |
| void | layerNameChanged () |
| Emit a signal that the layer name has been changed. | |
| void | layerCrsChanged () |
| Emit a signal that layer's CRS has been reset added in 1.4. | |
| void | repaintRequested () |
| This signal should be connected with the slot QgsMapCanvas::refresh() | |
| void | screenUpdateRequested () |
| The layer emits this signal when a screen update is requested. | |
| void | recalculateExtents () |
| This is used to send a request that any mapcanvas using this layer update its extents. | |
| void | dataChanged () |
| data of layer changed added in 1.5 | |
| void | blendModeChanged (const QPainter::CompositionMode &blendMode) |
| Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() | |
| Static Public Member Functions inherited from QgsMapLayer | |
| static QString | capitaliseLayerName (const QString &name) |
| A convenience function to (un)capitalise the layer name. | |
| Protected Member Functions inherited from QgsMapLayer | |
| void | setValid (bool valid) |
| set whether layer is valid or not - should be used in constructor. | |
| virtual bool | readXml (const QDomNode &layer_node) |
| called by readLayerXML(), used by children to read state specific to them from project files. | |
| virtual bool | writeXml (QDomNode &layer_node, QDomDocument &document) |
| called by writeLayerXML(), used by children to write state specific to them to project files. | |
| void | readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith="") |
| Read custom properties from project file. | |
| void | writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const |
| Write custom properties to project file. | |
| void | connectNotify (const char *signal) |
| debugging member - invoked when a connect() is made to this object | |
| void | appendError (const QgsErrorMessage &theMessage) |
| Add error message. | |
| void | setError (const QgsError &theError) |
| Set error message. | |
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 32 of file qgspluginlayer.h.
| QgsPluginLayer::QgsPluginLayer | ( | QString | layerType, |
| QString | layerName = QString() |
||
| ) |
Definition at line 17 of file qgspluginlayer.cpp.
|
virtual |
return a list of symbology items for the legend (defult implementation returns nothing)
Definition at line 32 of file qgspluginlayer.cpp.
| QString QgsPluginLayer::pluginLayerType | ( | ) |
return plugin layer type (the same as used in QgsPluginLayerRegistry)
Definition at line 22 of file qgspluginlayer.cpp.
References mPluginLayerType.
Referenced by QgsPluginLayerRegistry::removePluginLayerType().
|
virtual |
Set the extent.
Reimplemented from QgsMapLayer.
Definition at line 27 of file qgspluginlayer.cpp.
References QgsMapLayer::extent(), and QgsMapLayer::mExtent.
|
protected |
Definition at line 50 of file qgspluginlayer.h.
Referenced by pluginLayerType().
1.8.1.2