QGIS API Documentation  2.99.0-Master (f1c3692)
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 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 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 &project)=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 void buildStyleSheet (const QMap< QString, QVariant > &opts)=0
 Generate stylesheet. More...
 
virtual void closeComposer (QgsComposition *composition)=0
 Closes an open composer window showing the specified composition. More...
 
virtual void deregisterLocatorFilter (QgsLocatorFilter *filter)=0
 Deregisters a locator filter from the app's locator bar and deletes it. More...
 
virtual QgsAttributeDialoggetFeatureForm (QgsVectorLayer *l, QgsFeature &f)=0
 Returns a feature form for a given feature. More...
 
virtual void insertAddLayerAction (QAction *action)=0
 Add "add layer" action to layer menu. More...
 
virtual void newProject (bool promptToSaveFlag=false)=0
 Start a blank project. More...
 
virtual QgsComposerInterfaceopenComposer (QgsComposition *composition)=0
 Opens a new composer window for the specified composition, or brings an already open composer window to the foreground if one is already created for the composition. More...
 
virtual bool openFeatureForm (QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly=false, bool showModal=true)=0
 Open feature form. More...
 
virtual QgsLayoutDesignerInterface * openLayoutDesigner (QgsLayout *layout)=0
 Opens a new layout designer dialog for the specified layout, or brings an already open designer window to the foreground if one is already created for the layout. 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 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 haven't used the info tool first. More...
 
virtual void registerCustomDropHandler (QgsCustomDropHandler *handler)=0
 Register a new custom drop handler. More...
 
virtual void registerLocatorFilter (QgsLocatorFilter *filter)=0
 Registers a locator filter for the app's locator bar. 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 registerOptionsWidgetFactory (QgsOptionsWidgetFactory *factory)=0
 Register a new tab in the options dialog. More...
 
virtual void reloadConnections ()=0
 Triggered when connections have changed. 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 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 showOptionsDialog (QWidget *parent=nullptr, const QString &currentPage=QString())=0
 Opens the options 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 void unregisterOptionsWidgetFactory (QgsOptionsWidgetFactory *factory)=0
 Unregister a previously registered tab in the options dialog. More...
 
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 composerClosed (QgsComposerInterface *composer)
 This signal is emitted after a composer window is closed. More...
 
void composerOpened (QgsComposerInterface *composer)
 This signal is emitted when a new composer window has been opened. More...
 
void composerWillBeClosed (QgsComposerInterface *composer)
 This signal is emitted before a composer window is going to be closed and deleted. More...
 
void currentLayerChanged (QgsMapLayer *layer)
 Emitted whenever current (selected) layer changes. More...
 
void currentThemeChanged (const QString &theme)
 Signal emitted when the current theme is changed so plugins can change their tool button icons. 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 layoutDesignerClosed ()
 This signal is emitted after a layout designer window is closed. More...
 
void layoutDesignerOpened (QgsLayoutDesignerInterface *designer)
 This signal is emitted when a new layout designer has been opened. More...
 
void layoutDesignerWillBeClosed (QgsLayoutDesignerInterface *designer)
 This signal is emitted before a layout designer is going to be closed and deleted. 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 ()=default
 Constructor. More...
 
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 * actionHideDeselectedLayers ()=0
 Returns the Hide Deselected Layers action. More...
 
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 * 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 QgsMapLayeractiveLayer ()=0
 Get pointer to the active layer (layer selected in the legend) 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 QMenu * addLayerMenu ()=0
 
virtual QToolBar * advancedDigitizeToolBar ()=0
 
virtual QToolBar * attributesToolBar ()=0
 
virtual QgsAdvancedDigitizingDockWidgetcadDockWidget ()=0
 Advanced digitizing dock widget. More...
 
virtual void closeMapCanvas (const QString &name)=0
 Closes the additional map canvas with matching name. More...
 
virtual QgsMapCanvascreateNewMapCanvas (const QString &name)=0
 Create a new map canvas with the specified unique name. 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 QToolBar * digitizeToolBar ()=0
 
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 QMenu * helpMenu ()=0
 
virtual QToolBar * helpToolBar ()=0
 
virtual QSize iconSize (bool dockedToolbar=false) const =0
 Returns the toolbar icon size. More...
 
virtual QMenu * layerMenu ()=0
 
virtual QToolBar * layerToolBar ()=0
 
virtual QgsLayerTreeMapCanvasBridgelayerTreeCanvasBridge ()=0
 Returns a pointer to the layer tree canvas bridge. More...
 
virtual QgsLayerTreeViewlayerTreeView ()=0
 
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 QList< QgsMapCanvas *> mapCanvases ()=0
 Returns a list of all map canvases open in the app. 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 QList< QgsComposerInterface * > openComposers ()=0
 Returns all currently open composer windows. More...
 
virtual QList< QgsLayoutDesignerInterface * > openLayoutDesigners ()=0
 Returns all currently open layout designers. More...
 
virtual QgsPluginManagerInterfacepluginManagerInterface ()=0
 
virtual QMenu * pluginMenu ()=0
 
virtual QToolBar * pluginToolBar ()=0
 
virtual QMenu * projectMenu ()=0
 Accessors for inserting items into menus and toolbars. More...
 
virtual QMenu * rasterMenu ()=0
 
virtual QToolBar * rasterToolBar ()=0
 
virtual bool removeCustomActionForLayerType (QAction *action)=0
 Remove action for layers in the layer tree previously added with addCustomActionForLayerType() More...
 
virtual QMenu * settingsMenu ()=0
 
virtual QgsStatusBarstatusBarIface ()=0
 Returns a pointer to the app's status bar interface. 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
 

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

Constructor & Destructor Documentation

◆ QgisInterface()

QgisInterface::QgisInterface ( )
default

Constructor.

Member Function Documentation

◆ actionAbout()

virtual QAction* QgisInterface::actionAbout ( )
pure virtual

◆ actionAddAfsLayer()

virtual QAction* QgisInterface::actionAddAfsLayer ( )
pure virtual

Get access to the native Add ArcGIS FeatureServer action.

◆ actionAddAllToOverview()

virtual QAction* QgisInterface::actionAddAllToOverview ( )
pure virtual

◆ actionAddAmsLayer()

virtual QAction* QgisInterface::actionAddAmsLayer ( )
pure virtual

Get access to the native Add ArcGIS MapServer action.

◆ actionAddFeature()

virtual QAction* QgisInterface::actionAddFeature ( )
pure virtual

◆ actionAddOgrLayer()

virtual QAction* QgisInterface::actionAddOgrLayer ( )
pure virtual

◆ actionAddPart()

virtual QAction* QgisInterface::actionAddPart ( )
pure virtual

◆ actionAddPgLayer()

virtual QAction* QgisInterface::actionAddPgLayer ( )
pure virtual

◆ actionAddRasterLayer()

virtual QAction* QgisInterface::actionAddRasterLayer ( )
pure virtual

◆ actionAddRing()

virtual QAction* QgisInterface::actionAddRing ( )
pure virtual

◆ actionAddToOverview()

virtual QAction* QgisInterface::actionAddToOverview ( )
pure virtual

◆ actionAddWmsLayer()

virtual QAction* QgisInterface::actionAddWmsLayer ( )
pure virtual

◆ actionAllEdits()

virtual QAction* QgisInterface::actionAllEdits ( )
pure virtual

◆ actionCancelAllEdits()

virtual QAction* QgisInterface::actionCancelAllEdits ( )
pure virtual

◆ actionCancelEdits()

virtual QAction* QgisInterface::actionCancelEdits ( )
pure virtual

◆ actionCheckQgisVersion()

virtual QAction* QgisInterface::actionCheckQgisVersion ( )
pure virtual

◆ actionCopyFeatures()

virtual QAction* QgisInterface::actionCopyFeatures ( )
pure virtual

◆ actionCopyLayerStyle()

virtual QAction* QgisInterface::actionCopyLayerStyle ( )
pure virtual

◆ actionCustomProjection()

virtual QAction* QgisInterface::actionCustomProjection ( )
pure virtual

◆ actionCutFeatures()

virtual QAction* QgisInterface::actionCutFeatures ( )
pure virtual

◆ actionDeletePart()

virtual QAction* QgisInterface::actionDeletePart ( )
pure virtual

◆ actionDeleteRing()

virtual QAction* QgisInterface::actionDeleteRing ( )
pure virtual

◆ actionDeleteSelected()

virtual QAction* QgisInterface::actionDeleteSelected ( )
pure virtual

◆ actionDraw()

virtual QAction* QgisInterface::actionDraw ( )
pure virtual

Get access to the native draw action.

◆ actionDuplicateLayer()

virtual QAction* QgisInterface::actionDuplicateLayer ( )
pure virtual

◆ actionExit()

virtual QAction* QgisInterface::actionExit ( )
pure virtual

◆ actionFeatureAction()

virtual QAction* QgisInterface::actionFeatureAction ( )
pure virtual

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 virtual

◆ actionHideAllLayers()

virtual QAction* QgisInterface::actionHideAllLayers ( )
pure virtual

◆ actionHideDeselectedLayers()

virtual QAction* QgisInterface::actionHideDeselectedLayers ( )
pure virtual

Returns the Hide Deselected Layers action.

Since
QGIS 3.0

◆ actionHideSelectedLayers()

virtual QAction* QgisInterface::actionHideSelectedLayers ( )
pure virtual

◆ actionIdentify()

virtual QAction* QgisInterface::actionIdentify ( )
pure virtual

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

◆ actionLayerProperties()

virtual QAction* QgisInterface::actionLayerProperties ( )
pure virtual

◆ actionLayerSaveAs()

virtual QAction* QgisInterface::actionLayerSaveAs ( )
pure virtual

◆ actionManagePlugins()

virtual QAction* QgisInterface::actionManagePlugins ( )
pure virtual

◆ actionMapTips()

virtual QAction* QgisInterface::actionMapTips ( )
pure virtual

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

◆ actionMeasure()

virtual QAction* QgisInterface::actionMeasure ( )
pure virtual

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

◆ actionMeasureArea()

virtual QAction* QgisInterface::actionMeasureArea ( )
pure virtual

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 virtual

◆ actionNewBookmark()

virtual QAction* QgisInterface::actionNewBookmark ( )
pure virtual

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

◆ actionNewProject()

virtual QAction* QgisInterface::actionNewProject ( )
pure virtual

◆ actionNewVectorLayer()

virtual QAction* QgisInterface::actionNewVectorLayer ( )
pure virtual

◆ actionNodeTool()

virtual QAction* QgisInterface::actionNodeTool ( )
pure virtual

◆ actionOpenFieldCalculator()

virtual QAction* QgisInterface::actionOpenFieldCalculator ( )
pure virtual

◆ actionOpenProject()

virtual QAction* QgisInterface::actionOpenProject ( )
pure virtual

◆ actionOpenTable()

virtual QAction* QgisInterface::actionOpenTable ( )
pure virtual

◆ actionOptions()

virtual QAction* QgisInterface::actionOptions ( )
pure virtual

◆ actionPan()

virtual QAction* QgisInterface::actionPan ( )
pure virtual

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

◆ actionPanToSelected()

virtual QAction* QgisInterface::actionPanToSelected ( )
pure virtual

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 virtual

◆ actionPasteLayerStyle()

virtual QAction* QgisInterface::actionPasteLayerStyle ( )
pure virtual

◆ actionPluginListSeparator()

virtual QAction* QgisInterface::actionPluginListSeparator ( )
pure virtual

◆ actionPrintComposer()

virtual QAction* QgisInterface::actionPrintComposer ( )
pure virtual

◆ actionProjectProperties()

virtual QAction* QgisInterface::actionProjectProperties ( )
pure virtual

◆ actionQgisHomePage()

virtual QAction* QgisInterface::actionQgisHomePage ( )
pure virtual

◆ actionRemoveAllFromOverview()

virtual QAction* QgisInterface::actionRemoveAllFromOverview ( )
pure virtual

◆ actionRollbackAllEdits()

virtual QAction* QgisInterface::actionRollbackAllEdits ( )
pure virtual

◆ actionRollbackEdits()

virtual QAction* QgisInterface::actionRollbackEdits ( )
pure virtual

◆ actionSaveActiveLayerEdits()

virtual QAction* QgisInterface::actionSaveActiveLayerEdits ( )
pure virtual

◆ actionSaveAllEdits()

virtual QAction* QgisInterface::actionSaveAllEdits ( )
pure virtual

◆ actionSaveEdits()

virtual QAction* QgisInterface::actionSaveEdits ( )
pure virtual

◆ actionSaveMapAsImage()

virtual QAction* QgisInterface::actionSaveMapAsImage ( )
pure virtual

◆ actionSaveProject()

virtual QAction* QgisInterface::actionSaveProject ( )
pure virtual

◆ actionSaveProjectAs()

virtual QAction* QgisInterface::actionSaveProjectAs ( )
pure virtual

◆ actionSelect()

virtual QAction* QgisInterface::actionSelect ( )
pure virtual

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

◆ actionSelectFreehand()

virtual QAction* QgisInterface::actionSelectFreehand ( )
pure virtual

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 virtual

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 virtual

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 virtual

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 virtual

◆ actionShowBookmarks()

virtual QAction* QgisInterface::actionShowBookmarks ( )
pure virtual

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

◆ actionShowComposerManager()

virtual QAction* QgisInterface::actionShowComposerManager ( )
pure virtual

◆ actionShowPythonDialog()

virtual QAction* QgisInterface::actionShowPythonDialog ( )
pure virtual

◆ actionShowSelectedLayers()

virtual QAction* QgisInterface::actionShowSelectedLayers ( )
pure virtual

◆ actionSimplifyFeature()

virtual QAction* QgisInterface::actionSimplifyFeature ( )
pure virtual

◆ actionSplitFeatures()

virtual QAction* QgisInterface::actionSplitFeatures ( )
pure virtual

◆ actionSplitParts()

virtual QAction* QgisInterface::actionSplitParts ( )
pure virtual

◆ actionToggleEditing()

virtual QAction* QgisInterface::actionToggleEditing ( )
pure virtual

◆ actionToggleFullScreen()

virtual QAction* QgisInterface::actionToggleFullScreen ( )
pure virtual

◆ actionZoomActualSize()

virtual QAction* QgisInterface::actionZoomActualSize ( )
pure virtual

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

◆ actionZoomFullExtent()

virtual QAction* QgisInterface::actionZoomFullExtent ( )
pure virtual

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 virtual

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 virtual

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

◆ actionZoomNext()

virtual QAction* QgisInterface::actionZoomNext ( )
pure virtual

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

◆ actionZoomOut()

virtual QAction* QgisInterface::actionZoomOut ( )
pure virtual

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 virtual

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 virtual

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

◆ activeLayer()

virtual QgsMapLayer* QgisInterface::activeLayer ( )
pure virtual

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 virtual
Since
QGIS 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 &  project)
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.

Since
QGIS 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 virtual

◆ attributesToolBar()

virtual QToolBar* QgisInterface::attributesToolBar ( )
pure virtual

◆ 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 virtual

Advanced digitizing dock widget.

Since
QGIS 2.12

◆ closeComposer

virtual void QgisInterface::closeComposer ( QgsComposition composition)
pure virtualslot

Closes an open composer window showing the specified composition.

The composition remains unaffected.

Since
QGIS 3.0
See also
openComposer()

◆ closeMapCanvas()

virtual void QgisInterface::closeMapCanvas ( const QString &  name)
pure virtual

Closes the additional map canvas with matching name.

Since
QGIS 3.0
See also
createNewMapCanvas()

◆ composerClosed

void QgisInterface::composerClosed ( QgsComposerInterface composer)
signal

This signal is emitted after a composer window is closed.

Since
QGIS 3.0
See also
composerWillBeClosed()
composerOpened()

◆ composerOpened

void QgisInterface::composerOpened ( QgsComposerInterface composer)
signal

This signal is emitted when a new composer window has been opened.

Since
QGIS 3.0
See also
composerWillBeClosed()

◆ composerWillBeClosed

void QgisInterface::composerWillBeClosed ( QgsComposerInterface composer)
signal

This signal is emitted before a composer window is going to be closed and deleted.

Since
QGIS 3.0
See also
composerClosed()
composerOpened()

◆ createNewMapCanvas()

virtual QgsMapCanvas* QgisInterface::createNewMapCanvas ( const QString &  name)
pure virtual

Create a new map canvas with the specified unique name.

Since
QGIS 3.0
See also
closeMapCanvas()

◆ 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

◆ currentThemeChanged

void QgisInterface::currentThemeChanged ( const QString &  theme)
signal

Signal emitted when the current theme is changed so plugins can change their tool button icons.

Since
QGIS 3.0

◆ databaseMenu()

virtual QMenu* QgisInterface::databaseMenu ( )
pure virtual

◆ databaseToolBar()

virtual QToolBar* QgisInterface::databaseToolBar ( )
pure virtual

◆ defaultStyleSheetFont()

virtual QFont QgisInterface::defaultStyleSheetFont ( )
pure virtual

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

◆ defaultStyleSheetOptions()

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

Return changeable options built from settings and/or defaults.

◆ deregisterLocatorFilter

virtual void QgisInterface::deregisterLocatorFilter ( QgsLocatorFilter filter)
pure virtualslot

Deregisters a locator filter from the app's locator bar and deletes it.

Calling this will block whilst any currently running query is terminated.

Plugins which register filters to the locator bar must take care to correctly call deregisterLocatorFilter() to deregister their filters upon plugin unload to avoid crashes.

See also
registerLocatorFilter()
Since
QGIS 3.0

◆ digitizeToolBar()

virtual QToolBar* QgisInterface::digitizeToolBar ( )
pure virtual

◆ editableLayers()

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

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 virtual

◆ fileToolBar()

virtual QToolBar* QgisInterface::fileToolBar ( )
pure virtual

◆ firstRightStandardMenu()

virtual QMenu* QgisInterface::firstRightStandardMenu ( )
pure virtual

◆ 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 virtual

◆ helpToolBar()

virtual QToolBar* QgisInterface::helpToolBar ( )
pure virtual

◆ iconSize()

virtual QSize QgisInterface::iconSize ( bool  dockedToolbar = false) const
pure virtual

Returns the toolbar icon size.

If dockedToolbar is true, the icon size for toolbars contained within docks is returned.

◆ 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 virtual

◆ 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 virtual

◆ layerTreeCanvasBridge()

virtual QgsLayerTreeMapCanvasBridge* QgisInterface::layerTreeCanvasBridge ( )
pure virtual

Returns a pointer to the layer tree canvas bridge.

Since
QGIS 2.12

◆ layerTreeView()

virtual QgsLayerTreeView* QgisInterface::layerTreeView ( )
pure virtual

◆ layoutDesignerClosed

void QgisInterface::layoutDesignerClosed ( )
signal

This signal is emitted after a layout designer window is closed.

Since
QGIS 3.0
See also
layoutDesignerWillBeClosed()
layoutDesignerOpened()

◆ layoutDesignerOpened

void QgisInterface::layoutDesignerOpened ( QgsLayoutDesignerInterface *  designer)
signal

This signal is emitted when a new layout designer has been opened.

Since
QGIS 3.0
See also
layoutDesignerWillBeClosed()

◆ layoutDesignerWillBeClosed

void QgisInterface::layoutDesignerWillBeClosed ( QgsLayoutDesignerInterface *  designer)
signal

This signal is emitted before a layout designer is going to be closed and deleted.

Since
QGIS 3.0
See also
layoutDesignerClosed()
layoutDesignerOpened()

◆ mainWindow()

virtual QWidget* QgisInterface::mainWindow ( )
pure virtual

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

◆ mapCanvas()

virtual QgsMapCanvas* QgisInterface::mapCanvas ( )
pure virtual

Return a pointer to the map canvas.

◆ mapCanvases()

virtual QList< QgsMapCanvas * > QgisInterface::mapCanvases ( )
pure virtual

Returns a list of all map canvases open in the app.

Since
QGIS 3.0

◆ mapNavToolToolBar()

virtual QToolBar* QgisInterface::mapNavToolToolBar ( )
pure virtual

◆ messageBar()

virtual QgsMessageBar* QgisInterface::messageBar ( )
pure virtual

Return the message bar of the main app.

◆ messageTimeout()

virtual int QgisInterface::messageTimeout ( )
pure virtual

Get timeout for timed messages: default of 5 seconds.

◆ newLayerMenu()

virtual QMenu* QgisInterface::newLayerMenu ( )
pure virtual

◆ newProject

virtual void QgisInterface::newProject ( bool  promptToSaveFlag = 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.

◆ openComposer

virtual QgsComposerInterface* QgisInterface::openComposer ( QgsComposition composition)
pure virtualslot

Opens a new composer window for the specified composition, or brings an already open composer window to the foreground if one is already created for the composition.

Since
QGIS 3.0
See also
closeComposer()

◆ openComposers()

virtual QList<QgsComposerInterface *> QgisInterface::openComposers ( )
pure virtual

Returns all currently open composer windows.

Since
QGIS 3.0

◆ 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)

◆ openLayoutDesigner

virtual QgsLayoutDesignerInterface* QgisInterface::openLayoutDesigner ( QgsLayout layout)
pure virtualslot

Opens a new layout designer dialog for the specified layout, or brings an already open designer window to the foreground if one is already created for the layout.

Since
QGIS 3.0
See also
closeComposer()

◆ openLayoutDesigners()

virtual QList<QgsLayoutDesignerInterface *> QgisInterface::openLayoutDesigners ( )
pure virtual

Returns all currently open layout designers.

Since
QGIS 3.0

◆ 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 virtual

◆ pluginToolBar()

virtual QToolBar* QgisInterface::pluginToolBar ( )
pure virtual

◆ 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 haven't used the info tool first.

Python will crash bringing QGIS with 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 virtual

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 virtual

◆ rasterToolBar()

virtual QToolBar* QgisInterface::rasterToolBar ( )
pure virtual

◆ registerCustomDropHandler

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

Register a new custom drop handler.

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

◆ registerLocatorFilter

virtual void QgisInterface::registerLocatorFilter ( QgsLocatorFilter filter)
pure virtualslot

Registers a locator filter for the app's locator bar.

Ownership of the filter is transferred to the locator.

Warning
Plugins which register filters to the locator bar must take care to correctly call deregisterLocatorFilter() and deregister their filters upon plugin unload to avoid crashes.
See also
deregisterLocatorFilter()
Since
QGIS 3.0

◆ 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.

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

◆ registerOptionsWidgetFactory

virtual void QgisInterface::registerOptionsWidgetFactory ( QgsOptionsWidgetFactory factory)
pure virtualslot

Register a new tab in the options dialog.

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

◆ reloadConnections

virtual void QgisInterface::reloadConnections ( )
pure virtualslot

Triggered when connections have changed.

This calls reloadConnections in the main application and triggers a signal that is forwarded to the GUI elements that needs to be updated (i.e. the source select dialogs and the browser widgets)

Since
QGIS 3.0

◆ 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 virtual

◆ 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.

◆ showOptionsDialog

virtual void QgisInterface::showOptionsDialog ( QWidget *  parent = nullptr,
const QString &  currentPage = QString() 
)
pure virtualslot

Opens the options dialog.

The currentPage argument can be used to force the dialog to open at a specific page.

Since
QGIS 3.0

◆ statusBarIface()

virtual QgsStatusBar* QgisInterface::statusBarIface ( )
pure virtual

Returns a pointer to the app's status bar interface.

This should be used for interacting and adding widgets and messages to the app's status bar (do not use the native Qt statusBar() method).

Since
QGIS 3.0

◆ unregisterCustomDropHandler

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

Unregister a previously registered custom drop handler.

Since
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.

Since
QGIS 2.16
See also
registerMapLayerPropertiesFactory()

◆ unregisterOptionsWidgetFactory

virtual void QgisInterface::unregisterOptionsWidgetFactory ( QgsOptionsWidgetFactory factory)
pure virtualslot

Unregister a previously registered tab in the options dialog.

Since
QGIS 3.0
See also
registerOptionsWidgetFactory()

◆ vectorLayerTools()

virtual QgsVectorLayerTools* QgisInterface::vectorLayerTools ( )
pure virtual

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 virtual

◆ vectorToolBar()

virtual QToolBar* QgisInterface::vectorToolBar ( )
pure virtual

◆ viewMenu()

virtual QMenu* QgisInterface::viewMenu ( )
pure virtual

◆ webMenu()

virtual QMenu* QgisInterface::webMenu ( )
pure virtual

◆ webToolBar()

virtual QToolBar* QgisInterface::webToolBar ( )
pure virtual

◆ windowMenu()

virtual QMenu* QgisInterface::windowMenu ( )
pure virtual

◆ 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 file: