Quantum GIS API Documentation
1.7.5-Wroclaw
|
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) |
![]() | |
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. | |
Q_DECL_DEPRECATED QString | getLayerID () 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. | |
QString const & | name () const |
Get the display name of the 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. | |
QgsRectangle | extent () const |
Return the extent of the layer as a QRect. | |
bool | isValid () |
QString | publicSource () const |
QString const & | source () const |
Returns the source for the layer. | |
virtual QStringList | subLayers () |
Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS) | |
virtual void | setLayerOrder (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 | readXML (QDomNode &layer_node) |
sets state from Dom document | |
bool | writeXML (QDomNode &layer_node, 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 bool | copySymbologySettings (const QgsMapLayer &other)=0 |
Copies the symbology settings from another layer. | |
virtual bool | hasCompatibleSymbology (const QgsMapLayer &other) const =0 |
Returns true if this layer can be in the same symbology group with another layer. | |
unsigned int | getTransparency () |
Accessor for transparency level. | |
void | setTransparency (unsigned int) |
Mutator for transparency level. | |
virtual QString | lastErrorTitle () |
If an operation returns 0 (e.g. | |
virtual QString | lastError () |
If an operation returns 0 (e.g. | |
const QgsCoordinateReferenceSystem & | crs () |
Returns layer's spatial reference system. | |
Q_DECL_DEPRECATED const QgsCoordinateReferenceSystem & | srs () |
Returns layer's spatial reference system. | |
void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
Sets layer's spatial reference system. | |
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 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 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. |
Protected Attributes | |
QString | mPluginLayerType |
![]() | |
unsigned int | mTransparencyLevel |
Transparency level for this layer should be 0-255 (255 being opaque) | |
QgsRectangle | mLayerExtent |
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. | |
QgsCoordinateReferenceSystem * | mCRS |
layer's Spatial reference system |
Additional Inherited Members | |
![]() | |
enum | LayerType { VectorLayer, RasterLayer, PluginLayer } |
Layers enum defining the types of layers that can be added to a map. More... | |
![]() | |
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 member. | |
float | minimumScale () |
void | setMaximumScale (float theMaxScale) |
Accessor and mutator for the maximum scale member. | |
float | maximumScale () |
void | toggleScaleBasedVisibility (bool theVisibilityFlag) |
Accessor and mutator for the scale based visilibility flag. | |
bool | hasScaleBasedVisibility () |
void | clearCacheImage () |
Clear cached image added in 1.5. | |
virtual QDateTime | timestamp () const |
Time stamp of data source in the moment when data/metadata were loaded by provider. | |
![]() | |
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 | |
![]() | |
static QString | capitaliseLayerName (const QString name) |
A convenience function to capitalise the layer name. | |
![]() | |
void | setValid (bool valid) |
set whether layer is valid or not - should be used in constructor. | |
virtual bool | readXml (QDomNode &layer_node) |
called by readXML(), used by children to read state specific to them from project files. | |
virtual bool | writeXml (QDomNode &layer_node, QDomDocument &document) |
called by writeXML(), 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 |
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 16 of file qgspluginlayer.h.
QgsPluginLayer::QgsPluginLayer | ( | QString | layerType, |
QString | layerName = QString() |
||
) |
Definition at line 3 of file qgspluginlayer.cpp.
QString QgsPluginLayer::pluginLayerType | ( | ) |
return plugin layer type (the same as used in QgsPluginLayerRegistry)
Definition at line 8 of file qgspluginlayer.cpp.
References mPluginLayerType.
Referenced by QgsPluginLayerRegistry::removePluginLayerType().
void QgsPluginLayer::setExtent | ( | const QgsRectangle & | extent | ) |
Definition at line 13 of file qgspluginlayer.cpp.
References QgsMapLayer::extent(), and QgsMapLayer::mLayerExtent.
|
protected |
Definition at line 29 of file qgspluginlayer.h.
Referenced by pluginLayerType().