QgisInterface Class Reference
[Gui]

#include <qgisinterface.h>

List of all members.

---

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.

Definition at line 49 of file 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	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, const QStringList &layers, const QStringList &styles, const QString &format, const QString &crs)=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 int	addToolBarIcon (QAction *qAction)=0
	Add an icon to the plugins toolbar.
virtual void	removeToolBarIcon (QAction *qAction)=0
	Remove an action (icon) from the plugin toolbar.
virtual QToolBar *	addToolBar (QString name)=0
	Add toolbar with specified name.
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 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	addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget)=0
	Add a dock widget to the main window.
virtual void	refreshLegend (QgsMapLayer *l)=0
	refresh the legend of a layer
virtual void	addWindow (QAction *action)=0
	Add window to Window menu.
virtual void	removeWindow (QAction *action)=0
	Remove window from Window menu.
virtual void	openURL (QString url, bool useQgisDocDirectory=true)=0
	Open a url in the users browser.
virtual QMenu *	fileMenu ()=0
	Menus.
virtual QMenu *	editMenu ()=0
virtual QMenu *	viewMenu ()=0
virtual QMenu *	layerMenu ()=0
virtual QMenu *	settingsMenu ()=0
virtual QMenu *	pluginMenu ()=0
virtual QMenu *	firstRightStandardMenu ()=0
virtual QMenu *	windowMenu ()=0
virtual QMenu *	helpMenu ()=0
virtual QToolBar *	fileToolBar ()=0
	ToolBars.
virtual QToolBar *	layerToolBar ()=0
virtual QToolBar *	mapNavToolToolBar ()=0
virtual QToolBar *	digitizeToolBar ()=0
virtual QToolBar *	attributesToolBar ()=0
virtual QToolBar *	pluginToolBar ()=0
virtual QToolBar *	helpToolBar ()=0
virtual QAction *	actionNewProject ()=0
	File menu actions.
virtual QAction *	actionOpenProject ()=0
virtual QAction *	actionFileSeparator1 ()=0
virtual QAction *	actionSaveProject ()=0
virtual QAction *	actionSaveProjectAs ()=0
virtual QAction *	actionSaveMapAsImage ()=0
virtual QAction *	actionFileSeparator2 ()=0
virtual QAction *	actionProjectProperties ()=0
virtual QAction *	actionFileSeparator3 ()=0
virtual QAction *	actionPrintComposer ()=0
virtual QAction *	actionFileSeparator4 ()=0
virtual QAction *	actionExit ()=0
virtual QAction *	actionCutFeatures ()=0
	Edit menu actions.
virtual QAction *	actionCopyFeatures ()=0
virtual QAction *	actionPasteFeatures ()=0
virtual QAction *	actionEditSeparator1 ()=0
virtual QAction *	actionCapturePoint ()=0
virtual QAction *	actionCaptureLine ()=0
virtual QAction *	actionCapturePologon ()=0
virtual QAction *	actionDeleteSelected ()=0
virtual QAction *	actionMoveFeature ()=0
virtual QAction *	actionSplitFeatures ()=0
virtual QAction *	actionAddVertex ()=0
virtual QAction *	actionDelerteVertex ()=0
virtual QAction *	actioMoveVertex ()=0
virtual QAction *	actionAddRing ()=0
virtual QAction *	actionAddIsland ()=0
virtual QAction *	actionEditSeparator2 ()=0
virtual QAction *	actionPan ()=0
	View menu actions.
virtual QAction *	actionZoomIn ()=0
virtual QAction *	actionZoomOut ()=0
virtual QAction *	actionSelect ()=0
virtual QAction *	actionIdentify ()=0
virtual QAction *	actionMeasure ()=0
virtual QAction *	actionMeasureArea ()=0
virtual QAction *	actionViewSeparator1 ()=0
virtual QAction *	actionZoomFullExtent ()=0
virtual QAction *	actionZoomToLayer ()=0
virtual QAction *	actionZoomToSelected ()=0
virtual QAction *	actionZoomLast ()=0
virtual QAction *	actionZoomActualSize ()=0
virtual QAction *	actionViewSeparator2 ()=0
virtual QAction *	actionMapTips ()=0
virtual QAction *	actionNewBookmark ()=0
virtual QAction *	actionShowBookmarks ()=0
virtual QAction *	actionDraw ()=0
virtual QAction *	actionViewSeparator3 ()=0
virtual QAction *	actionNewVectorLayer ()=0
	Layer menu actions.
virtual QAction *	actionAddOgrLayer ()=0
virtual QAction *	actionAddRasterLayer ()=0
virtual QAction *	actionAddPgLayer ()=0
virtual QAction *	actionAddWmsLayer ()=0
virtual QAction *	actionLayerSeparator1 ()=0
virtual QAction *	actionOpenTable ()=0
virtual QAction *	actionToggleEditing ()=0
virtual QAction *	actionLayerSaveAs ()=0
virtual QAction *	actionLayerSelectionSaveAs ()=0
virtual QAction *	actionRemoveLayer ()=0
virtual QAction *	actionLayerProperties ()=0
virtual QAction *	actionLayerSeparator2 ()=0
virtual QAction *	actionAddToOverview ()=0
virtual QAction *	actionAddAllToOverview ()=0
virtual QAction *	actionRemoveAllFromOverview ()=0
virtual QAction *	actionLayerSeparator3 ()=0
virtual QAction *	actionHideAllLayers ()=0
virtual QAction *	actionShowAllLayers ()=0
virtual QAction *	actionManagePlugins ()=0
	Plugin menu actions.
virtual QAction *	actionPluginSeparator1 ()=0
virtual QAction *	actionPluginListSeparator ()=0
virtual QAction *	actionPluginSeparator2 ()=0
virtual QAction *	actionPluginPythonSeparator ()=0
virtual QAction *	actionShowPythonDialog ()=0
virtual QAction *	actionToggleFullScreen ()=0
	Settings menu actions.
virtual QAction *	actionSettingsSeparator1 ()=0
virtual QAction *	actionOptions ()=0
virtual QAction *	actionCustomProjection ()=0
virtual QAction *	actionHelpContents ()=0
	Help menu actions.
virtual QAction *	actionHelpSeparator1 ()=0
virtual QAction *	actionQgisHomePage ()=0
virtual QAction *	actionCheckQgisVersion ()=0
virtual QAction *	actionHelpSeparator2 ()=0
virtual QAction *	actionAbout ()=0
Signals
void	currentLayerChanged (QgsMapLayer *layer)
	Emited whenever current (selected) layer changes.
Public Member Functions
	QgisInterface ()
	Constructor.
virtual	~QgisInterface ()
	Virtual destructor.

---

Constructor & Destructor Documentation

QgisInterface::QgisInterface

(

)

Constructor.

Definition at line 22 of file qgisinterface.cpp.

QgisInterface::~QgisInterface

(

)

[virtual]

Virtual destructor.

Definition at line 28 of file qgisinterface.cpp.

---

Member Function Documentation

virtual void QgisInterface::zoomFull

(

)

[pure virtual, slot]

Zoom to full extent of map layers.

virtual void QgisInterface::zoomToPrevious

(

)

[pure virtual, slot]

Zoom to previous view extent.

virtual void QgisInterface::zoomToActiveLayer

(

)

[pure virtual, slot]

Zoom to extent of the active layer.

virtual QgsVectorLayer* QgisInterface::addVectorLayer	(	QString	vectorLayerPath,
		QString	baseName,
		QString	providerKey
	)			[pure virtual, slot]

Add a vector layer.

virtual QgsRasterLayer* QgisInterface::addRasterLayer	(	QString	rasterLayerPath,
		QString	baseName = QString()
	)			[pure virtual, slot]

Add a raster layer given a raster layer file name.

virtual QgsRasterLayer* QgisInterface::addRasterLayer	(	const QString &	url,
		const QString &	layerName,
		const QString &	providerKey,
		const QStringList &	layers,
		const QStringList &	styles,
		const QString &	format,
		const QString &	crs
	)			[pure virtual, slot]

Add a WMS layer.

virtual bool QgisInterface::addProject

(

QString

theProject

)

[pure virtual, slot]

Add a project.

virtual void QgisInterface::newProject

(

bool

thePromptToSaveFlag = false

)

[pure virtual, slot]

Start a blank project.

virtual QgsMapLayer* QgisInterface::activeLayer

(

)

[pure virtual, slot]

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

virtual int QgisInterface::addToolBarIcon

(

QAction *

qAction

)

[pure virtual, slot]

Add an icon to the plugins toolbar.

virtual void QgisInterface::removeToolBarIcon

(

QAction *

qAction

)

[pure virtual, slot]

Remove an action (icon) from the plugin toolbar.

virtual QToolBar* QgisInterface::addToolBar

(

QString

name

)

[pure virtual, slot]

Add toolbar with specified name.

virtual QgsMapCanvas* QgisInterface::mapCanvas

(

)

[pure virtual, slot]

Return a pointer to the map canvas.

virtual QWidget* QgisInterface::mainWindow

(

)

[pure virtual, slot]

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

virtual void QgisInterface::addPluginToMenu	(	QString	name,
		QAction *	action
	)			[pure virtual, slot]

Add action to the plugins menu.

virtual void QgisInterface::removePluginMenu	(	QString	name,
		QAction *	action
	)			[pure virtual, slot]

Remove action from the plugins menu.

virtual void QgisInterface::addDockWidget	(	Qt::DockWidgetArea	area,
		QDockWidget *	dockwidget
	)			[pure virtual, slot]

Add a dock widget to the main window.

virtual void QgisInterface::refreshLegend

(

QgsMapLayer *

l

)

[pure virtual, slot]

refresh the legend of a layer

virtual void QgisInterface::addWindow

(

QAction *

action

)

[pure virtual, slot]

Add window to Window menu.

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

virtual void QgisInterface::removeWindow

(

QAction *

action

)

[pure virtual, slot]

Remove window from Window menu.

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

virtual void QgisInterface::openURL	(	QString	url,
		bool	useQgisDocDirectory = true
	)			[pure virtual, slot]

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)

virtual QMenu* QgisInterface::fileMenu

(

)

[pure virtual, slot]

Menus.

An item can be inserted before any existing action.

virtual QMenu* QgisInterface::editMenu

(

)

[pure virtual, slot]

virtual QMenu* QgisInterface::viewMenu

(

)

[pure virtual, slot]

virtual QMenu* QgisInterface::layerMenu

(

)

[pure virtual, slot]

virtual QMenu* QgisInterface::settingsMenu

(

)

[pure virtual, slot]

virtual QMenu* QgisInterface::pluginMenu

(

)

[pure virtual, slot]

virtual QMenu* QgisInterface::firstRightStandardMenu

(

)

[pure virtual, slot]

virtual QMenu* QgisInterface::windowMenu

(

)

[pure virtual, slot]

virtual QMenu* QgisInterface::helpMenu

(

)

[pure virtual, slot]

virtual QToolBar* QgisInterface::fileToolBar

(

)

[pure virtual, slot]

ToolBars.

virtual QToolBar* QgisInterface::layerToolBar

(

)

[pure virtual, slot]

virtual QToolBar* QgisInterface::mapNavToolToolBar

(

)

[pure virtual, slot]

virtual QToolBar* QgisInterface::digitizeToolBar

(

)

[pure virtual, slot]

virtual QToolBar* QgisInterface::attributesToolBar

(

)

[pure virtual, slot]

virtual QToolBar* QgisInterface::pluginToolBar

(

)

[pure virtual, slot]

virtual QToolBar* QgisInterface::helpToolBar

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionNewProject

(

)

[pure virtual, slot]

File menu actions.

virtual QAction* QgisInterface::actionOpenProject

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator1

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionSaveProject

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionSaveProjectAs

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionSaveMapAsImage

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator2

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionProjectProperties

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator3

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionPrintComposer

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator4

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionExit

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionCutFeatures

(

)

[pure virtual, slot]

Edit menu actions.

virtual QAction* QgisInterface::actionCopyFeatures

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionPasteFeatures

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionEditSeparator1

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionCapturePoint

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionCaptureLine

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionCapturePologon

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionDeleteSelected

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionMoveFeature

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionSplitFeatures

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddVertex

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionDelerteVertex

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actioMoveVertex

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddRing

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddIsland

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionEditSeparator2

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionPan

(

)

[pure virtual, slot]

View menu actions.

virtual QAction* QgisInterface::actionZoomIn

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionZoomOut

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionSelect

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionIdentify

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionMeasure

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionMeasureArea

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionViewSeparator1

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionZoomFullExtent

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionZoomToLayer

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionZoomToSelected

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionZoomLast

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionZoomActualSize

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionViewSeparator2

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionMapTips

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionNewBookmark

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionShowBookmarks

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionDraw

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionViewSeparator3

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionNewVectorLayer

(

)

[pure virtual, slot]

Layer menu actions.

virtual QAction* QgisInterface::actionAddOgrLayer

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddRasterLayer

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddPgLayer

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddWmsLayer

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSeparator1

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionOpenTable

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionToggleEditing

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSaveAs

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSelectionSaveAs

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionRemoveLayer

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionLayerProperties

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSeparator2

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddToOverview

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAddAllToOverview

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionRemoveAllFromOverview

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSeparator3

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionHideAllLayers

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionShowAllLayers

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionManagePlugins

(

)

[pure virtual, slot]

Plugin menu actions.

virtual QAction* QgisInterface::actionPluginSeparator1

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionPluginListSeparator

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionPluginSeparator2

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionPluginPythonSeparator

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionShowPythonDialog

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionToggleFullScreen

(

)

[pure virtual, slot]

Settings menu actions.

virtual QAction* QgisInterface::actionSettingsSeparator1

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionOptions

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionCustomProjection

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionHelpContents

(

)

[pure virtual, slot]

Help menu actions.

virtual QAction* QgisInterface::actionHelpSeparator1

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionQgisHomePage

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionCheckQgisVersion

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionHelpSeparator2

(

)

[pure virtual, slot]

virtual QAction* QgisInterface::actionAbout

(

)

[pure virtual, slot]

void QgisInterface::currentLayerChanged

(

QgsMapLayer *

layer

)

[signal]

Emited whenever current (selected) layer changes.

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

---

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

• src/gui/qgisinterface.h
• src/gui/qgisinterface.cpp

---