QgsMapLayer Class Reference
[Core]

#include <qgsmaplayer.h>

Inheritance diagram for QgsMapLayer:

Inheritance graph
[legend]
Collaboration diagram for QgsMapLayer:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for all map layer types.

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

Definition at line 41 of file qgsmaplayer.h.

Public Types

enum  LayerType { VectorLayer, RasterLayer }
 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.
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 ()

Signals

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 layer name has been changed.
void repaintRequested ()
 This signal should be connected with the slot QgsMapCanvas::refresh() : to be removed - GUI dependency.
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.

Public Member Functions

 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 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 bool draw (QgsRenderContext &rendererContext)
virtual void drawLabels (QgsRenderContext &rendererContext)
 Draw labels to be removed: used only in vector layers.
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=0
 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
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 QgsCoordinateReferenceSystemsrs ()
 Returns layer's spatial reference system.
void setCrs (const QgsCoordinateReferenceSystem &srs)
 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 &, QDomDocument &doc, QString &errorMessage) const=0
 Write the symbology for the layer into the docment provided.

Static Public Member Functions

static QString capitaliseLayerName (const QString name)
 A convenience function to capitalise the layer name.

Protected Member Functions

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 connectNotify (const char *signal)
 debugging member - invoked when a connect() is made to this object

Protected Attributes

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.
QgsCoordinateReferenceSystemmCRS
 layer's Spatial reference system

Private Member Functions

 QgsMapLayer (QgsMapLayer const &)
 private copy constructor - QgsMapLayer not copyable
QgsMapLayeroperator= (QgsMapLayer const &)
 private assign operator - QgsMapLayer not copyable

Private Attributes

QString mID
 Unique ID of this layer - used to refer to this layer in map layer registry.
QgsMapLayer::LayerType mLayerType
 Type of the layer (eg.
QString mTag
 Tag for embedding additional information.
float mMinScale
 Minimum scale at which this layer should be displayed.
float mMaxScale
 Maximum scale at which this layer should be displayed.
bool mScaleBasedVisibility
 A flag that tells us whether to use the above vars to restrict layer visibility.


Member Enumeration Documentation

enum QgsMapLayer::LayerType

Layers enum defining the types of layers that can be added to a map.

Enumerator:
VectorLayer 
RasterLayer 

Reimplemented in QgsRasterLayer.

Definition at line 47 of file qgsmaplayer.h.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
type Type of layer as defined in QgsMapLayer::LayerType enum
lyrname Display Name of the layer

Definition at line 43 of file qgsmaplayer.cpp.

References capitaliseLayerName(), mCRS, mID, mLayerName, mMaxScale, mMinScale, mScaleBasedVisibility, and QgsDebugMsg.

QgsMapLayer::~QgsMapLayer (  )  [virtual]

Destructor.

Definition at line 80 of file qgsmaplayer.cpp.

References mCRS.

QgsMapLayer::QgsMapLayer ( QgsMapLayer const &   )  [private]

private copy constructor - QgsMapLayer not copyable


Member Function Documentation

QgsMapLayer::LayerType QgsMapLayer::type (  )  const

Get the type of the layer.

Returns:
Integer matching a value in the QgsMapLayer::LayerType enum

Definition at line 85 of file qgsmaplayer.cpp.

References mLayerType.

Referenced by QgsLegendModel::addLayer(), QgsRasterLayer::copySymbologySettings(), QgsVectorLayer::geometryType(), QgsRasterLayer::hasCompatibleSymbology(), QgsVectorLayer::hasCompatibleSymbology(), QgsRasterLayer::identify(), QgsRasterLayer::readData(), QgsMapRenderer::render(), QgsLegendModel::setLayerSet(), and QgsLegendModel::updateLayer().

QString QgsMapLayer::getLayerID (  )  const

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

Definition at line 91 of file qgsmaplayer.cpp.

References mID.

Referenced by QgsLegendModel::addLayer(), QgsMapLayerRegistry::addMapLayer(), QgsLegendModel::setLayerSet(), and writeXML().

void QgsMapLayer::setLayerName ( const QString &  name  ) 

Set the display name of the layer.

Parameters:
name New name for the layer

Definition at line 97 of file qgsmaplayer.cpp.

References capitaliseLayerName(), layerNameChanged(), mLayerName, and QgsDebugMsg.

Referenced by QgsRasterLayer::QgsRasterLayer(), readXML(), and QgsVectorLayer::setDataProvider().

QString const & QgsMapLayer::name (  )  const

Get the display name of the layer.

Returns:
the layer name

Definition at line 105 of file qgsmaplayer.cpp.

References mLayerName, and QgsDebugMsg.

Referenced by QgsLegendModel::addLayer(), QgsRasterLayer::bandStatistics(), QgsVectorLayer::commitChanges(), QgsVectorLayer::editType(), QgsVectorLayer::hasCompatibleSymbology(), QgsRasterLayer::legendAsPixmap(), QgsQuickPrint::printMap(), QgsRasterLayer::readData(), QgsVectorLayer::readSymbology(), QgsMapRenderer::render(), QgsRasterLayer::setDataProvider(), QgsVectorLayer::setDataProvider(), QgsVectorLayer::setEditType(), QgsLegendModel::setLayerSet(), QgsMapCanvas::showError(), QgsVectorLayer::writeSymbology(), and writeXML().

bool QgsMapLayer::draw ( QgsRenderContext rendererContext  )  [virtual]

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 131 of file qgsmaplayer.cpp.

void QgsMapLayer::drawLabels ( QgsRenderContext rendererContext  )  [virtual]

Draw labels to be removed: used only in vector layers.

Reimplemented in QgsVectorLayer.

Definition at line 136 of file qgsmaplayer.cpp.

Referenced by QgsMapRenderer::render().

QgsRectangle QgsMapLayer::extent (  )  const

Return the extent of the layer as a QRect.

Definition at line 126 of file qgsmaplayer.cpp.

References mLayerExtent.

Referenced by QgsMapRenderer::render().

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

Definition at line 314 of file qgsmaplayer.cpp.

References mValid.

Referenced by QgsMapLayerRegistry::addMapLayer(), QgsRasterLayer::readFile(), and QgsProjectFileTransform::transform0110to1000().

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.

Definition at line 111 of file qgsmaplayer.cpp.

References mDataSource.

Referenced by loadDefaultStyle(), and saveDefaultStyle().

QString const & QgsMapLayer::source (  )  const

Returns the source for the layer.

Definition at line 121 of file qgsmaplayer.cpp.

References mDataSource.

Referenced by QgsRasterLayer::readXml(), QgsRasterLayer::update(), and writeXML().

QStringList QgsMapLayer::subLayers (  )  [virtual]

Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS).

Definition at line 376 of file qgsmaplayer.cpp.

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

Definition at line 381 of file qgsmaplayer.cpp.

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

Set the visibility of the given sublayer name.

Definition at line 386 of file qgsmaplayer.cpp.

virtual bool QgsMapLayer::isEditable (  )  const [pure virtual]

True if the layer can be edited.

Implemented in QgsVectorLayer, and QgsRasterLayer.

bool QgsMapLayer::readXML ( QDomNode &  layer_node  ) 

sets state from Dom document

Parameters:
layer_node is Dom node 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

Definition at line 141 of file qgsmaplayer.cpp.

References QgsCoordinateReferenceSystem::customSrsValidation(), hasScaleBasedVisibility(), mCRS, mDataSource, mID, readXml(), QgsCoordinateReferenceSystem::readXML(), QgsCoordinateReferenceSystem::setCustomSrsValidation(), setLayerName(), setMaximumScale(), setMinimumScale(), setTransparency(), toggleScaleBasedVisibility(), and QgsCoordinateReferenceSystem::validate().

Referenced by _getMapLayers(), QgsProject::read(), and QgsLegendModel::readXML().

bool QgsMapLayer::writeXML ( QDomNode &  layer_node,
QDomDocument &  document 
)

stores state in Dom node

Parameters:
layer_node is Dom node corresponding to ``projectlayers'' tag
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 241 of file qgsmaplayer.cpp.

References getLayerID(), getTransparency(), hasScaleBasedVisibility(), maximumScale(), mCRS, minimumScale(), name(), source(), writeXml(), and QgsCoordinateReferenceSystem::writeXML().

virtual bool QgsMapLayer::copySymbologySettings ( const QgsMapLayer other  )  [pure virtual]

Copies the symbology settings from another layer.

Returns true in case of success

Implemented in QgsVectorLayer, and QgsRasterLayer.

virtual bool QgsMapLayer::hasCompatibleSymbology ( const QgsMapLayer other  )  const [pure virtual]

Returns true if this layer can be in the same symbology group with another layer.

Implemented in QgsVectorLayer, and QgsRasterLayer.

unsigned int QgsMapLayer::getTransparency (  ) 

Accessor for transparency level.

Definition at line 401 of file qgsmaplayer.cpp.

References mTransparencyLevel.

Referenced by writeXML().

void QgsMapLayer::setTransparency ( unsigned  int  ) 

Mutator for transparency level.

Should be between 0 and 255

Definition at line 406 of file qgsmaplayer.cpp.

References mTransparencyLevel.

Referenced by readXML().

QString QgsMapLayer::lastErrorTitle (  )  [virtual]

If an operation returns 0 (e.g.

draw()), this function returns the text of the error associated with the failure. Interactive users of this provider can then, for example, call a QMessageBox to display the contents.

Reimplemented in QgsRasterLayer.

Definition at line 327 of file qgsmaplayer.cpp.

Referenced by QgsMapCanvas::showError().

QString QgsMapLayer::lastError (  )  [virtual]

If an operation returns 0 (e.g.

draw()), this function returns the text of the error associated with the failure. Interactive users of this provider can then, for example, call a QMessageBox to display the contents.

Reimplemented in QgsRasterLayer.

Definition at line 332 of file qgsmaplayer.cpp.

Referenced by QgsMapCanvas::showError().

const QgsCoordinateReferenceSystem & QgsMapLayer::srs (  ) 

Returns layer's spatial reference system.

Definition at line 391 of file qgsmaplayer.cpp.

References mCRS.

Referenced by QgsMapRenderer::layerExtentToOutputExtent(), QgsMapRenderer::layerToMapCoordinates(), QgsMapRenderer::mapToLayerCoordinates(), QgsRasterLayer::readXml(), QgsMapRenderer::render(), setCrs(), QgsMapRenderer::splitLayersExtent(), and QgsVectorFileWriter::writeAsShapefile().

void QgsMapLayer::setCrs ( const QgsCoordinateReferenceSystem srs  ) 

Sets layer's spatial reference system.

Definition at line 396 of file qgsmaplayer.cpp.

References mCRS, and srs().

QString QgsMapLayer::capitaliseLayerName ( const QString  name  )  [static]

A convenience function to capitalise the layer name.

Definition at line 411 of file qgsmaplayer.cpp.

Referenced by QgsMapLayer(), and setLayerName().

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:
a 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 426 of file qgsmaplayer.cpp.

References loadNamedStyle(), and publicSource().

Referenced by QgsRasterLayer::QgsRasterLayer(), and QgsVectorLayer::QgsVectorLayer().

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:
QString 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.
a 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 ();

Definition at line 485 of file qgsmaplayer.cpp.

References QgsProject::instance(), loadNamedStyleFromDb(), QgsApplication::pkgDataPath(), QgsApplication::qgisSettingsDirPath(), QgsDebugMsg, and readSymbology().

Referenced by loadDefaultStyle().

bool QgsMapLayer::loadNamedStyleFromDb ( const QString  db,
const QString  theURI,
QString &  qml 
) [virtual]

Definition at line 443 of file qgsmaplayer.cpp.

References QgsDebugMsg.

Referenced by loadNamedStyle().

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:
a 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:
also loadNamedStyle () and saveNamedStyle()

Definition at line 552 of file qgsmaplayer.cpp.

References publicSource(), 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:
QString 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 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.
a 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:
also saveDefaultStyle ();

Definition at line 557 of file qgsmaplayer.cpp.

References QGis::QGIS_VERSION, QgsApplication::qgisSettingsDirPath(), and writeSymbology().

Referenced by saveDefaultStyle().

virtual bool QgsMapLayer::readSymbology ( const QDomNode &  node,
QString &  errorMessage 
) [pure virtual]

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

Parameters:
QDomNode node that will contain the symbology definition for this layer.
errorMessage reference to string that will be updated with any error messages
Returns:
true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

Referenced by loadNamedStyle().

virtual bool QgsMapLayer::writeSymbology ( QDomNode &  ,
QDomDocument &  doc,
QString &  errorMessage 
) const [pure virtual]

Write the symbology for the layer into the docment provided.

Parameters:
QDomNode the node that will have the style element added to it.
QDomDocument the document that will have the QDomNode added.
errorMessage reference to string that will be updated with any error messages
Returns:
true in case of success.

Implemented in QgsVectorLayer, and QgsRasterLayer.

Referenced by saveNamedStyle().

void QgsMapLayer::invalidTransformInput (  )  [virtual, slot]

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

Definition at line 320 of file qgsmaplayer.cpp.

References QgsLogger::warning().

void QgsMapLayer::setMinimumScale ( float  theMinScale  )  [slot]

Accessor and mutator for the minimum scale member.

Definition at line 354 of file qgsmaplayer.cpp.

References mMinScale.

Referenced by readXML().

float QgsMapLayer::minimumScale (  )  [slot]

Definition at line 359 of file qgsmaplayer.cpp.

References mMinScale.

Referenced by QgsMapRenderer::render(), and writeXML().

void QgsMapLayer::setMaximumScale ( float  theMaxScale  )  [slot]

Accessor and mutator for the maximum scale member.

Definition at line 365 of file qgsmaplayer.cpp.

References mMaxScale.

Referenced by readXML().

float QgsMapLayer::maximumScale (  )  [slot]

Definition at line 370 of file qgsmaplayer.cpp.

References mMaxScale.

Referenced by QgsMapRenderer::render(), and writeXML().

void QgsMapLayer::toggleScaleBasedVisibility ( bool  theVisibilityFlag  )  [slot]

Accessor and mutator for the scale based visilibility flag.

Definition at line 344 of file qgsmaplayer.cpp.

References mScaleBasedVisibility.

Referenced by readXML().

bool QgsMapLayer::hasScaleBasedVisibility (  )  [slot]

Definition at line 349 of file qgsmaplayer.cpp.

References mScaleBasedVisibility.

Referenced by readXML(), QgsMapRenderer::render(), and writeXML().

void QgsMapLayer::drawingProgress ( int  theProgress,
int  theTotalSteps 
) [signal]

Emit a signal to notify of a progress event.

Referenced by QgsRasterLayer::bandStatistics(), QgsRasterLayer::buildPyramids(), QgsVectorLayer::draw(), and QgsRasterLayer::updateProgress().

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)

Referenced by QgsRasterLayer::bandStatistics(), QgsRasterLayer::draw(), QgsRasterLayer::QgsRasterLayer(), and QgsRasterLayer::showStatusMessage().

void QgsMapLayer::layerNameChanged (  )  [signal]

Emit a signal that layer name has been changed.

Referenced by setLayerName().

void QgsMapLayer::repaintRequested (  )  [signal]

This signal should be connected with the slot QgsMapCanvas::refresh() : to be removed - GUI dependency.

Referenced by QgsRasterLayer::triggerRepaint(), and QgsVectorLayer::triggerRepaint().

void QgsMapLayer::screenUpdateRequested (  )  [signal]

The layer emits this signal when a screen update is requested.

This signal should be connected with the slot QgsMapCanvas::updateMap()

Referenced by QgsVectorLayer::draw().

void QgsMapLayer::recalculateExtents (  )  [signal]

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

Referenced by QgsVectorLayer::updateExtents().

bool QgsMapLayer::readXml ( QDomNode &  layer_node  )  [protected, virtual]

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

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 232 of file qgsmaplayer.cpp.

Referenced by readXML().

bool QgsMapLayer::writeXml ( QDomNode &  layer_node,
QDomDocument &  document 
) [protected, virtual]

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

Reimplemented in QgsVectorLayer, and QgsRasterLayer.

Definition at line 304 of file qgsmaplayer.cpp.

Referenced by writeXML().

void QgsMapLayer::connectNotify ( const char *  signal  )  [protected]

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

Definition at line 337 of file qgsmaplayer.cpp.

References QgsDebugMsg.

QgsMapLayer& QgsMapLayer::operator= ( QgsMapLayer const &   )  [private]

private assign operator - QgsMapLayer not copyable


Member Data Documentation

unsigned int QgsMapLayer::mTransparencyLevel [protected]

Transparency level for this layer should be 0-255 (255 being opaque).

Definition at line 318 of file qgsmaplayer.h.

Referenced by QgsRasterLayer::draw(), QgsVectorLayer::drawLineString(), QgsRasterLayer::drawMultiBandColor(), QgsRasterLayer::drawPalettedSingleBandColor(), QgsRasterLayer::drawPalettedSingleBandGray(), QgsRasterLayer::drawPalettedSingleBandPseudoColor(), QgsRasterLayer::drawSingleBandGray(), QgsRasterLayer::drawSingleBandPseudoColor(), getTransparency(), and setTransparency().

QgsRectangle QgsMapLayer::mLayerExtent [protected]

Extent of the layer.

Definition at line 321 of file qgsmaplayer.h.

Referenced by QgsRasterLayer::draw(), extent(), QgsRasterLayer::identify(), QgsRasterLayer::readFile(), QgsRasterLayer::setDataProvider(), QgsVectorLayer::setDataProvider(), and QgsVectorLayer::updateExtents().

bool QgsMapLayer::mValid [protected]

Indicates if the layer is valid and can be drawn.

Definition at line 324 of file qgsmaplayer.h.

Referenced by QgsRasterLayer::closeDataset(), isValid(), QgsVectorLayer::QgsVectorLayer(), QgsRasterLayer::readFile(), QgsVectorLayer::readXml(), QgsRasterLayer::setDataProvider(), QgsVectorLayer::setDataProvider(), and QgsVectorLayer::~QgsVectorLayer().

QString QgsMapLayer::mDataSource [protected]

data source description string, varies by layer type

Definition at line 327 of file qgsmaplayer.h.

Referenced by QgsRasterLayer::buildPyramids(), publicSource(), QgsVectorLayer::readXml(), readXML(), QgsRasterLayer::setDataProvider(), QgsVectorLayer::setDataProvider(), QgsVectorLayer::setSubsetString(), and source().

QString QgsMapLayer::mLayerName [protected]

Name of the layer - used for display.

Definition at line 330 of file qgsmaplayer.h.

Referenced by name(), QgsMapLayer(), and setLayerName().

QgsCoordinateReferenceSystem* QgsMapLayer::mCRS [protected]

layer's Spatial reference system

Definition at line 333 of file qgsmaplayer.h.

Referenced by QgsVectorLayer::addTopologicalPoints(), QgsRasterLayer::metadata(), QgsMapLayer(), QgsRasterLayer::readFile(), readXML(), QgsVectorLayer::setCoordinateSystem(), setCrs(), QgsRasterLayer::setDataProvider(), srs(), writeXML(), and ~QgsMapLayer().

QString QgsMapLayer::mID [private]

Unique ID of this layer - used to refer to this layer in map layer registry.

Definition at line 344 of file qgsmaplayer.h.

Referenced by getLayerID(), QgsMapLayer(), and readXML().

QgsMapLayer::LayerType QgsMapLayer::mLayerType [private]

Type of the layer (eg.

vector, raster)

Definition at line 347 of file qgsmaplayer.h.

Referenced by type().

QString QgsMapLayer::mTag [private]

Tag for embedding additional information.

Definition at line 350 of file qgsmaplayer.h.

float QgsMapLayer::mMinScale [private]

Minimum scale at which this layer should be displayed.

Definition at line 353 of file qgsmaplayer.h.

Referenced by minimumScale(), QgsMapLayer(), and setMinimumScale().

float QgsMapLayer::mMaxScale [private]

Maximum scale at which this layer should be displayed.

Definition at line 355 of file qgsmaplayer.h.

Referenced by maximumScale(), QgsMapLayer(), and setMaximumScale().

bool QgsMapLayer::mScaleBasedVisibility [private]

A flag that tells us whether to use the above vars to restrict layer visibility.

Definition at line 357 of file qgsmaplayer.h.

Referenced by hasScaleBasedVisibility(), QgsMapLayer(), and toggleScaleBasedVisibility().


The documentation for this class was generated from the following files:
Generated on Sat Feb 7 12:56:47 2009 for Quantum GIS API Documentation by  doxygen 1.5.1