QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | 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 }
 Layers enum defining the types of layers that can be added to a map. More...
 

Public Slots

virtual void invalidTransformInput ()
 Event handler for when a coordinate transform fails due to bad vertex error. More...
 
void setMinimumScale (float theMinScale)
 Accessor and mutator for the minimum scale denominator member. More...
 
float minimumScale () const
 
void setMaximumScale (float theMaxScale)
 Accessor and mutator for the maximum scale denominator member. More...
 
float maximumScale () const
 
void toggleScaleBasedVisibility (bool theVisibilityFlag)
 Accessor and mutator for the scale based visilibility flag. More...
 
bool hasScaleBasedVisibility () const
 
Q_DECL_DEPRECATED void clearCacheImage ()
 Clear cached image. More...
 
void triggerRepaint ()
 Will advice the map canvas (and any other interested party) that this layer requires to be repainted. More...
 
virtual QString metadata ()
 Obtain Metadata for this layer. More...
 
virtual QDateTime timestamp () const
 Time stamp of data source in the moment when data/metadata were loaded by provider. More...
 

Signals

void drawingProgress (int theProgress, int theTotalSteps)
 
void statusChanged (QString theStatus)
 Emit a signal with status (e.g. More...
 
void layerNameChanged ()
 Emit a signal that the layer name has been changed. More...
 
void layerCrsChanged ()
 Emit a signal that layer's CRS has been reset added in 1.4. More...
 
void repaintRequested ()
 By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself. More...
 
void screenUpdateRequested ()
 
void recalculateExtents ()
 This is used to send a request that any mapcanvas using this layer update its extents. More...
 
void dataChanged ()
 data of layer changed added in 1.5 More...
 
void blendModeChanged (const QPainter::CompositionMode &blendMode)
 Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() More...
 
void rendererChanged ()
 Signal emitted when renderer is changed. More...
 
void legendChanged ()
 Signal emitted when legend of the layer has changed. More...
 

Public Member Functions

 QgsMapLayer (QgsMapLayer::LayerType type=VectorLayer, QString lyrname=QString::null, QString source=QString::null)
 Constructor. More...
 
virtual ~QgsMapLayer ()
 Destructor. More...
 
QgsMapLayer::LayerType type () const
 Get the type of the layer. More...
 
QString id () const
 Get this layer's unique ID, this ID is used to access this layer from map layer registry. More...
 
void setLayerName (const QString &name)
 Set the display name of the layer. More...
 
const QString & name () const
 Get the display name of the layer. More...
 
const QString & originalName () const
 Get the original name of the layer. More...
 
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. More...
 
QPainter::CompositionMode blendMode () const
 Read blend mode for layer. More...
 
virtual void reload ()
 Synchronises with changes in the datasource. More...
 
virtual QgsMapLayerRenderercreateMapRenderer (QgsRenderContext &rendererContext)
 Return new instance of QgsMapLayerRenderer that will be used for rendering of given context. More...
 
virtual bool draw (QgsRenderContext &rendererContext)
 This is the method that does the actual work of drawing the layer onto a paint device. More...
 
virtual void drawLabels (QgsRenderContext &rendererContext)
 Draw labels. More...
 
virtual QgsRectangle extent ()
 Return the extent of the layer. More...
 
bool isValid ()
 
QString publicSource () const
 
const QString & source () const
 Returns the source for the layer. More...
 
virtual QStringList subLayers () const
 Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS) More...
 
virtual void setLayerOrder (const QStringList &layers)
 Reorders the previously selected sublayers of this layer from bottom to top (Useful for providers that manage their own layers, such as WMS) More...
 
virtual void setSubLayerVisibility (QString name, bool vis)
 Set the visibility of the given sublayer name. More...
 
virtual bool isEditable () const
 True if the layer can be edited. More...
 
bool readLayerXML (const QDomElement &layerElement)
 sets state from Dom document More...
 
bool writeLayerXML (QDomElement &layerElement, QDomDocument &document, QString relativeBasePath=QString::null)
 stores state in Dom node More...
 
void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for layer. More...
 
QVariant customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const
 Read a custom property from layer. More...
 
void removeCustomProperty (const QString &key)
 Remove a custom property from layer. More...
 
virtual Q_DECL_DEPRECATED QString lastErrorTitle ()
 
virtual Q_DECL_DEPRECATED QString lastError ()
 
virtual QgsError error () const
 Get current status error. More...
 
const
QgsCoordinateReferenceSystem
crs () const
 Returns layer's spatial reference system. More...
 
void setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
 Sets layer's spatial reference system. More...
 
virtual QString styleURI ()
 Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual QString loadDefaultStyle (bool &theResultFlag)
 Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual QString loadNamedStyle (const QString &theURI, bool &theResultFlag)
 Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual bool loadNamedStyleFromDb (const QString &db, const QString &theURI, QString &qml)
 
virtual void exportNamedStyle (QDomDocument &doc, QString &errorMsg)
 Export the properties of this layer as named style in a QDomDocument. More...
 
virtual void exportSldStyle (QDomDocument &doc, QString &errorMsg)
 Export the properties of this layer as SLD style in a QDomDocument. More...
 
virtual QString saveDefaultStyle (bool &theResultFlag)
 Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual QString saveNamedStyle (const QString &theURI, bool &theResultFlag)
 Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual QString saveSldStyle (const QString &theURI, bool &theResultFlag)
 
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. More...
 
virtual bool writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage) const =0
 Write the symbology for the layer into the docment provided. More...
 
QUndoStack * undoStack ()
 Return pointer to layer's undo stack. More...
 
void setLegendUrl (const QString &legendUrl)
 
const QString & legendUrl () const
 
void setLegendUrlFormat (const QString &legendUrlFormat)
 
const QString & legendUrlFormat () const
 
Q_DECL_DEPRECATED QImage * cacheImage ()
 
Q_DECL_DEPRECATED void setCacheImage (QImage *)
 
virtual Q_DECL_DEPRECATED void onCacheImageDelete ()
 
void setLegend (QgsMapLayerLegend *legend)
 Assign a legend controller to the map layer. More...
 
QgsMapLayerLegendlegend () const
 Can be null. More...
 

Static Public Member Functions

static QDomDocument asLayerDefinition (QList< QgsMapLayer * > layers, QString relativeBasePath=QString::null)
 Returns the given layer as a layer definition document Layer definitions store the data source as well as styling and custom properties. More...
 
static QList< QgsMapLayer * > fromLayerDefinition (QDomDocument &document)
 Creates a new layer from a layer defininition document. More...
 
static QList< QgsMapLayer * > fromLayerDefinitionFile (const QString qlrfile)
 
static QString capitaliseLayerName (const QString &name)
 A convenience function to (un)capitalise the layer name. More...
 

Protected Member Functions

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...
 
virtual bool readXml (const QDomNode &layer_node)
 called by readLayerXML(), used by children to read state specific to them from project files. More...
 
virtual bool writeXml (QDomNode &layer_node, QDomDocument &document)
 called by writeLayerXML(), used by children to write state specific to them to project files. More...
 
void readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith="")
 Read custom properties from project file. More...
 
void writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const
 Write custom properties to project file. More...
 
void connectNotify (const char *signal)
 debugging member - invoked when a connect() is made to this object More...
 
void appendError (const QgsErrorMessage &theMessage)
 Add error message. More...
 
void setError (const QgsError &theError)
 Set error message. More...
 

Protected Attributes

QgsRectangle mExtent
 Extent of the layer. More...
 
bool mValid
 Indicates if the layer is valid and can be drawn. More...
 
QString mDataSource
 data source description string, varies by layer type More...
 
QString mLayerName
 Name of the layer - used for display. More...
 
QString mLayerOrigName
 Original name of the layer. More...
 
QString mTitle
 
QString mAbstract
 Description of the layer. More...
 
QString mKeywordList
 
QString mDataUrl
 DataUrl of the layer. More...
 
QString mDataUrlFormat
 
QString mAttribution
 Attribution of the layer. More...
 
QString mAttributionUrl
 
QString mMetadataUrl
 MetadataUrl of the layer. More...
 
QString mMetadataUrlType
 
QString mMetadataUrlFormat
 
QString mLegendUrl
 WMS legend. More...
 
QString mLegendUrlFormat
 
QgsError mError
 Error. More...
 

Detailed Description

Base class for all map layer types.

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

Constructor & Destructor Documentation

QgsMapLayer::QgsMapLayer ( QgsMapLayer::LayerType  type = VectorLayer,
QString  lyrname = QString::null,
QString  source = QString::null 
)

Constructor.

Parameters
typeType of layer as defined in QgsMapLayer::LayerType enum
lyrnameDisplay Name of the layer
sourcedatasource of layer
QgsMapLayer::~QgsMapLayer ( )
virtual

Destructor.

Member Function Documentation

const QString& QgsMapLayer::abstract ( ) const
inline
void QgsMapLayer::appendError ( const QgsErrorMessage theMessage)
inlineprotected

Add error message.

QDomDocument QgsMapLayer::asLayerDefinition ( QList< QgsMapLayer * >  layers,
QString  relativeBasePath = QString::null 
)
static

Returns the given layer as a layer definition document Layer definitions store the data source as well as styling and custom properties.

Layer definitions can be used to load a layer and styling all from a single file.

const QString& QgsMapLayer::attribution ( ) const
inline
const QString& QgsMapLayer::attributionUrl ( ) const
inline
QPainter::CompositionMode QgsMapLayer::blendMode ( ) const

Read blend mode for layer.

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

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

Q_DECL_DEPRECATED QImage* QgsMapLayer::cacheImage ( )
inline
Deprecated:
since 2.4 - returns NULL
QString QgsMapLayer::capitaliseLayerName ( const QString &  name)
static

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

void QgsMapLayer::clearCacheImage ( )
slot

Clear cached image.

Deprecated:
in 2.4 - use triggerRepaint() - caches automatically listen to repaintRequested() signal to invalidate the cached image
void QgsMapLayer::connectNotify ( const char *  signal)
protected

debugging member - invoked when a connect() is made to this object

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

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

Note
added in 2.4

Reimplemented in QgsVectorLayer, QgsRasterLayer, and QgsPluginLayer.

const QgsCoordinateReferenceSystem & QgsMapLayer::crs ( ) const

Returns layer's spatial reference system.

Note
This was introduced in QGIS 1.4
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.

Note
Added in v1.4
void QgsMapLayer::dataChanged ( )
signal

data of layer changed added in 1.5

const QString& QgsMapLayer::dataUrl ( ) const
inline
const QString& QgsMapLayer::dataUrlFormat ( ) const
inline
bool QgsMapLayer::draw ( QgsRenderContext rendererContext)
virtual

This is the method that does the actual work of drawing the layer onto a paint device.

Parameters
rendererContextdescribes the extents, resolumon etc. that should be used when rendering the layer.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

void QgsMapLayer::drawingProgress ( int  theProgress,
int  theTotalSteps 
)
signal
Deprecated:
in 2.4 - not emitted anymore
void QgsMapLayer::drawLabels ( QgsRenderContext rendererContext)
virtual

Draw labels.

Todo:
to be removed: used only in vector layers

Reimplemented in QgsVectorLayer.

virtual QgsError QgsMapLayer::error ( ) const
inlinevirtual

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.

void QgsMapLayer::exportNamedStyle ( QDomDocument &  doc,
QString &  errorMsg 
)
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
void QgsMapLayer::exportSldStyle ( QDomDocument &  doc,
QString &  errorMsg 
)
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
QgsRectangle QgsMapLayer::extent ( )
virtual

Return the extent of the layer.

Reimplemented in QgsVectorLayer.

QList< QgsMapLayer * > QgsMapLayer::fromLayerDefinition ( QDomDocument &  document)
static

Creates a new layer from a layer defininition document.

QList< QgsMapLayer * > QgsMapLayer::fromLayerDefinitionFile ( const QString  qlrfile)
static
bool QgsMapLayer::hasScaleBasedVisibility ( ) const
slot
QString QgsMapLayer::id ( ) const

Get this layer's unique ID, this ID is used to access this layer from map layer registry.

Get this layer's unique ID.

Note
added in 1.7
void QgsMapLayer::invalidTransformInput ( )
virtualslot

Event handler for when a coordinate transform fails due to bad vertex error.

bool QgsMapLayer::isEditable ( ) const
virtual

True if the layer can be edited.

Reimplemented in QgsVectorLayer.

bool QgsMapLayer::isValid ( )

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 intialized

Returns
True if the layer is valid and can be accessed
const QString& QgsMapLayer::keywordList ( ) const
inline
QString QgsMapLayer::lastError ( )
virtual
Deprecated:
since 2.4 - returns empty string
QString QgsMapLayer::lastErrorTitle ( )
virtual
Deprecated:
since 2.4 - returns empty string
void QgsMapLayer::layerCrsChanged ( )
signal

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

void QgsMapLayer::layerNameChanged ( )
signal

Emit a signal that the layer name has been changed.

QgsMapLayerLegend * QgsMapLayer::legend ( ) const

Can be null.

Note
added in 2.6
void QgsMapLayer::legendChanged ( )
signal

Signal emitted when legend of the layer has changed.

Note
added in 2.6
const QString& QgsMapLayer::legendUrl ( ) const
inline
const QString& QgsMapLayer::legendUrlFormat ( ) const
inline
QString QgsMapLayer::loadDefaultStyle ( bool &  theResultFlag)
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
theResultFlaga 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 ();
QString QgsMapLayer::loadNamedStyle ( const QString &  theURI,
bool &  theResultFlag 
)
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
theURI- 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.
theResultFlaga 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.

bool QgsMapLayer::loadNamedStyleFromDb ( const QString &  db,
const QString &  theURI,
QString &  qml 
)
virtual
QString QgsMapLayer::loadSldStyle ( const QString &  theURI,
bool &  theResultFlag 
)
virtual
float QgsMapLayer::maximumScale ( ) const
slot
QString QgsMapLayer::metadata ( )
virtualslot

Obtain Metadata for this layer.

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

const QString& QgsMapLayer::metadataUrl ( ) const
inline
const QString& QgsMapLayer::metadataUrlFormat ( ) const
inline
const QString& QgsMapLayer::metadataUrlType ( ) const
inline
float QgsMapLayer::minimumScale ( ) const
slot
QString const & QgsMapLayer::name ( ) const

Get the display name of the layer.

Read property of QString layerName.

Returns
the layer name
virtual Q_DECL_DEPRECATED void QgsMapLayer::onCacheImageDelete ( )
inlinevirtual
Deprecated:
since 2.4 - does nothing
const QString& QgsMapLayer::originalName ( ) const
inline

Get the original name of the layer.

Note
added in 1.9
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.

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

Read custom properties from project file.

Added in v1.4

Parameters
layerNodenote to read from
keyStartsWithreads only properties starting with the specified string (or all if the string is empty)
bool QgsMapLayer::readLayerXML ( const QDomElement &  layerElement)

sets state from Dom document

Parameters
layerElementThe Dom element corresponding to ``maplayer'' tag
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
virtual bool QgsMapLayer::readSld ( const QDomNode &  node,
QString &  errorMessage 
)
inlinevirtual

Reimplemented in QgsVectorLayer.

virtual bool QgsMapLayer::readSymbology ( const QDomNode &  node,
QString &  errorMessage 
)
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
Returns
true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

bool QgsMapLayer::readXml ( const QDomNode &  layer_node)
protectedvirtual

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

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

void QgsMapLayer::recalculateExtents ( )
signal

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

virtual void QgsMapLayer::reload ( )
inlinevirtual

Synchronises with changes in the datasource.

Note
added in version 1.6

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

void QgsMapLayer::removeCustomProperty ( const QString &  key)

Remove a custom property from layer.

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

Note
Added in v1.4
void QgsMapLayer::rendererChanged ( )
signal

Signal emitted when renderer is changed.

void QgsMapLayer::repaintRequested ( )
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.

QString QgsMapLayer::saveDefaultStyle ( bool &  theResultFlag)
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
theResultFlaga 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()
QString QgsMapLayer::saveNamedStyle ( const QString &  theURI,
bool &  theResultFlag 
)
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
theURIthe 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.
theResultFlaga 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()
QString QgsMapLayer::saveSldStyle ( const QString &  theURI,
bool &  theResultFlag 
)
virtual
void QgsMapLayer::screenUpdateRequested ( )
signal
Note
Deprecated in 2.4 and not emitted anymore
void QgsMapLayer::setAbstract ( const QString &  abstract)
inline
void QgsMapLayer::setAttribution ( const QString &  attrib)
inline
void QgsMapLayer::setAttributionUrl ( const QString &  attribUrl)
inline
void QgsMapLayer::setBlendMode ( const QPainter::CompositionMode &  blendMode)

Write blend mode for layer.

void QgsMapLayer::setCacheImage ( QImage *  )
Deprecated:
since 2.4 - caches listen to repaintRequested() signal to invalidate the cached image
void QgsMapLayer::setCrs ( const QgsCoordinateReferenceSystem srs,
bool  emitSignal = true 
)

Sets layer's spatial reference system.

Note
emitSignal added in 1.4
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.

Note
Added in v1.4
void QgsMapLayer::setDataUrl ( const QString &  dataUrl)
inline
void QgsMapLayer::setDataUrlFormat ( const QString &  dataUrlFormat)
inline
void QgsMapLayer::setError ( const QgsError theError)
inlineprotected

Set error message.

void QgsMapLayer::setExtent ( const QgsRectangle rect)
protectedvirtual

Set the extent.

Reimplemented in QgsVectorLayer, and QgsPluginLayer.

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

Set the display name of the layer.

Write property of QString layerName.

Parameters
nameNew name for the layer
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.

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
Note
added in 2.6
void QgsMapLayer::setLegendUrl ( const QString &  legendUrl)
inline
void QgsMapLayer::setLegendUrlFormat ( const QString &  legendUrlFormat)
inline
void QgsMapLayer::setMaximumScale ( float  theMaxScale)
slot

Accessor and mutator for the maximum scale denominator member.

void QgsMapLayer::setMetadataUrl ( const QString &  metaUrl)
inline
void QgsMapLayer::setMetadataUrlFormat ( const QString &  metaUrlFormat)
inline
void QgsMapLayer::setMetadataUrlType ( const QString &  metaUrlType)
inline
void QgsMapLayer::setMinimumScale ( float  theMinScale)
slot

Accessor and mutator for the minimum scale denominator member.

void QgsMapLayer::setSubLayerVisibility ( QString  name,
bool  vis 
)
virtual

Set the visibility of the given sublayer name.

Reimplemented in QgsRasterLayer.

void QgsMapLayer::setTitle ( const QString &  title)
inline
void QgsMapLayer::setValid ( bool  valid)
protected

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

Note
added in v1.5
QString const & QgsMapLayer::source ( ) const

Returns the source for the layer.

void QgsMapLayer::statusChanged ( QString  theStatus)
signal

Emit a signal with status (e.g.

to be caught by QgisApp and display a msg on status bar)

QString QgsMapLayer::styleURI ( )
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 ();
Note
This method was added in QGIS 1.8
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.

virtual QDateTime QgsMapLayer::timestamp ( ) const
inlinevirtualslot

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

Reimplemented in QgsRasterLayer.

const QString& QgsMapLayer::title ( ) const
inline
void QgsMapLayer::toggleScaleBasedVisibility ( bool  theVisibilityFlag)
slot

Accessor and mutator for the scale based visilibility flag.

void QgsMapLayer::triggerRepaint ( )
slot

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

Will emit a repaintRequested() signal.

Note
in 2.6 function moved from vector/raster subclasses to QgsMapLayer
QgsMapLayer::LayerType QgsMapLayer::type ( ) const

Get the type of the layer.

Returns
Integer matching a value in the QgsMapLayer::LayerType enum
QUndoStack * QgsMapLayer::undoStack ( )

Return pointer to layer's undo stack.

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

Write custom properties to project file.

Added in v1.4

bool QgsMapLayer::writeLayerXML ( QDomElement &  layerElement,
QDomDocument &  document,
QString  relativeBasePath = QString::null 
)

stores state in Dom node

Parameters
layerElementis a Dom element corresponding to ``maplayer'' tag
documentis a the dom document being written
relativeBasePathbase path for relative 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
virtual bool QgsMapLayer::writeSymbology ( QDomNode &  node,
QDomDocument &  doc,
QString &  errorMessage 
) 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
Returns
true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

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

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

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Member Data Documentation

QString QgsMapLayer::mAbstract
protected

Description of the layer.

QString QgsMapLayer::mAttribution
protected

Attribution of the layer.

QString QgsMapLayer::mAttributionUrl
protected
QString QgsMapLayer::mDataSource
protected

data source description string, varies by layer type

QString QgsMapLayer::mDataUrl
protected

DataUrl of the layer.

QString QgsMapLayer::mDataUrlFormat
protected
QgsError QgsMapLayer::mError
protected

Error.

QgsRectangle QgsMapLayer::mExtent
protected

Extent of the layer.

QString QgsMapLayer::mKeywordList
protected
QString QgsMapLayer::mLayerName
protected

Name of the layer - used for display.

QString QgsMapLayer::mLayerOrigName
protected

Original name of the layer.

Note
added in 1.9
QString QgsMapLayer::mLegendUrl
protected

WMS legend.

QString QgsMapLayer::mLegendUrlFormat
protected
QString QgsMapLayer::mMetadataUrl
protected

MetadataUrl of the layer.

QString QgsMapLayer::mMetadataUrlFormat
protected
QString QgsMapLayer::mMetadataUrlType
protected
QString QgsMapLayer::mTitle
protected
bool QgsMapLayer::mValid
protected

Indicates if the layer is valid and can be drawn.


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