Source code for safe_qgis.qgis_interface
"""
InaSAFE Disaster risk assessment tool developed by AusAid -
**QGIS plugin implementation.**
Contact : ole.moller.nielsen@gmail.com
.. note:: This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.. note:: This source code was copied from the 'postgis viewer' application
with original authors:
Copyright (c) 2010 by Ivan Mincik, ivan.mincik@gista.sk
Copyright (c) 2011 German Carrillo, geotux_tuxman@linuxmail.org
"""
__author__ = 'tim@linfiniti.com'
__revision__ = '$Format:%H$'
__date__ = '10/01/2011'
__copyright__ = ('Copyright (c) 2010 by Ivan Mincik, ivan.mincik@gista.sk and '
'Copyright (c) 2011 German Carrillo, '
'geotux_tuxman@linuxmail.org')
import logging
from PyQt4.QtCore import QObject, SIGNAL, pyqtSlot
from qgis.core import QgsMapLayerRegistry
from qgis.gui import QgsMapCanvasLayer
LOGGER = logging.getLogger('InaSAFE')
[docs]class QgisInterface(QObject):
"""Class to expose qgis objects and functionalities to plugins.
This class is here for enabling us to run unit tests only,
so most methods are simply stubs.
"""
def __init__(self, canvas):
"""Constructor"""
QObject.__init__(self)
self.canvas = canvas
# Set up slots so we can mimick the behaviour of QGIS when layers
# are added.
LOGGER.debug('Initialising canvas...')
QObject.connect(QgsMapLayerRegistry.instance(),
SIGNAL('layersAdded(QList<QgsMapLayer *>)'),
self.addLayers)
QObject.connect(QgsMapLayerRegistry.instance(),
SIGNAL('layerWasAdded(QgsMapLayer *)'),
self.addLayer)
@pyqtSlot('QStringList')
[docs] def addLayers(self, theLayers):
"""Handle layers being added to the registry so they show up in canvas.
.. note: The QgsInterface api does not include this method, it is added
here as a helper to facilitate testing.
Args:
theLayers: list<QgsMapLayer> list of map layers that were added
Returns:
None
Raises:
None
"""
#LOGGER.debug('addLayers called on qgis_interface')
#LOGGER.debug('Number of layers being added: %s' % len(theLayers))
#LOGGER.debug('Layer Count Before: %s' % len(self.canvas.layers()))
myLayers = self.canvas.layers()
myCanvasLayers = []
for myLayer in myLayers:
myCanvasLayers.append(QgsMapCanvasLayer(myLayer))
for myLayer in theLayers:
myCanvasLayers.append(QgsMapCanvasLayer(myLayer))
self.canvas.setLayerSet(myCanvasLayers)
#LOGGER.debug('Layer Count After: %s' % len(self.canvas.layers()))
@pyqtSlot('QgsMapLayer')
[docs] def addLayer(self, theLayer):
"""Handle a layer being added to the registry so it shows up in canvas.
.. note: The QgsInterface api does not include this method, it is added
here as a helper to facilitate testing.
.. note: The addLayer method was deprecated in QGIS 1.8 so you should
not need this method much.
Args:
theLayers: list<QgsMapLayer> list of map layers that were added
Returns:
None
Raises:
None
"""
pass
# ---------------- API Mock for QgsInterface follows -------------------
[docs] def zoomFull(self):
"""Zoom to the map full extent"""
pass
[docs] def zoomToPrevious(self):
"""Zoom to previous view extent"""
pass
[docs] def zoomToNext(self):
"""Zoom to next view extent"""
pass
[docs] def zoomToActiveLayer(self):
"""Zoom to extent of active layer"""
pass
[docs] def addVectorLayer(self, vectorLayerPath, baseName, providerKey):
"""Add a vector layer"""
pass
[docs] def addRasterLayer(self, rasterLayerPath, baseName):
"""Add a raster layer given a raster layer file name"""
pass
[docs] def activeLayer(self):
"""Get pointer to the active layer (layer selected in the legend)"""
myLayers = QgsMapLayerRegistry.instance().mapLayers()
for myItem in myLayers:
return myLayers[myItem]
[docs] def mapCanvas(self):
"""Return a pointer to the map canvas"""
return self.canvas
[docs] def mainWindow(self):
"""Return a pointer to the main window
In case of QGIS it returns an instance of QgisApp
"""
pass