QgsProjectBadLayerGuiHandler Class Reference

Handler for missing layers within project. More...

#include <qgsprojectbadlayerguihandler.h>

Inheritance diagram for QgsProjectBadLayerGuiHandler:

Public Member Functions
	QgsProjectBadLayerGuiHandler ()
virtual void	handleBadLayers (QList< QDomNode > layers, QDomDocument projectDom)
	implementation of the handler
Public Member Functions inherited from QgsProjectBadLayerHandler
virtual	~QgsProjectBadLayerHandler ()

Static Public Attributes
static bool	mIgnore = false
	Flag to store the Ignore button press of MessageBox used by QgsLegend.

Protected Types
enum	DataType { IS_VECTOR, IS_RASTER, IS_BOGUS }
	file data representation More...
enum	ProviderType { IS_FILE, IS_DATABASE, IS_URL, IS_Unknown }
	the three flavors for data More...

Protected Member Functions
DataType	dataType (QDomNode &layerNode)
	returns data type associated with the given QgsProject file Dom node
QString	dataSource (QDomNode &layerNode)
	return the data source for the given layer
ProviderType	providerType (QDomNode &layerNode)
	return the physical storage type associated with the given layer
void	setDataSource (QDomNode &layerNode, const QString &dataSource)
	set the datasource element to the new value
bool	findMissingFile (const QString &fileFilters, QDomNode &layerNode)
	this is used to locate files that have moved or otherwise are missing
bool	findLayer (const QString &fileFilters, const QDomNode &constLayerNode)
	find relocated data source for the given layer
void	findLayers (const QString &fileFilters, const QList< QDomNode > &layerNodes)
	find relocated data sources for given layers

Detailed Description

Handler for missing layers within project.

Gives user a chance to select path to the missing layers.

Member Enumeration Documentation

enum QgsProjectBadLayerGuiHandler::DataType

protected

file data representation

Enumerator:

IS_VECTOR
IS_RASTER
IS_BOGUS

enum QgsProjectBadLayerGuiHandler::ProviderType

protected

the three flavors for data

Enumerator:

IS_FILE
IS_DATABASE
IS_URL
IS_Unknown

Constructor & Destructor Documentation

QgsProjectBadLayerGuiHandler::QgsProjectBadLayerGuiHandler

(

)

Member Function Documentation

QString QgsProjectBadLayerGuiHandler::dataSource ( QDomNode &  layerNode )

protected

return the data source for the given layer

The QDomNode is a QgsProject Dom node corresponding to a map layer state.

Essentially dumps datasource tag.

QgsProjectBadLayerGuiHandler::DataType QgsProjectBadLayerGuiHandler::dataType ( QDomNode &  layerNode )

protected

returns data type associated with the given QgsProject file Dom node

The Dom node should represent the state associated with a specific layer.

bool QgsProjectBadLayerGuiHandler::findLayer ( const QString &  fileFilters, const QDomNode &  constLayerNode  )

protected

find relocated data source for the given layer

This QDom object represents a QgsProject node that maps to a specific layer.

Parameters

fileFilters	file filters to use
constLayerNode	QDom node containing layer project information

Todo:

XXX Only implemented for file based layers. It will need to be extended for XXX other data source types such as databases.

void QgsProjectBadLayerGuiHandler::findLayers ( const QString &  fileFilters, const QList< QDomNode > &  layerNodes  )

protected

find relocated data sources for given layers

These QDom objects represent QgsProject nodes that map to specific layers.

bool QgsProjectBadLayerGuiHandler::findMissingFile ( const QString &  fileFilters, QDomNode &  layerNode  )

protected

this is used to locate files that have moved or otherwise are missing

void QgsProjectBadLayerGuiHandler::handleBadLayers ( QList< QDomNode >  layers, QDomDocument  projectDom  )

virtual

implementation of the handler

Implements QgsProjectBadLayerHandler.

QgsProjectBadLayerGuiHandler::ProviderType QgsProjectBadLayerGuiHandler::providerType ( QDomNode &  layerNode )

protected

return the physical storage type associated with the given layer

The QDomNode is a QgsProject Dom node corresponding to a map layer state.

If the provider tag is "ogr", then it's a file type.

However, if the layer is a raster, then there won't be a provider tag. It will always have an associated file.

If the layer doesn't fall into either of the previous two categories, then it's either a database or URL. If the datasource tag has "url=", then it's URL based and if it has "dbname=">, then the layer data is in a database.

void QgsProjectBadLayerGuiHandler::setDataSource ( QDomNode &  layerNode, const QString &  dataSource  )

protected

set the datasource element to the new value

Member Data Documentation

bool QgsProjectBadLayerGuiHandler::mIgnore = false

static

Flag to store the Ignore button press of MessageBox used by QgsLegend.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsprojectbadlayerguihandler.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsprojectbadlayerguihandler.cpp