QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
qgisinterface.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgisinterface.h
3  Interface class for exposing functions in QgisApp for use by plugins
4  -------------------
5  begin : 2004-02-11
6  copyright : (C) 2004 by Gary E.Sherman
7  email : sherman at mrcc.com
8  ***************************************************************************/
9 
10 /***************************************************************************
11  * *
12  * This program is free software; you can redistribute it and/or modify *
13  * it under the terms of the GNU General Public License as published by *
14  * the Free Software Foundation; either version 2 of the License, or *
15  * (at your option) any later version. *
16  * *
17  ***************************************************************************/
18 #ifndef QGISINTERFACE_H
19 #define QGISINTERFACE_H
20 
21 #include <QObject>
22 #include <map>
23 
24 #include "qgis.h"
25 #include "qgis_sip.h"
26 #include "qgis_gui.h"
29 
30 class QAction;
31 class QDialog;
32 class QFont;
33 class QMenu;
34 class QToolBar;
35 class QDockWidget;
36 class QMainWindow;
37 class QWidget;
38 class QActionGroup;
39 
41 class QgsAttributeDialog;
45 class QgsFeature;
47 class QgsLayerTreeView;
48 class QgsLayerTreeGroup;
49 class QgsLayout;
52 class QgsMapCanvas;
53 class QgsMapLayer;
55 class QgsMapDecoration;
56 class QgsMessageBar;
58 class QgsRasterLayer;
59 class QgsVectorLayer;
61 class QgsVectorTileLayer;
62 class QgsPointCloudLayer;
63 class QgsTiledSceneLayer;
65 class QgsLocatorFilter;
66 class QgsStatusBar;
67 class QgsMeshLayer;
68 class QgsBrowserGuiModel;
70 class QgsGpsConnection;
76 
77 #ifdef SIP_RUN
78 % ModuleHeaderCode
79 class Qgs3DMapCanvas;
80 % End
81 #endif
82 
97 class GUI_EXPORT QgisInterface : public QObject
98 {
99  Q_OBJECT
100 
101  public:
102 
104  QgisInterface() = default;
105 
107 
109 
122  virtual void addCustomActionForLayerType( QAction *action, QString menu,
123  Qgis::LayerType type, bool allLayers ) = 0;
124 
131  virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0;
132 
137  virtual bool removeCustomActionForLayerType( QAction *action ) = 0;
138 
142  virtual QList< QgsMapCanvas * > mapCanvases() = 0;
143 
148  virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0;
149 
154  virtual void closeMapCanvas( const QString &name ) = 0;
155 
160  virtual QList< Qgs3DMapCanvas * > mapCanvases3D() = 0;
161 
167  virtual Qgs3DMapCanvas *createNewMapCanvas3D( const QString &name ) = 0;
168 
174  virtual void closeMapCanvas3D( const QString &name ) = 0;
175 
180  virtual QSize iconSize( bool dockedToolbar = false ) const = 0;
181 
187  virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
188 
190  virtual QgsMapLayer *activeLayer() = 0;
191 
193  virtual QgsMapCanvas *mapCanvas() = 0;
194 
199  virtual QList<QgsMapDecoration *> activeDecorations() = 0;
200 
206 
208  virtual QWidget *mainWindow() = 0;
209 
211  virtual QgsMessageBar *messageBar() = 0;
212 
216  virtual QList<QgsLayoutDesignerInterface *> openLayoutDesigners() = 0;
217 
218 
220  virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
221 
223  virtual QFont defaultStyleSheetFont() = 0;
224 
229 
230  /*
231  * Accessors for inserting items into menus and toolbars.
232  * An item can be inserted before any existing action.
233  */
234 
238  virtual QMenu *projectMenu() = 0;
239 
247  virtual QMenu *projectImportExportMenu() = 0;
248 
256  virtual void addProjectImportAction( QAction *action ) = 0;
257 
265  virtual void removeProjectImportAction( QAction *action ) = 0;
266 
274  virtual void addProjectExportAction( QAction *action ) = 0;
275 
283  virtual void removeProjectExportAction( QAction *action ) = 0;
284 
288  virtual QMenu *editMenu() = 0;
289 
293  virtual QMenu *viewMenu() = 0;
294 
298  virtual QMenu *layerMenu() = 0;
299 
303  virtual QMenu *newLayerMenu() = 0;
304 
308  virtual QMenu *addLayerMenu() = 0;
309 
313  virtual QMenu *settingsMenu() = 0;
314 
318  virtual QMenu *pluginMenu() = 0;
319 
328  virtual QMenu *pluginHelpMenu() = 0;
329 
333  virtual QMenu *rasterMenu() = 0;
334 
338  virtual QMenu *databaseMenu() = 0;
339 
343  virtual QMenu *vectorMenu() = 0;
344 
348  virtual QMenu *webMenu() = 0;
349 
355  virtual QMenu *meshMenu() = 0;
356 
364  virtual QMenu *firstRightStandardMenu() = 0;
365 
369  virtual QMenu *windowMenu() = 0;
370 
374  virtual QMenu *helpMenu() = 0;
375 
376  // ToolBars
377 
381  virtual QToolBar *fileToolBar() = 0;
382 
386  virtual QToolBar *layerToolBar() = 0;
387 
392  virtual QToolBar *dataSourceManagerToolBar() = 0;
393 
401  virtual void openDataSourceManagerPage( const QString &pageName ) = 0;
402 
406  virtual QToolBar *mapNavToolToolBar() = 0;
407 
411  virtual QToolBar *digitizeToolBar() = 0;
412 
416  virtual QToolBar *advancedDigitizeToolBar() = 0;
417 
421  virtual QToolBar *shapeDigitizeToolBar() = 0;
422 
426  virtual QToolBar *attributesToolBar() = 0;
427 
432  virtual QToolBar *selectionToolBar() = 0;
433 
437  virtual QToolBar *pluginToolBar() = 0;
438 
442  virtual QToolBar *helpToolBar() = 0;
443 
447  virtual QToolBar *rasterToolBar() = 0;
448 
452  virtual QToolBar *vectorToolBar() = 0;
453 
457  virtual QToolBar *databaseToolBar() = 0;
458 
462  virtual QToolBar *webToolBar() = 0;
463 
464  // Project menu actions
466  virtual QAction *actionNewProject() = 0;
468  virtual QAction *actionOpenProject() = 0;
470  virtual QAction *actionSaveProject() = 0;
472  virtual QAction *actionSaveProjectAs() = 0;
474  virtual QAction *actionSaveMapAsImage() = 0;
476  virtual QAction *actionProjectProperties() = 0;
477 
479  virtual QAction *actionCreatePrintLayout() = 0;
480 
482  virtual QAction *actionShowLayoutManager() = 0;
484  virtual QAction *actionExit() = 0;
485 
486  // Edit menu actions
487 
489  virtual QAction *actionCutFeatures() = 0;
491  virtual QAction *actionCopyFeatures() = 0;
493  virtual QAction *actionPasteFeatures() = 0;
495  virtual QAction *actionAddFeature() = 0;
497  virtual QAction *actionDeleteSelected() = 0;
499  virtual QAction *actionMoveFeature() = 0;
501  virtual QAction *actionSplitFeatures() = 0;
503  virtual QAction *actionSplitParts() = 0;
505  virtual QAction *actionAddRing() = 0;
507  virtual QAction *actionAddPart() = 0;
509  virtual QAction *actionSimplifyFeature() = 0;
511  virtual QAction *actionDeleteRing() = 0;
513  virtual QAction *actionDeletePart() = 0;
514 
519  virtual QAction *actionVertexTool() = 0;
520 
526  virtual QAction *actionVertexToolActiveLayer() = 0;
527 
536  virtual QActionGroup *mapToolActionGroup() = 0;
537 
538  // View menu actions
540  virtual QAction *actionPan() = 0;
542  virtual QAction *actionPanToSelected() = 0;
544  virtual QAction *actionZoomIn() = 0;
546  virtual QAction *actionZoomOut() = 0;
548  virtual QAction *actionSelect() = 0;
550  virtual QAction *actionSelectRectangle() = 0;
552  virtual QAction *actionSelectPolygon() = 0;
554  virtual QAction *actionSelectFreehand() = 0;
556  virtual QAction *actionSelectRadius() = 0;
558  virtual QAction *actionIdentify() = 0;
560  virtual QAction *actionFeatureAction() = 0;
562  virtual QAction *actionMeasure() = 0;
564  virtual QAction *actionMeasureArea() = 0;
566  virtual QAction *actionZoomFullExtent() = 0;
567 
573  Q_DECL_DEPRECATED virtual QAction *actionZoomToLayer() = 0 SIP_DEPRECATED;
574 
579  virtual QAction *actionZoomToLayers() = 0;
580 
582  virtual QAction *actionZoomToSelected() = 0;
584  virtual QAction *actionZoomLast() = 0;
586  virtual QAction *actionZoomNext() = 0;
588  virtual QAction *actionZoomActualSize() = 0;
590  virtual QAction *actionMapTips() = 0;
592  virtual QAction *actionNewBookmark() = 0;
594  virtual QAction *actionShowBookmarks() = 0;
596  virtual QAction *actionDraw() = 0;
597 
598  // Layer menu actions
599  virtual QAction *actionNewVectorLayer() = 0;
600  virtual QAction *actionAddOgrLayer() = 0;
601  virtual QAction *actionAddRasterLayer() = 0;
602  virtual QAction *actionAddPgLayer() = 0;
603  virtual QAction *actionAddWmsLayer() = 0;
604 
609  virtual QAction *actionAddXyzLayer() = 0;
610 
615  virtual QAction *actionAddVectorTileLayer() = 0;
616 
621  virtual QAction *actionAddPointCloudLayer() = 0;
622 
624  virtual QAction *actionAddAfsLayer() = 0;
625 
627  virtual QAction *actionAddAmsLayer() = 0;
628 
629  virtual QAction *actionCopyLayerStyle() = 0;
630  virtual QAction *actionPasteLayerStyle() = 0;
631  virtual QAction *actionOpenTable() = 0;
632  virtual QAction *actionOpenFieldCalculator() = 0;
633 
637  virtual QAction *actionOpenStatisticalSummary() = 0;
638 
639  virtual QAction *actionToggleEditing() = 0;
640  virtual QAction *actionSaveActiveLayerEdits() = 0;
641  virtual QAction *actionAllEdits() = 0;
642  virtual QAction *actionSaveEdits() = 0;
643  virtual QAction *actionSaveAllEdits() = 0;
644  virtual QAction *actionRollbackEdits() = 0;
645  virtual QAction *actionRollbackAllEdits() = 0;
646  virtual QAction *actionCancelEdits() = 0;
647  virtual QAction *actionCancelAllEdits() = 0;
648  virtual QAction *actionLayerSaveAs() = 0;
649  virtual QAction *actionDuplicateLayer() = 0;
650  virtual QAction *actionLayerProperties() = 0;
651  virtual QAction *actionAddToOverview() = 0;
652  virtual QAction *actionAddAllToOverview() = 0;
653  virtual QAction *actionRemoveAllFromOverview() = 0;
654  virtual QAction *actionHideAllLayers() = 0;
655  virtual QAction *actionShowAllLayers() = 0;
656  virtual QAction *actionHideSelectedLayers() = 0;
657 
662  virtual QAction *actionToggleSelectedLayers() = 0;
663 
669 
673  virtual QAction *actionHideDeselectedLayers() = 0;
674  virtual QAction *actionShowSelectedLayers() = 0;
675 
676  // Plugin menu actions
677  virtual QAction *actionManagePlugins() = 0;
678  virtual QAction *actionPluginListSeparator() = 0;
679  virtual QAction *actionShowPythonDialog() = 0;
680 
681  // Settings menu actions
682  virtual QAction *actionToggleFullScreen() = 0;
683  virtual QAction *actionOptions() = 0;
684  virtual QAction *actionCustomProjection() = 0;
685 
686  // Help menu actions
687  virtual QAction *actionHelpContents() = 0;
688  virtual QAction *actionQgisHomePage() = 0;
689  virtual QAction *actionCheckQgisVersion() = 0;
690  virtual QAction *actionAbout() = 0;
691 
692  // Shape digitize actions
693 
698  Q_DECL_DEPRECATED virtual QAction *actionCircle2Points() SIP_DEPRECATED {return actionAddFeature();}
699 
704  Q_DECL_DEPRECATED virtual QAction *actionCircle3Points() SIP_DEPRECATED {return actionAddFeature();}
705 
710  Q_DECL_DEPRECATED virtual QAction *actionCircle3Tangents() SIP_DEPRECATED {return actionAddFeature();}
711 
716  Q_DECL_DEPRECATED virtual QAction *actionCircle2TangentsPoint() SIP_DEPRECATED {return actionAddFeature();}
717 
722  Q_DECL_DEPRECATED virtual QAction *actionCircleCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
723 
728  Q_DECL_DEPRECATED virtual QAction *actionEllipseCenter2Points() SIP_DEPRECATED {return actionAddFeature();}
729 
734  Q_DECL_DEPRECATED virtual QAction *actionEllipseCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
735 
740  Q_DECL_DEPRECATED virtual QAction *actionEllipseExtent() SIP_DEPRECATED {return actionAddFeature();}
741 
746  Q_DECL_DEPRECATED virtual QAction *actionEllipseFoci() SIP_DEPRECATED {return actionAddFeature();}
747 
752  Q_DECL_DEPRECATED virtual QAction *actionRectangleCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
753 
758  Q_DECL_DEPRECATED virtual QAction *actionRectangleExtent() SIP_DEPRECATED {return actionAddFeature();}
759 
764  Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsDistance() SIP_DEPRECATED {return actionAddFeature();}
765 
770  Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsProjected() SIP_DEPRECATED {return actionAddFeature();}
771 
776  Q_DECL_DEPRECATED virtual QAction *actionRegularPolygon2Points() SIP_DEPRECATED {return actionAddFeature();}
777 
782  Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
783 
788  Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterCorner() SIP_DEPRECATED {return actionAddFeature();}
789 
798 
800  virtual int messageTimeout() = 0;
801 
807  virtual QgsStatusBar *statusBarIface() = 0;
808 
816  virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 ) {Q_UNUSED( saveDirectory ) Q_UNUSED( categories );}
817 
824 
830 
831  public slots: // TODO: do these functions really need to be slots?
832 
833  /* Exposed functions */
834 
838  virtual void zoomFull() = 0;
839 
843  virtual void zoomToPrevious() = 0;
844 
848  virtual void zoomToNext() = 0;
849 
853  virtual void zoomToActiveLayer() = 0;
854 
861  virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
862 
869  virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
870 
876  virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
877 
883  virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
884 
892  virtual QgsVectorTileLayer *addVectorTileLayer( const QString &url, const QString &baseName ) = 0;
893 
901  virtual QgsPointCloudLayer *addPointCloudLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
902 
910  virtual QgsTiledSceneLayer *addTiledSceneLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
911 
913  virtual bool addProject( const QString &project ) = 0;
914 
925  virtual bool newProject( bool promptToSaveFlag = false ) = 0;
926 
933  virtual void reloadConnections( ) = 0;
934 
939  virtual bool setActiveLayer( QgsMapLayer * ) = 0;
940 
944  virtual void copySelectionToClipboard( QgsMapLayer * ) = 0;
945 
949  virtual void pasteFromClipboard( QgsMapLayer * ) = 0;
950 
952  virtual int addToolBarIcon( QAction *qAction ) = 0;
953 
962  virtual QAction *addToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
963 
965  virtual void removeToolBarIcon( QAction *qAction ) = 0;
966 
975  virtual QAction *addRasterToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
976 
978  virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
979 
981  virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
982 
984  virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
985 
994  virtual QAction *addVectorToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
995 
997  virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
998 
1000  virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
1001 
1010  virtual QAction *addDatabaseToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1011 
1013  virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
1014 
1016  virtual int addWebToolBarIcon( QAction *qAction ) = 0;
1017 
1026  virtual QAction *addWebToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1027 
1029  virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
1030 
1032  virtual QToolBar *addToolBar( const QString &name ) = 0 SIP_FACTORY;
1033 
1037  virtual void addToolBar( QToolBar *toolbar SIP_TRANSFER, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0;
1038 
1042  virtual void openMessageLog() = 0;
1043 
1045  virtual void addUserInputWidget( QWidget *widget ) = 0;
1046 
1050  virtual void showLayoutManager() = 0;
1051 
1058 
1063  virtual void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() ) = 0;
1064 
1070  virtual void showProjectPropertiesDialog( const QString &currentPage = QString() ) = 0;
1071 
1076  virtual void buildStyleSheet( const QMap<QString, QVariant> &opts ) = 0;
1077 
1079  virtual void saveStyleSheetOptions( const QMap<QString, QVariant> &opts ) = 0;
1080 
1082  virtual void addPluginToMenu( const QString &name, QAction *action ) = 0;
1083 
1085  virtual void removePluginMenu( const QString &name, QAction *action ) = 0;
1086 
1088  virtual void insertAddLayerAction( QAction *action ) = 0;
1089 
1091  virtual void removeAddLayerAction( QAction *action ) = 0;
1092 
1094  virtual void addPluginToDatabaseMenu( const QString &name, QAction *action ) = 0;
1095 
1097  virtual void removePluginDatabaseMenu( const QString &name, QAction *action ) = 0;
1098 
1100  virtual void addPluginToRasterMenu( const QString &name, QAction *action ) = 0;
1101 
1103  virtual void removePluginRasterMenu( const QString &name, QAction *action ) = 0;
1104 
1106  virtual void addPluginToVectorMenu( const QString &name, QAction *action ) = 0;
1107 
1109  virtual void removePluginVectorMenu( const QString &name, QAction *action ) = 0;
1110 
1112  virtual void addPluginToWebMenu( const QString &name, QAction *action ) = 0;
1113 
1115  virtual void removePluginWebMenu( const QString &name, QAction *action ) = 0;
1116 
1122  virtual void addPluginToMeshMenu( const QString &name, QAction *action ) = 0;
1123 
1129  virtual void removePluginMeshMenu( const QString &name, QAction *action ) = 0;
1130 
1137  virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget ) = 0;
1138 
1153  virtual void addTabifiedDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget, const QStringList &tabifyWith = QStringList(), bool raiseTab = false ) = 0;
1154 
1160  virtual void removeDockWidget( QDockWidget *dockwidget ) = 0;
1161 
1195  virtual void showLayerProperties( QgsMapLayer *l, const QString &page = QString() ) = 0;
1196 
1198  virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) = 0;
1199 
1204  virtual void addWindow( QAction *action ) = 0;
1205 
1210  virtual void removeWindow( QAction *action ) = 0;
1211 
1213  virtual bool registerMainWindowAction( QAction *action, const QString &defaultShortcut ) = 0;
1214 
1216  virtual bool unregisterMainWindowAction( QAction *action ) = 0;
1217 
1226 
1233 
1242 
1249 
1259 
1267 
1276 
1283 
1295 
1302 
1316 
1323 
1331  virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) = 0;
1332 
1339 
1349 
1357 
1366 
1373 
1374  // TODO is this deprecated in favour of QgsContextHelp?
1375 
1385 #ifndef Q_MOC_RUN
1386  Q_DECL_DEPRECATED
1387 #endif
1388  virtual void openURL( const QString &url, bool useQgisDocDirectory = true ) = 0 SIP_DEPRECATED;
1389 
1398  virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
1399 
1409 
1422  virtual void preloadForm( const QString &uifile ) = 0;
1423 
1430  virtual void locatorSearch( const QString &searchText ) = 0;
1431 
1440 
1450  virtual void deregisterLocatorFilter( QgsLocatorFilter *filter ) = 0;
1451 
1459  virtual void invalidateLocatorResults() = 0;
1460 
1467 
1474 
1483  virtual void setGpsPanelConnection( QgsGpsConnection *connection SIP_TRANSFER ) = 0;
1484 
1499  virtual void blockActiveLayerChanges( bool blocked ) = 0;
1500 
1501  signals:
1502 
1508 
1513  void currentThemeChanged( const QString &theme );
1514 
1520 
1528 
1535 
1540 
1547  void projectRead();
1548 
1558 
1562  void layerSavedAs( QgsMapLayer *l, const QString &path );
1563 
1564 };
1566 
1567 #endif //#ifndef QGISINTERFACE_H
QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugin...
Definition: qgisinterface.h:98
virtual void preloadForm(const QString &uifile)=0
This method is only needed when using a UI form with a custom widget plugin and calling openFeatureFo...
virtual QAction * actionFeatureAction()=0
Returns the native run action feature action. Call trigger() on it to set the default run feature act...
virtual QAction * actionAddPart()=0
Returns the native Add Part action.
virtual void unregisterCustomDropHandler(QgsCustomDropHandler *handler)=0
Unregister a previously registered custom drop handler.
virtual void zoomToNext()=0
Zooms to the next view extent.
virtual QToolBar * digitizeToolBar()=0
Returns a reference to the main window "Digitize" toolbar.
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenterPoint()
Returns the native add ellipse from center and a point action.
virtual QAction * actionMeasure()=0
Returns the native measure action. Call trigger() on it to set the default measure map tool.
virtual QgsAttributeDialog * getFeatureForm(QgsVectorLayer *l, QgsFeature &f)=0
Returns a feature form for a given feature.
virtual void removePluginMenu(const QString &name, QAction *action)=0
Remove action from the plugins menu.
virtual QAction * actionIdentify()=0
Returns the native identify action. Call trigger() on it to set the default identify map tool.
virtual void addPluginToWebMenu(const QString &name, QAction *action)=0
Add action to the Web menu.
virtual void unregisterMapLayerConfigWidgetFactory(QgsMapLayerConfigWidgetFactory *factory)=0
Unregister a previously registered tab in the map layer properties dialog.
virtual void removeVectorToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Vector toolbar.
virtual QAction * actionNewProject()=0
Returns the native New Project action.
virtual QAction * actionVertexToolActiveLayer()=0
Returns the native "Vertex Tool for Active Layer" action.
virtual QAction * actionCutFeatures()=0
Returns the native Cut Features action.
virtual QAction * actionAddAfsLayer()=0
Returns the native Add ArcGIS REST Server action.
virtual Q_DECL_DEPRECATED QAction * actionCircle2Points()
Returns the native add circle from 2 points action.
virtual void addProjectImportAction(QAction *action)=0
Adds an action to the QGIS "Import project" menu.
virtual bool openFeatureForm(QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly=false, bool showModal=true)=0
Opens a new feature form.
virtual Q_DECL_DEPRECATED QAction * actionCircle2TangentsPoint()
Returns the native add circle from 2 tangents and a point action.
virtual int addWebToolBarIcon(QAction *qAction)=0
Add an icon to the Web toolbar.
virtual QAction * actionAddPgLayer()=0
virtual QAction * actionPluginListSeparator()=0
virtual QList< QgsMapCanvas * > mapCanvases()=0
Returns a list of all map canvases open in the app.
virtual void showLayoutManager()=0
Opens the layout manager dialog.
virtual QgsLayerTreeView * layerTreeView()=0
void layoutDesignerWillBeClosed(QgsLayoutDesignerInterface *designer)
Emitted before a layout designer is going to be closed and deleted.
virtual QAction * actionHelpContents()=0
virtual QAction * actionZoomOut()=0
Returns the native zoom out action. Call trigger() on it to set the default zoom out map tool.
virtual QAction * actionAddOgrLayer()=0
virtual QAction * actionToggleFullScreen()=0
virtual QAction * actionRollbackAllEdits()=0
virtual void zoomToActiveLayer()=0
Zooms to extent of the active layer.
virtual void showLayerProperties(QgsMapLayer *l, const QString &page=QString())=0
Opens layer properties dialog for the layer l.
virtual QAction * actionSimplifyFeature()=0
Returns the native Simplify/Smooth Features action.
virtual void zoomFull()=0
Zooms to the full extent of all map layers.
virtual QgsMapLayer * activeLayer()=0
Returns a pointer to the active layer (layer selected in the legend)
virtual void pasteFromClipboard(QgsMapLayer *)=0
Paste features from clipboard to the layer.
virtual QAction * actionOpenProject()=0
Returns the Open Project action.
void currentThemeChanged(const QString &theme)
Emitted when the current theme is changed so plugins can change their tool button icons.
virtual QgsStatusBar * statusBarIface()=0
Returns a pointer to the app's status bar interface.
virtual QAction * actionShowAllLayers()=0
virtual void removeRasterToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Raster toolbar.
virtual QAction * actionPasteFeatures()=0
Returns the native Paste Features action.
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenter2Points()
Returns the native add ellipse from center and 2 points action.
virtual QToolBar * mapNavToolToolBar()=0
Returns a reference to the main window "Map Navigation" toolbar.
virtual QAction * actionCheckQgisVersion()=0
virtual QMenu * vectorMenu()=0
Returns a reference to the main window "Vector" menu.
virtual void deregisterLocatorFilter(QgsLocatorFilter *filter)=0
Deregisters a locator filter from the app's locator bar and deletes it.
virtual void invalidateLocatorResults()=0
Invalidate results from the locator filter.
virtual void registerMapLayerConfigWidgetFactory(QgsMapLayerConfigWidgetFactory *factory)=0
Register a new tab in the map layer properties dialog.
virtual QAction * actionAddVectorTileLayer()=0
Returns the native Add Vector Tile Layer action.
virtual QAction * actionOptions()=0
virtual void unregisterProjectPropertiesWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Unregister a previously registered tab in the options dialog.
virtual Q_DECL_DEPRECATED QAction * actionZoomToLayer()=0
Returns the native zoom to layer action.
virtual QAction * actionSelect()=0
Returns the native select action. Call trigger() on it to set the default select map tool.
virtual QAction * actionProjectProperties()=0
Returns the native Project Properties action.
virtual QAction * actionCreatePrintLayout()=0
Create new print layout action.
virtual QDialog * showAttributeTable(QgsVectorLayer *l, const QString &filterExpression=QString())=0
Open attribute table dialog.
virtual void showProjectPropertiesDialog(const QString &currentPage=QString())=0
Opens the project properties dialog.
virtual QAction * addToolBarWidget(QWidget *widget)=0
Add a widget to the plugins toolbar.
virtual QgsBrowserGuiModel * browserModel()=0
Returns the application browser model.
virtual void addWindow(QAction *action)=0
Add window to Window menu.
virtual QAction * actionAddPointCloudLayer()=0
Returns the native Add Point Cloud Layer action.
virtual QAction * actionQgisHomePage()=0
virtual QgsVectorLayer * addVectorLayer(const QString &vectorLayerPath, const QString &baseName, const QString &providerKey)=0
Adds a vector layer to the current project, using the specified data provider and source url.
virtual QActionGroup * mapToolActionGroup()=0
Returns the action group for map tools.
virtual void addPluginToRasterMenu(const QString &name, QAction *action)=0
Add action to the Raster menu.
virtual QToolBar * rasterToolBar()=0
Returns a reference to the main window "Raster" toolbar.
virtual QgsMeshLayer * addMeshLayer(const QString &url, const QString &baseName, const QString &providerKey)=0
Adds a mesh layer to the current project, using the specified data provider and source url.
virtual QAction * actionZoomToSelected()=0
Returns the native zoom to selected action. Call trigger() on it to zoom to the current selection.
virtual void addPluginToVectorMenu(const QString &name, QAction *action)=0
Add action to the Vector menu.
virtual void addPluginToDatabaseMenu(const QString &name, QAction *action)=0
Add action to the Database menu.
virtual void locatorSearch(const QString &searchText)=0
This will perform a search in the locator bar by setting the line edit text to searchText and automat...
virtual int messageTimeout()=0
Returns the timeout for timed messages: default of 5 seconds.
virtual QgsRasterLayer * addRasterLayer(const QString &rasterLayerPath, const QString &baseName=QString())=0
Adds a raster layer to the current project, given a raster layer file name.
virtual Q_DECL_DEPRECATED void openURL(const QString &url, bool useQgisDocDirectory=true)=0
Open a url in the users browser.
virtual void unregisterDevToolWidgetFactory(QgsDevToolWidgetFactory *factory)=0
Unregister a previously registered tool factory from the development/debugging tools dock.
virtual void removeWebToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Web toolbar.
virtual int addRasterToolBarIcon(QAction *qAction)=0
Add an icon to the Raster toolbar.
virtual bool askForDatumTransform(QgsCoordinateReferenceSystem sourceCrs, QgsCoordinateReferenceSystem destinationCrs)=0
Checks available datum transforms and ask user if several are available and none is chosen.
virtual void buildStyleSheet(const QMap< QString, QVariant > &opts)=0
Generate stylesheet.
virtual QAction * actionMoveFeature()=0
Returns the native Move Features action.
virtual QAction * addRasterToolBarWidget(QWidget *widget)=0
Add a widget to the raster toolbar.
void layerSavedAs(QgsMapLayer *l, const QString &path)
Emitted when a layer has been saved using save as.
virtual QAction * actionRemoveAllFromOverview()=0
virtual QMap< QString, QVariant > defaultStyleSheetOptions()=0
Returns changeable options built from settings and/or defaults.
virtual QMenu * firstRightStandardMenu()=0
Returns a reference to the right most standard menu, which is usually the last menu item before the "...
virtual bool newProject(bool promptToSaveFlag=false)=0
Starts a new blank project.
virtual Q_DECL_DEPRECATED QAction * actionRectangle3PointsDistance()
Returns the native add rectangle from 3 points (distance from 2nd and 3rd points) action.
virtual QAction * actionManagePlugins()=0
virtual QAction * actionLayerSaveAs()=0
virtual void registerCustomLayoutDropHandler(QgsLayoutCustomDropHandler *handler)=0
Register a new custom drop handler for layout windows.
virtual QMenu * addLayerMenu()=0
Returns a reference to the main window "Add Layer" menu.
virtual QAction * actionSaveAllEdits()=0
virtual QMenu * projectMenu()=0
Returns a reference to the main window "Project" menu.
virtual QgsTiledSceneLayer * addTiledSceneLayer(const QString &url, const QString &baseName, const QString &providerKey)=0
Adds a tiled scene layer to the current project, using the specified data provider and source url.
virtual QToolBar * shapeDigitizeToolBar()=0
Returns a reference to the main window "Shape Digitizing" toolbar.
virtual QAction * actionAllEdits()=0
virtual QAction * actionDuplicateLayer()=0
virtual QMenu * viewMenu()=0
Returns a reference to the main window "View" menu.
virtual QgsMessageBar * messageBar()=0
Returns the message bar of the main app.
virtual QAction * actionZoomActualSize()=0
Returns the native zoom resolution (100%) action. Call trigger() on it to zoom to actual size.
virtual QAction * actionDraw()=0
Returns the native draw action.
virtual void registerProjectPropertiesWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Register a new tab in the project properties dialog.
virtual QgsPointCloudLayer * addPointCloudLayer(const QString &url, const QString &baseName, const QString &providerKey)=0
Adds a point cloud layer to the current project, using the specified data provider and source url.
virtual QAction * actionSelectPolygon()=0
Returns the native select polygon action. Call trigger() on it to set the default select polygon map ...
virtual QAction * actionCopyFeatures()=0
Returns the native Copy Features action.
virtual Q_DECL_DEPRECATED QAction * actionEllipseExtent()
Returns the native add ellipse from an extent action.
virtual QgsLayoutDesignerInterface * openLayoutDesigner(QgsMasterLayoutInterface *layout)=0
Opens a new layout designer dialog for the specified layout, or brings an already open designer windo...
virtual Q_DECL_DEPRECATED QAction * actionEllipseFoci()
Returns the native add ellipse from foci action.
void initializationCompleted()
Emitted when the initialization is complete.
virtual QToolBar * attributesToolBar()=0
Returns a reference to the main window "Attributes" toolbar.
virtual QAction * actionMapTips()=0
Returns the native map tips action. Call trigger() on it to toggle map tips.
virtual QAction * actionAddAmsLayer()=0
Returns the native Add ArcGIS REST Server action.
virtual Q_DECL_DEPRECATED QAction * actionRectangleExtent()
Returns the native add rectangle from extent action.
virtual void zoomToPrevious()=0
Zooms to the previous view extent.
virtual QgsMapCanvas * mapCanvas()=0
Returns a pointer to the map canvas.
virtual QgsLayerTreeRegistryBridge::InsertionPoint layerTreeInsertionPoint()=0
Returns the insertion point.
virtual QAction * actionToggleEditing()=0
virtual QAction * actionPasteLayerStyle()=0
virtual QList< Qgs3DMapCanvas * > mapCanvases3D()=0
Returns a list of all 3D map canvases open in the app.
virtual QList< QgsMapDecoration * > activeDecorations()=0
Returns a list of the active decorations.
virtual QAction * actionSelectFreehand()=0
Returns the native select freehand action. Call trigger() on it to set the default select freehand ma...
virtual QAction * actionNewBookmark()=0
Returns the native new bookmark action. Call trigger() on it to open the new bookmark dialog.
virtual int addToolBarIcon(QAction *qAction)=0
Add an icon to the plugins toolbar.
virtual void closeMapCanvas3D(const QString &name)=0
Closes the additional map canvas with matching name.
virtual QAction * actionAbout()=0
virtual QToolBar * addToolBar(const QString &name)=0
Add toolbar with specified name.
void currentLayerChanged(QgsMapLayer *layer)
Emitted whenever current (selected) layer changes.
virtual Q_DECL_DEPRECATED QAction * actionCircle3Tangents()
Returns the native add circle from 3 tangents action.
virtual QAction * actionCustomProjection()=0
virtual QMenu * layerMenu()=0
Returns a reference to the main window "Layer" menu.
virtual QgsRasterLayer * addRasterLayer(const QString &url, const QString &layerName, const QString &providerKey)=0
Adds a raster layer to the current project, from the specified raster data provider and source url.
virtual QAction * actionAddRing()=0
Returns the native Add Ring action.
virtual QMenu * pluginMenu()=0
Returns a reference to the main window "Plugin" menu.
virtual QAction * actionSplitParts()=0
Returns the native Split Parts action.
virtual QAction * actionZoomIn()=0
Returns the native zoom in action. Call trigger() on it to set the default zoom in map tool.
virtual QgsUserProfileManager * userProfileManager()=0
Returns a reference to the user profile manager.
virtual QMenu * editMenu()=0
Returns a reference to the main window "Edit" menu.
virtual void registerDevToolWidgetFactory(QgsDevToolWidgetFactory *factory)=0
Register a new tool in the development/debugging tools dock.
virtual void addCustomActionForLayerType(QAction *action, QString menu, Qgis::LayerType type, bool allLayers)=0
Add action to context menu for layers in the layer tree.
virtual void registerOptionsWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Register a new tab in the options dialog.
virtual QAction * actionDeleteSelected()=0
Returns the native Delete Selected Features action.
virtual void removePluginRasterMenu(const QString &name, QAction *action)=0
Remove action from the Raster menu.
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterPoint()
Returns the native add regular polygon from center and a point action.
virtual Q_DECL_DEPRECATED QAction * actionCircleCenterPoint()
Returns the native add circle from center action.
virtual void unregisterMapToolHandler(QgsAbstractMapToolHandler *handler)=0
Unregister a previously registered map tool handler.
virtual QAction * actionCancelAllEdits()=0
virtual QToolBar * webToolBar()=0
Returns a reference to the main window "Web" toolbar.
virtual void copySelectionToClipboard(QgsMapLayer *)=0
Copy selected features from the layer to clipboard.
virtual QAction * actionSelectRectangle()=0
Returns the native select rectangle action. Call trigger() on it to set the default select rectangle ...
virtual QList< QgsMapLayer * > editableLayers(bool modified=false) const =0
Returns vector layers in edit mode.
virtual QMenu * pluginHelpMenu()=0
Returns a reference to the main window "Plugin Help" sub-menu.
virtual void unregisterCustomProjectOpenHandler(QgsCustomProjectOpenHandler *handler)=0
Unregister a previously registered custom project open handler.
virtual QAction * actionSplitFeatures()=0
Returns the native Split Features action.
virtual void addUserInputWidget(QWidget *widget)=0
Adds a widget to the user input tool bar.
virtual void removeToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the plugin toolbar.
virtual QAction * actionZoomLast()=0
Returns the native zoom last action. Call trigger() on it to zoom to last.
virtual void removeProjectImportAction(QAction *action)=0
Adds an action to the QGIS "Import project" menu.
virtual QToolBar * fileToolBar()=0
Returns a reference to the main window "File" toolbar.
virtual QAction * actionShowPythonDialog()=0
virtual QFont defaultStyleSheetFont()=0
Returns a reference font for initial qApp (may not be same as QgisApp)
virtual QAction * actionAddXyzLayer()=0
Returns the native Add XYZ Layer action.
virtual QAction * actionToggleSelectedLayers()=0
Returns the Toggle Selected Layers action.
virtual void insertAddLayerAction(QAction *action)=0
Add "add layer" action to layer menu.
virtual void unregisterOptionsWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Unregister a previously registered tab in the options dialog.
virtual void addToolBar(QToolBar *toolbar, Qt::ToolBarArea area=Qt::TopToolBarArea)=0
Add a toolbar.
virtual QAction * actionSaveProjectAs()=0
Returns the native Save Project As action.
virtual QAction * actionOpenFieldCalculator()=0
virtual void registerMapToolHandler(QgsAbstractMapToolHandler *handler)=0
Register a new application map tool handler, which can be used to automatically setup all connections...
virtual QMenu * webMenu()=0
Returns a reference to the main window "Web" menu.
virtual void saveStyleSheetOptions(const QMap< QString, QVariant > &opts)=0
Save changed default option keys/values to user settings.
virtual void removeWindow(QAction *action)=0
Remove window from Window menu.
virtual int addDatabaseToolBarIcon(QAction *qAction)=0
Add an icon to the Database toolbar.
virtual QToolBar * layerToolBar()=0
Returns a reference to the main window "Layer" toolbar.
virtual QAction * actionSaveProject()=0
Returns the native Save Project action.
virtual QAction * actionToggleSelectedLayersIndependently()=0
Returns the Toggle Selected Layers Independently action.
virtual QgsLayerTreeMapCanvasBridge * layerTreeCanvasBridge()=0
Returns a pointer to the layer tree canvas bridge.
virtual QAction * actionSaveActiveLayerEdits()=0
virtual QAction * actionAddAllToOverview()=0
virtual bool addProject(const QString &project)=0
Adds (opens) a project.
virtual QToolBar * helpToolBar()=0
Returns a reference to the main window "Help" toolbar.
virtual void unregisterCustomLayoutDropHandler(QgsLayoutCustomDropHandler *handler)=0
Unregister a previously registered custom drop handler for layout windows.
virtual void removePluginMeshMenu(const QString &name, QAction *action)=0
Remove action from the Mesh menu.
virtual Q_DECL_DEPRECATED QAction * actionRectangle3PointsProjected()
Returns the native add rectangle from 3 points (distance from projected 3rd point on segment p1 and p...
virtual QAction * actionShowLayoutManager()=0
Show layout manager action.
virtual QAction * actionPanToSelected()=0
Returns the native pan to selected action. Call trigger() on it to pan the map canvas to the selectio...
virtual QWidget * mainWindow()=0
Returns a pointer to the main window (instance of QgisApp in case of QGIS)
virtual void addPluginToMeshMenu(const QString &name, QAction *action)=0
Add action to the Mesh menu.
virtual void removePluginVectorMenu(const QString &name, QAction *action)=0
Remove action from the Vector menu.
virtual QAction * actionRollbackEdits()=0
virtual QToolBar * advancedDigitizeToolBar()=0
Returns a reference to the main window "Advanced Digitizing" toolbar.
virtual QToolBar * pluginToolBar()=0
Returns a reference to the main window "Plugin" toolbar.
virtual QAction * actionPan()=0
Returns the native pan action. Call trigger() on it to set the default pan map tool.
virtual void removeDockWidget(QDockWidget *dockwidget)=0
Removes the specified dock widget from main window (without deleting it).
virtual QAction * actionAddToOverview()=0
void layoutDesignerClosed()
Emitted after a layout designer window is closed.
virtual void reloadConnections()=0
Triggered when connections have changed.
virtual QMenu * newLayerMenu()=0
Returns a reference to the main window "Create New Layer" menu.
virtual QAction * actionSelectRadius()=0
Returns the native select radius action. Call trigger() on it to set the default select radius map to...
virtual QAction * actionDeleteRing()=0
Returns the native Delete Ring action.
virtual QAction * actionShowBookmarks()=0
Returns the native show bookmarks action. Call trigger() on it to open the bookmarks dialog.
virtual void removeDatabaseToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Database toolbar.
virtual QList< QgsLayoutDesignerInterface * > openLayoutDesigners()=0
Returns all currently open layout designers.
virtual QAction * actionAddFeature()=0
Returns the native Add Feature action.
virtual QMenu * helpMenu()=0
Returns a reference to the main window "Help" menu.
virtual QSize iconSize(bool dockedToolbar=false) const =0
Returns the toolbar icon size.
virtual QToolBar * dataSourceManagerToolBar()=0
Returns a reference to the main window "Data Source Manager" toolbar.
virtual QAction * actionAddWmsLayer()=0
virtual void registerApplicationExitBlocker(QgsApplicationExitBlockerInterface *blocker)=0
Register a new application exit blocker, which can be used to prevent the QGIS application from exiti...
virtual void removePluginDatabaseMenu(const QString &name, QAction *action)=0
Remove action from the Database menu.
virtual QgsVectorLayerTools * vectorLayerTools()=0
Access the vector layer tools instance.
virtual bool setActiveLayer(QgsMapLayer *)=0
Set the active layer (layer gets selected in the legend) returns true if the layer exists,...
virtual QAction * actionSaveEdits()=0
virtual QMenu * projectImportExportMenu()=0
Returns a reference to the main window "Import/Export" project menu.
virtual Qgs3DMapCanvas * createNewMapCanvas3D(const QString &name)=0
Create a new 3D map canvas with the specified unique name.
virtual QAction * actionDeletePart()=0
Returns the native Delete Part action.
virtual void takeAppScreenShots(const QString &saveDirectory, const int categories=0)
Take screenshots for user documentation.
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterCorner()
Returns the native add regular polygon from center and a corner action.
virtual bool registerMainWindowAction(QAction *action, const QString &defaultShortcut)=0
Register action to the shortcuts manager so its shortcut can be changed in GUI.
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygon2Points()
Returns the native add regular polygon from 2 points action.
virtual QAction * actionZoomNext()=0
Returns the native zoom next action. Call trigger() on it to zoom to next.
virtual QAction * actionSaveMapAsImage()=0
Returns the native Save Map as Image action.
virtual QAction * actionHideDeselectedLayers()=0
Returns the Hide Deselected Layers action.
virtual QAction * actionLayerProperties()=0
virtual void removePluginWebMenu(const QString &name, QAction *action)=0
Remove action from the Web menu.
virtual QAction * actionVertexTool()=0
Returns the native "Vertex Tool for All Layers" action.
virtual QAction * actionShowSelectedLayers()=0
virtual void addDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget)=0
Adds a dock widget to the main window, in the specified dock area.
virtual void registerCustomDropHandler(QgsCustomDropHandler *handler)=0
Register a new custom drop handler.
void layoutDesignerOpened(QgsLayoutDesignerInterface *designer)
Emitted when a new layout designer has been opened.
virtual Q_DECL_DEPRECATED QAction * actionRectangleCenterPoint()
Returns the native add rectangle from center and a point action.
virtual QAction * actionOpenStatisticalSummary()=0
Statistical summary action.
virtual QAction * actionExit()=0
Returns the Exit QGIS action.
virtual QgsMapCanvas * createNewMapCanvas(const QString &name)=0
Create a new map canvas with the specified unique name.
virtual void unregisterApplicationExitBlocker(QgsApplicationExitBlockerInterface *blocker)=0
Unregister a previously registered application exit blocker.
virtual bool removeCustomActionForLayerType(QAction *action)=0
Remove action for layers in the layer tree previously added with addCustomActionForLayerType()
virtual void registerLocatorFilter(QgsLocatorFilter *filter)=0
Registers a locator filter for the app's locator bar.
virtual void openMessageLog()=0
Opens the message log dock widget.
virtual QgsVectorTileLayer * addVectorTileLayer(const QString &url, const QString &baseName)=0
Adds a vector tile layer to the current project, using the specified source url.
virtual QAction * actionNewVectorLayer()=0
virtual QAction * actionHideAllLayers()=0
virtual int addVectorToolBarIcon(QAction *qAction)=0
Add an icon to the Vector toolbar.
virtual QAction * actionZoomToLayers()=0
Returns the native zoom to layers action.
virtual void setGpsPanelConnection(QgsGpsConnection *connection)=0
Sets a GPS connection to use within the GPS Panel widget.
virtual QAction * actionCancelEdits()=0
virtual QAction * actionCopyLayerStyle()=0
QgisInterface()=default
Constructor.
virtual bool unregisterMainWindowAction(QAction *action)=0
Unregister a previously registered action. (e.g. when plugin is going to be unloaded)
virtual QAction * addDatabaseToolBarWidget(QWidget *widget)=0
Add a widget to the database toolbar.
virtual QMenu * windowMenu()=0
Returns a reference to the main window "Window" menu.
virtual Q_DECL_DEPRECATED QAction * actionCircle3Points()
Returns the native add circle from 3 points action.
virtual void openDataSourceManagerPage(const QString &pageName)=0
Opens a page in the main window "Data Source Manager" dialog.
virtual QgsPluginManagerInterface * pluginManagerInterface()=0
virtual void registerCustomProjectOpenHandler(QgsCustomProjectOpenHandler *handler)=0
Register a new custom project open handler.
virtual QToolBar * selectionToolBar()=0
Returns a reference to the main window "Selection" toolbar.
virtual void removeProjectExportAction(QAction *action)=0
Adds an action to the QGIS "Export project" menu.
virtual QMenu * databaseMenu()=0
Returns a reference to the main window "Database" menu.
virtual void addProjectExportAction(QAction *action)=0
Adds an action to the QGIS "Export project" menu.
virtual QAction * actionHideSelectedLayers()=0
virtual QAction * addWebToolBarWidget(QWidget *widget)=0
Add a widget to the web toolbar.
virtual void removeAddLayerAction(QAction *action)=0
Remove "add layer" action from layer menu.
virtual QAction * addVectorToolBarWidget(QWidget *widget)=0
Add a widget to the vector toolbar.
virtual void addTabifiedDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget, const QStringList &tabifyWith=QStringList(), bool raiseTab=false)=0
Add a dock widget to the given area and tabify it (if other dock widgets exist in the same area).
virtual void blockActiveLayerChanges(bool blocked)=0
Sets whether changes to the active layer should be temporarily blocked.
virtual QgsAdvancedDigitizingDockWidget * cadDockWidget()=0
Advanced digitizing dock widget.
void newProjectCreated()
Emitted when starting an entirely new project.
virtual QToolBar * databaseToolBar()=0
Returns a reference to the main window "Database" toolbar.
virtual QMenu * settingsMenu()=0
Returns a reference to the main window "Settings" menu.
virtual void closeMapCanvas(const QString &name)=0
Closes the additional map canvas with matching name.
void projectRead()
Emitted when a project file is successfully read.
virtual QMenu * meshMenu()=0
Returns a reference to the main window "Mesh" menu.
virtual void addPluginToMenu(const QString &name, QAction *action)=0
Add action to the plugins menu.
virtual void showOptionsDialog(QWidget *parent=nullptr, const QString &currentPage=QString())=0
Opens the options dialog.
virtual QAction * actionAddRasterLayer()=0
virtual QAction * actionMeasureArea()=0
Returns the native measure area action. Call trigger() on it to set the default measure area map tool...
virtual void addCustomActionForLayer(QAction *action, QgsMapLayer *layer)=0
Add action to context menu for a specific layer in the layer tree.
virtual QToolBar * vectorToolBar()=0
Returns a reference to the main window "Vector" toolbar.
virtual QMenu * rasterMenu()=0
Returns a reference to the main window "Raster" menu.
virtual QAction * actionZoomFullExtent()=0
Returns the native zoom full extent action. Call trigger() on it to zoom to the full extent.
virtual QAction * actionOpenTable()=0
LayerType
Types of layers that can be added to a map.
Definition: qgis.h:114
An abstract base class for map tool handlers which automatically handle all the necessary logic for t...
The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of...
An interface that may be implemented to allow plugins or scripts to temporarily block the QGIS applic...
A model for showing available data sources and other items in a structured tree.
This class represents a coordinate reference system (CRS).
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS.
Abstract base class that may be implemented to handle new project file types within the QGIS applicat...
The QgsDataSourceManagerDialog class embeds the browser panel and all the provider dialogs.
Factory class for creating custom developer/debugging tool pages.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Abstract base class for connection to a GPS device.
Layer tree group node serves as a container for layers and further groups.
The QgsLayerTreeMapCanvasBridge class takes care of updates of layer set for QgsMapCanvas from a laye...
The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working ...
Abstract base class that may be implemented to handle new types of data to be dropped or pasted in QG...
A common interface for layout designer dialogs and widgets.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
Abstract base class for filters which collect locator results.
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:93
Interface for map decorations.
Factory class for creating custom map layer property pages.
Base class for all map layer types.
Definition: qgsmaplayer.h:75
Interface for master layout type objects, such as print layouts and reports.
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Definition: qgsmeshlayer.h:101
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61
A factory class for creating custom options pages.
Represents a map layer supporting display of point clouds.
Represents a raster layer.
A proxy widget for QStatusBar.
Definition: qgsstatusbar.h:46
Represents a map layer supporting display of tiled scene objects.
User profile manager is used to manager list, and manage user profiles on the users machine.
Methods in this class are used to handle basic operations on vector layers.
Represents a vector layer which manages a vector based data sets.
Implements a map layer that is dedicated to rendering of vector tiles.
#define Q_NOWARN_DEPRECATED_POP
Definition: qgis.h:5741
#define Q_NOWARN_DEPRECATED_PUSH
Definition: qgis.h:5740
#define SIP_DEPRECATED
Definition: qgis_sip.h:106
#define SIP_EXTERNAL
Definition: qgis_sip.h:116
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76
A structure to define the insertion point to the layer tree.