QGIS API Documentation 4.1.0-Master (0cdd3ae6384)
Loading...
Searching...
No Matches
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 <map>
22
23#include "qgis.h"
24#include "qgis_gui.h"
25#include "qgis_sip.h"
28
29#include <QObject>
30
31class QAction;
32class QDialog;
33class QFont;
34class QMenu;
35class QToolBar;
36class QDockWidget;
37class QMainWindow;
38class QWidget;
39class QActionGroup;
40
46class QgsFeature;
51class QgsLayout;
54class QgsMapCanvas;
55class QgsMapLayer;
58class QgsMessageBar;
60class QgsRasterLayer;
61class QgsVectorLayer;
68class QgsStatusBar;
69class QgsMeshLayer;
78
79#ifdef SIP_RUN
80//%ModuleHeaderCode
81class Qgs3DMapCanvas;
82//%End
83#endif
84
96
98class GUI_EXPORT QgisInterface : public QObject
99{
100 Q_OBJECT
101
102 public:
103 QgisInterface() = default;
104
106
108
113
127 virtual void addCustomActionForLayerType( QAction *action, QString menu, Qgis::LayerType type, bool allLayers ) = 0;
128
136 virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0;
137
143 virtual bool removeCustomActionForLayerType( QAction *action ) = 0;
144
148 virtual QList<QgsMapCanvas *> mapCanvases() = 0;
149
154 virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0;
155
160 virtual void closeMapCanvas( const QString &name ) = 0;
161
166 virtual QList<Qgs3DMapCanvas *> mapCanvases3D() = 0;
167
174 virtual Qgs3DMapCanvas *createNewMapCanvas3D( const QString &name, Qgis::SceneMode sceneMode = Qgis::SceneMode::Local ) = 0;
175
181 virtual void closeMapCanvas3D( const QString &name ) = 0;
182
188 virtual QSize iconSize( bool dockedToolbar = false ) const = 0;
189
196 virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
197
199 virtual QgsMapLayer *activeLayer() = 0;
200
202 virtual QgsMapCanvas *mapCanvas() = 0;
203
208 virtual QList<QgsMapDecoration *> activeDecorations() = 0;
209
215
217 virtual QWidget *mainWindow() = 0;
218
220 virtual QgsMessageBar *messageBar() = 0;
221
225 virtual QList<QgsLayoutDesignerInterface *> openLayoutDesigners() = 0;
226
228 virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
229
231 virtual QFont defaultStyleSheetFont() = 0;
232
237
238 /*
239 * Accessors for inserting items into menus and toolbars.
240 * An item can be inserted before any existing action.
241 */
242
246 virtual QMenu *projectMenu() = 0;
247
255 virtual QMenu *projectImportExportMenu() = 0;
256
264 virtual void addProjectImportAction( QAction *action ) = 0;
265
273 virtual void removeProjectImportAction( QAction *action ) = 0;
274
282 virtual void addProjectExportAction( QAction *action ) = 0;
283
291 virtual void removeProjectExportAction( QAction *action ) = 0;
292
298 virtual QMenu *projectModelsMenu() = 0;
299
305 virtual QMenu *createProjectModelSubMenu( const QString &title ) = 0;
306
310 virtual QMenu *editMenu() = 0;
311
315 virtual QMenu *viewMenu() = 0;
316
320 virtual QMenu *layerMenu() = 0;
321
325 virtual QMenu *newLayerMenu() = 0;
326
330 virtual QMenu *addLayerMenu() = 0;
331
335 virtual QMenu *settingsMenu() = 0;
336
340 virtual QMenu *pluginMenu() = 0;
341
350 virtual QMenu *pluginHelpMenu() = 0;
351
355 virtual QMenu *rasterMenu() = 0;
356
360 virtual QMenu *databaseMenu() = 0;
361
365 virtual QMenu *vectorMenu() = 0;
366
370 virtual QMenu *webMenu() = 0;
371
377 virtual QMenu *meshMenu() = 0;
378
386 virtual QMenu *firstRightStandardMenu() = 0;
387
391 virtual QMenu *windowMenu() = 0;
392
396 virtual QMenu *helpMenu() = 0;
397
398 // ToolBars
399
403 virtual QToolBar *fileToolBar() = 0;
404
408 virtual QToolBar *layerToolBar() = 0;
409
414 virtual QToolBar *dataSourceManagerToolBar() = 0;
415
423 virtual void openDataSourceManagerPage( const QString &pageName ) = 0;
424
428 virtual QToolBar *mapNavToolToolBar() = 0;
429
433 virtual QToolBar *digitizeToolBar() = 0;
434
438 virtual QToolBar *advancedDigitizeToolBar() = 0;
439
443 virtual QToolBar *shapeDigitizeToolBar() = 0;
444
448 virtual QToolBar *attributesToolBar() = 0;
449
454 virtual QToolBar *selectionToolBar() = 0;
455
459 virtual QToolBar *pluginToolBar() = 0;
460
464 virtual QToolBar *helpToolBar() = 0;
465
469 virtual QToolBar *rasterToolBar() = 0;
470
474 virtual QToolBar *vectorToolBar() = 0;
475
479 virtual QToolBar *databaseToolBar() = 0;
480
484 virtual QToolBar *webToolBar() = 0;
485
486 // Project menu actions
488 virtual QAction *actionNewProject() = 0;
490 virtual QAction *actionOpenProject() = 0;
492 virtual QAction *actionSaveProject() = 0;
494 virtual QAction *actionSaveProjectAs() = 0;
496 virtual QAction *actionSaveMapAsImage() = 0;
498 virtual QAction *actionProjectProperties() = 0;
499
501 virtual QAction *actionCreatePrintLayout() = 0;
502
504 virtual QAction *actionShowLayoutManager() = 0;
506 virtual QAction *actionExit() = 0;
507
508 // Edit menu actions
509
511 virtual QAction *actionCutFeatures() = 0;
513 virtual QAction *actionCopyFeatures() = 0;
515 virtual QAction *actionPasteFeatures() = 0;
517 virtual QAction *actionAddFeature() = 0;
519 virtual QAction *actionDeleteSelected() = 0;
521 virtual QAction *actionMoveFeature() = 0;
523 virtual QAction *actionSplitFeatures() = 0;
525 virtual QAction *actionSplitParts() = 0;
527 virtual QAction *actionAddRing() = 0;
529 virtual QAction *actionAddPart() = 0;
531 virtual QAction *actionSimplifyFeature() = 0;
533 virtual QAction *actionDeleteRing() = 0;
535 virtual QAction *actionDeletePart() = 0;
536
541 virtual QAction *actionVertexTool() = 0;
542
548 virtual QAction *actionVertexToolActiveLayer() = 0;
549
558 virtual QActionGroup *mapToolActionGroup() = 0;
559
560 // View menu actions
561
567 virtual QAction *actionPan() = 0;
568
574 virtual QAction *actionPanToSelected() = 0;
575
581 virtual QAction *actionZoomIn() = 0;
582
588 virtual QAction *actionZoomOut() = 0;
589
595 virtual QAction *actionSelect() = 0;
596
602 virtual QAction *actionSelectRectangle() = 0;
603
609 virtual QAction *actionSelectPolygon() = 0;
610
616 virtual QAction *actionSelectFreehand() = 0;
617
623 virtual QAction *actionSelectRadius() = 0;
624
630 virtual QAction *actionIdentify() = 0;
631
637 virtual QAction *actionFeatureAction() = 0;
638
644 virtual QAction *actionMeasure() = 0;
645
651 virtual QAction *actionMeasureArea() = 0;
652
658 virtual QAction *actionZoomFullExtent() = 0;
659
667 Q_DECL_DEPRECATED virtual QAction *actionZoomToLayer() = 0 SIP_DEPRECATED;
668
675 virtual QAction *actionZoomToLayers() = 0;
676
682 virtual QAction *actionZoomToSelected() = 0;
683
689 virtual QAction *actionZoomLast() = 0;
690
696 virtual QAction *actionZoomNext() = 0;
697
703 virtual QAction *actionZoomActualSize() = 0;
704
710 virtual QAction *actionMapTips() = 0;
711
717 virtual QAction *actionNewBookmark() = 0;
718
724 virtual QAction *actionShowBookmarks() = 0;
725
729 virtual QAction *actionDraw() = 0;
730
731 // Layer menu actions
732 virtual QAction *actionNewVectorLayer() = 0;
733 virtual QAction *actionAddOgrLayer() = 0;
734 virtual QAction *actionAddRasterLayer() = 0;
735 virtual QAction *actionAddPgLayer() = 0;
736 virtual QAction *actionAddWmsLayer() = 0;
737
742 virtual QAction *actionAddXyzLayer() = 0;
743
748 virtual QAction *actionAddVectorTileLayer() = 0;
749
754 virtual QAction *actionAddPointCloudLayer() = 0;
755
757 virtual QAction *actionAddAfsLayer() = 0;
758
760 virtual QAction *actionAddAmsLayer() = 0;
761
762 virtual QAction *actionCopyLayerStyle() = 0;
763 virtual QAction *actionPasteLayerStyle() = 0;
764 virtual QAction *actionOpenTable() = 0;
765 virtual QAction *actionOpenFieldCalculator() = 0;
766
770 virtual QAction *actionOpenStatisticalSummary() = 0;
771
772 virtual QAction *actionToggleEditing() = 0;
773 virtual QAction *actionSaveActiveLayerEdits() = 0;
774 virtual QAction *actionAllEdits() = 0;
775 virtual QAction *actionSaveEdits() = 0;
776 virtual QAction *actionSaveAllEdits() = 0;
777 virtual QAction *actionRollbackEdits() = 0;
778 virtual QAction *actionRollbackAllEdits() = 0;
779 virtual QAction *actionCancelEdits() = 0;
780 virtual QAction *actionCancelAllEdits() = 0;
781 virtual QAction *actionLayerSaveAs() = 0;
782 virtual QAction *actionDuplicateLayer() = 0;
783 virtual QAction *actionLayerProperties() = 0;
784 virtual QAction *actionAddToOverview() = 0;
785 virtual QAction *actionAddAllToOverview() = 0;
786 virtual QAction *actionRemoveAllFromOverview() = 0;
787 virtual QAction *actionHideAllLayers() = 0;
788 virtual QAction *actionShowAllLayers() = 0;
789 virtual QAction *actionHideSelectedLayers() = 0;
790
795 virtual QAction *actionToggleSelectedLayers() = 0;
796
802
806 virtual QAction *actionHideDeselectedLayers() = 0;
807 virtual QAction *actionShowSelectedLayers() = 0;
808
809 // Plugin menu actions
810 virtual QAction *actionManagePlugins() = 0;
811 virtual QAction *actionPluginListSeparator() = 0;
812 virtual QAction *actionShowPythonDialog() = 0;
813
814 // Settings menu actions
815 virtual QAction *actionToggleFullScreen() = 0;
816 virtual QAction *actionOptions() = 0;
817 virtual QAction *actionCustomProjection() = 0;
818
819 // Help menu actions
820 virtual QAction *actionHelpContents() = 0;
821 virtual QAction *actionQgisHomePage() = 0;
822 virtual QAction *actionCheckQgisVersion() = 0;
823 virtual QAction *actionAbout() = 0;
824
825 // Shape digitize actions
826
833 Q_DECL_DEPRECATED virtual QAction *actionCircle2Points() SIP_DEPRECATED { return actionAddFeature(); }
834
841 Q_DECL_DEPRECATED virtual QAction *actionCircle3Points() SIP_DEPRECATED { return actionAddFeature(); }
842
849 Q_DECL_DEPRECATED virtual QAction *actionCircle3Tangents() SIP_DEPRECATED { return actionAddFeature(); }
850
857 Q_DECL_DEPRECATED virtual QAction *actionCircle2TangentsPoint() SIP_DEPRECATED { return actionAddFeature(); }
858
865 Q_DECL_DEPRECATED virtual QAction *actionCircleCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
866
873 Q_DECL_DEPRECATED virtual QAction *actionEllipseCenter2Points() SIP_DEPRECATED { return actionAddFeature(); }
874
881 Q_DECL_DEPRECATED virtual QAction *actionEllipseCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
882
889 Q_DECL_DEPRECATED virtual QAction *actionEllipseExtent() SIP_DEPRECATED { return actionAddFeature(); }
890
897 Q_DECL_DEPRECATED virtual QAction *actionEllipseFoci() SIP_DEPRECATED { return actionAddFeature(); }
898
905 Q_DECL_DEPRECATED virtual QAction *actionRectangleCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
906
913 Q_DECL_DEPRECATED virtual QAction *actionRectangleExtent() SIP_DEPRECATED { return actionAddFeature(); }
914
921 Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsDistance() SIP_DEPRECATED { return actionAddFeature(); }
922
929 Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsProjected() SIP_DEPRECATED { return actionAddFeature(); }
930
937 Q_DECL_DEPRECATED virtual QAction *actionRegularPolygon2Points() SIP_DEPRECATED { return actionAddFeature(); }
938
945 Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
946
953 Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterCorner() SIP_DEPRECATED { return actionAddFeature(); }
954
964
966 virtual int messageTimeout() = 0;
967
975
983 virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 )
984 {
985 Q_UNUSED( saveDirectory )
986 Q_UNUSED( categories );
987 }
988
996
1002
1003 public slots: // TODO: do these functions really need to be slots?
1004
1005 /* Exposed functions */
1006
1010 virtual void zoomFull() = 0;
1011
1015 virtual void zoomToPrevious() = 0;
1016
1020 virtual void zoomToNext() = 0;
1021
1025 virtual void zoomToActiveLayer() = 0;
1026
1033 virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
1034
1041 virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
1042
1048 virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
1049
1055 virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
1056
1064 virtual QgsVectorTileLayer *addVectorTileLayer( const QString &url, const QString &baseName ) = 0;
1065
1073 virtual QgsPointCloudLayer *addPointCloudLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
1074
1082 virtual QgsTiledSceneLayer *addTiledSceneLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
1083
1085 virtual bool addProject( const QString &project ) = 0;
1086
1097 virtual bool newProject( bool promptToSaveFlag = false ) = 0;
1098
1106 virtual void reloadConnections() = 0;
1107
1115 virtual bool setActiveLayer( QgsMapLayer *layer ) = 0;
1116
1120 virtual void copySelectionToClipboard( QgsMapLayer *layer ) = 0;
1121
1125 virtual void pasteFromClipboard( QgsMapLayer *layer ) = 0;
1126
1128 virtual int addToolBarIcon( QAction *qAction ) = 0;
1129
1139 virtual QAction *addToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1140
1142 virtual void removeToolBarIcon( QAction *qAction ) = 0;
1143
1153 virtual QAction *addRasterToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1154
1156 virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
1157
1159 virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
1160
1162 virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
1163
1173 virtual QAction *addVectorToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1174
1176 virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
1177
1179 virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
1180
1190 virtual QAction *addDatabaseToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1191
1193 virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
1194
1196 virtual int addWebToolBarIcon( QAction *qAction ) = 0;
1197
1207 virtual QAction *addWebToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1208
1210 virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
1211
1213 virtual QToolBar *addToolBar( const QString &name ) = 0 SIP_FACTORY;
1214
1218 virtual void addToolBar( QToolBar *toolbar SIP_TRANSFER, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0;
1219
1225 virtual void openMessageLog( const QString &tabName = QString() ) = 0;
1226
1228 virtual void addUserInputWidget( QWidget *widget ) = 0;
1229
1233 virtual void showLayoutManager() = 0;
1234
1241
1248 virtual void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() ) = 0;
1249
1257 virtual void showProjectPropertiesDialog( const QString &currentPage = QString() ) = 0;
1258
1263 virtual void buildStyleSheet( const QMap<QString, QVariant> &opts ) = 0;
1264
1266 virtual void saveStyleSheetOptions( const QMap<QString, QVariant> &opts ) = 0;
1267
1269 virtual void addPluginToMenu( const QString &name, QAction *action ) = 0;
1270
1272 virtual void removePluginMenu( const QString &name, QAction *action ) = 0;
1273
1275 virtual void insertAddLayerAction( QAction *action ) = 0;
1276
1278 virtual void removeAddLayerAction( QAction *action ) = 0;
1279
1281 virtual void addPluginToDatabaseMenu( const QString &name, QAction *action ) = 0;
1282
1284 virtual void removePluginDatabaseMenu( const QString &name, QAction *action ) = 0;
1285
1287 virtual void addPluginToRasterMenu( const QString &name, QAction *action ) = 0;
1288
1290 virtual void removePluginRasterMenu( const QString &name, QAction *action ) = 0;
1291
1293 virtual void addPluginToVectorMenu( const QString &name, QAction *action ) = 0;
1294
1296 virtual void removePluginVectorMenu( const QString &name, QAction *action ) = 0;
1297
1299 virtual void addPluginToWebMenu( const QString &name, QAction *action ) = 0;
1300
1302 virtual void removePluginWebMenu( const QString &name, QAction *action ) = 0;
1303
1309 virtual void addPluginToMeshMenu( const QString &name, QAction *action ) = 0;
1310
1316 virtual void removePluginMeshMenu( const QString &name, QAction *action ) = 0;
1317
1324 virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget ) = 0;
1325
1341 virtual void addTabifiedDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget, const QStringList &tabifyWith = QStringList(), bool raiseTab = false ) = 0;
1342
1348 virtual void removeDockWidget( QDockWidget *dockwidget ) = 0;
1349
1384 virtual void showLayerProperties( QgsMapLayer *l, const QString &page = QString() ) = 0;
1385
1387 virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) = 0;
1388
1395 virtual void addWindow( QAction *action ) = 0;
1396
1403 virtual void removeWindow( QAction *action ) = 0;
1404
1406 virtual bool registerMainWindowAction( QAction *action, const QString &defaultShortcut ) = 0;
1407
1409 virtual bool unregisterMainWindowAction( QAction *action ) = 0;
1410
1419
1426
1435
1442
1452
1460
1469
1476
1488 const QString &object = QString(),
1489 const QString &module = QString()
1490 ) = 0;
1491
1503
1510
1524
1531
1540
1547
1557
1565
1574
1581
1582 // TODO is this deprecated in favour of QgsContextHelp?
1583
1595#ifndef Q_MOC_RUN
1596 Q_DECL_DEPRECATED
1597#endif
1598 virtual void openURL( const QString &url, bool useQgisDocDirectory = true ) = 0 SIP_DEPRECATED;
1599
1610 virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
1611
1621
1635 virtual void preloadForm( const QString &uifile ) = 0;
1636
1643 virtual void locatorSearch( const QString &searchText ) = 0;
1644
1655
1666 virtual void deregisterLocatorFilter( QgsLocatorFilter *filter ) = 0;
1667
1675 virtual void invalidateLocatorResults() = 0;
1676
1685
1694
1704 Q_DECL_DEPRECATED virtual void setGpsPanelConnection( QgsGpsConnection *connection SIP_TRANSFER ) = 0 SIP_DEPRECATED;
1705
1720 virtual void blockActiveLayerChanges( bool blocked ) = 0;
1721
1722 signals:
1723
1730
1735 void currentThemeChanged( const QString &theme );
1736
1742
1750
1757
1762
1770
1780
1784 void layerSavedAs( QgsMapLayer *l, const QString &path );
1785};
1787
1788#endif //#ifndef QGISINTERFACE_H
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 Q_DECL_DEPRECATED QAction * actionEllipseExtent()
Returns the native add ellipse from an extent action.
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 * actionExit()=0
Returns the Exit QGIS action.
virtual void unregisterCustomDropHandler(QgsCustomDropHandler *handler)=0
Unregisters a previously registered custom drop handler.
virtual QMenu * databaseMenu()=0
Returns a reference to the main window "Database" menu.
virtual QAction * addToolBarWidget(QWidget *widget)=0
Adds a widget to the plugins toolbar.
virtual void zoomToNext()=0
Zooms to the next view extent.
virtual QMenu * windowMenu()=0
Returns a reference to the main window "Window" menu.
virtual QAction * actionNewBookmark()=0
Returns the native new bookmark action.
virtual Q_DECL_DEPRECATED QAction * actionCircle3Tangents()
Returns the native add circle from 3 tangents action.
virtual QAction * actionSelectPolygon()=0
Returns the native select polygon action.
virtual void removePluginMenu(const QString &name, QAction *action)=0
Removes action from the plugins menu.
virtual void addPluginToWebMenu(const QString &name, QAction *action)=0
Adds an action to the Web menu.
virtual QAction * actionToggleFullScreen()=0
virtual void unregisterMapLayerConfigWidgetFactory(QgsMapLayerConfigWidgetFactory *factory)=0
Unregisters a previously registered tab in the map layer properties dialog.
virtual void removeVectorToolBarIcon(QAction *qAction)=0
Removes an action (icon only, no text) from the Vector toolbar.
virtual QAction * actionAddAllToOverview()=0
virtual QAction * actionToggleSelectedLayers()=0
Returns the Toggle Selected Layers action.
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 QAction * actionAddWmsLayer()=0
virtual QAction * addWebToolBarWidget(QWidget *widget)=0
Adds a widget to the web toolbar.
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 QAction * actionZoomOut()=0
Returns the native zoom out action.
virtual int addWebToolBarIcon(QAction *qAction)=0
Adds an action (icon only, no text) to the Web toolbar.
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 QAction * actionOpenFieldCalculator()=0
virtual QAction * actionIdentify()=0
Returns the native identify action.
virtual Q_DECL_DEPRECATED QAction * actionCircle3Points()
Returns the native add circle from 3 points action.
void layoutDesignerWillBeClosed(QgsLayoutDesignerInterface *designer)
Emitted before a layout designer is going to be closed and deleted.
virtual QAction * actionPan()=0
Returns the native pan action.
virtual QAction * actionQgisHomePage()=0
virtual QAction * actionCopyFeatures()=0
Returns the native Copy Features action.
virtual QAction * actionToggleSelectedLayersIndependently()=0
Returns the Toggle Selected Layers Independently action.
virtual QAction * actionHelpContents()=0
virtual Qgs3DMapCanvas * createNewMapCanvas3D(const QString &name, Qgis::SceneMode sceneMode=Qgis::SceneMode::Local)=0
Creates a new 3D map canvas with the specified unique name.
virtual QAction * actionSplitFeatures()=0
Returns the native Split Features action.
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 void zoomFull()=0
Zooms to the full extent of all map layers.
virtual QAction * actionPasteFeatures()=0
Returns the native Paste Features action.
virtual QAction * actionAddToOverview()=0
void currentThemeChanged(const QString &theme)
Emitted when the current theme is changed so plugins can change their tool button icons.
virtual void removeRasterToolBarIcon(QAction *qAction)=0
Removes an action (icon only, no text) from the Raster toolbar.
virtual QAction * actionHideDeselectedLayers()=0
Returns the Hide Deselected Layers action.
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
Registers a new tab in the map layer properties dialog.
virtual QAction * actionSplitParts()=0
Returns the native Split Parts action.
virtual void unregisterProjectPropertiesWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Unregisters a previously registered tab in the options dialog.
virtual QToolBar * rasterToolBar()=0
Returns a reference to the main window "Raster" toolbar.
virtual QgsLayoutDesignerInterface * openLayoutDesigner(QgsMasterLayoutInterface *layout)=0
Opens a new layout designer dialog for the specified layout, or brings an already open designer windo...
virtual QToolBar * vectorToolBar()=0
Returns a reference to the main window "Vector" toolbar.
virtual QAction * actionAddAmsLayer()=0
Returns the native Add ArcGIS REST Server action.
virtual QMenu * newLayerMenu()=0
Returns a reference to the main window "Create New Layer" menu.
virtual QAction * actionSaveProject()=0
Returns the native Save Project action.
virtual QAction * actionMeasureArea()=0
Returns the native measure area action.
virtual void showProjectPropertiesDialog(const QString &currentPage=QString())=0
Opens the project properties dialog.
virtual QAction * actionProjectProperties()=0
Returns the native Project Properties action.
virtual QAction * actionMapTips()=0
Returns the native map tips action.
virtual QAction * actionSelectFreehand()=0
Returns the native select freehand action.
virtual QAction * actionSaveProjectAs()=0
Returns the native Save Project As action.
virtual QAction * actionHideSelectedLayers()=0
virtual void addWindow(QAction *action)=0
Adds window to Window menu.
virtual QAction * actionToggleEditing()=0
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenter2Points()
Returns the native add ellipse from center and 2 points action.
virtual void addPluginToRasterMenu(const QString &name, QAction *action)=0
Adds an action to the Raster menu.
virtual QMenu * layerMenu()=0
Returns a reference to the main window "Layer" menu.
virtual QAction * actionPluginListSeparator()=0
virtual QAction * actionOpenProject()=0
Returns the Open Project action.
virtual void addPluginToVectorMenu(const QString &name, QAction *action)=0
Adds an action to the Vector menu.
virtual QMenu * webMenu()=0
Returns a reference to the main window "Web" menu.
virtual QgsMessageBar * messageBar()=0
Returns the message bar of the main app.
virtual QMenu * editMenu()=0
Returns a reference to the main window "Edit" menu.
virtual void showApiDocumentation(Qgis::DocumentationApi api=Qgis::DocumentationApi::PyQgis, Qgis::DocumentationBrowser browser=Qgis::DocumentationBrowser::DeveloperToolsPanel, const QString &object=QString(), const QString &module=QString())=0
Show a page of the API documentation.
virtual void addPluginToDatabaseMenu(const QString &name, QAction *action)=0
Adds an 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 Q_DECL_DEPRECATED void openURL(const QString &url, bool useQgisDocDirectory=true)=0
Opens a url in the users browser.
virtual void unregisterDevToolWidgetFactory(QgsDevToolWidgetFactory *factory)=0
Unregisters a previously registered tool factory from the development/debugging tools dock.
virtual QAction * actionSaveActiveLayerEdits()=0
virtual QMenu * viewMenu()=0
Returns a reference to the main window "View" menu.
virtual void removeWebToolBarIcon(QAction *qAction)=0
Removes an action (icon only, no text) from the Web toolbar.
virtual int addRasterToolBarIcon(QAction *qAction)=0
Adds an action (icon only, no text) to the Raster toolbar.
virtual Q_DECL_DEPRECATED void setGpsPanelConnection(QgsGpsConnection *connection)=0
Sets a GPS connection to use within the GPS Panel widget.
virtual bool askForDatumTransform(QgsCoordinateReferenceSystem sourceCrs, QgsCoordinateReferenceSystem destinationCrs)=0
Checks available datum transforms and ask user if several are available and none is chosen.
virtual QMenu * projectModelsMenu()=0
Returns a reference to the main window "Projects" - "Models" submenu.
virtual void buildStyleSheet(const QMap< QString, QVariant > &opts)=0
Generate stylesheet.
virtual QAction * actionAbout()=0
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 * actionVertexTool()=0
Returns the native "Vertex Tool for All Layers" action.
virtual QgsMapLayer * activeLayer()=0
Returns a pointer to the active layer (layer selected in the legend).
virtual QAction * actionMoveFeature()=0
Returns the native Move Features action.
virtual QToolBar * fileToolBar()=0
Returns a reference to the main window "File" toolbar.
virtual QAction * actionRollbackEdits()=0
virtual QAction * actionCutFeatures()=0
Returns the native Cut Features action.
void layerSavedAs(QgsMapLayer *l, const QString &path)
Emitted when a layer has been saved using save as.
virtual QDialog * showAttributeTable(QgsVectorLayer *l, const QString &filterExpression=QString())=0
Open attribute table dialog.
virtual bool newProject(bool promptToSaveFlag=false)=0
Starts a new blank project.
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterCorner()
Returns the native add regular polygon from center and a corner action.
virtual QToolBar * digitizeToolBar()=0
Returns a reference to the main window "Digitize" toolbar.
virtual QAction * actionOpenTable()=0
virtual Q_DECL_DEPRECATED QAction * actionRectangleExtent()
Returns the native add rectangle from extent action.
virtual QAction * actionZoomToSelected()=0
Returns the native zoom to selected action.
virtual void registerCustomLayoutDropHandler(QgsLayoutCustomDropHandler *handler)=0
Registers a new custom drop handler for layout windows.
virtual QToolBar * attributesToolBar()=0
Returns a reference to the main window "Attributes" toolbar.
virtual QAction * actionCancelAllEdits()=0
virtual QAction * actionZoomNext()=0
Returns the native zoom next action.
virtual QAction * actionDuplicateLayer()=0
virtual QAction * actionOpenStatisticalSummary()=0
Statistical summary action.
virtual QAction * actionManagePlugins()=0
virtual QgsAttributeDialog * getFeatureForm(QgsVectorLayer *l, QgsFeature &f)=0
Returns a feature form for a given feature.
virtual QMenu * projectMenu()=0
Returns a reference to the main window "Project" menu.
virtual QAction * actionRollbackAllEdits()=0
virtual void registerProjectPropertiesWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Registers a new tab in the project properties dialog.
virtual QMenu * vectorMenu()=0
Returns a reference to the main window "Vector" menu.
virtual QgsGpsToolsInterface * gpsTools()=0
Returns an interface to allow plugins to use QGIS GPS tools.
virtual QAction * actionZoomLast()=0
Returns the native zoom last action.
virtual QAction * actionZoomToLayers()=0
Returns the native zoom to layers action.
virtual QAction * actionShowLayoutManager()=0
Shows layout manager action.
virtual QAction * actionNewProject()=0
Returns the native New Project action.
virtual QToolBar * layerToolBar()=0
Returns a reference to the main window "Layer" toolbar.
virtual QMenu * helpMenu()=0
Returns a reference to the main window "Help" menu.
virtual QgsMapCanvas * createNewMapCanvas(const QString &name)=0
Creates a new map canvas with the specified unique name.
virtual QAction * actionShowPythonDialog()=0
void initializationCompleted()
Emitted when the initialization is complete.
virtual QAction * actionPasteLayerStyle()=0
virtual QAction * actionVertexToolActiveLayer()=0
Returns the native "Vertex Tool for Active Layer" action.
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterPoint()
Returns the native add regular polygon from center and a point action.
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 void zoomToPrevious()=0
Zooms to the previous view extent.
virtual QActionGroup * mapToolActionGroup()=0
Returns the action group for map tools.
virtual QgsLayerTreeRegistryBridge::InsertionPoint layerTreeInsertionPoint()=0
Returns the insertion point.
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 QAction * actionAddPgLayer()=0
virtual QList< Qgs3DMapCanvas * > mapCanvases3D()=0
Returns a list of all 3D map canvases open in the app.
virtual Q_DECL_DEPRECATED QAction * actionRectangle3PointsDistance()
Returns the native add rectangle from 3 points (distance from 2nd and 3rd points) action.
virtual int addToolBarIcon(QAction *qAction)=0
Adds an action (icon only, no text) to the plugins toolbar.
virtual void closeMapCanvas3D(const QString &name)=0
Closes the additional map canvas with matching name.
virtual QAction * actionShowAllLayers()=0
void currentLayerChanged(QgsMapLayer *layer)
Emitted whenever current (selected) layer changes.
virtual QToolBar * dataSourceManagerToolBar()=0
Returns a reference to the main window "Data Source Manager" toolbar.
virtual QAction * actionAddXyzLayer()=0
Returns the native Add XYZ Layer action.
virtual QgsBrowserGuiModel * browserModel()=0
Returns the application browser model.
virtual void registerDevToolWidgetFactory(QgsDevToolWidgetFactory *factory)=0
Registers a new tool in the development/debugging tools dock.
virtual QAction * actionPanToSelected()=0
Returns the native pan to selected action.
virtual void addCustomActionForLayerType(QAction *action, QString menu, Qgis::LayerType type, bool allLayers)=0
Adds an action to context menu for layers in the layer tree.
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 void registerOptionsWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Registers a new tab in the options dialog.
virtual void removePluginRasterMenu(const QString &name, QAction *action)=0
Removes action from the Raster menu.
virtual QAction * actionOptions()=0
virtual QgsStatusBar * statusBarIface()=0
Returns a pointer to the app's status bar interface.
virtual void unregisterMapToolHandler(QgsAbstractMapToolHandler *handler)=0
Unregisters a previously registered map tool handler.
virtual Q_DECL_DEPRECATED QAction * actionCircle2TangentsPoint()
Returns the native add circle from 2 tangents and a point action.
virtual QAction * actionAddRing()=0
Returns the native Add Ring action.
virtual QToolBar * pluginToolBar()=0
Returns a reference to the main window "Plugin" toolbar.
virtual QgsMapCanvas * mapCanvas()=0
Returns a pointer to the map canvas.
virtual QAction * actionAddPart()=0
Returns the native Add Part action.
virtual Q_DECL_DEPRECATED QAction * actionZoomToLayer()=0
Returns the native zoom to layer action.
virtual QgsPluginManagerInterface * pluginManagerInterface()=0
virtual void unregisterCustomProjectOpenHandler(QgsCustomProjectOpenHandler *handler)=0
Unregisters a previously registered custom project open handler.
virtual void addUserInputWidget(QWidget *widget)=0
Adds a widget to the user input tool bar.
virtual QMenu * addLayerMenu()=0
Returns a reference to the main window "Add Layer" menu.
virtual QMenu * firstRightStandardMenu()=0
Returns a reference to the right most standard menu, which is usually the last menu item before the "...
virtual void removeToolBarIcon(QAction *qAction)=0
Removes an action (icon only, no text) from the plugin toolbar.
virtual QToolBar * helpToolBar()=0
Returns a reference to the main window "Help" toolbar.
virtual void removeProjectImportAction(QAction *action)=0
Removes an action from the QGIS "Import project" menu.
virtual QFont defaultStyleSheetFont()=0
Returns a reference font for initial qApp (may not be same as QgisApp).
virtual QToolBar * databaseToolBar()=0
Returns a reference to the main window "Database" toolbar.
virtual QAction * actionSelectRectangle()=0
Returns the native select rectangle action.
virtual QAction * actionCreatePrintLayout()=0
Creates new print layout action.
virtual QAction * actionDeleteRing()=0
Returns the native Delete Ring action.
virtual void insertAddLayerAction(QAction *action)=0
Adds "add layer" action to layer menu.
virtual void unregisterOptionsWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Unregisters a previously registered tab in the options dialog.
virtual QToolBar * selectionToolBar()=0
Returns a reference to the main window "Selection" toolbar.
virtual void addToolBar(QToolBar *toolbar, Qt::ToolBarArea area=Qt::TopToolBarArea)=0
Adds a toolbar.
virtual QMenu * projectImportExportMenu()=0
Returns a reference to the main window "Import/Export" project menu.
virtual Q_DECL_DEPRECATED QAction * actionCircle2Points()
Returns the native add circle from 2 points action.
virtual QList< QgsLayoutDesignerInterface * > openLayoutDesigners()=0
Returns all currently open layout designers.
virtual void registerMapToolHandler(QgsAbstractMapToolHandler *handler)=0
Registers a new application map tool handler, which can be used to automatically setup all connection...
virtual void saveStyleSheetOptions(const QMap< QString, QVariant > &opts)=0
Saves changed default option keys/values to user settings.
virtual QAction * actionShowBookmarks()=0
Returns the native show bookmarks action.
virtual QMap< QString, QVariant > defaultStyleSheetOptions()=0
Returns changeable options built from settings and/or defaults.
virtual QAction * actionSaveMapAsImage()=0
Returns the native Save Map as Image action.
virtual void removeWindow(QAction *action)=0
Remove window from Window menu.
virtual int addDatabaseToolBarIcon(QAction *qAction)=0
Adds an action (icon only, no text) to the Database toolbar.
virtual bool addProject(const QString &project)=0
Adds (opens) a project.
virtual QAction * actionZoomActualSize()=0
Returns the native zoom resolution (100%) action.
virtual bool setActiveLayer(QgsMapLayer *layer)=0
Sets the active layer.
virtual QgsLayerTreeMapCanvasBridge * layerTreeCanvasBridge()=0
Returns a pointer to the layer tree canvas bridge.
virtual void unregisterCustomLayoutDropHandler(QgsLayoutCustomDropHandler *handler)=0
Unregisters a previously registered custom drop handler for layout windows.
virtual void removePluginMeshMenu(const QString &name, QAction *action)=0
Removes action from the Mesh menu.
virtual Q_DECL_DEPRECATED QAction * actionEllipseFoci()
Returns the native add ellipse from foci action.
virtual void addPluginToMeshMenu(const QString &name, QAction *action)=0
Adds an action to the Mesh menu.
virtual QAction * actionDeleteSelected()=0
Returns the native Delete Selected Features action.
virtual void removePluginVectorMenu(const QString &name, QAction *action)=0
Removes action from the Vector menu.
virtual QAction * actionSelect()=0
Returns the native select action.
virtual void removeDockWidget(QDockWidget *dockwidget)=0
Removes the specified dock widget from main window (without deleting it).
void layoutDesignerClosed()
Emitted after a layout designer window is closed.
virtual QAction * actionZoomIn()=0
Returns the native zoom in action.
virtual QAction * actionAddAfsLayer()=0
Returns the native Add ArcGIS REST Server action.
virtual void reloadConnections()=0
Triggered when connections have changed.
virtual QAction * actionAddFeature()=0
Returns the native Add Feature action.
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 void removeDatabaseToolBarIcon(QAction *qAction)=0
Removes an action (icon only, no text) from the Database toolbar.
virtual QList< QgsMapDecoration * > activeDecorations()=0
Returns a list of the active decorations.
virtual void pasteFromClipboard(QgsMapLayer *layer)=0
Paste features from the clipboard to a layer.
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenterPoint()
Returns the native add ellipse from center and a point action.
virtual QSize iconSize(bool dockedToolbar=false) const =0
Returns the toolbar icon size.
virtual void registerApplicationExitBlocker(QgsApplicationExitBlockerInterface *blocker)=0
Registers a new application exit blocker, which can be used to prevent the QGIS application from exit...
virtual void removePluginDatabaseMenu(const QString &name, QAction *action)=0
Removes action from the Database menu.
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 Q_DECL_DEPRECATED QAction * actionRegularPolygon2Points()
Returns the native add regular polygon from 2 points action.
virtual QAction * actionCustomProjection()=0
virtual QAction * actionSimplifyFeature()=0
Returns the native Simplify/Smooth Features action.
virtual void takeAppScreenShots(const QString &saveDirectory, const int categories=0)
Take screenshots for user documentation.
virtual QMenu * createProjectModelSubMenu(const QString &title)=0
Creates a new project model submenu in the "Projects" - "Models" submenu.
virtual bool registerMainWindowAction(QAction *action, const QString &defaultShortcut)=0
Registers an action to the shortcuts manager so its shortcut can be changed in GUI.
virtual void copySelectionToClipboard(QgsMapLayer *layer)=0
Copy selected features from a layer to the clipboard.
virtual QAction * actionAddPointCloudLayer()=0
Returns the native Add Point Cloud Layer action.
virtual void openMessageLog(const QString &tabName=QString())=0
Opens the message log dock widget, and optionally activates a specific tab by name.
virtual void removePluginWebMenu(const QString &name, QAction *action)=0
Removes action from the Web menu.
virtual QAction * addVectorToolBarWidget(QWidget *widget)=0
Adds a widget to the vector toolbar.
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
Registers a new custom drop handler.
void layoutDesignerOpened(QgsLayoutDesignerInterface *designer)
Emitted when a new layout designer has been opened.
virtual QAction * actionDeletePart()=0
Returns the native Delete Part action.
virtual QAction * actionSaveEdits()=0
virtual QAction * actionShowSelectedLayers()=0
virtual QAction * actionAllEdits()=0
virtual QMenu * pluginMenu()=0
Returns a reference to the main window "Plugin" menu.
virtual QgsAdvancedDigitizingDockWidget * cadDockWidget()=0
Returns a reference to the app's advanced digitizing dock widget.
virtual QAction * actionAddOgrLayer()=0
virtual QAction * actionLayerProperties()=0
virtual QAction * actionAddRasterLayer()=0
virtual QMenu * meshMenu()=0
Returns a reference to the main window "Mesh" menu.
virtual Q_DECL_DEPRECATED QAction * actionRectangleCenterPoint()
Returns the native add rectangle from center and a point action.
virtual QList< QgsMapLayer * > editableLayers(bool modified=false) const =0
Returns vector layers in edit mode.
virtual void unregisterApplicationExitBlocker(QgsApplicationExitBlockerInterface *blocker)=0
Unregisters a previously registered application exit blocker.
virtual QgsVectorLayerTools * vectorLayerTools()=0
Access the vector layer tools instance.
virtual bool removeCustomActionForLayerType(QAction *action)=0
Removes action for layers in the layer tree previously added with addCustomActionForLayerType().
virtual QAction * actionAddVectorTileLayer()=0
Returns the native Add Vector Tile Layer action.
virtual QToolBar * shapeDigitizeToolBar()=0
Returns a reference to the main window "Shape Digitizing" toolbar.
virtual void registerLocatorFilter(QgsLocatorFilter *filter)=0
Registers a locator filter for the app's locator bar.
virtual QAction * actionMeasure()=0
Returns the native measure action.
virtual QgsLayerTreeView * layerTreeView()=0
virtual int addVectorToolBarIcon(QAction *qAction)=0
Adds an action (icon only, no text) to the Vector toolbar.
virtual QAction * actionCheckQgisVersion()=0
QgisInterface()=default
virtual QAction * actionHideAllLayers()=0
virtual bool unregisterMainWindowAction(QAction *action)=0
Unregisters a previously registered action. (e.g. when plugin is going to be unloaded).
virtual QToolBar * webToolBar()=0
Returns a reference to the main window "Web" toolbar.
virtual QAction * actionSelectRadius()=0
Returns the native select radius action.
virtual QgsUserProfileManager * userProfileManager()=0
Returns a reference to the user profile manager.
virtual void openDataSourceManagerPage(const QString &pageName)=0
Opens a page in the main window "Data Source Manager" dialog.
virtual QToolBar * advancedDigitizeToolBar()=0
Returns a reference to the main window "Advanced Digitizing" toolbar.
virtual void registerCustomProjectOpenHandler(QgsCustomProjectOpenHandler *handler)=0
Registers a new custom project open handler.
virtual QWidget * mainWindow()=0
Returns a pointer to the main window (instance of QgisApp in case of QGIS).
virtual void removeProjectExportAction(QAction *action)=0
Removes an action from the the QGIS "Export project" menu.
virtual void addProjectExportAction(QAction *action)=0
Adds an action to the QGIS "Export project" menu.
virtual Q_DECL_DEPRECATED QAction * actionCircleCenterPoint()
Returns the native add circle from center action.
virtual QAction * actionSaveAllEdits()=0
virtual QAction * actionRemoveAllFromOverview()=0
virtual QToolBar * addToolBar(const QString &name)=0
Adds toolbar with specified name.
virtual QMenu * settingsMenu()=0
Returns a reference to the main window "Settings" menu.
virtual QAction * actionDraw()=0
Returns the native draw action.
virtual QAction * actionFeatureAction()=0
Returns the native run action feature action.
virtual void removeAddLayerAction(QAction *action)=0
Removes "add layer" action from layer menu.
virtual QToolBar * mapNavToolToolBar()=0
Returns a reference to the main window "Map Navigation" toolbar.
virtual void addTabifiedDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget, const QStringList &tabifyWith=QStringList(), bool raiseTab=false)=0
Adds 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 QAction * actionLayerSaveAs()=0
void newProjectCreated()
Emitted when starting an entirely new project.
virtual QAction * actionCancelEdits()=0
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 QAction * actionZoomFullExtent()=0
Returns the native zoom full extent action.
virtual void addPluginToMenu(const QString &name, QAction *action)=0
Adds an action to the plugins menu.
virtual QAction * actionCopyLayerStyle()=0
virtual void showOptionsDialog(QWidget *parent=nullptr, const QString &currentPage=QString())=0
Opens the options dialog.
virtual void addCustomActionForLayer(QAction *action, QgsMapLayer *layer)=0
Adds an action to context menu for a specific layer in the layer tree.
virtual QMenu * pluginHelpMenu()=0
Returns a reference to the main window "Plugin Help" sub-menu.
virtual QAction * addRasterToolBarWidget(QWidget *widget)=0
Adds a widget to the raster toolbar.
virtual QAction * addDatabaseToolBarWidget(QWidget *widget)=0
Adds a widget to the database toolbar.
virtual QMenu * rasterMenu()=0
Returns a reference to the main window "Raster" menu.
DocumentationBrowser
Documentation API browser.
Definition qgis.h:6686
@ DeveloperToolsPanel
Embedded webview in the DevTools panel.
Definition qgis.h:6687
LayerType
Types of layers that can be added to a map.
Definition qgis.h:206
DocumentationApi
Documentation API.
Definition qgis.h:6672
@ PyQgis
PyQgis API documentation.
Definition qgis.h:6673
SceneMode
The 3D scene mode used in 3D map views.
Definition qgis.h:4490
@ Local
Local scene based on a projected CRS.
Definition qgis.h:4491
Convenience wrapper to simplify the creation of a 3D window ready to be used with QGIS.
An abstract base class for map tool handlers, implementing application level UI logic.
A dockable widget used to handle the CAD tools on top of a selection of map tools.
An interface that may be implemented to allow plugins or scripts to temporarily block the QGIS applic...
An attribute table dialog for a vector layer.
A model for showing available data sources and other items in a structured tree.
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...
A dialog which embeds the browser panel and all the provider source select widgets.
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:60
Abstract base class for connections to a GPS device.
Abstract interface class for the QGIS GPS tools.
Layer tree group node serves as a container for layers and further groups.
Takes care of updates of layer sets for a QgsMapCanvas from a layer tree.
Extends QTreeView and provides additional functionality when working with a layer tree.
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:51
Abstract base class for filters which collect locator results.
Map canvas is a class for displaying all GIS data types on a canvas.
Interface for map decorations.
Factory class for creating custom map layer property pages.
Base class for all map layer types.
Definition qgsmaplayer.h:83
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.
A bar for displaying non-blocking messages to the user.
A factory class for creating custom options pages.
Abstract interface class for the QGIS plugin manager.
Represents a map layer supporting display of point clouds.
Represents a raster layer.
A proxy widget for QStatusBar.
Represents a map layer supporting display of tiled scene objects.
A manager for QGIS user profiles.
Used to handle basic editing operations on vector layers.
Represents a vector layer which manages a vector based dataset.
Implements a map layer that is dedicated to rendering of vector tiles.
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:7938
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:7937
#define SIP_DEPRECATED
Definition qgis_sip.h:113
#define SIP_EXTERNAL
Definition qgis_sip.h:123
#define SIP_TRANSFER
Definition qgis_sip.h:35
#define SIP_FACTORY
Definition qgis_sip.h:83
A structure to define the insertion point to the layer tree.