QGIS API Documentation  3.5.0-Master (591bb75)
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 class QAction;
22 class QMenu;
23 class QToolBar;
24 class QDockWidget;
25 class QMainWindow;
26 class QWidget;
27 
29 class QgsAttributeDialog;
32 class QgsFeature;
34 class QgsLayerTreeView;
35 class QgsLayout;
38 class QgsMapCanvas;
39 class QgsMapLayer;
41 class QgsMessageBar;
43 class QgsRasterLayer;
44 class QgsSnappingUtils;
45 class QgsVectorLayer;
48 class QgsLocatorFilter;
49 class QgsStatusBar;
50 class QgsMeshLayer;
51 class QgsBrowserModel;
52 
53 #include <QObject>
54 #include <QFont>
55 #include <QPair>
56 #include <map>
57 
58 #include "qgis.h"
59 #include "qgsmaplayer.h"
60 #include "qgis_gui.h"
61 
62 
77 class GUI_EXPORT QgisInterface : public QObject
78 {
79  Q_OBJECT
80 
81  public:
82 
84  QgisInterface() = default;
85 
86  virtual QgsPluginManagerInterface *pluginManagerInterface() = 0;
87 
88  virtual QgsLayerTreeView *layerTreeView() = 0;
89 
102  virtual void addCustomActionForLayerType( QAction *action, QString menu,
103  QgsMapLayer::LayerType type, bool allLayers ) = 0;
104 
111  virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0;
112 
117  virtual bool removeCustomActionForLayerType( QAction *action ) = 0;
118 
123  virtual QList< QgsMapCanvas * > mapCanvases() = 0;
124 
130  virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0;
131 
137  virtual void closeMapCanvas( const QString &name ) = 0;
138 
143  virtual QSize iconSize( bool dockedToolbar = false ) const = 0;
144 
149  virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
150 
152  virtual QgsMapLayer *activeLayer() = 0;
153 
155  virtual QgsMapCanvas *mapCanvas() = 0;
156 
162  virtual QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() = 0;
163 
165  virtual QWidget *mainWindow() = 0;
166 
168  virtual QgsMessageBar *messageBar() = 0;
169 
174  virtual QList<QgsLayoutDesignerInterface *> openLayoutDesigners() = 0;
175 
176 
178  virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
179 
181  virtual QFont defaultStyleSheetFont() = 0;
182 
187  virtual QgsAdvancedDigitizingDockWidget *cadDockWidget() = 0;
188 
189  /*
190  * Accessors for inserting items into menus and toolbars.
191  * An item can be inserted before any existing action.
192  */
193 
197  virtual QMenu *projectMenu() = 0;
198 
202  virtual QMenu *editMenu() = 0;
203 
207  virtual QMenu *viewMenu() = 0;
208 
212  virtual QMenu *layerMenu() = 0;
213 
217  virtual QMenu *newLayerMenu() = 0;
218 
223  virtual QMenu *addLayerMenu() = 0;
224 
228  virtual QMenu *settingsMenu() = 0;
229 
233  virtual QMenu *pluginMenu() = 0;
234 
238  virtual QMenu *rasterMenu() = 0;
239 
243  virtual QMenu *databaseMenu() = 0;
244 
248  virtual QMenu *vectorMenu() = 0;
249 
253  virtual QMenu *webMenu() = 0;
254 
262  virtual QMenu *firstRightStandardMenu() = 0;
263 
267  virtual QMenu *windowMenu() = 0;
268 
272  virtual QMenu *helpMenu() = 0;
273 
274  // ToolBars
275 
279  virtual QToolBar *fileToolBar() = 0;
280 
284  virtual QToolBar *layerToolBar() = 0;
285 
290  virtual QToolBar *dataSourceManagerToolBar() = 0;
291 
295  virtual QToolBar *mapNavToolToolBar() = 0;
296 
300  virtual QToolBar *digitizeToolBar() = 0;
301 
305  virtual QToolBar *advancedDigitizeToolBar() = 0;
306 
311  virtual QToolBar *shapeDigitizeToolBar() = 0;
312 
316  virtual QToolBar *attributesToolBar() = 0;
317 
321  virtual QToolBar *pluginToolBar() = 0;
322 
326  virtual QToolBar *helpToolBar() = 0;
327 
331  virtual QToolBar *rasterToolBar() = 0;
332 
336  virtual QToolBar *vectorToolBar() = 0;
337 
341  virtual QToolBar *databaseToolBar() = 0;
342 
346  virtual QToolBar *webToolBar() = 0;
347 
348  // Project menu actions
350  virtual QAction *actionNewProject() = 0;
352  virtual QAction *actionOpenProject() = 0;
354  virtual QAction *actionSaveProject() = 0;
356  virtual QAction *actionSaveProjectAs() = 0;
358  virtual QAction *actionSaveMapAsImage() = 0;
360  virtual QAction *actionProjectProperties() = 0;
361 
363  virtual QAction *actionCreatePrintLayout() = 0;
364 
366  virtual QAction *actionShowLayoutManager() = 0;
368  virtual QAction *actionExit() = 0;
369 
370  // Edit menu actions
371 
373  virtual QAction *actionCutFeatures() = 0;
375  virtual QAction *actionCopyFeatures() = 0;
377  virtual QAction *actionPasteFeatures() = 0;
379  virtual QAction *actionAddFeature() = 0;
381  virtual QAction *actionDeleteSelected() = 0;
383  virtual QAction *actionMoveFeature() = 0;
385  virtual QAction *actionSplitFeatures() = 0;
387  virtual QAction *actionSplitParts() = 0;
389  virtual QAction *actionAddRing() = 0;
391  virtual QAction *actionAddPart() = 0;
393  virtual QAction *actionSimplifyFeature() = 0;
395  virtual QAction *actionDeleteRing() = 0;
397  virtual QAction *actionDeletePart() = 0;
399  virtual QAction *actionVertexTool() = 0;
400 
401  // View menu actions
403  virtual QAction *actionPan() = 0;
405  virtual QAction *actionPanToSelected() = 0;
407  virtual QAction *actionZoomIn() = 0;
409  virtual QAction *actionZoomOut() = 0;
411  virtual QAction *actionSelect() = 0;
413  virtual QAction *actionSelectRectangle() = 0;
415  virtual QAction *actionSelectPolygon() = 0;
417  virtual QAction *actionSelectFreehand() = 0;
419  virtual QAction *actionSelectRadius() = 0;
421  virtual QAction *actionIdentify() = 0;
423  virtual QAction *actionFeatureAction() = 0;
425  virtual QAction *actionMeasure() = 0;
427  virtual QAction *actionMeasureArea() = 0;
429  virtual QAction *actionZoomFullExtent() = 0;
431  virtual QAction *actionZoomToLayer() = 0;
433  virtual QAction *actionZoomToSelected() = 0;
435  virtual QAction *actionZoomLast() = 0;
437  virtual QAction *actionZoomNext() = 0;
439  virtual QAction *actionZoomActualSize() = 0;
441  virtual QAction *actionMapTips() = 0;
443  virtual QAction *actionNewBookmark() = 0;
445  virtual QAction *actionShowBookmarks() = 0;
447  virtual QAction *actionDraw() = 0;
448 
449  // Layer menu actions
450  virtual QAction *actionNewVectorLayer() = 0;
451  virtual QAction *actionAddOgrLayer() = 0;
452  virtual QAction *actionAddRasterLayer() = 0;
453  virtual QAction *actionAddPgLayer() = 0;
454  virtual QAction *actionAddWmsLayer() = 0;
456  virtual QAction *actionAddAfsLayer() = 0;
458  virtual QAction *actionAddAmsLayer() = 0;
459  virtual QAction *actionCopyLayerStyle() = 0;
460  virtual QAction *actionPasteLayerStyle() = 0;
461  virtual QAction *actionOpenTable() = 0;
462  virtual QAction *actionOpenFieldCalculator() = 0;
463 
468  virtual QAction *actionOpenStatisticalSummary() = 0;
469 
470  virtual QAction *actionToggleEditing() = 0;
471  virtual QAction *actionSaveActiveLayerEdits() = 0;
472  virtual QAction *actionAllEdits() = 0;
473  virtual QAction *actionSaveEdits() = 0;
474  virtual QAction *actionSaveAllEdits() = 0;
475  virtual QAction *actionRollbackEdits() = 0;
476  virtual QAction *actionRollbackAllEdits() = 0;
477  virtual QAction *actionCancelEdits() = 0;
478  virtual QAction *actionCancelAllEdits() = 0;
479  virtual QAction *actionLayerSaveAs() = 0;
480  virtual QAction *actionDuplicateLayer() = 0;
481  virtual QAction *actionLayerProperties() = 0;
482  virtual QAction *actionAddToOverview() = 0;
483  virtual QAction *actionAddAllToOverview() = 0;
484  virtual QAction *actionRemoveAllFromOverview() = 0;
485  virtual QAction *actionHideAllLayers() = 0;
486  virtual QAction *actionShowAllLayers() = 0;
487  virtual QAction *actionHideSelectedLayers() = 0;
488 
493  virtual QAction *actionHideDeselectedLayers() = 0;
494  virtual QAction *actionShowSelectedLayers() = 0;
495 
496  // Plugin menu actions
497  virtual QAction *actionManagePlugins() = 0;
498  virtual QAction *actionPluginListSeparator() = 0;
499  virtual QAction *actionShowPythonDialog() = 0;
500 
501  // Settings menu actions
502  virtual QAction *actionToggleFullScreen() = 0;
503  virtual QAction *actionOptions() = 0;
504  virtual QAction *actionCustomProjection() = 0;
505 
506  // Help menu actions
507  virtual QAction *actionHelpContents() = 0;
508  virtual QAction *actionQgisHomePage() = 0;
509  virtual QAction *actionCheckQgisVersion() = 0;
510  virtual QAction *actionAbout() = 0;
511 
519  virtual QgsVectorLayerTools *vectorLayerTools() = 0;
520 
522  virtual int messageTimeout() = 0;
523 
530  virtual QgsStatusBar *statusBarIface() = 0;
531 
538  virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 ) {Q_UNUSED( saveDirectory ); Q_UNUSED( categories );}
539 
540  public slots: // TODO: do these functions really need to be slots?
541 
542  /* Exposed functions */
543 
547  virtual void zoomFull() = 0;
548 
552  virtual void zoomToPrevious() = 0;
553 
557  virtual void zoomToNext() = 0;
558 
562  virtual void zoomToActiveLayer() = 0;
563 
567  virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
568 
572  virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
573 
577  virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
578 
582  virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
583 
585  virtual bool addProject( const QString &project ) = 0;
587  virtual void newProject( bool promptToSaveFlag = false ) = 0;
588 
596  virtual void reloadConnections( ) = 0;
597 
602  virtual bool setActiveLayer( QgsMapLayer * ) = 0;
603 
608  virtual void copySelectionToClipboard( QgsMapLayer * ) = 0;
609 
614  virtual void pasteFromClipboard( QgsMapLayer * ) = 0;
615 
617  virtual int addToolBarIcon( QAction *qAction ) = 0;
618 
627  virtual QAction *addToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
628 
630  virtual void removeToolBarIcon( QAction *qAction ) = 0;
631 
640  virtual QAction *addRasterToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
641 
643  virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
644 
646  virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
647 
649  virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
650 
659  virtual QAction *addVectorToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
660 
662  virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
663 
665  virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
666 
675  virtual QAction *addDatabaseToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
676 
678  virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
679 
681  virtual int addWebToolBarIcon( QAction *qAction ) = 0;
682 
691  virtual QAction *addWebToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
692 
694  virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
695 
697  virtual QToolBar *addToolBar( const QString &name ) = 0 SIP_FACTORY;
698 
703  virtual void addToolBar( QToolBar *toolbar SIP_TRANSFER, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0;
704 
708  virtual void openMessageLog() = 0;
709 
711  virtual void addUserInputWidget( QWidget *widget ) = 0;
712 
717  virtual void showLayoutManager() = 0;
718 
725  virtual QgsLayoutDesignerInterface *openLayoutDesigner( QgsMasterLayoutInterface *layout ) = 0;
726 
732  virtual void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() ) = 0;
733 
738  virtual void buildStyleSheet( const QMap<QString, QVariant> &opts ) = 0;
739 
741  virtual void saveStyleSheetOptions( const QMap<QString, QVariant> &opts ) = 0;
742 
744  virtual void addPluginToMenu( const QString &name, QAction *action ) = 0;
745 
747  virtual void removePluginMenu( const QString &name, QAction *action ) = 0;
748 
750  virtual void insertAddLayerAction( QAction *action ) = 0;
751 
753  virtual void removeAddLayerAction( QAction *action ) = 0;
754 
756  virtual void addPluginToDatabaseMenu( const QString &name, QAction *action ) = 0;
757 
759  virtual void removePluginDatabaseMenu( const QString &name, QAction *action ) = 0;
760 
762  virtual void addPluginToRasterMenu( const QString &name, QAction *action ) = 0;
763 
765  virtual void removePluginRasterMenu( const QString &name, QAction *action ) = 0;
766 
768  virtual void addPluginToVectorMenu( const QString &name, QAction *action ) = 0;
769 
771  virtual void removePluginVectorMenu( const QString &name, QAction *action ) = 0;
772 
774  virtual void addPluginToWebMenu( const QString &name, QAction *action ) = 0;
775 
777  virtual void removePluginWebMenu( const QString &name, QAction *action ) = 0;
778 
784  virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget ) = 0;
785 
791  virtual void removeDockWidget( QDockWidget *dockwidget ) = 0;
792 
794  virtual void showLayerProperties( QgsMapLayer *l ) = 0;
795 
797  virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) = 0;
798 
802  virtual void addWindow( QAction *action ) = 0;
803 
807  virtual void removeWindow( QAction *action ) = 0;
808 
810  virtual bool registerMainWindowAction( QAction *action, const QString &defaultShortcut ) = 0;
811 
813  virtual bool unregisterMainWindowAction( QAction *action ) = 0;
814 
823  virtual void registerMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;
824 
831  virtual void unregisterMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;
832 
841  virtual void registerOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
842 
849  virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
850 
859  virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) = 0;
860 
867  virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) = 0;
868 
877  virtual void registerCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;
878 
885  virtual void unregisterCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;
886 
887  // TODO is this deprecated in favour of QgsContextHelp?
888 
898 #ifndef Q_MOC_RUN
899  Q_DECL_DEPRECATED
900 #endif
901  virtual void openURL( const QString &url, bool useQgisDocDirectory = true ) = 0 SIP_DEPRECATED;
902 
911  virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
912 
921  virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0;
922 
935  virtual void preloadForm( const QString &uifile ) = 0;
936 
945  virtual void registerLocatorFilter( QgsLocatorFilter *filter SIP_TRANSFER ) = 0;
946 
957  virtual void deregisterLocatorFilter( QgsLocatorFilter *filter ) = 0;
958 
966  virtual void invalidateLocatorResults() = 0;
967 
974  virtual bool askForDatumTransform( QgsCoordinateReferenceSystem sourceCrs, QgsCoordinateReferenceSystem destinationCrs ) = 0;
975 
981  virtual QgsBrowserModel *browserModel() = 0;
982 
983  signals:
984 
989  void currentLayerChanged( QgsMapLayer *layer );
990 
996  void currentThemeChanged( const QString &theme );
997 
1003  void layoutDesignerOpened( QgsLayoutDesignerInterface *designer );
1004 
1012  void layoutDesignerWillBeClosed( QgsLayoutDesignerInterface *designer );
1013 
1020  void layoutDesignerClosed();
1021 
1025  void initializationCompleted();
1026 
1033  void projectRead();
1034 
1043  void newProjectCreated();
1044 
1049  void layerSavedAs( QgsMapLayer *l, const QString &path );
1050 
1051 };
1053 
1054 #endif //#ifndef QGISINTERFACE_H
Methods in this class are used to handle basic operations on vector layers.
Base class for all map layer types.
Definition: qgsmaplayer.h:64
The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working ...
The QgsLayerTreeMapCanvasBridge class takes care of updates of layer set for QgsMapCanvas from a laye...
This class provides qgis with the ability to render raster datasets onto the mapcanvas.
Factory class for creating custom map layer property pages.
#define Q_NOWARN_DEPRECATED_PUSH
Definition: qgis.h:607
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:45
A common interface for layout designer dialogs and widgets.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS layouts...
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:74
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS...
LayerType
Types of layers that can be added to a map.
Definition: qgsmaplayer.h:106
#define SIP_TRANSFER
Definition: qgis_sip.h:36
Abstract base class for filters which collect locator results.
#define SIP_FACTORY
Definition: qgis_sip.h:69
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
#define SIP_DEPRECATED
Definition: qgis_sip.h:99
QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugin...
Definition: qgisinterface.h:77
#define Q_NOWARN_DEPRECATED_POP
Definition: qgis.h:608
This class represents a coordinate reference system (CRS).
A factory class for creating custom options pages.
This class has all the configuration of snapping and can return answers to snapping queries...
A model for showing available data sources and other items in a structured tree.
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Definition: qgsmeshlayer.h:89
Interface for master layout type objects, such as print layouts and reports.
The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of...
Represents a vector layer which manages a vector based data sets.
virtual void takeAppScreenShots(const QString &saveDirectory, const int categories=0)
Take screenshots for user documentation.
A proxy widget for QStatusBar.
Definition: qgsstatusbar.h:45