QGIS API Documentation 3.41.0-Master (af5edcb665c)
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 <QObject>
22#include <map>
23
24#include "qgis.h"
25#include "qgis_sip.h"
26#include "qgis_gui.h"
29
30class QAction;
31class QDialog;
32class QFont;
33class QMenu;
34class QToolBar;
35class QDockWidget;
36class QMainWindow;
37class QWidget;
38class QActionGroup;
39
45class QgsFeature;
49class QgsLayout;
52class QgsMapCanvas;
53class QgsMapLayer;
56class QgsMessageBar;
58class QgsRasterLayer;
59class QgsVectorLayer;
66class QgsStatusBar;
67class QgsMeshLayer;
76
77#ifdef SIP_RUN
78//%ModuleHeaderCode
79class Qgs3DMapCanvas;
80//%End
81#endif
82
97class GUI_EXPORT QgisInterface : public QObject
98{
99 Q_OBJECT
100
101 public:
102 QgisInterface() = default;
103
105
107
120 virtual void addCustomActionForLayerType( QAction *action, QString menu, Qgis::LayerType type, bool allLayers ) = 0;
121
128 virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0;
129
134 virtual bool removeCustomActionForLayerType( QAction *action ) = 0;
135
139 virtual QList<QgsMapCanvas *> mapCanvases() = 0;
140
145 virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0;
146
151 virtual void closeMapCanvas( const QString &name ) = 0;
152
157 virtual QList<Qgs3DMapCanvas *> mapCanvases3D() = 0;
158
164 virtual Qgs3DMapCanvas *createNewMapCanvas3D( const QString &name ) = 0;
165
171 virtual void closeMapCanvas3D( const QString &name ) = 0;
172
177 virtual QSize iconSize( bool dockedToolbar = false ) const = 0;
178
184 virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
185
187 virtual QgsMapLayer *activeLayer() = 0;
188
190 virtual QgsMapCanvas *mapCanvas() = 0;
191
196 virtual QList<QgsMapDecoration *> activeDecorations() = 0;
197
203
205 virtual QWidget *mainWindow() = 0;
206
208 virtual QgsMessageBar *messageBar() = 0;
209
213 virtual QList<QgsLayoutDesignerInterface *> openLayoutDesigners() = 0;
214
215
217 virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
218
220 virtual QFont defaultStyleSheetFont() = 0;
221
226
227 /*
228 * Accessors for inserting items into menus and toolbars.
229 * An item can be inserted before any existing action.
230 */
231
235 virtual QMenu *projectMenu() = 0;
236
244 virtual QMenu *projectImportExportMenu() = 0;
245
253 virtual void addProjectImportAction( QAction *action ) = 0;
254
262 virtual void removeProjectImportAction( QAction *action ) = 0;
263
271 virtual void addProjectExportAction( QAction *action ) = 0;
272
280 virtual void removeProjectExportAction( QAction *action ) = 0;
281
287 virtual QMenu *projectModelsMenu() = 0;
288
294 virtual QMenu *createProjectModelSubMenu( const QString &title ) = 0;
295
299 virtual QMenu *editMenu() = 0;
300
304 virtual QMenu *viewMenu() = 0;
305
309 virtual QMenu *layerMenu() = 0;
310
314 virtual QMenu *newLayerMenu() = 0;
315
319 virtual QMenu *addLayerMenu() = 0;
320
324 virtual QMenu *settingsMenu() = 0;
325
329 virtual QMenu *pluginMenu() = 0;
330
339 virtual QMenu *pluginHelpMenu() = 0;
340
344 virtual QMenu *rasterMenu() = 0;
345
349 virtual QMenu *databaseMenu() = 0;
350
354 virtual QMenu *vectorMenu() = 0;
355
359 virtual QMenu *webMenu() = 0;
360
366 virtual QMenu *meshMenu() = 0;
367
375 virtual QMenu *firstRightStandardMenu() = 0;
376
380 virtual QMenu *windowMenu() = 0;
381
385 virtual QMenu *helpMenu() = 0;
386
387 // ToolBars
388
392 virtual QToolBar *fileToolBar() = 0;
393
397 virtual QToolBar *layerToolBar() = 0;
398
403 virtual QToolBar *dataSourceManagerToolBar() = 0;
404
412 virtual void openDataSourceManagerPage( const QString &pageName ) = 0;
413
417 virtual QToolBar *mapNavToolToolBar() = 0;
418
422 virtual QToolBar *digitizeToolBar() = 0;
423
427 virtual QToolBar *advancedDigitizeToolBar() = 0;
428
432 virtual QToolBar *shapeDigitizeToolBar() = 0;
433
437 virtual QToolBar *attributesToolBar() = 0;
438
443 virtual QToolBar *selectionToolBar() = 0;
444
448 virtual QToolBar *pluginToolBar() = 0;
449
453 virtual QToolBar *helpToolBar() = 0;
454
458 virtual QToolBar *rasterToolBar() = 0;
459
463 virtual QToolBar *vectorToolBar() = 0;
464
468 virtual QToolBar *databaseToolBar() = 0;
469
473 virtual QToolBar *webToolBar() = 0;
474
475 // Project menu actions
477 virtual QAction *actionNewProject() = 0;
479 virtual QAction *actionOpenProject() = 0;
481 virtual QAction *actionSaveProject() = 0;
483 virtual QAction *actionSaveProjectAs() = 0;
485 virtual QAction *actionSaveMapAsImage() = 0;
487 virtual QAction *actionProjectProperties() = 0;
488
490 virtual QAction *actionCreatePrintLayout() = 0;
491
493 virtual QAction *actionShowLayoutManager() = 0;
495 virtual QAction *actionExit() = 0;
496
497 // Edit menu actions
498
500 virtual QAction *actionCutFeatures() = 0;
502 virtual QAction *actionCopyFeatures() = 0;
504 virtual QAction *actionPasteFeatures() = 0;
506 virtual QAction *actionAddFeature() = 0;
508 virtual QAction *actionDeleteSelected() = 0;
510 virtual QAction *actionMoveFeature() = 0;
512 virtual QAction *actionSplitFeatures() = 0;
514 virtual QAction *actionSplitParts() = 0;
516 virtual QAction *actionAddRing() = 0;
518 virtual QAction *actionAddPart() = 0;
520 virtual QAction *actionSimplifyFeature() = 0;
522 virtual QAction *actionDeleteRing() = 0;
524 virtual QAction *actionDeletePart() = 0;
525
530 virtual QAction *actionVertexTool() = 0;
531
537 virtual QAction *actionVertexToolActiveLayer() = 0;
538
547 virtual QActionGroup *mapToolActionGroup() = 0;
548
549 // View menu actions
551 virtual QAction *actionPan() = 0;
553 virtual QAction *actionPanToSelected() = 0;
555 virtual QAction *actionZoomIn() = 0;
557 virtual QAction *actionZoomOut() = 0;
559 virtual QAction *actionSelect() = 0;
561 virtual QAction *actionSelectRectangle() = 0;
563 virtual QAction *actionSelectPolygon() = 0;
565 virtual QAction *actionSelectFreehand() = 0;
567 virtual QAction *actionSelectRadius() = 0;
569 virtual QAction *actionIdentify() = 0;
571 virtual QAction *actionFeatureAction() = 0;
573 virtual QAction *actionMeasure() = 0;
575 virtual QAction *actionMeasureArea() = 0;
577 virtual QAction *actionZoomFullExtent() = 0;
578
584 Q_DECL_DEPRECATED virtual QAction *actionZoomToLayer() = 0 SIP_DEPRECATED;
585
590 virtual QAction *actionZoomToLayers() = 0;
591
593 virtual QAction *actionZoomToSelected() = 0;
595 virtual QAction *actionZoomLast() = 0;
597 virtual QAction *actionZoomNext() = 0;
599 virtual QAction *actionZoomActualSize() = 0;
601 virtual QAction *actionMapTips() = 0;
603 virtual QAction *actionNewBookmark() = 0;
605 virtual QAction *actionShowBookmarks() = 0;
607 virtual QAction *actionDraw() = 0;
608
609 // Layer menu actions
610 virtual QAction *actionNewVectorLayer() = 0;
611 virtual QAction *actionAddOgrLayer() = 0;
612 virtual QAction *actionAddRasterLayer() = 0;
613 virtual QAction *actionAddPgLayer() = 0;
614 virtual QAction *actionAddWmsLayer() = 0;
615
620 virtual QAction *actionAddXyzLayer() = 0;
621
626 virtual QAction *actionAddVectorTileLayer() = 0;
627
632 virtual QAction *actionAddPointCloudLayer() = 0;
633
635 virtual QAction *actionAddAfsLayer() = 0;
636
638 virtual QAction *actionAddAmsLayer() = 0;
639
640 virtual QAction *actionCopyLayerStyle() = 0;
641 virtual QAction *actionPasteLayerStyle() = 0;
642 virtual QAction *actionOpenTable() = 0;
643 virtual QAction *actionOpenFieldCalculator() = 0;
644
648 virtual QAction *actionOpenStatisticalSummary() = 0;
649
650 virtual QAction *actionToggleEditing() = 0;
651 virtual QAction *actionSaveActiveLayerEdits() = 0;
652 virtual QAction *actionAllEdits() = 0;
653 virtual QAction *actionSaveEdits() = 0;
654 virtual QAction *actionSaveAllEdits() = 0;
655 virtual QAction *actionRollbackEdits() = 0;
656 virtual QAction *actionRollbackAllEdits() = 0;
657 virtual QAction *actionCancelEdits() = 0;
658 virtual QAction *actionCancelAllEdits() = 0;
659 virtual QAction *actionLayerSaveAs() = 0;
660 virtual QAction *actionDuplicateLayer() = 0;
661 virtual QAction *actionLayerProperties() = 0;
662 virtual QAction *actionAddToOverview() = 0;
663 virtual QAction *actionAddAllToOverview() = 0;
664 virtual QAction *actionRemoveAllFromOverview() = 0;
665 virtual QAction *actionHideAllLayers() = 0;
666 virtual QAction *actionShowAllLayers() = 0;
667 virtual QAction *actionHideSelectedLayers() = 0;
668
673 virtual QAction *actionToggleSelectedLayers() = 0;
674
680
684 virtual QAction *actionHideDeselectedLayers() = 0;
685 virtual QAction *actionShowSelectedLayers() = 0;
686
687 // Plugin menu actions
688 virtual QAction *actionManagePlugins() = 0;
689 virtual QAction *actionPluginListSeparator() = 0;
690 virtual QAction *actionShowPythonDialog() = 0;
691
692 // Settings menu actions
693 virtual QAction *actionToggleFullScreen() = 0;
694 virtual QAction *actionOptions() = 0;
695 virtual QAction *actionCustomProjection() = 0;
696
697 // Help menu actions
698 virtual QAction *actionHelpContents() = 0;
699 virtual QAction *actionQgisHomePage() = 0;
700 virtual QAction *actionCheckQgisVersion() = 0;
701 virtual QAction *actionAbout() = 0;
702
703 // Shape digitize actions
704
709 Q_DECL_DEPRECATED virtual QAction *actionCircle2Points() SIP_DEPRECATED { return actionAddFeature(); }
710
715 Q_DECL_DEPRECATED virtual QAction *actionCircle3Points() SIP_DEPRECATED { return actionAddFeature(); }
716
721 Q_DECL_DEPRECATED virtual QAction *actionCircle3Tangents() SIP_DEPRECATED { return actionAddFeature(); }
722
727 Q_DECL_DEPRECATED virtual QAction *actionCircle2TangentsPoint() SIP_DEPRECATED { return actionAddFeature(); }
728
733 Q_DECL_DEPRECATED virtual QAction *actionCircleCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
734
739 Q_DECL_DEPRECATED virtual QAction *actionEllipseCenter2Points() SIP_DEPRECATED { return actionAddFeature(); }
740
745 Q_DECL_DEPRECATED virtual QAction *actionEllipseCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
746
751 Q_DECL_DEPRECATED virtual QAction *actionEllipseExtent() SIP_DEPRECATED { return actionAddFeature(); }
752
757 Q_DECL_DEPRECATED virtual QAction *actionEllipseFoci() SIP_DEPRECATED { return actionAddFeature(); }
758
763 Q_DECL_DEPRECATED virtual QAction *actionRectangleCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
764
769 Q_DECL_DEPRECATED virtual QAction *actionRectangleExtent() SIP_DEPRECATED { return actionAddFeature(); }
770
775 Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsDistance() SIP_DEPRECATED { return actionAddFeature(); }
776
781 Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsProjected() SIP_DEPRECATED { return actionAddFeature(); }
782
787 Q_DECL_DEPRECATED virtual QAction *actionRegularPolygon2Points() SIP_DEPRECATED { return actionAddFeature(); }
788
793 Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterPoint() SIP_DEPRECATED { return actionAddFeature(); }
794
799 Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterCorner() SIP_DEPRECATED { return actionAddFeature(); }
800
809
811 virtual int messageTimeout() = 0;
812
819
827 virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 )
828 {
829 Q_UNUSED( saveDirectory )
830 Q_UNUSED( categories );
831 }
832
839
845
846 public slots: // TODO: do these functions really need to be slots?
847
848 /* Exposed functions */
849
853 virtual void zoomFull() = 0;
854
858 virtual void zoomToPrevious() = 0;
859
863 virtual void zoomToNext() = 0;
864
868 virtual void zoomToActiveLayer() = 0;
869
876 virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
877
884 virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
885
891 virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
892
898 virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
899
907 virtual QgsVectorTileLayer *addVectorTileLayer( const QString &url, const QString &baseName ) = 0;
908
916 virtual QgsPointCloudLayer *addPointCloudLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
917
925 virtual QgsTiledSceneLayer *addTiledSceneLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
926
928 virtual bool addProject( const QString &project ) = 0;
929
940 virtual bool newProject( bool promptToSaveFlag = false ) = 0;
941
948 virtual void reloadConnections() = 0;
949
954 virtual bool setActiveLayer( QgsMapLayer * ) = 0;
955
960
964 virtual void pasteFromClipboard( QgsMapLayer * ) = 0;
965
967 virtual int addToolBarIcon( QAction *qAction ) = 0;
968
977 virtual QAction *addToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
978
980 virtual void removeToolBarIcon( QAction *qAction ) = 0;
981
990 virtual QAction *addRasterToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
991
993 virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
994
996 virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
997
999 virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
1000
1009 virtual QAction *addVectorToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1010
1012 virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
1013
1015 virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
1016
1025 virtual QAction *addDatabaseToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1026
1028 virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
1029
1031 virtual int addWebToolBarIcon( QAction *qAction ) = 0;
1032
1041 virtual QAction *addWebToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
1042
1044 virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
1045
1047 virtual QToolBar *addToolBar( const QString &name ) = 0 SIP_FACTORY;
1048
1052 virtual void addToolBar( QToolBar *toolbar SIP_TRANSFER, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0;
1053
1057 virtual void openMessageLog() = 0;
1058
1060 virtual void addUserInputWidget( QWidget *widget ) = 0;
1061
1065 virtual void showLayoutManager() = 0;
1066
1073
1078 virtual void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() ) = 0;
1079
1085 virtual void showProjectPropertiesDialog( const QString &currentPage = QString() ) = 0;
1086
1091 virtual void buildStyleSheet( const QMap<QString, QVariant> &opts ) = 0;
1092
1094 virtual void saveStyleSheetOptions( const QMap<QString, QVariant> &opts ) = 0;
1095
1097 virtual void addPluginToMenu( const QString &name, QAction *action ) = 0;
1098
1100 virtual void removePluginMenu( const QString &name, QAction *action ) = 0;
1101
1103 virtual void insertAddLayerAction( QAction *action ) = 0;
1104
1106 virtual void removeAddLayerAction( QAction *action ) = 0;
1107
1109 virtual void addPluginToDatabaseMenu( const QString &name, QAction *action ) = 0;
1110
1112 virtual void removePluginDatabaseMenu( const QString &name, QAction *action ) = 0;
1113
1115 virtual void addPluginToRasterMenu( const QString &name, QAction *action ) = 0;
1116
1118 virtual void removePluginRasterMenu( const QString &name, QAction *action ) = 0;
1119
1121 virtual void addPluginToVectorMenu( const QString &name, QAction *action ) = 0;
1122
1124 virtual void removePluginVectorMenu( const QString &name, QAction *action ) = 0;
1125
1127 virtual void addPluginToWebMenu( const QString &name, QAction *action ) = 0;
1128
1130 virtual void removePluginWebMenu( const QString &name, QAction *action ) = 0;
1131
1137 virtual void addPluginToMeshMenu( const QString &name, QAction *action ) = 0;
1138
1144 virtual void removePluginMeshMenu( const QString &name, QAction *action ) = 0;
1145
1152 virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget ) = 0;
1153
1168 virtual void addTabifiedDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget, const QStringList &tabifyWith = QStringList(), bool raiseTab = false ) = 0;
1169
1175 virtual void removeDockWidget( QDockWidget *dockwidget ) = 0;
1176
1210 virtual void showLayerProperties( QgsMapLayer *l, const QString &page = QString() ) = 0;
1211
1213 virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) = 0;
1214
1219 virtual void addWindow( QAction *action ) = 0;
1220
1225 virtual void removeWindow( QAction *action ) = 0;
1226
1228 virtual bool registerMainWindowAction( QAction *action, const QString &defaultShortcut ) = 0;
1229
1231 virtual bool unregisterMainWindowAction( QAction *action ) = 0;
1232
1241
1248
1257
1264
1274
1282
1291
1298
1307 virtual void showApiDocumentation( Qgis::DocumentationApi api = Qgis::DocumentationApi::PyQgis, Qgis::DocumentationBrowser browser = Qgis::DocumentationBrowser::DeveloperToolsPanel, const QString &object = QString(), const QString &module = QString() ) = 0;
1308
1320
1327
1341
1348
1357
1364
1374
1382
1391
1398
1399 // TODO is this deprecated in favour of QgsContextHelp?
1400
1410#ifndef Q_MOC_RUN
1411 Q_DECL_DEPRECATED
1412#endif
1413 virtual void openURL( const QString &url, bool useQgisDocDirectory = true ) = 0 SIP_DEPRECATED;
1414
1423 virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
1424
1434
1447 virtual void preloadForm( const QString &uifile ) = 0;
1448
1455 virtual void locatorSearch( const QString &searchText ) = 0;
1456
1465
1475 virtual void deregisterLocatorFilter( QgsLocatorFilter *filter ) = 0;
1476
1484 virtual void invalidateLocatorResults() = 0;
1485
1492
1499
1508 virtual void setGpsPanelConnection( QgsGpsConnection *connection SIP_TRANSFER ) = 0;
1509
1524 virtual void blockActiveLayerChanges( bool blocked ) = 0;
1525
1526 signals:
1527
1533
1538 void currentThemeChanged( const QString &theme );
1539
1545
1553
1560
1565
1573
1583
1587 void layerSavedAs( QgsMapLayer *l, const QString &path );
1588};
1590
1591#endif //#ifndef QGISINTERFACE_H
QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugin...
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
Unregister 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
Add 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. Call trigger() on it to open the new bookmark dialog.
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. Call trigger() on it to set the default select polygon map ...
virtual void removePluginMenu(const QString &name, QAction *action)=0
Remove action from the plugins menu.
virtual void addPluginToWebMenu(const QString &name, QAction *action)=0
Add action to the Web menu.
virtual QAction * actionToggleFullScreen()=0
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 * 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
Add 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. Call trigger() on it to set the default zoom out map tool.
virtual int addWebToolBarIcon(QAction *qAction)=0
Add an icon 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. Call trigger() on it to set the default identify map tool.
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. Call trigger() on it to set the default pan map tool.
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 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 void pasteFromClipboard(QgsMapLayer *)=0
Paste features from clipboard to the layer.
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
Remove an action (icon) 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
Register 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
Unregister 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. Call trigger() on it to set the default measure area map tool...
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. Call trigger() on it to toggle map tips.
virtual QAction * actionSelectFreehand()=0
Returns the native select freehand action. Call trigger() on it to set the default select freehand ma...
virtual QAction * actionSaveProjectAs()=0
Returns the native Save Project As action.
virtual QAction * actionHideSelectedLayers()=0
virtual void addWindow(QAction *action)=0
Add 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
Add 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
Add 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
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 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 QAction * actionSaveActiveLayerEdits()=0
virtual QMenu * viewMenu()=0
Returns a reference to the main window "View" menu.
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 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. Call trigger() on it to zoom to the current selection.
virtual void registerCustomLayoutDropHandler(QgsLayoutCustomDropHandler *handler)=0
Register 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. Call trigger() on it to zoom to next.
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
Register a new tab in the project properties dialog.
virtual QMenu * vectorMenu()=0
Returns a reference to the main window "Vector" menu.
virtual QAction * actionZoomLast()=0
Returns the native zoom last action. Call trigger() on it to zoom to last.
virtual QAction * actionZoomToLayers()=0
Returns the native zoom to layers action.
virtual QAction * actionShowLayoutManager()=0
Show 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
Create 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
Add an icon 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
Register a new tool in the development/debugging tools dock.
virtual QAction * actionPanToSelected()=0
Returns the native pan to selected action. Call trigger() on it to pan the map canvas to the selectio...
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 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
Register a new tab in the options dialog.
virtual void removePluginRasterMenu(const QString &name, QAction *action)=0
Remove 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
Unregister 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 void copySelectionToClipboard(QgsMapLayer *)=0
Copy selected features from the layer to clipboard.
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
Unregister 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
Remove an action (icon) from the plugin toolbar.
virtual QToolBar * helpToolBar()=0
Returns a reference to the main window "Help" toolbar.
virtual void removeProjectImportAction(QAction *action)=0
Adds an action to 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. Call trigger() on it to set the default select rectangle ...
virtual QAction * actionCreatePrintLayout()=0
Create new print layout action.
virtual QAction * actionDeleteRing()=0
Returns the native Delete Ring 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 QToolBar * selectionToolBar()=0
Returns a reference to the main window "Selection" toolbar.
virtual void addToolBar(QToolBar *toolbar, Qt::ToolBarArea area=Qt::TopToolBarArea)=0
Add 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
Register a new application map tool handler, which can be used to automatically setup all connections...
virtual void saveStyleSheetOptions(const QMap< QString, QVariant > &opts)=0
Save changed default option keys/values to user settings.
virtual QAction * actionShowBookmarks()=0
Returns the native show bookmarks action. Call trigger() on it to open the bookmarks dialog.
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
Add an icon 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. Call trigger() on it to zoom to actual size.
virtual QgsLayerTreeMapCanvasBridge * layerTreeCanvasBridge()=0
Returns a pointer to the layer tree canvas bridge.
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 * actionEllipseFoci()
Returns the native add ellipse from foci action.
virtual void addPluginToMeshMenu(const QString &name, QAction *action)=0
Add 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
Remove action from the Vector menu.
virtual QAction * actionSelect()=0
Returns the native select action. Call trigger() on it to set the default select map tool.
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. Call trigger() on it to set the default zoom in map tool.
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
Remove an action (icon) from the Database toolbar.
virtual QList< QgsMapDecoration * > activeDecorations()=0
Returns a list of the active decorations.
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
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 bool setActiveLayer(QgsMapLayer *)=0
Set the active layer (layer gets selected in the legend) returns true if the layer exists,...
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 Qgs3DMapCanvas * createNewMapCanvas3D(const QString &name)=0
Create a new 3D map canvas with the specified unique name.
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
Register action to the shortcuts manager so its shortcut can be changed in GUI.
virtual QAction * actionAddPointCloudLayer()=0
Returns the native Add Point Cloud Layer action.
virtual void removePluginWebMenu(const QString &name, QAction *action)=0
Remove action from the Web menu.
virtual QAction * addVectorToolBarWidget(QWidget *widget)=0
Add 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
Register 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
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
Unregister a previously registered application exit blocker.
virtual QgsVectorLayerTools * vectorLayerTools()=0
Access the vector layer tools instance.
virtual bool removeCustomActionForLayerType(QAction *action)=0
Remove 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 void openMessageLog()=0
Opens the message log dock widget.
virtual QAction * actionMeasure()=0
Returns the native measure action. Call trigger() on it to set the default measure map tool.
virtual QgsLayerTreeView * layerTreeView()=0
virtual int addVectorToolBarIcon(QAction *qAction)=0
Add an icon to the Vector toolbar.
virtual QAction * actionCheckQgisVersion()=0
virtual void setGpsPanelConnection(QgsGpsConnection *connection)=0
Sets a GPS connection to use within the GPS Panel widget.
QgisInterface()=default
virtual QAction * actionHideAllLayers()=0
virtual bool unregisterMainWindowAction(QAction *action)=0
Unregister 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. Call trigger() on it to set the default select radius map to...
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
Register 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
Adds an action to 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
Add 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. Call trigger() on it to set the default run feature act...
virtual void removeAddLayerAction(QAction *action)=0
Remove "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
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 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. Call trigger() on it to zoom to the full extent.
virtual void addPluginToMenu(const QString &name, QAction *action)=0
Add 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
Add 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
Add a widget to the raster toolbar.
virtual QAction * addDatabaseToolBarWidget(QWidget *widget)=0
Add 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:5673
@ DeveloperToolsPanel
Embedded webview in the DevTools panel.
LayerType
Types of layers that can be added to a map.
Definition qgis.h:169
DocumentationApi
Documentation API.
Definition qgis.h:5659
@ PyQgis
PyQgis API documentation.
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:58
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.
Interface for map decorations.
Factory class for creating custom map layer property pages.
Base class for all map layer types.
Definition qgsmaplayer.h:76
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.
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.
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:6643
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:6642
#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.