QGIS API Documentation  2.99.0-Master (8ec3eaf)
Public Slots | Signals | Public Member Functions | List of all members
QgisInterface Class Referenceabstract

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

#include <qgisinterface.h>

Inheritance diagram for QgisInterface:
Inheritance graph
[legend]

Public Slots

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

Signals

void composerAdded (QgsComposerView *v)
 This signal is emitted when a new composer instance has been created. More...
 
void composerRemoved (QgsComposerView *v)
 This signal is emitted when a composer instance has been removed. More...
 
void composerWillBeRemoved (QgsComposerView *v)
 This signal is emitted before a new composer instance is going to be removed. More...
 
void currentLayerChanged (QgsMapLayer *layer)
 Emitted whenever current (selected) layer changes. More...
 
void initializationCompleted ()
 This signal is emitted when the initialization is complete. More...
 
void layerSavedAs (QgsMapLayer *l, const QString &path)
 This signal is emitted when a layer has been saved using save as. More...
 
void newProjectCreated ()
 Emitted when starting an entirely new project. More...
 
void projectRead ()
 Emitted when a project file is successfully read. More...
 

Public Member Functions

 QgisInterface ()
 Constructor. More...
 
virtual ~QgisInterface ()
 Virtual destructor. More...
 
virtual void addCustomActionForLayer (QAction *action, QgsMapLayer *layer)=0
 Add action to context menu for a specific layer in the layer tree. More...
 
virtual void addCustomActionForLayerType (QAction *action, QString menu, QgsMapLayer::LayerType type, bool allLayers)=0
 Add action to context menu for layers in the layer tree. More...
 
virtual QgsLayerTreeViewlayerTreeView ()=0
 
virtual QgsPluginManagerInterfacepluginManagerInterface ()=0
 
virtual bool removeCustomActionForLayerType (QAction *action)=0
 Remove action for layers in the layer tree previously added with addCustomActionForLayerType() More...
 

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 66 of file qgisinterface.h.

Constructor & Destructor Documentation

§ QgisInterface()

QgisInterface::QgisInterface ( )

Constructor.

Definition at line 21 of file qgisinterface.cpp.

§ ~QgisInterface()

QgisInterface::~QgisInterface ( )
virtual

Virtual destructor.

Definition at line 27 of file qgisinterface.cpp.

Member Function Documentation

§ actionAbout

virtual QAction* QgisInterface::actionAbout ( )
pure virtualslot

§ actionAddAfsLayer

virtual QAction* QgisInterface::actionAddAfsLayer ( )
pure virtualslot

Get access to the native Add ArcGIS FeatureServer action.

§ actionAddAllToOverview

virtual QAction* QgisInterface::actionAddAllToOverview ( )
pure virtualslot

§ actionAddAmsLayer

virtual QAction* QgisInterface::actionAddAmsLayer ( )
pure virtualslot

Get access to the native Add ArcGIS MapServer action.

§ actionAddFeature

virtual QAction* QgisInterface::actionAddFeature ( )
pure virtualslot

§ actionAddOgrLayer

virtual QAction* QgisInterface::actionAddOgrLayer ( )
pure virtualslot

§ actionAddPart

virtual QAction* QgisInterface::actionAddPart ( )
pure virtualslot

§ actionAddPgLayer

virtual QAction* QgisInterface::actionAddPgLayer ( )
pure virtualslot

§ actionAddRasterLayer

virtual QAction* QgisInterface::actionAddRasterLayer ( )
pure virtualslot

§ actionAddRing

virtual QAction* QgisInterface::actionAddRing ( )
pure virtualslot

§ actionAddToOverview

virtual QAction* QgisInterface::actionAddToOverview ( )
pure virtualslot

§ actionAddWmsLayer

virtual QAction* QgisInterface::actionAddWmsLayer ( )
pure virtualslot

§ actionAllEdits

virtual QAction* QgisInterface::actionAllEdits ( )
pure virtualslot

§ actionCancelAllEdits

virtual QAction* QgisInterface::actionCancelAllEdits ( )
pure virtualslot

§ actionCancelEdits

virtual QAction* QgisInterface::actionCancelEdits ( )
pure virtualslot

§ actionCheckQgisVersion

virtual QAction* QgisInterface::actionCheckQgisVersion ( )
pure virtualslot

§ actionCopyFeatures

virtual QAction* QgisInterface::actionCopyFeatures ( )
pure virtualslot

§ actionCopyLayerStyle

virtual QAction* QgisInterface::actionCopyLayerStyle ( )
pure virtualslot

§ actionCustomProjection

virtual QAction* QgisInterface::actionCustomProjection ( )
pure virtualslot

§ actionCutFeatures

virtual QAction* QgisInterface::actionCutFeatures ( )
pure virtualslot

§ actionDeletePart

virtual QAction* QgisInterface::actionDeletePart ( )
pure virtualslot

§ actionDeleteRing

virtual QAction* QgisInterface::actionDeleteRing ( )
pure virtualslot

§ actionDeleteSelected

virtual QAction* QgisInterface::actionDeleteSelected ( )
pure virtualslot

§ actionDraw

virtual QAction* QgisInterface::actionDraw ( )
pure virtualslot

Get access to the native draw action.

§ actionDuplicateLayer

virtual QAction* QgisInterface::actionDuplicateLayer ( )
pure virtualslot

§ actionExit

virtual QAction* QgisInterface::actionExit ( )
pure virtualslot

§ actionFeatureAction

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.

§ actionHelpContents

virtual QAction* QgisInterface::actionHelpContents ( )
pure virtualslot

§ actionHideAllLayers

virtual QAction* QgisInterface::actionHideAllLayers ( )
pure virtualslot

§ actionHideSelectedLayers

virtual QAction* QgisInterface::actionHideSelectedLayers ( )
pure virtualslot

§ actionIdentify

virtual QAction* QgisInterface::actionIdentify ( )
pure virtualslot

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

§ actionLayerProperties

virtual QAction* QgisInterface::actionLayerProperties ( )
pure virtualslot

§ actionLayerSaveAs

virtual QAction* QgisInterface::actionLayerSaveAs ( )
pure virtualslot

§ actionManagePlugins

virtual QAction* QgisInterface::actionManagePlugins ( )
pure virtualslot

§ actionMapTips

virtual QAction* QgisInterface::actionMapTips ( )
pure virtualslot

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

§ actionMeasure

virtual QAction* QgisInterface::actionMeasure ( )
pure virtualslot

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

§ actionMeasureArea

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.

§ actionMoveFeature

virtual QAction* QgisInterface::actionMoveFeature ( )
pure virtualslot

§ actionNewBookmark

virtual QAction* QgisInterface::actionNewBookmark ( )
pure virtualslot

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

§ actionNewProject

virtual QAction* QgisInterface::actionNewProject ( )
pure virtualslot

§ actionNewVectorLayer

virtual QAction* QgisInterface::actionNewVectorLayer ( )
pure virtualslot

§ actionNodeTool

virtual QAction* QgisInterface::actionNodeTool ( )
pure virtualslot

§ actionOpenFieldCalculator

virtual QAction* QgisInterface::actionOpenFieldCalculator ( )
pure virtualslot

§ actionOpenProject

virtual QAction* QgisInterface::actionOpenProject ( )
pure virtualslot

§ actionOpenTable

virtual QAction* QgisInterface::actionOpenTable ( )
pure virtualslot

§ actionOptions

virtual QAction* QgisInterface::actionOptions ( )
pure virtualslot

§ actionPan

virtual QAction* QgisInterface::actionPan ( )
pure virtualslot

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

§ actionPanToSelected

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.

§ actionPasteFeatures

virtual QAction* QgisInterface::actionPasteFeatures ( )
pure virtualslot

§ actionPasteLayerStyle

virtual QAction* QgisInterface::actionPasteLayerStyle ( )
pure virtualslot

§ actionPluginListSeparator

virtual QAction* QgisInterface::actionPluginListSeparator ( )
pure virtualslot

§ actionPrintComposer

virtual QAction* QgisInterface::actionPrintComposer ( )
pure virtualslot

§ actionProjectProperties

virtual QAction* QgisInterface::actionProjectProperties ( )
pure virtualslot

§ actionQgisHomePage

virtual QAction* QgisInterface::actionQgisHomePage ( )
pure virtualslot

§ actionRemoveAllFromOverview

virtual QAction* QgisInterface::actionRemoveAllFromOverview ( )
pure virtualslot

§ actionRollbackAllEdits

virtual QAction* QgisInterface::actionRollbackAllEdits ( )
pure virtualslot

§ actionRollbackEdits

virtual QAction* QgisInterface::actionRollbackEdits ( )
pure virtualslot

§ actionSaveActiveLayerEdits

virtual QAction* QgisInterface::actionSaveActiveLayerEdits ( )
pure virtualslot

§ actionSaveAllEdits

virtual QAction* QgisInterface::actionSaveAllEdits ( )
pure virtualslot

§ actionSaveEdits

virtual QAction* QgisInterface::actionSaveEdits ( )
pure virtualslot

§ actionSaveMapAsImage

virtual QAction* QgisInterface::actionSaveMapAsImage ( )
pure virtualslot

§ actionSaveProject

virtual QAction* QgisInterface::actionSaveProject ( )
pure virtualslot

§ actionSaveProjectAs

virtual QAction* QgisInterface::actionSaveProjectAs ( )
pure virtualslot

§ actionSelect

virtual QAction* QgisInterface::actionSelect ( )
pure virtualslot

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

§ actionSelectFreehand

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.

§ actionSelectPolygon

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.

§ actionSelectRadius

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.

§ actionSelectRectangle

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.

§ actionShowAllLayers

virtual QAction* QgisInterface::actionShowAllLayers ( )
pure virtualslot

§ actionShowBookmarks

virtual QAction* QgisInterface::actionShowBookmarks ( )
pure virtualslot

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

§ actionShowComposerManager

virtual QAction* QgisInterface::actionShowComposerManager ( )
pure virtualslot

§ actionShowPythonDialog

virtual QAction* QgisInterface::actionShowPythonDialog ( )
pure virtualslot

§ actionShowSelectedLayers

virtual QAction* QgisInterface::actionShowSelectedLayers ( )
pure virtualslot

§ actionSimplifyFeature

virtual QAction* QgisInterface::actionSimplifyFeature ( )
pure virtualslot

§ actionSplitFeatures

virtual QAction* QgisInterface::actionSplitFeatures ( )
pure virtualslot

§ actionSplitParts

virtual QAction* QgisInterface::actionSplitParts ( )
pure virtualslot

§ actionToggleEditing

virtual QAction* QgisInterface::actionToggleEditing ( )
pure virtualslot

§ actionToggleFullScreen

virtual QAction* QgisInterface::actionToggleFullScreen ( )
pure virtualslot

§ actionTouch

virtual QAction* QgisInterface::actionTouch ( )
pure virtualslot

Get access to the native touch action.

§ actionZoomActualSize

virtual QAction* QgisInterface::actionZoomActualSize ( )
pure virtualslot

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

§ actionZoomFullExtent

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.

§ actionZoomIn

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.

§ actionZoomLast

virtual QAction* QgisInterface::actionZoomLast ( )
pure virtualslot

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

§ actionZoomNext

virtual QAction* QgisInterface::actionZoomNext ( )
pure virtualslot

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

§ actionZoomOut

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.

§ actionZoomToLayer

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.

§ actionZoomToSelected

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.

§ activeComposers

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

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

§ activeLayer

virtual QgsMapLayer* QgisInterface::activeLayer ( )
pure virtualslot

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

§ addCustomActionForLayer()

virtual void QgisInterface::addCustomActionForLayer ( QAction *  action,
QgsMapLayer layer 
)
pure virtual

Add action to context menu for a specific layer in the layer tree.

It is necessary to first call addCustomActionForLayerType() with allLayers=false in order for this method to have any effect.

See also
addCustomActionForLayerType()

§ addCustomActionForLayerType()

virtual void QgisInterface::addCustomActionForLayerType ( QAction *  action,
QString  menu,
QgsMapLayer::LayerType  type,
bool  allLayers 
)
pure virtual

Add action to context menu for layers in the layer tree.

If allLayers is true, then the action will be available for all layers of given type, otherwise the action will be available only for specific layers added with addCustomActionForLayer() after this call.

If menu argument is not empty, the action will be also added to a menu within the main window, creating menu with the given name if it does not exist yet.

See also
removeCustomActionForLayerType()
addCustomActionForLayer()

§ addDatabaseToolBarIcon

virtual int QgisInterface::addDatabaseToolBarIcon ( QAction *  qAction)
pure virtualslot

Add an icon to the Database toolbar.

§ addDatabaseToolBarWidget

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
widgetwidget to add. The toolbar will take ownership of this widget
Returns
the QAction you can use to remove this widget from the toolbar

§ addDockWidget

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

Add a dock widget to the main window.

§ addLayerMenu

virtual QMenu* QgisInterface::addLayerMenu ( )
pure virtualslot
Note
added in 2.5

§ addPluginToDatabaseMenu

virtual void QgisInterface::addPluginToDatabaseMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Add action to the Database menu.

§ addPluginToMenu

virtual void QgisInterface::addPluginToMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Add action to the plugins menu.

§ addPluginToRasterMenu

virtual void QgisInterface::addPluginToRasterMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Add action to the Raster menu.

§ addPluginToVectorMenu

virtual void QgisInterface::addPluginToVectorMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Add action to the Vector menu.

§ addPluginToWebMenu

virtual void QgisInterface::addPluginToWebMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Add action to the Web menu.

§ addProject

virtual bool QgisInterface::addProject ( const QString &  theProject)
pure virtualslot

Add a project.

§ addRasterLayer [1/2]

virtual QgsRasterLayer* QgisInterface::addRasterLayer ( const QString &  rasterLayerPath,
const QString &  baseName = QString() 
)
pure virtualslot

Add a raster layer given a raster layer file name.

§ addRasterLayer [2/2]

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

Add a WMS layer.

§ addRasterToolBarIcon

virtual int QgisInterface::addRasterToolBarIcon ( QAction *  qAction)
pure virtualslot

Add an icon to the Raster toolbar.

§ addRasterToolBarWidget

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
widgetwidget to add. The toolbar will take ownership of this widget
Returns
the QAction you can use to remove this widget from the toolbar

§ addToolBar [1/2]

virtual QToolBar* QgisInterface::addToolBar ( const QString &  name)
pure virtualslot

Add toolbar with specified name.

§ addToolBar [2/2]

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

Add a toolbar.

Note
added in 2.3

§ addToolBarIcon

virtual int QgisInterface::addToolBarIcon ( QAction *  qAction)
pure virtualslot

Add an icon to the plugins toolbar.

§ addToolBarWidget

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
widgetwidget to add. The toolbar will take ownership of this widget
Returns
the QAction you can use to remove this widget from the toolbar

§ addUserInputWidget

virtual void QgisInterface::addUserInputWidget ( QWidget *  widget)
pure virtualslot

Adds a widget to the user input tool bar.

§ addVectorLayer

virtual QgsVectorLayer* QgisInterface::addVectorLayer ( const QString &  vectorLayerPath,
const QString &  baseName,
const QString &  providerKey 
)
pure virtualslot

Add a vector layer.

§ addVectorToolBarIcon

virtual int QgisInterface::addVectorToolBarIcon ( QAction *  qAction)
pure virtualslot

Add an icon to the Vector toolbar.

§ addVectorToolBarWidget

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
widgetwidget to add. The toolbar will take ownership of this widget
Returns
the QAction you can use to remove this widget from the toolbar

§ addWebToolBarIcon

virtual int QgisInterface::addWebToolBarIcon ( QAction *  qAction)
pure virtualslot

Add an icon to the Web toolbar.

§ addWebToolBarWidget

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
widgetwidget to add. The toolbar will take ownership of this widget
Returns
the QAction you can use to remove this widget from the toolbar

§ addWindow

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.

§ advancedDigitizeToolBar

virtual QToolBar* QgisInterface::advancedDigitizeToolBar ( )
pure virtualslot

§ attributesToolBar

virtual QToolBar* QgisInterface::attributesToolBar ( )
pure virtualslot

§ buildStyleSheet

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

Generate stylesheet.

Parameters
optsgenerated default option values, or a changed copy of them

§ cadDockWidget

virtual QgsAdvancedDigitizingDockWidget* QgisInterface::cadDockWidget ( )
pure virtualslot

Advanced digitizing dock widget.

Note
Added in 2.12

§ composerAdded

void QgisInterface::composerAdded ( QgsComposerView v)
signal

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

§ composerRemoved

void QgisInterface::composerRemoved ( QgsComposerView v)
signal

This signal is emitted when a composer instance has been removed.

Note
added in version 2.9

§ composerWillBeRemoved

void QgisInterface::composerWillBeRemoved ( QgsComposerView v)
signal

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

§ createNewComposer

virtual QgsComposerView* QgisInterface::createNewComposer ( const QString &  title = QString())
pure virtualslot

Create a new composer.

Parameters
titlewindow 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

§ currentLayerChanged

void QgisInterface::currentLayerChanged ( QgsMapLayer layer)
signal

Emitted whenever current (selected) layer changes.

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

§ databaseMenu

virtual QMenu* QgisInterface::databaseMenu ( )
pure virtualslot

§ databaseToolBar

virtual QToolBar* QgisInterface::databaseToolBar ( )
pure virtualslot

§ defaultStyleSheetFont

virtual QFont QgisInterface::defaultStyleSheetFont ( )
pure virtualslot

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

§ defaultStyleSheetOptions

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

Return changeable options built from settings and/or defaults.

§ deleteComposer

virtual void QgisInterface::deleteComposer ( QgsComposerView composerView)
pure virtualslot

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

§ digitizeToolBar

virtual QToolBar* QgisInterface::digitizeToolBar ( )
pure virtualslot

§ duplicateComposer

virtual QgsComposerView* QgisInterface::duplicateComposer ( QgsComposerView composerView,
const QString &  title = QString() 
)
pure virtualslot

Duplicate an existing parent composer from composer view.

Parameters
composerViewpointer to existing composer view
titlewindow 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

§ editableLayers

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

Return vector layers in edit mode.

Parameters
modifiedwhether to return only layers that have been modified
Returns
list of layers in legend order, or empty list

§ editMenu

virtual QMenu* QgisInterface::editMenu ( )
pure virtualslot

§ fileToolBar

virtual QToolBar* QgisInterface::fileToolBar ( )
pure virtualslot

§ firstRightStandardMenu

virtual QMenu* QgisInterface::firstRightStandardMenu ( )
pure virtualslot

§ getFeatureForm

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

Returns a feature form for a given feature.

Parameters
lThe layer for which the dialog will be created
fThe feature for which the dialog will be created
Returns
A feature form

§ helpMenu

virtual QMenu* QgisInterface::helpMenu ( )
pure virtualslot

§ helpToolBar

virtual QToolBar* QgisInterface::helpToolBar ( )
pure virtualslot

§ initializationCompleted

void QgisInterface::initializationCompleted ( )
signal

This signal is emitted when the initialization is complete.

§ insertAddLayerAction

virtual void QgisInterface::insertAddLayerAction ( QAction *  action)
pure virtualslot

Add "add layer" action to layer menu.

§ layerMenu

virtual QMenu* QgisInterface::layerMenu ( )
pure virtualslot

§ layerSavedAs

void QgisInterface::layerSavedAs ( QgsMapLayer l,
const QString &  path 
)
signal

This signal is emitted when a layer has been saved using save as.

Note
added in version 2.7

§ layerToolBar

virtual QToolBar* QgisInterface::layerToolBar ( )
pure virtualslot

§ layerTreeCanvasBridge

virtual QgsLayerTreeMapCanvasBridge* QgisInterface::layerTreeCanvasBridge ( )
pure virtualslot

Returns a pointer to the layer tree canvas bridge.

Note
added in 2.12

§ layerTreeView()

virtual QgsLayerTreeView* QgisInterface::layerTreeView ( )
pure virtual

§ mainWindow

virtual QWidget* QgisInterface::mainWindow ( )
pure virtualslot

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

§ mapCanvas

virtual QgsMapCanvas* QgisInterface::mapCanvas ( )
pure virtualslot

Return a pointer to the map canvas.

§ mapNavToolToolBar

virtual QToolBar* QgisInterface::mapNavToolToolBar ( )
pure virtualslot

§ messageBar

virtual QgsMessageBar* QgisInterface::messageBar ( )
pure virtualslot

Return the message bar of the main app.

§ messageTimeout

virtual int QgisInterface::messageTimeout ( )
pure virtualslot

Get timeout for timed messages: default of 5 seconds.

§ newLayerMenu

virtual QMenu* QgisInterface::newLayerMenu ( )
pure virtualslot

§ newProject

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

Start a blank project.

§ newProjectCreated

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.

§ openFeatureForm

virtual bool QgisInterface::openFeatureForm ( QgsVectorLayer l,
QgsFeature f,
bool  updateFeatureOnly = false,
bool  showModal = true 
)
pure virtualslot

Open feature form.

Parameters
lvector layer
ffeature to show/modify
updateFeatureOnlyonly update the feature update (don't change any attributes of the layer) [UNUSED]
showModalif true, will wait for the dialog to be executed (only shown otherwise)

§ openMessageLog

virtual void QgisInterface::openMessageLog ( )
pure virtualslot

Open the message log dock widget *.

§ openURL

virtual Q_DECL_DEPRECATED void QgisInterface::openURL ( const 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
urlURL to open
useQgisDocDirectoryIf true, the URL will be formed by concatenating url to the QGIS documentation directory path (prefix/share/doc)
Deprecated:

§ pluginManagerInterface()

virtual QgsPluginManagerInterface* QgisInterface::pluginManagerInterface ( )
pure virtual

§ pluginMenu

virtual QMenu* QgisInterface::pluginMenu ( )
pure virtualslot

§ pluginToolBar

virtual QToolBar* QgisInterface::pluginToolBar ( )
pure virtualslot

§ preloadForm

virtual void QgisInterface::preloadForm ( const 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/

§ projectMenu

virtual QMenu* QgisInterface::projectMenu ( )
pure virtualslot

Accessors for inserting items into menus and toolbars.

An item can be inserted before any existing action.

§ projectRead

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.

§ rasterMenu

virtual QMenu* QgisInterface::rasterMenu ( )
pure virtualslot

§ rasterToolBar

virtual QToolBar* QgisInterface::rasterToolBar ( )
pure virtualslot

§ registerCustomDropHandler

virtual void QgisInterface::registerCustomDropHandler ( QgsCustomDropHandler handler)
pure virtualslot

Register a new custom drop handler.

Note
added in QGIS 3.0
Ownership of the factory is not transferred, and the factory must be unregistered when plugin is unloaded.
See also
unregisterCustomDropHandler()

§ registerMainWindowAction

virtual bool QgisInterface::registerMainWindowAction ( QAction *  action,
const QString &  defaultShortcut 
)
pure virtualslot

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

§ registerMapLayerConfigWidgetFactory

virtual void QgisInterface::registerMapLayerConfigWidgetFactory ( QgsMapLayerConfigWidgetFactory factory)
pure virtualslot

Register a new tab in the vector layer properties dialog.

Note
added in QGIS 2.16
Ownership of the factory is not transferred, and the factory must be unregistered when plugin is unloaded.
See also
unregisterMapLayerPropertiesFactory()

§ removeAddLayerAction

virtual void QgisInterface::removeAddLayerAction ( QAction *  action)
pure virtualslot

Remove "add layer" action from layer menu.

§ removeCustomActionForLayerType()

virtual bool QgisInterface::removeCustomActionForLayerType ( QAction *  action)
pure virtual

Remove action for layers in the layer tree previously added with addCustomActionForLayerType()

See also
addCustomActionForLayerType()

§ removeDatabaseToolBarIcon

virtual void QgisInterface::removeDatabaseToolBarIcon ( QAction *  qAction)
pure virtualslot

Remove an action (icon) from the Database toolbar.

§ removeDockWidget

virtual void QgisInterface::removeDockWidget ( QDockWidget *  dockwidget)
pure virtualslot

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

§ removePluginDatabaseMenu

virtual void QgisInterface::removePluginDatabaseMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Remove action from the Database menu.

§ removePluginMenu

virtual void QgisInterface::removePluginMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Remove action from the plugins menu.

§ removePluginRasterMenu

virtual void QgisInterface::removePluginRasterMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Remove action from the Raster menu.

§ removePluginVectorMenu

virtual void QgisInterface::removePluginVectorMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Remove action from the Vector menu.

§ removePluginWebMenu

virtual void QgisInterface::removePluginWebMenu ( const QString &  name,
QAction *  action 
)
pure virtualslot

Remove action from the Web menu.

§ removeRasterToolBarIcon

virtual void QgisInterface::removeRasterToolBarIcon ( QAction *  qAction)
pure virtualslot

Remove an action (icon) from the Raster toolbar.

§ removeToolBarIcon

virtual void QgisInterface::removeToolBarIcon ( QAction *  qAction)
pure virtualslot

Remove an action (icon) from the plugin toolbar.

§ removeVectorToolBarIcon

virtual void QgisInterface::removeVectorToolBarIcon ( QAction *  qAction)
pure virtualslot

Remove an action (icon) from the Vector toolbar.

§ removeWebToolBarIcon

virtual void QgisInterface::removeWebToolBarIcon ( QAction *  qAction)
pure virtualslot

Remove an action (icon) from the Web toolbar.

§ removeWindow

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.

§ saveStyleSheetOptions

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

Save changed default option keys/values to user settings.

§ setActiveLayer

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.

§ settingsMenu

virtual QMenu* QgisInterface::settingsMenu ( )
pure virtualslot

§ showAttributeTable

virtual QDialog* QgisInterface::showAttributeTable ( QgsVectorLayer l,
const QString &  filterExpression = QString() 
)
pure virtualslot

Open attribute table dialog.

§ showLayerProperties

virtual void QgisInterface::showLayerProperties ( QgsMapLayer l)
pure virtualslot

Open layer properties dialog.

§ unregisterCustomDropHandler

virtual void QgisInterface::unregisterCustomDropHandler ( QgsCustomDropHandler handler)
pure virtualslot

Unregister a previously registered custom drop handler.

Note
added in QGIS 3.0
See also
registerCustomDropHandler()

§ unregisterMainWindowAction

virtual bool QgisInterface::unregisterMainWindowAction ( QAction *  action)
pure virtualslot

Unregister a previously registered action. (e.g. when plugin is going to be unloaded)

§ unregisterMapLayerConfigWidgetFactory

virtual void QgisInterface::unregisterMapLayerConfigWidgetFactory ( QgsMapLayerConfigWidgetFactory factory)
pure virtualslot

Unregister a previously registered tab in the vector layer properties dialog.

Note
added in QGIS 2.16
See also
registerMapLayerPropertiesFactory()

§ vectorLayerTools

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

§ vectorMenu

virtual QMenu* QgisInterface::vectorMenu ( )
pure virtualslot

§ vectorToolBar

virtual QToolBar* QgisInterface::vectorToolBar ( )
pure virtualslot

§ viewMenu

virtual QMenu* QgisInterface::viewMenu ( )
pure virtualslot

§ webMenu

virtual QMenu* QgisInterface::webMenu ( )
pure virtualslot

§ webToolBar

virtual QToolBar* QgisInterface::webToolBar ( )
pure virtualslot

§ windowMenu

virtual QMenu* QgisInterface::windowMenu ( )
pure virtualslot

§ zoomFull

virtual void QgisInterface::zoomFull ( )
pure virtualslot

Zoom to full extent of map layers.

§ zoomToActiveLayer

virtual void QgisInterface::zoomToActiveLayer ( )
pure virtualslot

Zoom to extent of the active layer.

§ zoomToNext

virtual void QgisInterface::zoomToNext ( )
pure virtualslot

Zoom to next view extent.

§ zoomToPrevious

virtual void QgisInterface::zoomToPrevious ( )
pure virtualslot

Zoom to previous view extent.


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