safe.gis.qgis_interface module¶

InaSAFE Disaster risk assessment tool developed by AusAid - QGIS plugin implementation.

Contact : ole.moller.nielsen@gmail.com

class safe.gis.qgis_interface.QgisInterface(canvas)[source]¶

Bases: PyQt4.QtCore.QObject

Class to expose qgis objects and functions to plugins.

This class is here for enabling us to run unit tests only, so most methods are simply stubs.

activeLayer()[source]¶

Get pointer to the active layer (layer selected in the legend).

addDockWidget(area, dock_widget)[source]¶

Add a dock widget to the main window.

Parameters:	area – Where in the ui the dock should be placed. dock_widget (QDockWidget) – A dock widget to add to the UI.

addLayer(layer)[source]¶

Handle a layer being added to the registry so it shows up in canvas.

Parameters:	layer – list<QgsMapLayer> list of map layers that were added

addLayers(layers)[source]¶

Handle layers being added to the registry so they show up in canvas.

Parameters:	layers – list<QgsMapLayer> list of map layers that were added

Note

The QgsInterface api does not include this method, it is added here as a helper to facilitate testing.

addRasterLayer(path, base_name)[source]¶

Add a raster layer given a raster layer file name

Parameters:	path (str) – Path to layer. base_name (str) – Base name for layer.

addToolBar(name)[source]¶

Add toolbar with specified name.

Parameters:	name (str) – Name for the toolbar.

addToolBarIcon(action)[source]¶

Add an icon to the plugins toolbar.

Parameters:	action (QAction) – Action to add to the toolbar.

addVectorLayer(path, base_name, provider_key)[source]¶

Add a vector layer.

Parameters:	path (str) – Path to layer. base_name (str) – Base name for layer. provider_key (str) – Provider key e.g. ‘ogr’

currentLayerChanged¶

layerSavedAs¶

layers()[source]¶

legendInterface()[source]¶

Get the legend.

See also discussion at:

https://github.com/AIFDR/inasafe/pull/924/

Implementation added for version 3.2.

mainWindow()[source]¶

Return a pointer to the main window.

In case of QGIS it returns an instance of QgisApp.

mapCanvas()[source]¶

Return a pointer to the map canvas.

messageBar()[source]¶

Get the message bar.

New in version 3.2.

Returns:	A QGIS message bar instance
Return type:	QgsMessageBar

newProject()[source]¶

Create new project.

next()[source]¶

removeAllLayers()[source]¶

Remove layers from the canvas before they get deleted.

Note

This is NOT part of the QGisInterface API but is needed to support QgsMapLayerRegistry.removeAllLayers().

removeToolBarIcon(action)[source]¶

Remove an action (icon) from the plugin toolbar.

Parameters:	action (QAction) – Action to add to the toolbar.

setActiveLayer(layer)[source]¶

Set the currently active layer in the legend. :param layer: Layer to make active. :type layer: QgsMapLayer, QgsVectorLayer, QgsRasterLayer

zoomFull()[source]¶

Zoom to the map full extent.

zoomToActiveLayer()[source]¶

Zoom to extent of active layer.

zoomToNext()[source]¶

Zoom to next view extent.

zoomToPrevious()[source]¶

Zoom to previous view extent.