QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugins. More...

#include <qgisinterface.h>

Public Slots
virtual void	zoomFull ()=0
	Zoom to full extent of map layers.
virtual void	zoomToPrevious ()=0
	Zoom to previous view extent.
virtual void	zoomToNext ()=0
	Zoom to next view extent.
virtual void	zoomToActiveLayer ()=0
	Zoom to extent of the active layer.
virtual QgsVectorLayer *	addVectorLayer (QString vectorLayerPath, QString baseName, QString providerKey)=0
	Add a vector layer.
virtual QgsRasterLayer *	addRasterLayer (QString rasterLayerPath, QString baseName=QString())=0
	Add a raster layer given a raster layer file name.
virtual QgsRasterLayer *	addRasterLayer (const QString &url, const QString &layerName, const QString &providerKey)=0
	Add a WMS layer.
virtual bool	addProject (QString theProject)=0
	Add a project.
virtual void	newProject (bool thePromptToSaveFlag=false)=0
	Start a blank project.
virtual QgsMapLayer *	activeLayer ()=0
	Get pointer to the active layer (layer selected in the legend)
virtual bool	setActiveLayer (QgsMapLayer *)=0
	Set the active layer (layer gets selected in the legend) returns true if the layer exists, false otherwise.
virtual int	addToolBarIcon (QAction *qAction)=0
	Add an icon to the plugins toolbar.
virtual QAction *	addToolBarWidget (QWidget *widget)=0
	Add a widget to the plugins toolbar.
virtual void	removeToolBarIcon (QAction *qAction)=0
	Remove an action (icon) from the plugin toolbar.
virtual QAction *	addRasterToolBarWidget (QWidget *widget)=0
	Add a widget to the raster toolbar.
virtual int	addRasterToolBarIcon (QAction *qAction)=0
	Add an icon to the Raster toolbar.
virtual void	removeRasterToolBarIcon (QAction *qAction)=0
	Remove an action (icon) from the Raster toolbar.
virtual int	addVectorToolBarIcon (QAction *qAction)=0
	Add an icon to the Vector toolbar.
virtual QAction *	addVectorToolBarWidget (QWidget *widget)=0
	Add a widget to the vector toolbar.
virtual void	removeVectorToolBarIcon (QAction *qAction)=0
	Remove an action (icon) from the Vector toolbar.
virtual int	addDatabaseToolBarIcon (QAction *qAction)=0
	Add an icon to the Database toolbar.
virtual QAction *	addDatabaseToolBarWidget (QWidget *widget)=0
	Add a widget to the database toolbar.
virtual void	removeDatabaseToolBarIcon (QAction *qAction)=0
	Remove an action (icon) from the Database toolbar.
virtual int	addWebToolBarIcon (QAction *qAction)=0
	Add an icon to the Web toolbar.
virtual QAction *	addWebToolBarWidget (QWidget *widget)=0
	Add a widget to the web toolbar.
virtual void	removeWebToolBarIcon (QAction *qAction)=0
	Remove an action (icon) from the Web toolbar.
virtual QToolBar *	addToolBar (QString name)=0
	Add toolbar with specified name.
virtual void	addToolBar (QToolBar *toolbar, Qt::ToolBarArea area=Qt::TopToolBarArea)=0
	Add a toolbar.
virtual QgsMapCanvas *	mapCanvas ()=0
	Return a pointer to the map canvas.
virtual QWidget *	mainWindow ()=0
	Return a pointer to the main window (instance of QgisApp in case of QGIS)
virtual QgsMessageBar *	messageBar ()=0
	Return the message bar of the main app.
virtual QList< QgsComposerView * >	activeComposers ()=0
	Return mainwindows / composer views of running composer instances (currently only one)
virtual QgsComposerView *	createNewComposer (QString title=QString(""))=0
	Create a new composer.
virtual QgsComposerView *	duplicateComposer (QgsComposerView *composerView, QString title=QString(""))=0
	Duplicate an existing parent composer from composer view.
virtual void	deleteComposer (QgsComposerView *composerView)=0
	Deletes parent composer of composer view, after closing composer window.
virtual QMap< QString, QVariant >	defaultStyleSheetOptions ()=0
	Return changeable options built from settings and/or defaults.
virtual void	buildStyleSheet (const QMap< QString, QVariant > &opts)=0
	Generate stylesheet.
virtual void	saveStyleSheetOptions (const QMap< QString, QVariant > &opts)=0
	Save changed default option keys/values to user settings.
virtual QFont	defaultStyleSheetFont ()=0
	Get reference font for initial qApp (may not be same as QgisApp)
virtual void	addPluginToMenu (QString name, QAction *action)=0
	Add action to the plugins menu.
virtual void	removePluginMenu (QString name, QAction *action)=0
	Remove action from the plugins menu.
virtual void	insertAddLayerAction (QAction *action)=0
	Add "add layer" action to layer menu.
virtual void	removeAddLayerAction (QAction *action)=0
	Remove "add layer" action from layer menu.
virtual void	addPluginToDatabaseMenu (QString name, QAction *action)=0
	Add action to the Database menu.
virtual void	removePluginDatabaseMenu (QString name, QAction *action)=0
	Remove action from the Database menu.
virtual void	addPluginToRasterMenu (QString name, QAction *action)=0
	Add action to the Raster menu.
virtual void	removePluginRasterMenu (QString name, QAction *action)=0
	Remove action from the Raster menu.
virtual void	addPluginToVectorMenu (QString name, QAction *action)=0
	Add action to the Vector menu.
virtual void	removePluginVectorMenu (QString name, QAction *action)=0
	Remove action from the Vector menu.
virtual void	addPluginToWebMenu (QString name, QAction *action)=0
	Add action to the Web menu.
virtual void	removePluginWebMenu (QString name, QAction *action)=0
	Remove action from the Web menu.
virtual void	addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget)=0
	Add a dock widget to the main window.
virtual void	removeDockWidget (QDockWidget *dockwidget)=0
	Remove specified dock widget from main window (doesn't delete it).
virtual void	showLayerProperties (QgsMapLayer *l)=0
	open layer properties dialog
virtual void	showAttributeTable (QgsVectorLayer *l)=0
	open attribute table dialog
virtual void	addWindow (QAction *action)=0
	Add window to Window menu.
virtual void	removeWindow (QAction *action)=0
	Remove window from Window menu.
virtual bool	registerMainWindowAction (QAction *action, QString defaultShortcut)=0
	Register action to the shortcuts manager so its shortcut can be changed in GUI.
virtual bool	unregisterMainWindowAction (QAction *action)=0
	Unregister a previously registered action.
virtual Q_DECL_DEPRECATED void	openURL (QString url, bool useQgisDocDirectory=true)=0
	Open a url in the users browser.
virtual Q_DECL_DEPRECATED QMenu *	fileMenu ()=0
	Accessors for inserting items into menus and toolbars.
virtual QMenu *	projectMenu ()=0
virtual QMenu *	editMenu ()=0
virtual QMenu *	viewMenu ()=0
virtual QMenu *	layerMenu ()=0
virtual QMenu *	newLayerMenu ()=0
virtual QMenu *	addLayerMenu ()=0
virtual QMenu *	settingsMenu ()=0
virtual QMenu *	pluginMenu ()=0
virtual QMenu *	rasterMenu ()=0
virtual QMenu *	databaseMenu ()=0
virtual QMenu *	vectorMenu ()=0
virtual QMenu *	webMenu ()=0
virtual QMenu *	firstRightStandardMenu ()=0
virtual QMenu *	windowMenu ()=0
virtual QMenu *	helpMenu ()=0
virtual QToolBar *	fileToolBar ()=0
virtual QToolBar *	layerToolBar ()=0
virtual QToolBar *	mapNavToolToolBar ()=0
virtual QToolBar *	digitizeToolBar ()=0
virtual QToolBar *	advancedDigitizeToolBar ()=0
virtual QToolBar *	attributesToolBar ()=0
virtual QToolBar *	pluginToolBar ()=0
virtual QToolBar *	helpToolBar ()=0
virtual QToolBar *	rasterToolBar ()=0
virtual QToolBar *	vectorToolBar ()=0
virtual QToolBar *	databaseToolBar ()=0
virtual QToolBar *	webToolBar ()=0
virtual QAction *	actionNewProject ()=0
virtual QAction *	actionOpenProject ()=0
virtual QAction *	actionSaveProject ()=0
virtual QAction *	actionSaveProjectAs ()=0
virtual QAction *	actionSaveMapAsImage ()=0
virtual QAction *	actionProjectProperties ()=0
virtual QAction *	actionPrintComposer ()=0
virtual QAction *	actionShowComposerManager ()=0
virtual QAction *	actionExit ()=0
virtual QAction *	actionCutFeatures ()=0
virtual QAction *	actionCopyFeatures ()=0
virtual QAction *	actionPasteFeatures ()=0
virtual QAction *	actionAddFeature ()=0
virtual QAction *	actionDeleteSelected ()=0
virtual QAction *	actionMoveFeature ()=0
virtual QAction *	actionSplitFeatures ()=0
virtual QAction *	actionSplitParts ()=0
virtual QAction *	actionAddRing ()=0
virtual QAction *	actionAddPart ()=0
virtual QAction *	actionSimplifyFeature ()=0
virtual QAction *	actionDeleteRing ()=0
virtual QAction *	actionDeletePart ()=0
virtual QAction *	actionNodeTool ()=0
virtual QAction *	actionPan ()=0
	Get access to the native pan action. Call trigger() on it to set the default pan map tool.
virtual QAction *	actionTouch ()=0
	Get access to the native touch action.
virtual QAction *	actionPanToSelected ()=0
	Get access to the native pan to selected action. Call trigger() on it to pan the map canvas to the selection.
virtual QAction *	actionZoomIn ()=0
	Get access to the native zoom in action. Call trigger() on it to set the default zoom in map tool.
virtual QAction *	actionZoomOut ()=0
	Get access to the native zoom out action. Call trigger() on it to set the default zoom out map tool.
virtual QAction *	actionSelect ()=0
	Get access to the native select action. Call trigger() on it to set the default select map tool.
virtual QAction *	actionSelectRectangle ()=0
	Get access to the native select rectangle action. Call trigger() on it to set the default select rectangle map tool.
virtual QAction *	actionSelectPolygon ()=0
	Get access to the native select polygon action. Call trigger() on it to set the default select polygon map tool.
virtual QAction *	actionSelectFreehand ()=0
	Get access to the native select freehand action. Call trigger() on it to set the default select freehand map tool.
virtual QAction *	actionSelectRadius ()=0
	Get access to the native select radius action. Call trigger() on it to set the default select radius map tool.
virtual QAction *	actionIdentify ()=0
	Get access to the native identify action. Call trigger() on it to set the default identify map tool.
virtual QAction *	actionFeatureAction ()=0
	Get access to the native run action feature action. Call trigger() on it to set the default run feature action map tool.
virtual QAction *	actionMeasure ()=0
	Get access to the native measure action. Call trigger() on it to set the default measure map tool.
virtual QAction *	actionMeasureArea ()=0
	Get access to the native measure area action. Call trigger() on it to set the default measure area map tool.
virtual QAction *	actionZoomFullExtent ()=0
	Get access to the native zoom full extent action. Call trigger() on it to zoom to the full extent.
virtual QAction *	actionZoomToLayer ()=0
	Get access to the native zoom to layer action. Call trigger() on it to zoom to the active layer.
virtual QAction *	actionZoomToSelected ()=0
	Get access to the native zoom to selected action. Call trigger() on it to zoom to the current selection.
virtual QAction *	actionZoomLast ()=0
	Get access to the native zoom last action. Call trigger() on it to zoom to last.
virtual QAction *	actionZoomNext ()=0
	Get access to the native zoom next action. Call trigger() on it to zoom to next.
virtual QAction *	actionZoomActualSize ()=0
	Get access to the native zoom actual size action. Call trigger() on it to zoom to actual size.
virtual QAction *	actionMapTips ()=0
	Get access to the native map tips action. Call trigger() on it to toggle map tips.
virtual QAction *	actionNewBookmark ()=0
	Get access to the native new bookmark action. Call trigger() on it to open the new bookmark dialog.
virtual QAction *	actionShowBookmarks ()=0
	Get access to the native show bookmarks action. Call trigger() on it to open the bookmarks dialog.
virtual QAction *	actionDraw ()=0
	Get access to the native draw action.
virtual QAction *	actionNewVectorLayer ()=0
virtual QAction *	actionAddOgrLayer ()=0
virtual QAction *	actionAddRasterLayer ()=0
virtual QAction *	actionAddPgLayer ()=0
virtual QAction *	actionAddWmsLayer ()=0
virtual QAction *	actionCopyLayerStyle ()=0
virtual QAction *	actionPasteLayerStyle ()=0
virtual QAction *	actionOpenTable ()=0
virtual QAction *	actionOpenFieldCalculator ()=0
virtual QAction *	actionToggleEditing ()=0
virtual QAction *	actionSaveActiveLayerEdits ()=0
virtual QAction *	actionAllEdits ()=0
virtual QAction *	actionSaveEdits ()=0
virtual QAction *	actionSaveAllEdits ()=0
virtual QAction *	actionRollbackEdits ()=0
virtual QAction *	actionRollbackAllEdits ()=0
virtual QAction *	actionCancelEdits ()=0
virtual QAction *	actionCancelAllEdits ()=0
virtual QAction *	actionLayerSaveAs ()=0
virtual Q_DECL_DEPRECATED QAction *	actionLayerSelectionSaveAs ()=0
virtual QAction *	actionRemoveLayer ()=0
virtual QAction *	actionDuplicateLayer ()=0
virtual QAction *	actionLayerProperties ()=0
virtual QAction *	actionAddToOverview ()=0
virtual QAction *	actionAddAllToOverview ()=0
virtual QAction *	actionRemoveAllFromOverview ()=0
virtual QAction *	actionHideAllLayers ()=0
virtual QAction *	actionShowAllLayers ()=0
virtual QAction *	actionHideSelectedLayers ()=0
virtual QAction *	actionShowSelectedLayers ()=0
virtual QAction *	actionManagePlugins ()=0
virtual QAction *	actionPluginListSeparator ()=0
virtual QAction *	actionShowPythonDialog ()=0
virtual QAction *	actionToggleFullScreen ()=0
virtual QAction *	actionOptions ()=0
virtual QAction *	actionCustomProjection ()=0
virtual QAction *	actionHelpContents ()=0
virtual QAction *	actionQgisHomePage ()=0
virtual QAction *	actionCheckQgisVersion ()=0
virtual QAction *	actionAbout ()=0
virtual bool	openFeatureForm (QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly=false, bool showModal=true)=0
	Open feature form.
virtual QgsAttributeDialog *	getFeatureForm (QgsVectorLayer *l, QgsFeature &f)=0
	Returns a feature form for a given feature.
virtual QgsVectorLayerTools *	vectorLayerTools ()=0
	Access the vector layer tools instance.
virtual void	preloadForm (QString uifile)=0
	This method is only needed when using a UI form with a custom widget plugin and calling openFeatureForm or getFeatureForm from Python (PyQt4) and you havn't used the info tool first.
virtual QList< QgsMapLayer * >	editableLayers (bool modified=false) const =0
	Return vector layers in edit mode.
virtual int	messageTimeout ()=0
	Get timeout for timed messages: default of 5 seconds.

Signals
void	currentLayerChanged (QgsMapLayer *layer)
	Emitted whenever current (selected) layer changes.
void	composerAdded (QgsComposerView *v)
	This signal is emitted when a new composer instance has been created.
void	composerWillBeRemoved (QgsComposerView *v)
	This signal is emitted before a new composer instance is going to be removed.
void	initializationCompleted ()
	This signal is emitted when the initialization is complete.
void	projectRead ()
	emitted when a project file is successfully read
void	newProjectCreated ()
	emitted when starting an entirely new project

Public Member Functions
	QgisInterface ()
	Constructor.
virtual	~QgisInterface ()
	Virtual destructor.
virtual QgsLegendInterface *	legendInterface ()=0
	Get pointer to legend interface.
virtual QgsPluginManagerInterface *	pluginManagerInterface ()=0
virtual QgsLayerTreeView *	layerTreeView ()=0

Detailed Description

QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugins.

Only functionality exposed by QgisInterface can be used in plugins. This interface has to be implemented with application specific details.

QGIS implements it in QgisAppInterface class, 3rd party applications could provide their own implementation to be able to use plugins.

Constructor & Destructor Documentation

QgisInterface::QgisInterface ( )

Constructor.

QgisInterface::~QgisInterface ( )

virtual

Virtual destructor.

Member Function Documentation

virtual QAction* QgisInterface::actionAbout ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddAllToOverview ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddFeature ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddOgrLayer ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddPart ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddPgLayer ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddRasterLayer ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddRing ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddToOverview ( )

pure virtualslot

virtual QAction* QgisInterface::actionAddWmsLayer ( )

pure virtualslot

virtual QAction* QgisInterface::actionAllEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionCancelAllEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionCancelEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionCheckQgisVersion ( )

pure virtualslot

virtual QAction* QgisInterface::actionCopyFeatures ( )

pure virtualslot

virtual QAction* QgisInterface::actionCopyLayerStyle ( )

pure virtualslot

virtual QAction* QgisInterface::actionCustomProjection ( )

pure virtualslot

virtual QAction* QgisInterface::actionCutFeatures ( )

pure virtualslot

virtual QAction* QgisInterface::actionDeletePart ( )

pure virtualslot

virtual QAction* QgisInterface::actionDeleteRing ( )

pure virtualslot

virtual QAction* QgisInterface::actionDeleteSelected ( )

pure virtualslot

virtual QAction* QgisInterface::actionDraw ( )

pure virtualslot

Get access to the native draw action.

virtual QAction* QgisInterface::actionDuplicateLayer ( )

pure virtualslot

virtual QAction* QgisInterface::actionExit ( )

pure virtualslot

virtual QAction* QgisInterface::actionFeatureAction ( )

pure virtualslot

Get access to the native run action feature action. Call trigger() on it to set the default run feature action map tool.

virtual QAction* QgisInterface::actionHelpContents ( )

pure virtualslot

virtual QAction* QgisInterface::actionHideAllLayers ( )

pure virtualslot

virtual QAction* QgisInterface::actionHideSelectedLayers ( )

pure virtualslot

virtual QAction* QgisInterface::actionIdentify ( )

pure virtualslot

Get access to the native identify action. Call trigger() on it to set the default identify map tool.

virtual QAction* QgisInterface::actionLayerProperties ( )

pure virtualslot

virtual QAction* QgisInterface::actionLayerSaveAs ( )

pure virtualslot

virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionLayerSelectionSaveAs ( )

pure virtualslot

Deprecated:: in 2.4 - returns null pointer

virtual QAction* QgisInterface::actionManagePlugins ( )

pure virtualslot

virtual QAction* QgisInterface::actionMapTips ( )

pure virtualslot

Get access to the native map tips action. Call trigger() on it to toggle map tips.

virtual QAction* QgisInterface::actionMeasure ( )

pure virtualslot

Get access to the native measure action. Call trigger() on it to set the default measure map tool.

virtual QAction* QgisInterface::actionMeasureArea ( )

pure virtualslot

Get access to the native measure area action. Call trigger() on it to set the default measure area map tool.

virtual QAction* QgisInterface::actionMoveFeature ( )

pure virtualslot

virtual QAction* QgisInterface::actionNewBookmark ( )

pure virtualslot

Get access to the native new bookmark action. Call trigger() on it to open the new bookmark dialog.

virtual QAction* QgisInterface::actionNewProject ( )

pure virtualslot

virtual QAction* QgisInterface::actionNewVectorLayer ( )

pure virtualslot

virtual QAction* QgisInterface::actionNodeTool ( )

pure virtualslot

virtual QAction* QgisInterface::actionOpenFieldCalculator ( )

pure virtualslot

virtual QAction* QgisInterface::actionOpenProject ( )

pure virtualslot

virtual QAction* QgisInterface::actionOpenTable ( )

pure virtualslot

virtual QAction* QgisInterface::actionOptions ( )

pure virtualslot

virtual QAction* QgisInterface::actionPan ( )

pure virtualslot

Get access to the native pan action. Call trigger() on it to set the default pan map tool.

virtual QAction* QgisInterface::actionPanToSelected ( )

pure virtualslot

Get access to the native pan to selected action. Call trigger() on it to pan the map canvas to the selection.

virtual QAction* QgisInterface::actionPasteFeatures ( )

pure virtualslot

virtual QAction* QgisInterface::actionPasteLayerStyle ( )

pure virtualslot

virtual QAction* QgisInterface::actionPluginListSeparator ( )

pure virtualslot

virtual QAction* QgisInterface::actionPrintComposer ( )

pure virtualslot

virtual QAction* QgisInterface::actionProjectProperties ( )

pure virtualslot

virtual QAction* QgisInterface::actionQgisHomePage ( )

pure virtualslot

virtual QAction* QgisInterface::actionRemoveAllFromOverview ( )

pure virtualslot

virtual QAction* QgisInterface::actionRemoveLayer ( )

pure virtualslot

virtual QAction* QgisInterface::actionRollbackAllEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionRollbackEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionSaveActiveLayerEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionSaveAllEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionSaveEdits ( )

pure virtualslot

virtual QAction* QgisInterface::actionSaveMapAsImage ( )

pure virtualslot

virtual QAction* QgisInterface::actionSaveProject ( )

pure virtualslot

virtual QAction* QgisInterface::actionSaveProjectAs ( )

pure virtualslot

virtual QAction* QgisInterface::actionSelect ( )

pure virtualslot

Get access to the native select action. Call trigger() on it to set the default select map tool.

virtual QAction* QgisInterface::actionSelectFreehand ( )

pure virtualslot

Get access to the native select freehand action. Call trigger() on it to set the default select freehand map tool.

virtual QAction* QgisInterface::actionSelectPolygon ( )

pure virtualslot

Get access to the native select polygon action. Call trigger() on it to set the default select polygon map tool.

virtual QAction* QgisInterface::actionSelectRadius ( )

pure virtualslot

Get access to the native select radius action. Call trigger() on it to set the default select radius map tool.

virtual QAction* QgisInterface::actionSelectRectangle ( )

pure virtualslot

Get access to the native select rectangle action. Call trigger() on it to set the default select rectangle map tool.

virtual QAction* QgisInterface::actionShowAllLayers ( )

pure virtualslot

virtual QAction* QgisInterface::actionShowBookmarks ( )

pure virtualslot

Get access to the native show bookmarks action. Call trigger() on it to open the bookmarks dialog.

virtual QAction* QgisInterface::actionShowComposerManager ( )

pure virtualslot

virtual QAction* QgisInterface::actionShowPythonDialog ( )

pure virtualslot

virtual QAction* QgisInterface::actionShowSelectedLayers ( )

pure virtualslot

virtual QAction* QgisInterface::actionSimplifyFeature ( )

pure virtualslot

virtual QAction* QgisInterface::actionSplitFeatures ( )

pure virtualslot

virtual QAction* QgisInterface::actionSplitParts ( )

pure virtualslot

virtual QAction* QgisInterface::actionToggleEditing ( )

pure virtualslot

virtual QAction* QgisInterface::actionToggleFullScreen ( )

pure virtualslot

virtual QAction* QgisInterface::actionTouch ( )

pure virtualslot

Get access to the native touch action.

virtual QAction* QgisInterface::actionZoomActualSize ( )

pure virtualslot

Get access to the native zoom actual size action. Call trigger() on it to zoom to actual size.

virtual QAction* QgisInterface::actionZoomFullExtent ( )

pure virtualslot

Get access to the native zoom full extent action. Call trigger() on it to zoom to the full extent.

virtual QAction* QgisInterface::actionZoomIn ( )

pure virtualslot

Get access to the native zoom in action. Call trigger() on it to set the default zoom in map tool.

virtual QAction* QgisInterface::actionZoomLast ( )

pure virtualslot

Get access to the native zoom last action. Call trigger() on it to zoom to last.

virtual QAction* QgisInterface::actionZoomNext ( )

pure virtualslot

Get access to the native zoom next action. Call trigger() on it to zoom to next.

virtual QAction* QgisInterface::actionZoomOut ( )

pure virtualslot

Get access to the native zoom out action. Call trigger() on it to set the default zoom out map tool.

virtual QAction* QgisInterface::actionZoomToLayer ( )

pure virtualslot

Get access to the native zoom to layer action. Call trigger() on it to zoom to the active layer.

virtual QAction* QgisInterface::actionZoomToSelected ( )

pure virtualslot

Get access to the native zoom to selected action. Call trigger() on it to zoom to the current selection.

virtual QList<QgsComposerView*> QgisInterface::activeComposers ( )

pure virtualslot

Return mainwindows / composer views of running composer instances (currently only one)

virtual QgsMapLayer* QgisInterface::activeLayer ( )

pure virtualslot

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

virtual int QgisInterface::addDatabaseToolBarIcon ( QAction * qAction )

pure virtualslot

Add an icon to the Database toolbar.

virtual QAction* QgisInterface::addDatabaseToolBarWidget ( QWidget * widget )

pure virtualslot

Add a widget to the database toolbar.

To remove this widget again, call removeDatabaseToolBarIcon with the returned QAction.

Parameters

widget widget to add. The toolbar will take ownership of this widget

Returns: the QAction you can use to remove this widget from the toolbar

virtual void QgisInterface::addDockWidget	(	Qt::DockWidgetArea	area,
		QDockWidget *	dockwidget
	)

pure virtualslot

Add a dock widget to the main window.

virtual QMenu* QgisInterface::addLayerMenu ( )

pure virtualslot

Note: added in 2.5

virtual void QgisInterface::addPluginToDatabaseMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Add action to the Database menu.

virtual void QgisInterface::addPluginToMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Add action to the plugins menu.

virtual void QgisInterface::addPluginToRasterMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Add action to the Raster menu.

virtual void QgisInterface::addPluginToVectorMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Add action to the Vector menu.

virtual void QgisInterface::addPluginToWebMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Add action to the Web menu.

virtual bool QgisInterface::addProject ( QString theProject )

pure virtualslot

Add a project.

virtual QgsRasterLayer* QgisInterface::addRasterLayer	(	QString	rasterLayerPath,
		QString	baseName = `QString()`
	)

pure virtualslot

Add a raster layer given a raster layer file name.

virtual QgsRasterLayer* QgisInterface::addRasterLayer	(	const QString &	url,
		const QString &	layerName,
		const QString &	providerKey
	)

pure virtualslot

Add a WMS layer.

virtual int QgisInterface::addRasterToolBarIcon ( QAction * qAction )

pure virtualslot

Add an icon to the Raster toolbar.

virtual QAction* QgisInterface::addRasterToolBarWidget ( QWidget * widget )

pure virtualslot

Add a widget to the raster toolbar.

To remove this widget again, call removeRasterToolBarIcon with the returned QAction.

Parameters

widget widget to add. The toolbar will take ownership of this widget

Returns: the QAction you can use to remove this widget from the toolbar

virtual QToolBar* QgisInterface::addToolBar ( QString name )

pure virtualslot

Add toolbar with specified name.

virtual void QgisInterface::addToolBar	(	QToolBar *	toolbar,
		Qt::ToolBarArea	area = `Qt::TopToolBarArea`
	)

pure virtualslot

Add a toolbar.

Note: added in 2.3

virtual int QgisInterface::addToolBarIcon ( QAction * qAction )

pure virtualslot

Add an icon to the plugins toolbar.

virtual QAction* QgisInterface::addToolBarWidget ( QWidget * widget )

pure virtualslot

Add a widget to the plugins toolbar.

To remove this widget again, call removeToolBarIcon with the returned QAction.

Parameters

widget widget to add. The toolbar will take ownership of this widget

Returns: the QAction you can use to remove this widget from the toolbar

virtual QgsVectorLayer* QgisInterface::addVectorLayer	(	QString	vectorLayerPath,
		QString	baseName,
		QString	providerKey
	)

pure virtualslot

Add a vector layer.

virtual int QgisInterface::addVectorToolBarIcon ( QAction * qAction )

pure virtualslot

Add an icon to the Vector toolbar.

virtual QAction* QgisInterface::addVectorToolBarWidget ( QWidget * widget )

pure virtualslot

Add a widget to the vector toolbar.

To remove this widget again, call removeVectorToolBarIcon with the returned QAction.

Parameters

widget widget to add. The toolbar will take ownership of this widget

Returns: the QAction you can use to remove this widget from the toolbar

virtual int QgisInterface::addWebToolBarIcon ( QAction * qAction )

pure virtualslot

Add an icon to the Web toolbar.

virtual QAction* QgisInterface::addWebToolBarWidget ( QWidget * widget )

pure virtualslot

Add a widget to the web toolbar.

To remove this widget again, call removeWebToolBarIcon with the returned QAction.

Parameters

widget widget to add. The toolbar will take ownership of this widget

Returns: the QAction you can use to remove this widget from the toolbar

virtual void QgisInterface::addWindow ( QAction * action )

pure virtualslot

Add window to Window menu.

The action title is the window title and the action should raise, unminimize and activate the window.

virtual QToolBar* QgisInterface::advancedDigitizeToolBar ( )

pure virtualslot

virtual QToolBar* QgisInterface::attributesToolBar ( )

pure virtualslot

virtual void QgisInterface::buildStyleSheet ( const QMap< QString, QVariant > & opts )

pure virtualslot

Generate stylesheet.

Parameters

opts	generated default option values, or a changed copy of them

void QgisInterface::composerAdded ( QgsComposerView * v )

signal

This signal is emitted when a new composer instance has been created.

void QgisInterface::composerWillBeRemoved ( QgsComposerView * v )

signal

This signal is emitted before a new composer instance is going to be removed.

virtual QgsComposerView* QgisInterface::createNewComposer ( QString title = QString("") )

pure virtualslot

Create a new composer.

Parameters

title window title for new composer (one will be generated if empty)

Returns: pointer to composer's view

Note: new composer window will be shown and activated

void QgisInterface::currentLayerChanged ( QgsMapLayer * layer )

signal

Emitted whenever current (selected) layer changes.

The pointer to layer can be null if no layer is selected

virtual QMenu* QgisInterface::databaseMenu ( )

pure virtualslot

virtual QToolBar* QgisInterface::databaseToolBar ( )

pure virtualslot

virtual QFont QgisInterface::defaultStyleSheetFont ( )

pure virtualslot

Get reference font for initial qApp (may not be same as QgisApp)

virtual QMap<QString, QVariant> QgisInterface::defaultStyleSheetOptions ( )

pure virtualslot

Return changeable options built from settings and/or defaults.

virtual void QgisInterface::deleteComposer ( QgsComposerView * composerView )

pure virtualslot

Deletes parent composer of composer view, after closing composer window.

virtual QToolBar* QgisInterface::digitizeToolBar ( )

pure virtualslot

virtual QgsComposerView* QgisInterface::duplicateComposer	(	QgsComposerView *	composerView,
		QString	title = `QString("")`
	)

pure virtualslot

Duplicate an existing parent composer from composer view.

Parameters

composerView	pointer to existing composer view
title	window title for duplicated composer (one will be generated if empty)

Returns: pointer to duplicate composer's view

Note: dupicate composer window will be hidden until loaded, then shown and activated

virtual QList<QgsMapLayer *> QgisInterface::editableLayers ( bool modified = false ) const

pure virtualslot

Return vector layers in edit mode.

Parameters

modified whether to return only layers that have been modified

Returns: list of layers in legend order, or empty list

virtual QMenu* QgisInterface::editMenu ( )

pure virtualslot

virtual Q_DECL_DEPRECATED QMenu* QgisInterface::fileMenu ( )

pure virtualslot

Accessors for inserting items into menus and toolbars.

An item can be inserted before any existing action.

virtual QToolBar* QgisInterface::fileToolBar ( )

pure virtualslot

virtual QMenu* QgisInterface::firstRightStandardMenu ( )

pure virtualslot

virtual QgsAttributeDialog* QgisInterface::getFeatureForm	(	QgsVectorLayer *	l,
		QgsFeature &	f
	)

pure virtualslot

Returns a feature form for a given feature.

Parameters

l	The layer for which the dialog will be created
f	The feature for which the dialog will be created

Returns: A feature form

virtual QMenu* QgisInterface::helpMenu ( )

pure virtualslot

virtual QToolBar* QgisInterface::helpToolBar ( )

pure virtualslot

void QgisInterface::initializationCompleted ( )

signal

This signal is emitted when the initialization is complete.

virtual void QgisInterface::insertAddLayerAction ( QAction * action )

pure virtualslot

Add "add layer" action to layer menu.

virtual QMenu* QgisInterface::layerMenu ( )

pure virtualslot

virtual QToolBar* QgisInterface::layerToolBar ( )

pure virtualslot

virtual QgsLayerTreeView* QgisInterface::layerTreeView ( )

pure virtual

virtual QgsLegendInterface* QgisInterface::legendInterface ( )

pure virtual

Get pointer to legend interface.

virtual QWidget* QgisInterface::mainWindow ( )

pure virtualslot

Return a pointer to the main window (instance of QgisApp in case of QGIS)

virtual QgsMapCanvas* QgisInterface::mapCanvas ( )

pure virtualslot

Return a pointer to the map canvas.

virtual QToolBar* QgisInterface::mapNavToolToolBar ( )

pure virtualslot

virtual QgsMessageBar* QgisInterface::messageBar ( )

pure virtualslot

Return the message bar of the main app.

virtual int QgisInterface::messageTimeout ( )

pure virtualslot

Get timeout for timed messages: default of 5 seconds.

virtual QMenu* QgisInterface::newLayerMenu ( )

pure virtualslot

virtual void QgisInterface::newProject ( bool thePromptToSaveFlag = false )

pure virtualslot

Start a blank project.

void QgisInterface::newProjectCreated ( )

signal

emitted when starting an entirely new project

Note: This is similar to projectRead(); plug-ins might want to be notified that they're in a new project. Yes, projectRead() could have been overloaded to be used in the case of new projects instead. However, it's probably more semantically correct to have an entirely separate signal for when this happens.

virtual bool QgisInterface::openFeatureForm	(	QgsVectorLayer *	l,
		QgsFeature &	f,
		bool	updateFeatureOnly = `false`,
		bool	showModal = `true`
	)

pure virtualslot

Open feature form.

Parameters

l	vector layer
f	feature to show/modify
updateFeatureOnly	only update the feature update (don't change any attributes of the layer) [UNUSED]
showModal	if true, will wait for the dialog to be executed (only shown otherwise)

virtual Q_DECL_DEPRECATED void QgisInterface::openURL	(	QString	url,
		bool	useQgisDocDirectory = `true`
	)

pure virtualslot

Open a url in the users browser.

By default the QGIS doc directory is used as the base for the URL. To open a URL that is not relative to the installed QGIS documentation, set useQgisDocDirectory to false.

Parameters

url	URL to open
useQgisDocDirectory	If true, the URL will be formed by concatenating url to the QGIS documentation directory path (prefix/share/doc)

Deprecated:

virtual QgsPluginManagerInterface* QgisInterface::pluginManagerInterface ( )

pure virtual

virtual QMenu* QgisInterface::pluginMenu ( )

pure virtualslot

virtual QToolBar* QgisInterface::pluginToolBar ( )

pure virtualslot

virtual void QgisInterface::preloadForm ( QString uifile )

pure virtualslot

This method is only needed when using a UI form with a custom widget plugin and calling openFeatureForm or getFeatureForm from Python (PyQt4) and you havn't used the info tool first.

Python will crash bringing QGIS wtih it if the custom form is not loaded from a C++ method call.

This method uses a QTimer to call QUiLoader in order to load the form via C++ you only need to call this once after that you can call openFeatureForm/getFeatureForm like normal

More information here: http://qt-project.org/forums/viewthread/27098/

virtual QMenu* QgisInterface::projectMenu ( )

pure virtualslot

void QgisInterface::projectRead ( )

signal

emitted when a project file is successfully read

Note: This is useful for plug-ins that store properties with project files. A plug-in can connect to this signal. When it is emitted, the plug-in knows to then check the project properties for any relevant state.

virtual QMenu* QgisInterface::rasterMenu ( )

pure virtualslot

virtual QToolBar* QgisInterface::rasterToolBar ( )

pure virtualslot

virtual bool QgisInterface::registerMainWindowAction	(	QAction *	action,
		QString	defaultShortcut
	)

pure virtualslot

Register action to the shortcuts manager so its shortcut can be changed in GUI.

virtual void QgisInterface::removeAddLayerAction ( QAction * action )

pure virtualslot

Remove "add layer" action from layer menu.

virtual void QgisInterface::removeDatabaseToolBarIcon ( QAction * qAction )

pure virtualslot

Remove an action (icon) from the Database toolbar.

virtual void QgisInterface::removeDockWidget ( QDockWidget * dockwidget )

pure virtualslot

Remove specified dock widget from main window (doesn't delete it).

virtual void QgisInterface::removePluginDatabaseMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Remove action from the Database menu.

virtual void QgisInterface::removePluginMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Remove action from the plugins menu.

virtual void QgisInterface::removePluginRasterMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Remove action from the Raster menu.

virtual void QgisInterface::removePluginVectorMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Remove action from the Vector menu.

virtual void QgisInterface::removePluginWebMenu	(	QString	name,
		QAction *	action
	)

pure virtualslot

Remove action from the Web menu.

virtual void QgisInterface::removeRasterToolBarIcon ( QAction * qAction )

pure virtualslot

Remove an action (icon) from the Raster toolbar.

virtual void QgisInterface::removeToolBarIcon ( QAction * qAction )

pure virtualslot

Remove an action (icon) from the plugin toolbar.

virtual void QgisInterface::removeVectorToolBarIcon ( QAction * qAction )

pure virtualslot

Remove an action (icon) from the Vector toolbar.

virtual void QgisInterface::removeWebToolBarIcon ( QAction * qAction )

pure virtualslot

Remove an action (icon) from the Web toolbar.

virtual void QgisInterface::removeWindow ( QAction * action )

pure virtualslot

Remove window from Window menu.

Calling this is necessary only for windows which are hidden rather than deleted when closed.

virtual void QgisInterface::saveStyleSheetOptions ( const QMap< QString, QVariant > & opts )

pure virtualslot

Save changed default option keys/values to user settings.

virtual bool QgisInterface::setActiveLayer ( QgsMapLayer * )

pure virtualslot

Set the active layer (layer gets selected in the legend) returns true if the layer exists, false otherwise.

virtual QMenu* QgisInterface::settingsMenu ( )

pure virtualslot

virtual void QgisInterface::showAttributeTable ( QgsVectorLayer * l )

pure virtualslot

open attribute table dialog

virtual void QgisInterface::showLayerProperties ( QgsMapLayer * l )

pure virtualslot

open layer properties dialog

virtual bool QgisInterface::unregisterMainWindowAction ( QAction * action )

pure virtualslot

Unregister a previously registered action.

(e.g. when plugin is going to be unloaded)

virtual QgsVectorLayerTools* QgisInterface::vectorLayerTools ( )

pure virtualslot

Access the vector layer tools instance.

With the help of this you can access methods like addFeature, startEditing or stopEditing while giving the user the appropriate dialogs.

Returns: An instance of the vector layer tools

virtual QMenu* QgisInterface::vectorMenu ( )

pure virtualslot

virtual QToolBar* QgisInterface::vectorToolBar ( )

pure virtualslot

virtual QMenu* QgisInterface::viewMenu ( )

pure virtualslot

virtual QMenu* QgisInterface::webMenu ( )

pure virtualslot

virtual QToolBar* QgisInterface::webToolBar ( )

pure virtualslot

virtual QMenu* QgisInterface::windowMenu ( )

pure virtualslot

virtual void QgisInterface::zoomFull ( )

pure virtualslot

Zoom to full extent of map layers.

virtual void QgisInterface::zoomToActiveLayer ( )

pure virtualslot

Zoom to extent of the active layer.

virtual void QgisInterface::zoomToNext ( )

pure virtualslot

Zoom to next view extent.

virtual void QgisInterface::zoomToPrevious ( )

pure virtualslot

Zoom to previous view extent.

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

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

Public Slots

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation