QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
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"
27 #include "qgscoordinatereferencesystem.h"
28 #include "qgslayertreeregistrybridge.h"
29 
30 class QAction;
31 class QDialog;
32 class QFont;
33 class QMenu;
34 class QToolBar;
35 class QDockWidget;
36 class QMainWindow;
37 class QWidget;
38 class QActionGroup;
39 
40 class QgsAdvancedDigitizingDockWidget;
41 class QgsAttributeDialog;
42 class QgsCustomDropHandler;
43 class QgsCustomProjectOpenHandler;
44 class QgsLayoutCustomDropHandler;
45 class QgsFeature;
46 class QgsLayerTreeMapCanvasBridge;
47 class QgsLayerTreeView;
48 class QgsLayerTreeGroup;
49 class QgsLayout;
50 class QgsMasterLayoutInterface;
51 class QgsLayoutDesignerInterface;
52 class QgsMapCanvas;
53 class QgsMapLayer;
54 enum class QgsMapLayerType;
55 class QgsMapLayerConfigWidgetFactory;
56 class QgsMapDecoration;
57 class QgsMessageBar;
58 class QgsPluginManagerInterface;
59 class QgsRasterLayer;
60 class QgsVectorLayer;
61 class QgsVectorLayerTools;
62 class QgsVectorTileLayer;
63 class QgsPointCloudLayer;
64 class QgsOptionsWidgetFactory;
65 class QgsLocatorFilter;
66 class QgsStatusBar;
67 class QgsMeshLayer;
68 class QgsBrowserGuiModel;
69 class QgsDevToolWidgetFactory;
70 class QgsGpsConnection;
71 class QgsApplicationExitBlockerInterface;
72 class QgsAbstractMapToolHandler;
73 
87 Q_NOWARN_DEPRECATED_PUSH
88 class GUI_EXPORT QgisInterface : public QObject
89 {
90  Q_OBJECT
91 
92  public:
93 
95  QgisInterface() = default;
96 
97  virtual QgsPluginManagerInterface *pluginManagerInterface() = 0;
98 
99  virtual QgsLayerTreeView *layerTreeView() = 0;
100 
113  virtual void addCustomActionForLayerType( QAction *action, QString menu,
114  QgsMapLayerType type, bool allLayers ) = 0;
115 
122  virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0;
123 
128  virtual bool removeCustomActionForLayerType( QAction *action ) = 0;
129 
134  virtual QList< QgsMapCanvas * > mapCanvases() = 0;
135 
141  virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0;
142 
148  virtual void closeMapCanvas( const QString &name ) = 0;
149 
154  virtual QSize iconSize( bool dockedToolbar = false ) const = 0;
155 
161  virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
162 
164  virtual QgsMapLayer *activeLayer() = 0;
165 
167  virtual QgsMapCanvas *mapCanvas() = 0;
168 
173  virtual QList<QgsMapDecoration *> activeDecorations() = 0;
174 
180  virtual QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() = 0;
181 
183  virtual QWidget *mainWindow() = 0;
184 
186  virtual QgsMessageBar *messageBar() = 0;
187 
192  virtual QList<QgsLayoutDesignerInterface *> openLayoutDesigners() = 0;
193 
194 
196  virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
197 
199  virtual QFont defaultStyleSheetFont() = 0;
200 
205  virtual QgsAdvancedDigitizingDockWidget *cadDockWidget() = 0;
206 
207  /*
208  * Accessors for inserting items into menus and toolbars.
209  * An item can be inserted before any existing action.
210  */
211 
215  virtual QMenu *projectMenu() = 0;
216 
220  virtual QMenu *editMenu() = 0;
221 
225  virtual QMenu *viewMenu() = 0;
226 
230  virtual QMenu *layerMenu() = 0;
231 
235  virtual QMenu *newLayerMenu() = 0;
236 
241  virtual QMenu *addLayerMenu() = 0;
242 
246  virtual QMenu *settingsMenu() = 0;
247 
251  virtual QMenu *pluginMenu() = 0;
252 
261  virtual QMenu *pluginHelpMenu() = 0;
262 
266  virtual QMenu *rasterMenu() = 0;
267 
271  virtual QMenu *databaseMenu() = 0;
272 
276  virtual QMenu *vectorMenu() = 0;
277 
281  virtual QMenu *webMenu() = 0;
282 
290  virtual QMenu *firstRightStandardMenu() = 0;
291 
295  virtual QMenu *windowMenu() = 0;
296 
300  virtual QMenu *helpMenu() = 0;
301 
302  // ToolBars
303 
307  virtual QToolBar *fileToolBar() = 0;
308 
312  virtual QToolBar *layerToolBar() = 0;
313 
318  virtual QToolBar *dataSourceManagerToolBar() = 0;
319 
323  virtual QToolBar *mapNavToolToolBar() = 0;
324 
328  virtual QToolBar *digitizeToolBar() = 0;
329 
333  virtual QToolBar *advancedDigitizeToolBar() = 0;
334 
339  virtual QToolBar *shapeDigitizeToolBar() = 0;
340 
344  virtual QToolBar *attributesToolBar() = 0;
345 
350  virtual QToolBar *selectionToolBar() = 0;
351 
355  virtual QToolBar *pluginToolBar() = 0;
356 
360  virtual QToolBar *helpToolBar() = 0;
361 
365  virtual QToolBar *rasterToolBar() = 0;
366 
370  virtual QToolBar *vectorToolBar() = 0;
371 
375  virtual QToolBar *databaseToolBar() = 0;
376 
380  virtual QToolBar *webToolBar() = 0;
381 
382  // Project menu actions
384  virtual QAction *actionNewProject() = 0;
386  virtual QAction *actionOpenProject() = 0;
388  virtual QAction *actionSaveProject() = 0;
390  virtual QAction *actionSaveProjectAs() = 0;
392  virtual QAction *actionSaveMapAsImage() = 0;
394  virtual QAction *actionProjectProperties() = 0;
395 
397  virtual QAction *actionCreatePrintLayout() = 0;
398 
400  virtual QAction *actionShowLayoutManager() = 0;
402  virtual QAction *actionExit() = 0;
403 
404  // Edit menu actions
405 
407  virtual QAction *actionCutFeatures() = 0;
409  virtual QAction *actionCopyFeatures() = 0;
411  virtual QAction *actionPasteFeatures() = 0;
413  virtual QAction *actionAddFeature() = 0;
415  virtual QAction *actionDeleteSelected() = 0;
417  virtual QAction *actionMoveFeature() = 0;
419  virtual QAction *actionSplitFeatures() = 0;
421  virtual QAction *actionSplitParts() = 0;
423  virtual QAction *actionAddRing() = 0;
425  virtual QAction *actionAddPart() = 0;
427  virtual QAction *actionSimplifyFeature() = 0;
429  virtual QAction *actionDeleteRing() = 0;
431  virtual QAction *actionDeletePart() = 0;
432 
437  virtual QAction *actionVertexTool() = 0;
438 
444  virtual QAction *actionVertexToolActiveLayer() = 0;
445 
454  virtual QActionGroup *mapToolActionGroup() = 0;
455 
456  // View menu actions
458  virtual QAction *actionPan() = 0;
460  virtual QAction *actionPanToSelected() = 0;
462  virtual QAction *actionZoomIn() = 0;
464  virtual QAction *actionZoomOut() = 0;
466  virtual QAction *actionSelect() = 0;
468  virtual QAction *actionSelectRectangle() = 0;
470  virtual QAction *actionSelectPolygon() = 0;
472  virtual QAction *actionSelectFreehand() = 0;
474  virtual QAction *actionSelectRadius() = 0;
476  virtual QAction *actionIdentify() = 0;
478  virtual QAction *actionFeatureAction() = 0;
480  virtual QAction *actionMeasure() = 0;
482  virtual QAction *actionMeasureArea() = 0;
484  virtual QAction *actionZoomFullExtent() = 0;
485 
491  Q_DECL_DEPRECATED virtual QAction *actionZoomToLayer() = 0 SIP_DEPRECATED;
492 
497  virtual QAction *actionZoomToLayers() = 0;
498 
500  virtual QAction *actionZoomToSelected() = 0;
502  virtual QAction *actionZoomLast() = 0;
504  virtual QAction *actionZoomNext() = 0;
506  virtual QAction *actionZoomActualSize() = 0;
508  virtual QAction *actionMapTips() = 0;
510  virtual QAction *actionNewBookmark() = 0;
512  virtual QAction *actionShowBookmarks() = 0;
514  virtual QAction *actionDraw() = 0;
515 
516  // Layer menu actions
517  virtual QAction *actionNewVectorLayer() = 0;
518  virtual QAction *actionAddOgrLayer() = 0;
519  virtual QAction *actionAddRasterLayer() = 0;
520  virtual QAction *actionAddPgLayer() = 0;
521  virtual QAction *actionAddWmsLayer() = 0;
522 
527  virtual QAction *actionAddXyzLayer() = 0;
528 
533  virtual QAction *actionAddVectorTileLayer() = 0;
534 
539  virtual QAction *actionAddPointCloudLayer() = 0;
540 
542  virtual QAction *actionAddAfsLayer() = 0;
543 
545  virtual QAction *actionAddAmsLayer() = 0;
546 
547  virtual QAction *actionCopyLayerStyle() = 0;
548  virtual QAction *actionPasteLayerStyle() = 0;
549  virtual QAction *actionOpenTable() = 0;
550  virtual QAction *actionOpenFieldCalculator() = 0;
551 
556  virtual QAction *actionOpenStatisticalSummary() = 0;
557 
558  virtual QAction *actionToggleEditing() = 0;
559  virtual QAction *actionSaveActiveLayerEdits() = 0;
560  virtual QAction *actionAllEdits() = 0;
561  virtual QAction *actionSaveEdits() = 0;
562  virtual QAction *actionSaveAllEdits() = 0;
563  virtual QAction *actionRollbackEdits() = 0;
564  virtual QAction *actionRollbackAllEdits() = 0;
565  virtual QAction *actionCancelEdits() = 0;
566  virtual QAction *actionCancelAllEdits() = 0;
567  virtual QAction *actionLayerSaveAs() = 0;
568  virtual QAction *actionDuplicateLayer() = 0;
569  virtual QAction *actionLayerProperties() = 0;
570  virtual QAction *actionAddToOverview() = 0;
571  virtual QAction *actionAddAllToOverview() = 0;
572  virtual QAction *actionRemoveAllFromOverview() = 0;
573  virtual QAction *actionHideAllLayers() = 0;
574  virtual QAction *actionShowAllLayers() = 0;
575  virtual QAction *actionHideSelectedLayers() = 0;
576 
581  virtual QAction *actionToggleSelectedLayers() = 0;
582 
587  virtual QAction *actionToggleSelectedLayersIndependently() = 0;
588 
593  virtual QAction *actionHideDeselectedLayers() = 0;
594  virtual QAction *actionShowSelectedLayers() = 0;
595 
596  // Plugin menu actions
597  virtual QAction *actionManagePlugins() = 0;
598  virtual QAction *actionPluginListSeparator() = 0;
599  virtual QAction *actionShowPythonDialog() = 0;
600 
601  // Settings menu actions
602  virtual QAction *actionToggleFullScreen() = 0;
603  virtual QAction *actionOptions() = 0;
604  virtual QAction *actionCustomProjection() = 0;
605 
606  // Help menu actions
607  virtual QAction *actionHelpContents() = 0;
608  virtual QAction *actionQgisHomePage() = 0;
609  virtual QAction *actionCheckQgisVersion() = 0;
610  virtual QAction *actionAbout() = 0;
611 
612  // Shape digitize actions
613 
618  Q_DECL_DEPRECATED virtual QAction *actionCircle2Points() SIP_DEPRECATED {return actionAddFeature();}
619 
624  Q_DECL_DEPRECATED virtual QAction *actionCircle3Points() SIP_DEPRECATED {return actionAddFeature();}
625 
630  Q_DECL_DEPRECATED virtual QAction *actionCircle3Tangents() SIP_DEPRECATED {return actionAddFeature();}
631 
636  Q_DECL_DEPRECATED virtual QAction *actionCircle2TangentsPoint() SIP_DEPRECATED {return actionAddFeature();}
637 
642  Q_DECL_DEPRECATED virtual QAction *actionCircleCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
643 
648  Q_DECL_DEPRECATED virtual QAction *actionEllipseCenter2Points() SIP_DEPRECATED {return actionAddFeature();}
649 
654  Q_DECL_DEPRECATED virtual QAction *actionEllipseCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
655 
660  Q_DECL_DEPRECATED virtual QAction *actionEllipseExtent() SIP_DEPRECATED {return actionAddFeature();}
661 
666  Q_DECL_DEPRECATED virtual QAction *actionEllipseFoci() SIP_DEPRECATED {return actionAddFeature();}
667 
672  Q_DECL_DEPRECATED virtual QAction *actionRectangleCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
673 
678  Q_DECL_DEPRECATED virtual QAction *actionRectangleExtent() SIP_DEPRECATED {return actionAddFeature();}
679 
684  Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsDistance() SIP_DEPRECATED {return actionAddFeature();}
685 
690  Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsProjected() SIP_DEPRECATED {return actionAddFeature();}
691 
696  Q_DECL_DEPRECATED virtual QAction *actionRegularPolygon2Points() SIP_DEPRECATED {return actionAddFeature();}
697 
702  Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
703 
708  Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterCorner() SIP_DEPRECATED {return actionAddFeature();}
709 
717  virtual QgsVectorLayerTools *vectorLayerTools() = 0;
718 
720  virtual int messageTimeout() = 0;
721 
728  virtual QgsStatusBar *statusBarIface() = 0;
729 
737  virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 ) {Q_UNUSED( saveDirectory ) Q_UNUSED( categories );}
738 
744  virtual QgsLayerTreeRegistryBridge::InsertionPoint layerTreeInsertionPoint() = 0;
745 
746  public slots: // TODO: do these functions really need to be slots?
747 
748  /* Exposed functions */
749 
753  virtual void zoomFull() = 0;
754 
758  virtual void zoomToPrevious() = 0;
759 
763  virtual void zoomToNext() = 0;
764 
768  virtual void zoomToActiveLayer() = 0;
769 
773  virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
774 
778  virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
779 
783  virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
784 
788  virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
789 
794  virtual QgsVectorTileLayer *addVectorTileLayer( const QString &url, const QString &baseName ) = 0;
795 
800  virtual QgsPointCloudLayer *addPointCloudLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
801 
803  virtual bool addProject( const QString &project ) = 0;
804 
815  virtual bool newProject( bool promptToSaveFlag = false ) = 0;
816 
824  virtual void reloadConnections( ) = 0;
825 
830  virtual bool setActiveLayer( QgsMapLayer * ) = 0;
831 
836  virtual void copySelectionToClipboard( QgsMapLayer * ) = 0;
837 
842  virtual void pasteFromClipboard( QgsMapLayer * ) = 0;
843 
845  virtual int addToolBarIcon( QAction *qAction ) = 0;
846 
855  virtual QAction *addToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
856 
858  virtual void removeToolBarIcon( QAction *qAction ) = 0;
859 
868  virtual QAction *addRasterToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
869 
871  virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
872 
874  virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
875 
877  virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
878 
887  virtual QAction *addVectorToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
888 
890  virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
891 
893  virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
894 
903  virtual QAction *addDatabaseToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
904 
906  virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
907 
909  virtual int addWebToolBarIcon( QAction *qAction ) = 0;
910 
919  virtual QAction *addWebToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
920 
922  virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
923 
925  virtual QToolBar *addToolBar( const QString &name ) = 0 SIP_FACTORY;
926 
931  virtual void addToolBar( QToolBar *toolbar SIP_TRANSFER, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0;
932 
936  virtual void openMessageLog() = 0;
937 
939  virtual void addUserInputWidget( QWidget *widget ) = 0;
940 
945  virtual void showLayoutManager() = 0;
946 
953  virtual QgsLayoutDesignerInterface *openLayoutDesigner( QgsMasterLayoutInterface *layout ) = 0;
954 
960  virtual void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() ) = 0;
961 
967  virtual void showProjectPropertiesDialog( const QString &currentPage = QString() ) = 0;
968 
973  virtual void buildStyleSheet( const QMap<QString, QVariant> &opts ) = 0;
974 
976  virtual void saveStyleSheetOptions( const QMap<QString, QVariant> &opts ) = 0;
977 
979  virtual void addPluginToMenu( const QString &name, QAction *action ) = 0;
980 
982  virtual void removePluginMenu( const QString &name, QAction *action ) = 0;
983 
985  virtual void insertAddLayerAction( QAction *action ) = 0;
986 
988  virtual void removeAddLayerAction( QAction *action ) = 0;
989 
991  virtual void addPluginToDatabaseMenu( const QString &name, QAction *action ) = 0;
992 
994  virtual void removePluginDatabaseMenu( const QString &name, QAction *action ) = 0;
995 
997  virtual void addPluginToRasterMenu( const QString &name, QAction *action ) = 0;
998 
1000  virtual void removePluginRasterMenu( const QString &name, QAction *action ) = 0;
1001 
1003  virtual void addPluginToVectorMenu( const QString &name, QAction *action ) = 0;
1004 
1006  virtual void removePluginVectorMenu( const QString &name, QAction *action ) = 0;
1007 
1009  virtual void addPluginToWebMenu( const QString &name, QAction *action ) = 0;
1010 
1012  virtual void removePluginWebMenu( const QString &name, QAction *action ) = 0;
1013 
1019  virtual void addPluginToMeshMenu( const QString &name, QAction *action ) = 0;
1020 
1026  virtual void removePluginMeshMenu( const QString &name, QAction *action ) = 0;
1027 
1034  virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget ) = 0;
1035 
1050  virtual void addTabifiedDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget, const QStringList &tabifyWith = QStringList(), bool raiseTab = false ) = 0;
1051 
1057  virtual void removeDockWidget( QDockWidget *dockwidget ) = 0;
1058 
1091  virtual void showLayerProperties( QgsMapLayer *l, const QString &page = QString() ) = 0;
1092 
1094  virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) = 0;
1095 
1100  virtual void addWindow( QAction *action ) = 0;
1101 
1106  virtual void removeWindow( QAction *action ) = 0;
1107 
1109  virtual bool registerMainWindowAction( QAction *action, const QString &defaultShortcut ) = 0;
1110 
1112  virtual bool unregisterMainWindowAction( QAction *action ) = 0;
1113 
1122  virtual void registerMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;
1123 
1130  virtual void unregisterMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;
1131 
1140  virtual void registerOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
1141 
1148  virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
1149 
1158  virtual void registerProjectPropertiesWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
1159 
1166  virtual void unregisterProjectPropertiesWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
1167 
1175  virtual void registerDevToolWidgetFactory( QgsDevToolWidgetFactory *factory ) = 0;
1176 
1182  virtual void unregisterDevToolWidgetFactory( QgsDevToolWidgetFactory *factory ) = 0;
1183 
1194  virtual void registerApplicationExitBlocker( QgsApplicationExitBlockerInterface *blocker ) = 0;
1195 
1201  virtual void unregisterApplicationExitBlocker( QgsApplicationExitBlockerInterface *blocker ) = 0;
1202 
1215  virtual void registerMapToolHandler( QgsAbstractMapToolHandler *handler ) = 0;
1216 
1222  virtual void unregisterMapToolHandler( QgsAbstractMapToolHandler *handler ) = 0;
1223 
1232  virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) = 0;
1233 
1240  virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) = 0;
1241 
1250  virtual void registerCustomProjectOpenHandler( QgsCustomProjectOpenHandler *handler ) = 0;
1251 
1258  virtual void unregisterCustomProjectOpenHandler( QgsCustomProjectOpenHandler *handler ) = 0;
1259 
1268  virtual void registerCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;
1269 
1276  virtual void unregisterCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;
1277 
1278  // TODO is this deprecated in favour of QgsContextHelp?
1279 
1289 #ifndef Q_MOC_RUN
1290  Q_DECL_DEPRECATED
1291 #endif
1292  virtual void openURL( const QString &url, bool useQgisDocDirectory = true ) = 0 SIP_DEPRECATED;
1293 
1302  virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
1303 
1312  virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0;
1313 
1326  virtual void preloadForm( const QString &uifile ) = 0;
1327 
1334  virtual void locatorSearch( const QString &searchText ) = 0;
1335 
1344  virtual void registerLocatorFilter( QgsLocatorFilter *filter SIP_TRANSFER ) = 0;
1345 
1356  virtual void deregisterLocatorFilter( QgsLocatorFilter *filter ) = 0;
1357 
1365  virtual void invalidateLocatorResults() = 0;
1366 
1373  virtual bool askForDatumTransform( QgsCoordinateReferenceSystem sourceCrs, QgsCoordinateReferenceSystem destinationCrs ) = 0;
1374 
1380  virtual QgsBrowserGuiModel *browserModel() = 0;
1381 
1390  virtual void setGpsPanelConnection( QgsGpsConnection *connection ) = 0;
1391 
1392  signals:
1393 
1398  void currentLayerChanged( QgsMapLayer *layer );
1399 
1405  void currentThemeChanged( const QString &theme );
1406 
1412  void layoutDesignerOpened( QgsLayoutDesignerInterface *designer );
1413 
1421  void layoutDesignerWillBeClosed( QgsLayoutDesignerInterface *designer );
1422 
1429  void layoutDesignerClosed();
1430 
1434  void initializationCompleted();
1435 
1442  void projectRead();
1443 
1452  void newProjectCreated();
1453 
1458  void layerSavedAs( QgsMapLayer *l, const QString &path );
1459 
1460 };
1461 Q_NOWARN_DEPRECATED_POP
1462 
1463 #endif //#ifndef QGISINTERFACE_H
QgsAttributeDialog
Definition: qgsattributedialog.h:37
QgsLocatorFilter
Abstract base class for filters which collect locator results.
Definition: qgslocatorfilter.h:152
QgsLayerTreeRegistryBridge::InsertionPoint
A structure to define the insertion point to the layer tree.
Definition: qgslayertreeregistrybridge.h:54
QgisInterface::actionRectangleExtent
virtual Q_DECL_DEPRECATED QAction * actionRectangleExtent()
Returns the native add rectangle from extent action.
Definition: qgisinterface.h:678
QgsVectorTileLayer
Implements a map layer that is dedicated to rendering of vector tiles. Vector tiles compared to "ordi...
Definition: qgsvectortilelayer.h:84
QgisInterface::actionCircle2TangentsPoint
virtual Q_DECL_DEPRECATED QAction * actionCircle2TangentsPoint()
Returns the native add circle from 2 tangents and a point action.
Definition: qgisinterface.h:636
QgsOptionsWidgetFactory
A factory class for creating custom options pages.
Definition: qgsoptionswidgetfactory.h:106
QgisInterface::actionEllipseCenter2Points
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenter2Points()
Returns the native add ellipse from center and 2 points action.
Definition: qgisinterface.h:648
qgslayertreeregistrybridge.h
QgsPointCloudLayer
Represents a map layer supporting display of point clouds.
Definition: qgspointcloudlayer.h:45
QgsAbstractMapToolHandler
An abstract base class for map tool handlers which automatically handle all the necessary logic for t...
Definition: qgsabstractmaptoolhandler.h:61
QgisInterface::actionEllipseExtent
virtual Q_DECL_DEPRECATED QAction * actionEllipseExtent()
Returns the native add ellipse from an extent action.
Definition: qgisinterface.h:660
QgsMapLayerType
QgsMapLayerType
Types of layers that can be added to a map.
Definition: qgis.h:46
QgisInterface::actionRectangle3PointsProjected
virtual Q_DECL_DEPRECATED QAction * actionRectangle3PointsProjected()
Returns the native add rectangle from 3 points (distance from projected 3rd point on segment p1 and p...
Definition: qgisinterface.h:690
QgsMapCanvas
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:89
QgsVectorLayerTools
Methods in this class are used to handle basic operations on vector layers. With an implementation of...
Definition: qgsvectorlayertools.h:39
qgis.h
QgsPluginManagerInterface
Definition: qgspluginmanagerinterface.h:31
QgsDevToolWidgetFactory
Factory class for creating custom developer/debugging tool pages.
Definition: qgsdevtoolwidgetfactory.h:33
QgsGuiUtils::iconSize
QSize iconSize(bool dockableToolbar)
Returns the user-preferred size of a window's toolbar icons.
Definition: qgsguiutils.cpp:264
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
SIP_DEPRECATED
#define SIP_DEPRECATED
Definition: qgis_sip.h:106
Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_POP
Definition: qgis.h:2820
QgisInterface::actionRectangle3PointsDistance
virtual Q_DECL_DEPRECATED QAction * actionRectangle3PointsDistance()
Returns the native add rectangle from 3 points (distance from 2nd and 3rd points) action.
Definition: qgisinterface.h:684
QgsApplicationExitBlockerInterface
An interface that may be implemented to allow plugins or scripts to temporarily block the QGIS applic...
Definition: qgsapplicationexitblockerinterface.h:55
QgisInterface::actionRegularPolygonCenterCorner
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterCorner()
Returns the native add regular polygon from center and a corner action.
Definition: qgisinterface.h:708
QgsMeshLayer
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Definition: qgsmeshlayer.h:98
qgis_sip.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QgsLayerTreeGroup
Layer tree group node serves as a container for layers and further groups.
Definition: qgslayertreegroup.h:40
QgsMessageBar
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:60
QgisInterface::actionRectangleCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionRectangleCenterPoint()
Returns the native add rectangle from center and a point action.
Definition: qgisinterface.h:672
QgsRasterLayer
Represents a raster layer.
Definition: qgsrasterlayer.h:76
QgsAdvancedDigitizingDockWidget
The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of...
Definition: qgsadvanceddigitizingdockwidget.h:50
QgsCoordinateReferenceSystem
This class represents a coordinate reference system (CRS).
Definition: qgscoordinatereferencesystem.h:211
QgisInterface::takeAppScreenShots
virtual void takeAppScreenShots(const QString &saveDirectory, const int categories=0)
Take screenshots for user documentation.
Definition: qgisinterface.h:737
QgisInterface::actionRegularPolygon2Points
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygon2Points()
Returns the native add regular polygon from 2 points action.
Definition: qgisinterface.h:696
QgisInterface::actionCircleCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionCircleCenterPoint()
Returns the native add circle from center action.
Definition: qgisinterface.h:642
QgisInterface::actionEllipseFoci
virtual Q_DECL_DEPRECATED QAction * actionEllipseFoci()
Returns the native add ellipse from foci action.
Definition: qgisinterface.h:666
QgsStatusBar
A proxy widget for QStatusBar.
Definition: qgsstatusbar.h:46
QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:50
QgsVectorLayer
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:391
QgisInterface
QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugin...
Definition: qgisinterface.h:88
QgsMapLayer
Base class for all map layer types. This is the base class for all map layer types (vector,...
Definition: qgsmaplayer.h:72
QgsLayoutCustomDropHandler
Abstract base class that may be implemented to handle new types of data to be dropped or pasted in QG...
Definition: qgslayoutcustomdrophandler.h:33
QgsCustomDropHandler
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS.
Definition: qgscustomdrophandler.h:47
QgsLayoutDesignerInterface
A common interface for layout designer dialogs and widgets.
Definition: qgslayoutdesignerinterface.h:55
QgisInterface::actionEllipseCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenterPoint()
Returns the native add ellipse from center and a point action.
Definition: qgisinterface.h:654
QgsGpsConnection
Abstract base class for connection to a GPS device.
Definition: qgsgpsconnection.h:287
QgisInterface::actionCircle3Points
virtual Q_DECL_DEPRECATED QAction * actionCircle3Points()
Returns the native add circle from 3 points action.
Definition: qgisinterface.h:624
QgsFeature
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:55
QgsLayerTreeView
The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working ...
Definition: qgslayertreeview.h:103
QgsMapDecoration
Interface for map decorations.
Definition: qgsmapdecoration.h:34
QgisInterface::actionRegularPolygonCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterPoint()
Returns the native add regular polygon from center and a point action.
Definition: qgisinterface.h:702
QgsMasterLayoutInterface
Interface for master layout type objects, such as print layouts and reports.
Definition: qgsmasterlayoutinterface.h:42
Q_NOWARN_DEPRECATED_PUSH
#define Q_NOWARN_DEPRECATED_PUSH
Definition: qgis.h:2819
QgisInterface::actionCircle3Tangents
virtual Q_DECL_DEPRECATED QAction * actionCircle3Tangents()
Returns the native add circle from 3 tangents action.
Definition: qgisinterface.h:630
qgscoordinatereferencesystem.h
QgisInterface::actionCircle2Points
virtual Q_DECL_DEPRECATED QAction * actionCircle2Points()
Returns the native add circle from 2 points action.
Definition: qgisinterface.h:618
QgsBrowserGuiModel
A model for showing available data sources and other items in a structured tree.
Definition: qgsbrowserguimodel.h:36
QgsCustomProjectOpenHandler
Abstract base class that may be implemented to handle new project file types within the QGIS applicat...
Definition: qgscustomprojectopenhandler.h:37
QgsLayerTreeMapCanvasBridge
The QgsLayerTreeMapCanvasBridge class takes care of updates of layer set for QgsMapCanvas from a laye...
Definition: qgslayertreemapcanvasbridge.h:48
QgsMapLayerConfigWidgetFactory
Factory class for creating custom map layer property pages.
Definition: qgsmaplayerconfigwidgetfactory.h:34
Generated on Sun Sep 11 2022 00:03:17 for QGIS API Documentation by   doxygen 1.8.17