qgisinterface.h

Go to the documentation of this file.

/***************************************************************************
                          qgisinterface.h
  Interface class for exposing functions in QgisApp for use by plugins
                             -------------------
  begin                : 2004-02-11
  copyright            : (C) 2004 by Gary E.Sherman
  email                : sherman at mrcc.com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGISINTERFACE_H
#define QGISINTERFACE_H
 
#include <QObject>
#include <map>
 
#include "qgis.h"
#include "qgis_sip.h"
#include "qgis_gui.h"
#include "qgscoordinatereferencesystem.h"
#include "qgslayertreeregistrybridge.h"
 
class QAction;
class QDialog;
class QFont;
class QMenu;
class QToolBar;
class QDockWidget;
class QMainWindow;
class QWidget;
class QActionGroup;
 
class QgsAdvancedDigitizingDockWidget;
class QgsAttributeDialog;
class QgsCustomDropHandler;
class QgsCustomProjectOpenHandler;
class QgsLayoutCustomDropHandler;
class QgsFeature;
class QgsLayerTreeMapCanvasBridge;
class QgsLayerTreeView;
class QgsLayerTreeGroup;
class QgsLayout;
class QgsMasterLayoutInterface;
class QgsLayoutDesignerInterface;
class QgsMapCanvas;
class QgsMapLayer;
enum class QgsMapLayerType;
class QgsMapLayerConfigWidgetFactory;
class QgsMapDecoration;
class QgsMessageBar;
class QgsPluginManagerInterface;
class QgsRasterLayer;
class QgsVectorLayer;
class QgsVectorLayerTools;
class QgsVectorTileLayer;
class QgsPointCloudLayer;
class QgsOptionsWidgetFactory;
class QgsLocatorFilter;
class QgsStatusBar;
class QgsMeshLayer;
class QgsBrowserGuiModel;
class QgsDevToolWidgetFactory;
class QgsGpsConnection;
class QgsApplicationExitBlockerInterface;
class QgsAbstractMapToolHandler;
 
Q_NOWARN_DEPRECATED_PUSH
class GUI_EXPORT QgisInterface : public QObject
{
    Q_OBJECT
 
  public:
 
    QgisInterface() = default;
 
    virtual QgsPluginManagerInterface *pluginManagerInterface() = 0;
 
    virtual QgsLayerTreeView *layerTreeView() = 0;
 
    virtual void addCustomActionForLayerType( QAction *action, QString menu,
        QgsMapLayerType type, bool allLayers ) = 0;
 
    virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0;
 
    virtual bool removeCustomActionForLayerType( QAction *action ) = 0;
 
    virtual QList< QgsMapCanvas * > mapCanvases() = 0;
 
    virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0;
 
    virtual void closeMapCanvas( const QString &name ) = 0;
 
    virtual QSize iconSize( bool dockedToolbar = false ) const = 0;
 
    virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
 
    virtual QgsMapLayer *activeLayer() = 0;
 
    virtual QgsMapCanvas *mapCanvas() = 0;
 
    virtual QList<QgsMapDecoration *> activeDecorations() = 0;
 
    virtual QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() = 0;
 
    virtual QWidget *mainWindow() = 0;
 
    virtual QgsMessageBar *messageBar() = 0;
 
    virtual QList<QgsLayoutDesignerInterface *> openLayoutDesigners() = 0;
 
 
    virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
 
    virtual QFont defaultStyleSheetFont() = 0;
 
    virtual QgsAdvancedDigitizingDockWidget *cadDockWidget() = 0;
 
    /*
     * Accessors for inserting items into menus and toolbars.
     * An item can be inserted before any existing action.
     */
 
    virtual QMenu *projectMenu() = 0;
 
    virtual QMenu *editMenu() = 0;
 
    virtual QMenu *viewMenu() = 0;
 
    virtual QMenu *layerMenu() = 0;
 
    virtual QMenu *newLayerMenu() = 0;
 
    virtual QMenu *addLayerMenu() = 0;
 
    virtual QMenu *settingsMenu() = 0;
 
    virtual QMenu *pluginMenu() = 0;
 
    virtual QMenu *pluginHelpMenu() = 0;
 
    virtual QMenu *rasterMenu() = 0;
 
    virtual QMenu *databaseMenu() = 0;
 
    virtual QMenu *vectorMenu() = 0;
 
    virtual QMenu *webMenu() = 0;
 
    virtual QMenu *firstRightStandardMenu() = 0;
 
    virtual QMenu *windowMenu() = 0;
 
    virtual QMenu *helpMenu() = 0;
 
    // ToolBars
 
    virtual QToolBar *fileToolBar() = 0;
 
    virtual QToolBar *layerToolBar() = 0;
 
    virtual QToolBar *dataSourceManagerToolBar() = 0;
 
    virtual QToolBar *mapNavToolToolBar() = 0;
 
    virtual QToolBar *digitizeToolBar() = 0;
 
    virtual QToolBar *advancedDigitizeToolBar() = 0;
 
    virtual QToolBar *shapeDigitizeToolBar() = 0;
 
    virtual QToolBar *attributesToolBar() = 0;
 
    virtual QToolBar *selectionToolBar() = 0;
 
    virtual QToolBar *pluginToolBar() = 0;
 
    virtual QToolBar *helpToolBar() = 0;
 
    virtual QToolBar *rasterToolBar() = 0;
 
    virtual QToolBar *vectorToolBar() = 0;
 
    virtual QToolBar *databaseToolBar() = 0;
 
    virtual QToolBar *webToolBar() = 0;
 
    // Project menu actions
    virtual QAction *actionNewProject() = 0;
    virtual QAction *actionOpenProject() = 0;
    virtual QAction *actionSaveProject() = 0;
    virtual QAction *actionSaveProjectAs() = 0;
    virtual QAction *actionSaveMapAsImage() = 0;
    virtual QAction *actionProjectProperties() = 0;
 
    virtual QAction *actionCreatePrintLayout() = 0;
 
    virtual QAction *actionShowLayoutManager() = 0;
    virtual QAction *actionExit() = 0;
 
    // Edit menu actions
 
    virtual QAction *actionCutFeatures() = 0;
    virtual QAction *actionCopyFeatures() = 0;
    virtual QAction *actionPasteFeatures() = 0;
    virtual QAction *actionAddFeature() = 0;
    virtual QAction *actionDeleteSelected() = 0;
    virtual QAction *actionMoveFeature() = 0;
    virtual QAction *actionSplitFeatures() = 0;
    virtual QAction *actionSplitParts() = 0;
    virtual QAction *actionAddRing() = 0;
    virtual QAction *actionAddPart() = 0;
    virtual QAction *actionSimplifyFeature() = 0;
    virtual QAction *actionDeleteRing() = 0;
    virtual QAction *actionDeletePart() = 0;
 
    virtual QAction *actionVertexTool() = 0;
 
    virtual QAction *actionVertexToolActiveLayer() = 0;
 
    virtual QActionGroup *mapToolActionGroup() = 0;
 
    // View menu actions
    virtual QAction *actionPan() = 0;
    virtual QAction *actionPanToSelected() = 0;
    virtual QAction *actionZoomIn() = 0;
    virtual QAction *actionZoomOut() = 0;
    virtual QAction *actionSelect() = 0;
    virtual QAction *actionSelectRectangle() = 0;
    virtual QAction *actionSelectPolygon() = 0;
    virtual QAction *actionSelectFreehand() = 0;
    virtual QAction *actionSelectRadius() = 0;
    virtual QAction *actionIdentify() = 0;
    virtual QAction *actionFeatureAction() = 0;
    virtual QAction *actionMeasure() = 0;
    virtual QAction *actionMeasureArea() = 0;
    virtual QAction *actionZoomFullExtent() = 0;
 
    Q_DECL_DEPRECATED virtual QAction *actionZoomToLayer() = 0 SIP_DEPRECATED;
 
    virtual QAction *actionZoomToLayers() = 0;
 
    virtual QAction *actionZoomToSelected() = 0;
    virtual QAction *actionZoomLast() = 0;
    virtual QAction *actionZoomNext() = 0;
    virtual QAction *actionZoomActualSize() = 0;
    virtual QAction *actionMapTips() = 0;
    virtual QAction *actionNewBookmark() = 0;
    virtual QAction *actionShowBookmarks() = 0;
    virtual QAction *actionDraw() = 0;
 
    // Layer menu actions
    virtual QAction *actionNewVectorLayer() = 0;
    virtual QAction *actionAddOgrLayer() = 0;
    virtual QAction *actionAddRasterLayer() = 0;
    virtual QAction *actionAddPgLayer() = 0;
    virtual QAction *actionAddWmsLayer() = 0;
 
    virtual QAction *actionAddXyzLayer() = 0;
 
    virtual QAction *actionAddVectorTileLayer() = 0;
 
    virtual QAction *actionAddPointCloudLayer() = 0;
 
    virtual QAction *actionAddAfsLayer() = 0;
 
    virtual QAction *actionAddAmsLayer() = 0;
 
    virtual QAction *actionCopyLayerStyle() = 0;
    virtual QAction *actionPasteLayerStyle() = 0;
    virtual QAction *actionOpenTable() = 0;
    virtual QAction *actionOpenFieldCalculator() = 0;
 
    virtual QAction *actionOpenStatisticalSummary() = 0;
 
    virtual QAction *actionToggleEditing() = 0;
    virtual QAction *actionSaveActiveLayerEdits() = 0;
    virtual QAction *actionAllEdits() = 0;
    virtual QAction *actionSaveEdits() = 0;
    virtual QAction *actionSaveAllEdits() = 0;
    virtual QAction *actionRollbackEdits() = 0;
    virtual QAction *actionRollbackAllEdits() = 0;
    virtual QAction *actionCancelEdits() = 0;
    virtual QAction *actionCancelAllEdits() = 0;
    virtual QAction *actionLayerSaveAs() = 0;
    virtual QAction *actionDuplicateLayer() = 0;
    virtual QAction *actionLayerProperties() = 0;
    virtual QAction *actionAddToOverview() = 0;
    virtual QAction *actionAddAllToOverview() = 0;
    virtual QAction *actionRemoveAllFromOverview() = 0;
    virtual QAction *actionHideAllLayers() = 0;
    virtual QAction *actionShowAllLayers() = 0;
    virtual QAction *actionHideSelectedLayers() = 0;
 
    virtual QAction *actionToggleSelectedLayers() = 0;
 
    virtual QAction *actionToggleSelectedLayersIndependently() = 0;
 
    virtual QAction *actionHideDeselectedLayers() = 0;
    virtual QAction *actionShowSelectedLayers() = 0;
 
    // Plugin menu actions
    virtual QAction *actionManagePlugins() = 0;
    virtual QAction *actionPluginListSeparator() = 0;
    virtual QAction *actionShowPythonDialog() = 0;
 
    // Settings menu actions
    virtual QAction *actionToggleFullScreen() = 0;
    virtual QAction *actionOptions() = 0;
    virtual QAction *actionCustomProjection() = 0;
 
    // Help menu actions
    virtual QAction *actionHelpContents() = 0;
    virtual QAction *actionQgisHomePage() = 0;
    virtual QAction *actionCheckQgisVersion() = 0;
    virtual QAction *actionAbout() = 0;
 
    // Shape digitize actions
 
    Q_DECL_DEPRECATED virtual QAction *actionCircle2Points() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionCircle3Points() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionCircle3Tangents() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionCircle2TangentsPoint() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionCircleCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionEllipseCenter2Points() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionEllipseCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionEllipseExtent() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionEllipseFoci() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionRectangleCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionRectangleExtent() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsDistance() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionRectangle3PointsProjected() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionRegularPolygon2Points() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterPoint() SIP_DEPRECATED {return actionAddFeature();}
 
    Q_DECL_DEPRECATED virtual QAction *actionRegularPolygonCenterCorner() SIP_DEPRECATED {return actionAddFeature();}
 
    virtual QgsVectorLayerTools *vectorLayerTools() = 0;
 
    virtual int messageTimeout() = 0;
 
    virtual QgsStatusBar *statusBarIface() = 0;
 
    virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 ) {Q_UNUSED( saveDirectory ) Q_UNUSED( categories );}
 
    virtual QgsLayerTreeRegistryBridge::InsertionPoint layerTreeInsertionPoint() = 0;
 
  public slots: // TODO: do these functions really need to be slots?
 
    /* Exposed functions */
 
    virtual void zoomFull() = 0;
 
    virtual void zoomToPrevious() = 0;
 
    virtual void zoomToNext() = 0;
 
    virtual void zoomToActiveLayer() = 0;
 
    virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
 
    virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
 
    virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
 
    virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
 
    virtual QgsVectorTileLayer *addVectorTileLayer( const QString &url, const QString &baseName ) = 0;
 
    virtual QgsPointCloudLayer *addPointCloudLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
 
    virtual bool addProject( const QString &project ) = 0;
 
    virtual bool newProject( bool promptToSaveFlag = false ) = 0;
 
    virtual void reloadConnections( ) = 0;
 
    virtual bool setActiveLayer( QgsMapLayer * ) = 0;
 
    virtual void copySelectionToClipboard( QgsMapLayer * ) = 0;
 
    virtual void pasteFromClipboard( QgsMapLayer * ) = 0;
 
    virtual int addToolBarIcon( QAction *qAction ) = 0;
 
    virtual QAction *addToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
 
    virtual void removeToolBarIcon( QAction *qAction ) = 0;
 
    virtual QAction *addRasterToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
 
    virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
 
    virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
 
    virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
 
    virtual QAction *addVectorToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
 
    virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
 
    virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
 
    virtual QAction *addDatabaseToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
 
    virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
 
    virtual int addWebToolBarIcon( QAction *qAction ) = 0;
 
    virtual QAction *addWebToolBarWidget( QWidget *widget SIP_TRANSFER ) = 0;
 
    virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
 
    virtual QToolBar *addToolBar( const QString &name ) = 0 SIP_FACTORY;
 
    virtual void addToolBar( QToolBar *toolbar SIP_TRANSFER, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0;
 
    virtual void openMessageLog() = 0;
 
    virtual void addUserInputWidget( QWidget *widget ) = 0;
 
    virtual void showLayoutManager() = 0;
 
    virtual QgsLayoutDesignerInterface *openLayoutDesigner( QgsMasterLayoutInterface *layout ) = 0;
 
    virtual void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() ) = 0;
 
    virtual void showProjectPropertiesDialog( const QString &currentPage = QString() ) = 0;
 
    virtual void buildStyleSheet( const QMap<QString, QVariant> &opts ) = 0;
 
    virtual void saveStyleSheetOptions( const QMap<QString, QVariant> &opts ) = 0;
 
    virtual void addPluginToMenu( const QString &name, QAction *action ) = 0;
 
    virtual void removePluginMenu( const QString &name, QAction *action ) = 0;
 
    virtual void insertAddLayerAction( QAction *action ) = 0;
 
    virtual void removeAddLayerAction( QAction *action ) = 0;
 
    virtual void addPluginToDatabaseMenu( const QString &name, QAction *action ) = 0;
 
    virtual void removePluginDatabaseMenu( const QString &name, QAction *action ) = 0;
 
    virtual void addPluginToRasterMenu( const QString &name, QAction *action ) = 0;
 
    virtual void removePluginRasterMenu( const QString &name, QAction *action ) = 0;
 
    virtual void addPluginToVectorMenu( const QString &name, QAction *action ) = 0;
 
    virtual void removePluginVectorMenu( const QString &name, QAction *action ) = 0;
 
    virtual void addPluginToWebMenu( const QString &name, QAction *action ) = 0;
 
    virtual void removePluginWebMenu( const QString &name, QAction *action ) = 0;
 
    virtual void addPluginToMeshMenu( const QString &name, QAction *action ) = 0;
 
    virtual void removePluginMeshMenu( const QString &name, QAction *action ) = 0;
 
    virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget ) = 0;
 
    virtual void addTabifiedDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget, const QStringList &tabifyWith = QStringList(), bool raiseTab = false ) = 0;
 
    virtual void removeDockWidget( QDockWidget *dockwidget ) = 0;
 
    virtual void showLayerProperties( QgsMapLayer *l, const QString &page = QString() ) = 0;
 
    virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) = 0;
 
    virtual void addWindow( QAction *action ) = 0;
 
    virtual void removeWindow( QAction *action ) = 0;
 
    virtual bool registerMainWindowAction( QAction *action, const QString &defaultShortcut ) = 0;
 
    virtual bool unregisterMainWindowAction( QAction *action ) = 0;
 
    virtual void registerMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;
 
    virtual void unregisterMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;
 
    virtual void registerOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
 
    virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
 
    virtual void registerProjectPropertiesWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
 
    virtual void unregisterProjectPropertiesWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;
 
    virtual void registerDevToolWidgetFactory( QgsDevToolWidgetFactory *factory ) = 0;
 
    virtual void unregisterDevToolWidgetFactory( QgsDevToolWidgetFactory *factory ) = 0;
 
    virtual void registerApplicationExitBlocker( QgsApplicationExitBlockerInterface *blocker ) = 0;
 
    virtual void unregisterApplicationExitBlocker( QgsApplicationExitBlockerInterface *blocker ) = 0;
 
    virtual void registerMapToolHandler( QgsAbstractMapToolHandler *handler ) = 0;
 
    virtual void unregisterMapToolHandler( QgsAbstractMapToolHandler *handler ) = 0;
 
    virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) = 0;
 
    virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) = 0;
 
    virtual void registerCustomProjectOpenHandler( QgsCustomProjectOpenHandler *handler ) = 0;
 
    virtual void unregisterCustomProjectOpenHandler( QgsCustomProjectOpenHandler *handler ) = 0;
 
    virtual void registerCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;
 
    virtual void unregisterCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;
 
    // TODO is this deprecated in favour of QgsContextHelp?
 
#ifndef Q_MOC_RUN
    Q_DECL_DEPRECATED
#endif
    virtual void openURL( const QString &url, bool useQgisDocDirectory = true ) = 0 SIP_DEPRECATED;
 
    virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
 
    virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0;
 
    virtual void preloadForm( const QString &uifile ) = 0;
 
    virtual void locatorSearch( const QString &searchText ) = 0;
 
    virtual void registerLocatorFilter( QgsLocatorFilter *filter SIP_TRANSFER ) = 0;
 
    virtual void deregisterLocatorFilter( QgsLocatorFilter *filter ) = 0;
 
    virtual void invalidateLocatorResults() = 0;
 
    virtual bool askForDatumTransform( QgsCoordinateReferenceSystem sourceCrs, QgsCoordinateReferenceSystem destinationCrs ) = 0;
 
    virtual QgsBrowserGuiModel *browserModel() = 0;
 
    virtual void setGpsPanelConnection( QgsGpsConnection *connection ) = 0;
 
  signals:
 
    void currentLayerChanged( QgsMapLayer *layer );
 
    void currentThemeChanged( const QString &theme );
 
    void layoutDesignerOpened( QgsLayoutDesignerInterface *designer );
 
    void layoutDesignerWillBeClosed( QgsLayoutDesignerInterface *designer );
 
    void layoutDesignerClosed();
 
    void initializationCompleted();
 
    void projectRead();
 
    void newProjectCreated();
 
    void layerSavedAs( QgsMapLayer *l, const QString &path );
 
};
Q_NOWARN_DEPRECATED_POP
 
#endif //#ifndef QGISINTERFACE_H