api/qgisinterface_8h_source.html

/***************************************************************************

                          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 <map>


#include "qgis.h"

#include "qgis_gui.h"

#include "qgis_sip.h"

#include "qgscoordinatereferencesystem.h"

#include "qgslayertreeregistrybridge.h"


#include <QObject>


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 QgsGpsToolsInterface;

class QgsLayerTreeMapCanvasBridge;

class QgsLayerTreeView;

class QgsLayerTreeGroup;

class QgsLayout;

class QgsMasterLayoutInterface;

class QgsLayoutDesignerInterface;

class QgsMapCanvas;

class QgsMapLayer;

class QgsMapLayerConfigWidgetFactory;

class QgsMapDecoration;

class QgsMessageBar;

class QgsPluginManagerInterface;

class QgsRasterLayer;

class QgsVectorLayer;

class QgsVectorLayerTools;

class QgsVectorTileLayer;

class QgsPointCloudLayer;

class QgsTiledSceneLayer;

class QgsOptionsWidgetFactory;

class QgsLocatorFilter;

class QgsStatusBar;

class QgsMeshLayer;

class QgsBrowserGuiModel;

class QgsDevToolWidgetFactory;

class QgsGpsConnection;

class QgsApplicationExitBlockerInterface;

class QgsAbstractMapToolHandler;

class QgsUserProfileManager;

class QgsDataSourceManagerDialog;

class Qgs3DMapCanvas SIP_EXTERNAL;


#ifdef SIP_RUN

//%ModuleHeaderCode

class Qgs3DMapCanvas;

//%End

#endif


Q_NOWARN_DEPRECATED_PUSH


class GUI_EXPORT QgisInterface : public QObject

{

    Q_OBJECT


  public:

    QgisInterface() = default;


    virtual QgsPluginManagerInterface *pluginManagerInterface() = 0;


    virtual QgsLayerTreeView *layerTreeView() = 0;


    virtual QgsGpsToolsInterface *gpsTools() = 0;


    virtual void addCustomActionForLayerType( QAction *action, QString menu, Qgis::LayerType 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 QList<Qgs3DMapCanvas *> mapCanvases3D() = 0;


    virtual Qgs3DMapCanvas *createNewMapCanvas3D( const QString &name, Qgis::SceneMode sceneMode = Qgis::SceneMode::Local ) = 0;


    virtual void closeMapCanvas3D( 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 *projectImportExportMenu() = 0;


    virtual void addProjectImportAction( QAction *action ) = 0;


    virtual void removeProjectImportAction( QAction *action ) = 0;


    virtual void addProjectExportAction( QAction *action ) = 0;


    virtual void removeProjectExportAction( QAction *action ) = 0;


    virtual QMenu *projectModelsMenu() = 0;


    virtual QMenu *createProjectModelSubMenu( const QString &title ) = 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 *meshMenu() = 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 void openDataSourceManagerPage( const QString &pageName ) = 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;


    virtual QgsUserProfileManager *userProfileManager() = 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 QgsTiledSceneLayer *addTiledSceneLayer( 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( const QString &tabName = QString() ) = 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 showApiDocumentation( Qgis::DocumentationApi api = Qgis::DocumentationApi::PyQgis, Qgis::DocumentationBrowser browser = Qgis::DocumentationBrowser::DeveloperToolsPanel, const QString &object = QString(), const QString &module = QString() ) = 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;


    Q_DECL_DEPRECATED virtual void setGpsPanelConnection( QgsGpsConnection *connection SIP_TRANSFER ) = 0 SIP_DEPRECATED;


    virtual void blockActiveLayerChanges( bool blocked ) = 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

QgisInterface::preloadForm
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...

QgisInterface::actionEllipseExtent
virtual Q_DECL_DEPRECATED QAction * actionEllipseExtent()
Returns the native add ellipse from an extent action.
Definition qgisinterface.h:758

QgisInterface::addRasterLayer
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.

QgisInterface::actionExit
virtual QAction * actionExit()=0
Returns the Exit QGIS action.

QgisInterface::unregisterCustomDropHandler
virtual void unregisterCustomDropHandler(QgsCustomDropHandler *handler)=0
Unregister a previously registered custom drop handler.

QgisInterface::databaseMenu
virtual QMenu * databaseMenu()=0
Returns a reference to the main window "Database" menu.

QgisInterface::addToolBarWidget
virtual QAction * addToolBarWidget(QWidget *widget)=0
Add a widget to the plugins toolbar.

QgisInterface::zoomToNext
virtual void zoomToNext()=0
Zooms to the next view extent.

QgisInterface::windowMenu
virtual QMenu * windowMenu()=0
Returns a reference to the main window "Window" menu.

QgisInterface::actionNewBookmark
virtual QAction * actionNewBookmark()=0
Returns the native new bookmark action. Call trigger() on it to open the new bookmark dialog.

QgisInterface::actionCircle3Tangents
virtual Q_DECL_DEPRECATED QAction * actionCircle3Tangents()
Returns the native add circle from 3 tangents action.
Definition qgisinterface.h:728

QgisInterface::actionSelectPolygon
virtual QAction * actionSelectPolygon()=0
Returns the native select polygon action. Call trigger() on it to set the default select polygon map ...

QgisInterface::removePluginMenu
virtual void removePluginMenu(const QString &name, QAction *action)=0
Remove action from the plugins menu.

QgisInterface::addPluginToWebMenu
virtual void addPluginToWebMenu(const QString &name, QAction *action)=0
Add action to the Web menu.

QgisInterface::actionToggleFullScreen
virtual QAction * actionToggleFullScreen()=0

QgisInterface::unregisterMapLayerConfigWidgetFactory
virtual void unregisterMapLayerConfigWidgetFactory(QgsMapLayerConfigWidgetFactory *factory)=0
Unregister a previously registered tab in the map layer properties dialog.

QgisInterface::removeVectorToolBarIcon
virtual void removeVectorToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Vector toolbar.

QgisInterface::actionAddAllToOverview
virtual QAction * actionAddAllToOverview()=0

QgisInterface::actionToggleSelectedLayers
virtual QAction * actionToggleSelectedLayers()=0
Returns the Toggle Selected Layers action.

QgisInterface::addRasterLayer
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.

QgisInterface::actionAddWmsLayer
virtual QAction * actionAddWmsLayer()=0

QgisInterface::addWebToolBarWidget
virtual QAction * addWebToolBarWidget(QWidget *widget)=0
Add a widget to the web toolbar.

QgisInterface::addProjectImportAction
virtual void addProjectImportAction(QAction *action)=0
Adds an action to the QGIS "Import project" menu.

QgisInterface::openFeatureForm
virtual bool openFeatureForm(QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly=false, bool showModal=true)=0
Opens a new feature form.

QgisInterface::actionZoomOut
virtual QAction * actionZoomOut()=0
Returns the native zoom out action. Call trigger() on it to set the default zoom out map tool.

QgisInterface::addWebToolBarIcon
virtual int addWebToolBarIcon(QAction *qAction)=0
Add an icon to the Web toolbar.

QgisInterface::mapCanvases
virtual QList< QgsMapCanvas * > mapCanvases()=0
Returns a list of all map canvases open in the app.

QgisInterface::showLayoutManager
virtual void showLayoutManager()=0
Opens the layout manager dialog.

QgisInterface::actionOpenFieldCalculator
virtual QAction * actionOpenFieldCalculator()=0

QgisInterface::actionIdentify
virtual QAction * actionIdentify()=0
Returns the native identify action. Call trigger() on it to set the default identify map tool.

QgisInterface::actionCircle3Points
virtual Q_DECL_DEPRECATED QAction * actionCircle3Points()
Returns the native add circle from 3 points action.
Definition qgisinterface.h:722

QgisInterface::layoutDesignerWillBeClosed
void layoutDesignerWillBeClosed(QgsLayoutDesignerInterface *designer)
Emitted before a layout designer is going to be closed and deleted.

QgisInterface::actionPan
virtual QAction * actionPan()=0
Returns the native pan action. Call trigger() on it to set the default pan map tool.

QgisInterface::actionQgisHomePage
virtual QAction * actionQgisHomePage()=0

QgisInterface::actionCopyFeatures
virtual QAction * actionCopyFeatures()=0
Returns the native Copy Features action.

QgisInterface::actionToggleSelectedLayersIndependently
virtual QAction * actionToggleSelectedLayersIndependently()=0
Returns the Toggle Selected Layers Independently action.

QgisInterface::actionHelpContents
virtual QAction * actionHelpContents()=0

QgisInterface::createNewMapCanvas3D
virtual Qgs3DMapCanvas * createNewMapCanvas3D(const QString &name, Qgis::SceneMode sceneMode=Qgis::SceneMode::Local)=0
Create a new 3D map canvas with the specified unique name.

QgisInterface::actionSplitFeatures
virtual QAction * actionSplitFeatures()=0
Returns the native Split Features action.

QgisInterface::zoomToActiveLayer
virtual void zoomToActiveLayer()=0
Zooms to extent of the active layer.

QgisInterface::showLayerProperties
virtual void showLayerProperties(QgsMapLayer *l, const QString &page=QString())=0
Opens layer properties dialog for the layer l.

QgisInterface::zoomFull
virtual void zoomFull()=0
Zooms to the full extent of all map layers.

QgisInterface::pasteFromClipboard
virtual void pasteFromClipboard(QgsMapLayer *)=0
Paste features from clipboard to the layer.

QgisInterface::actionPasteFeatures
virtual QAction * actionPasteFeatures()=0
Returns the native Paste Features action.

QgisInterface::actionAddToOverview
virtual QAction * actionAddToOverview()=0

QgisInterface::currentThemeChanged
void currentThemeChanged(const QString &theme)
Emitted when the current theme is changed so plugins can change their tool button icons.

QgisInterface::removeRasterToolBarIcon
virtual void removeRasterToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Raster toolbar.

QgisInterface::actionHideDeselectedLayers
virtual QAction * actionHideDeselectedLayers()=0
Returns the Hide Deselected Layers action.

QgisInterface::deregisterLocatorFilter
virtual void deregisterLocatorFilter(QgsLocatorFilter *filter)=0
Deregisters a locator filter from the app's locator bar and deletes it.

QgisInterface::invalidateLocatorResults
virtual void invalidateLocatorResults()=0
Invalidate results from the locator filter.

QgisInterface::registerMapLayerConfigWidgetFactory
virtual void registerMapLayerConfigWidgetFactory(QgsMapLayerConfigWidgetFactory *factory)=0
Register a new tab in the map layer properties dialog.

QgisInterface::actionSplitParts
virtual QAction * actionSplitParts()=0
Returns the native Split Parts action.

QgisInterface::unregisterProjectPropertiesWidgetFactory
virtual void unregisterProjectPropertiesWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Unregister a previously registered tab in the options dialog.

QgisInterface::rasterToolBar
virtual QToolBar * rasterToolBar()=0
Returns a reference to the main window "Raster" toolbar.

QgisInterface::openLayoutDesigner
virtual QgsLayoutDesignerInterface * openLayoutDesigner(QgsMasterLayoutInterface *layout)=0
Opens a new layout designer dialog for the specified layout, or brings an already open designer windo...

QgisInterface::vectorToolBar
virtual QToolBar * vectorToolBar()=0
Returns a reference to the main window "Vector" toolbar.

QgisInterface::actionAddAmsLayer
virtual QAction * actionAddAmsLayer()=0
Returns the native Add ArcGIS REST Server action.

QgisInterface::newLayerMenu
virtual QMenu * newLayerMenu()=0
Returns a reference to the main window "Create New Layer" menu.

QgisInterface::actionSaveProject
virtual QAction * actionSaveProject()=0
Returns the native Save Project action.

QgisInterface::actionMeasureArea
virtual QAction * actionMeasureArea()=0
Returns the native measure area action. Call trigger() on it to set the default measure area map tool...

QgisInterface::showProjectPropertiesDialog
virtual void showProjectPropertiesDialog(const QString &currentPage=QString())=0
Opens the project properties dialog.

QgisInterface::actionProjectProperties
virtual QAction * actionProjectProperties()=0
Returns the native Project Properties action.

QgisInterface::actionMapTips
virtual QAction * actionMapTips()=0
Returns the native map tips action. Call trigger() on it to toggle map tips.

QgisInterface::actionSelectFreehand
virtual QAction * actionSelectFreehand()=0
Returns the native select freehand action. Call trigger() on it to set the default select freehand ma...

QgisInterface::actionSaveProjectAs
virtual QAction * actionSaveProjectAs()=0
Returns the native Save Project As action.

QgisInterface::actionHideSelectedLayers
virtual QAction * actionHideSelectedLayers()=0

QgisInterface::addWindow
virtual void addWindow(QAction *action)=0
Add window to Window menu.

QgisInterface::actionToggleEditing
virtual QAction * actionToggleEditing()=0

QgisInterface::actionEllipseCenter2Points
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenter2Points()
Returns the native add ellipse from center and 2 points action.
Definition qgisinterface.h:746

QgisInterface::addPluginToRasterMenu
virtual void addPluginToRasterMenu(const QString &name, QAction *action)=0
Add action to the Raster menu.

QgisInterface::layerMenu
virtual QMenu * layerMenu()=0
Returns a reference to the main window "Layer" menu.

QgisInterface::actionPluginListSeparator
virtual QAction * actionPluginListSeparator()=0

QgisInterface::actionOpenProject
virtual QAction * actionOpenProject()=0
Returns the Open Project action.

QgisInterface::addPluginToVectorMenu
virtual void addPluginToVectorMenu(const QString &name, QAction *action)=0
Add action to the Vector menu.

QgisInterface::webMenu
virtual QMenu * webMenu()=0
Returns a reference to the main window "Web" menu.

QgisInterface::messageBar
virtual QgsMessageBar * messageBar()=0
Returns the message bar of the main app.

QgisInterface::editMenu
virtual QMenu * editMenu()=0
Returns a reference to the main window "Edit" menu.

QgisInterface::showApiDocumentation
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.

QgisInterface::addPluginToDatabaseMenu
virtual void addPluginToDatabaseMenu(const QString &name, QAction *action)=0
Add action to the Database menu.

QgisInterface::locatorSearch
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...

QgisInterface::messageTimeout
virtual int messageTimeout()=0
Returns the timeout for timed messages: default of 5 seconds.

QgisInterface::openURL
virtual Q_DECL_DEPRECATED void openURL(const QString &url, bool useQgisDocDirectory=true)=0
Open a url in the users browser.

QgisInterface::unregisterDevToolWidgetFactory
virtual void unregisterDevToolWidgetFactory(QgsDevToolWidgetFactory *factory)=0
Unregister a previously registered tool factory from the development/debugging tools dock.

QgisInterface::actionSaveActiveLayerEdits
virtual QAction * actionSaveActiveLayerEdits()=0

QgisInterface::viewMenu
virtual QMenu * viewMenu()=0
Returns a reference to the main window "View" menu.

QgisInterface::removeWebToolBarIcon
virtual void removeWebToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Web toolbar.

QgisInterface::addRasterToolBarIcon
virtual int addRasterToolBarIcon(QAction *qAction)=0
Add an icon to the Raster toolbar.

QgisInterface::setGpsPanelConnection
virtual Q_DECL_DEPRECATED void setGpsPanelConnection(QgsGpsConnection *connection)=0
Sets a GPS connection to use within the GPS Panel widget.

QgisInterface::askForDatumTransform
virtual bool askForDatumTransform(QgsCoordinateReferenceSystem sourceCrs, QgsCoordinateReferenceSystem destinationCrs)=0
Checks available datum transforms and ask user if several are available and none is chosen.

QgisInterface::projectModelsMenu
virtual QMenu * projectModelsMenu()=0
Returns a reference to the main window "Projects" - "Models" submenu.

QgisInterface::buildStyleSheet
virtual void buildStyleSheet(const QMap< QString, QVariant > &opts)=0
Generate stylesheet.

QgisInterface::actionAbout
virtual QAction * actionAbout()=0

QgisInterface::addVectorTileLayer
virtual QgsVectorTileLayer * addVectorTileLayer(const QString &url, const QString &baseName)=0
Adds a vector tile layer to the current project, using the specified source url.

QgisInterface::actionNewVectorLayer
virtual QAction * actionNewVectorLayer()=0

QgisInterface::actionVertexTool
virtual QAction * actionVertexTool()=0
Returns the native "Vertex Tool for All Layers" action.

QgisInterface::activeLayer
virtual QgsMapLayer * activeLayer()=0
Returns a pointer to the active layer (layer selected in the legend).

QgisInterface::actionMoveFeature
virtual QAction * actionMoveFeature()=0
Returns the native Move Features action.

QgisInterface::fileToolBar
virtual QToolBar * fileToolBar()=0
Returns a reference to the main window "File" toolbar.

QgisInterface::actionRollbackEdits
virtual QAction * actionRollbackEdits()=0

QgisInterface::actionCutFeatures
virtual QAction * actionCutFeatures()=0
Returns the native Cut Features action.

QgisInterface::layerSavedAs
void layerSavedAs(QgsMapLayer *l, const QString &path)
Emitted when a layer has been saved using save as.

QgisInterface::showAttributeTable
virtual QDialog * showAttributeTable(QgsVectorLayer *l, const QString &filterExpression=QString())=0
Open attribute table dialog.

QgisInterface::newProject
virtual bool newProject(bool promptToSaveFlag=false)=0
Starts a new blank project.

QgisInterface::actionRegularPolygonCenterCorner
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterCorner()
Returns the native add regular polygon from center and a corner action.
Definition qgisinterface.h:806

QgisInterface::digitizeToolBar
virtual QToolBar * digitizeToolBar()=0
Returns a reference to the main window "Digitize" toolbar.

QgisInterface::actionOpenTable
virtual QAction * actionOpenTable()=0

QgisInterface::actionRectangleExtent
virtual Q_DECL_DEPRECATED QAction * actionRectangleExtent()
Returns the native add rectangle from extent action.
Definition qgisinterface.h:776

QgisInterface::actionZoomToSelected
virtual QAction * actionZoomToSelected()=0
Returns the native zoom to selected action. Call trigger() on it to zoom to the current selection.

QgisInterface::registerCustomLayoutDropHandler
virtual void registerCustomLayoutDropHandler(QgsLayoutCustomDropHandler *handler)=0
Register a new custom drop handler for layout windows.

QgisInterface::attributesToolBar
virtual QToolBar * attributesToolBar()=0
Returns a reference to the main window "Attributes" toolbar.

QgisInterface::actionCancelAllEdits
virtual QAction * actionCancelAllEdits()=0

QgisInterface::actionZoomNext
virtual QAction * actionZoomNext()=0
Returns the native zoom next action. Call trigger() on it to zoom to next.

QgisInterface::actionDuplicateLayer
virtual QAction * actionDuplicateLayer()=0

QgisInterface::actionOpenStatisticalSummary
virtual QAction * actionOpenStatisticalSummary()=0
Statistical summary action.

QgisInterface::actionManagePlugins
virtual QAction * actionManagePlugins()=0

QgisInterface::getFeatureForm
virtual QgsAttributeDialog * getFeatureForm(QgsVectorLayer *l, QgsFeature &f)=0
Returns a feature form for a given feature.

QgisInterface::projectMenu
virtual QMenu * projectMenu()=0
Returns a reference to the main window "Project" menu.

QgisInterface::actionRollbackAllEdits
virtual QAction * actionRollbackAllEdits()=0

QgisInterface::registerProjectPropertiesWidgetFactory
virtual void registerProjectPropertiesWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Register a new tab in the project properties dialog.

QgisInterface::vectorMenu
virtual QMenu * vectorMenu()=0
Returns a reference to the main window "Vector" menu.

QgisInterface::gpsTools
virtual QgsGpsToolsInterface * gpsTools()=0
Returns an interface to allow plugins to use QGIS GPS tools.

QgisInterface::actionZoomLast
virtual QAction * actionZoomLast()=0
Returns the native zoom last action. Call trigger() on it to zoom to last.

QgisInterface::actionZoomToLayers
virtual QAction * actionZoomToLayers()=0
Returns the native zoom to layers action.

QgisInterface::actionShowLayoutManager
virtual QAction * actionShowLayoutManager()=0
Show layout manager action.

QgisInterface::actionNewProject
virtual QAction * actionNewProject()=0
Returns the native New Project action.

QgisInterface::layerToolBar
virtual QToolBar * layerToolBar()=0
Returns a reference to the main window "Layer" toolbar.

QgisInterface::helpMenu
virtual QMenu * helpMenu()=0
Returns a reference to the main window "Help" menu.

QgisInterface::createNewMapCanvas
virtual QgsMapCanvas * createNewMapCanvas(const QString &name)=0
Create a new map canvas with the specified unique name.

QgisInterface::actionShowPythonDialog
virtual QAction * actionShowPythonDialog()=0

QgisInterface::initializationCompleted
void initializationCompleted()
Emitted when the initialization is complete.

QgisInterface::actionPasteLayerStyle
virtual QAction * actionPasteLayerStyle()=0

QgisInterface::actionVertexToolActiveLayer
virtual QAction * actionVertexToolActiveLayer()=0
Returns the native "Vertex Tool for Active Layer" action.

QgisInterface::actionRegularPolygonCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygonCenterPoint()
Returns the native add regular polygon from center and a point action.
Definition qgisinterface.h:800

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:788

QgisInterface::zoomToPrevious
virtual void zoomToPrevious()=0
Zooms to the previous view extent.

QgisInterface::mapToolActionGroup
virtual QActionGroup * mapToolActionGroup()=0
Returns the action group for map tools.

QgisInterface::layerTreeInsertionPoint
virtual QgsLayerTreeRegistryBridge::InsertionPoint layerTreeInsertionPoint()=0
Returns the insertion point.

QgisInterface::addVectorLayer
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.

QgisInterface::actionAddPgLayer
virtual QAction * actionAddPgLayer()=0

QgisInterface::mapCanvases3D
virtual QList< Qgs3DMapCanvas * > mapCanvases3D()=0
Returns a list of all 3D map canvases open in the app.

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:782

QgisInterface::addToolBarIcon
virtual int addToolBarIcon(QAction *qAction)=0
Add an icon to the plugins toolbar.

QgisInterface::closeMapCanvas3D
virtual void closeMapCanvas3D(const QString &name)=0
Closes the additional map canvas with matching name.

QgisInterface::actionShowAllLayers
virtual QAction * actionShowAllLayers()=0

QgisInterface::currentLayerChanged
void currentLayerChanged(QgsMapLayer *layer)
Emitted whenever current (selected) layer changes.

QgisInterface::dataSourceManagerToolBar
virtual QToolBar * dataSourceManagerToolBar()=0
Returns a reference to the main window "Data Source Manager" toolbar.

QgisInterface::actionAddXyzLayer
virtual QAction * actionAddXyzLayer()=0
Returns the native Add XYZ Layer action.

QgisInterface::browserModel
virtual QgsBrowserGuiModel * browserModel()=0
Returns the application browser model.

QgisInterface::registerDevToolWidgetFactory
virtual void registerDevToolWidgetFactory(QgsDevToolWidgetFactory *factory)=0
Register a new tool in the development/debugging tools dock.

QgisInterface::actionPanToSelected
virtual QAction * actionPanToSelected()=0
Returns the native pan to selected action. Call trigger() on it to pan the map canvas to the selectio...

QgisInterface::addCustomActionForLayerType
virtual void addCustomActionForLayerType(QAction *action, QString menu, Qgis::LayerType type, bool allLayers)=0
Add action to context menu for layers in the layer tree.

QgisInterface::addPointCloudLayer
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.

QgisInterface::registerOptionsWidgetFactory
virtual void registerOptionsWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Register a new tab in the options dialog.

QgisInterface::removePluginRasterMenu
virtual void removePluginRasterMenu(const QString &name, QAction *action)=0
Remove action from the Raster menu.

QgisInterface::actionOptions
virtual QAction * actionOptions()=0

QgisInterface::statusBarIface
virtual QgsStatusBar * statusBarIface()=0
Returns a pointer to the app's status bar interface.

QgisInterface::unregisterMapToolHandler
virtual void unregisterMapToolHandler(QgsAbstractMapToolHandler *handler)=0
Unregister a previously registered map tool handler.

QgisInterface::actionCircle2TangentsPoint
virtual Q_DECL_DEPRECATED QAction * actionCircle2TangentsPoint()
Returns the native add circle from 2 tangents and a point action.
Definition qgisinterface.h:734

QgisInterface::copySelectionToClipboard
virtual void copySelectionToClipboard(QgsMapLayer *)=0
Copy selected features from the layer to clipboard.

QgisInterface::actionAddRing
virtual QAction * actionAddRing()=0
Returns the native Add Ring action.

QgisInterface::pluginToolBar
virtual QToolBar * pluginToolBar()=0
Returns a reference to the main window "Plugin" toolbar.

QgisInterface::mapCanvas
virtual QgsMapCanvas * mapCanvas()=0
Returns a pointer to the map canvas.

QgisInterface::actionAddPart
virtual QAction * actionAddPart()=0
Returns the native Add Part action.

QgisInterface::actionZoomToLayer
virtual Q_DECL_DEPRECATED QAction * actionZoomToLayer()=0
Returns the native zoom to layer action.

QgisInterface::pluginManagerInterface
virtual QgsPluginManagerInterface * pluginManagerInterface()=0

QgisInterface::unregisterCustomProjectOpenHandler
virtual void unregisterCustomProjectOpenHandler(QgsCustomProjectOpenHandler *handler)=0
Unregister a previously registered custom project open handler.

QgisInterface::addUserInputWidget
virtual void addUserInputWidget(QWidget *widget)=0
Adds a widget to the user input tool bar.

QgisInterface::addLayerMenu
virtual QMenu * addLayerMenu()=0
Returns a reference to the main window "Add Layer" menu.

QgisInterface::firstRightStandardMenu
virtual QMenu * firstRightStandardMenu()=0
Returns a reference to the right most standard menu, which is usually the last menu item before the "...

QgisInterface::removeToolBarIcon
virtual void removeToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the plugin toolbar.

QgisInterface::helpToolBar
virtual QToolBar * helpToolBar()=0
Returns a reference to the main window "Help" toolbar.

QgisInterface::removeProjectImportAction
virtual void removeProjectImportAction(QAction *action)=0
Adds an action to the QGIS "Import project" menu.

QgisInterface::defaultStyleSheetFont
virtual QFont defaultStyleSheetFont()=0
Returns a reference font for initial qApp (may not be same as QgisApp).

QgisInterface::databaseToolBar
virtual QToolBar * databaseToolBar()=0
Returns a reference to the main window "Database" toolbar.

QgisInterface::actionSelectRectangle
virtual QAction * actionSelectRectangle()=0
Returns the native select rectangle action. Call trigger() on it to set the default select rectangle ...

QgisInterface::actionCreatePrintLayout
virtual QAction * actionCreatePrintLayout()=0
Create new print layout action.

QgisInterface::actionDeleteRing
virtual QAction * actionDeleteRing()=0
Returns the native Delete Ring action.

QgisInterface::insertAddLayerAction
virtual void insertAddLayerAction(QAction *action)=0
Add "add layer" action to layer menu.

QgisInterface::unregisterOptionsWidgetFactory
virtual void unregisterOptionsWidgetFactory(QgsOptionsWidgetFactory *factory)=0
Unregister a previously registered tab in the options dialog.

QgisInterface::selectionToolBar
virtual QToolBar * selectionToolBar()=0
Returns a reference to the main window "Selection" toolbar.

QgisInterface::addToolBar
virtual void addToolBar(QToolBar *toolbar, Qt::ToolBarArea area=Qt::TopToolBarArea)=0
Add a toolbar.

QgisInterface::projectImportExportMenu
virtual QMenu * projectImportExportMenu()=0
Returns a reference to the main window "Import/Export" project menu.

QgisInterface::actionCircle2Points
virtual Q_DECL_DEPRECATED QAction * actionCircle2Points()
Returns the native add circle from 2 points action.
Definition qgisinterface.h:716

QgisInterface::openLayoutDesigners
virtual QList< QgsLayoutDesignerInterface * > openLayoutDesigners()=0
Returns all currently open layout designers.

QgisInterface::registerMapToolHandler
virtual void registerMapToolHandler(QgsAbstractMapToolHandler *handler)=0
Register a new application map tool handler, which can be used to automatically setup all connections...

QgisInterface::saveStyleSheetOptions
virtual void saveStyleSheetOptions(const QMap< QString, QVariant > &opts)=0
Save changed default option keys/values to user settings.

QgisInterface::actionShowBookmarks
virtual QAction * actionShowBookmarks()=0
Returns the native show bookmarks action. Call trigger() on it to open the bookmarks dialog.

QgisInterface::defaultStyleSheetOptions
virtual QMap< QString, QVariant > defaultStyleSheetOptions()=0
Returns changeable options built from settings and/or defaults.

QgisInterface::actionSaveMapAsImage
virtual QAction * actionSaveMapAsImage()=0
Returns the native Save Map as Image action.

QgisInterface::removeWindow
virtual void removeWindow(QAction *action)=0
Remove window from Window menu.

QgisInterface::addDatabaseToolBarIcon
virtual int addDatabaseToolBarIcon(QAction *qAction)=0
Add an icon to the Database toolbar.

QgisInterface::addProject
virtual bool addProject(const QString &project)=0
Adds (opens) a project.

QgisInterface::actionZoomActualSize
virtual QAction * actionZoomActualSize()=0
Returns the native zoom resolution (100%) action. Call trigger() on it to zoom to actual size.

QgisInterface::layerTreeCanvasBridge
virtual QgsLayerTreeMapCanvasBridge * layerTreeCanvasBridge()=0
Returns a pointer to the layer tree canvas bridge.

QgisInterface::unregisterCustomLayoutDropHandler
virtual void unregisterCustomLayoutDropHandler(QgsLayoutCustomDropHandler *handler)=0
Unregister a previously registered custom drop handler for layout windows.

QgisInterface::removePluginMeshMenu
virtual void removePluginMeshMenu(const QString &name, QAction *action)=0
Remove action from the Mesh menu.

QgisInterface::actionEllipseFoci
virtual Q_DECL_DEPRECATED QAction * actionEllipseFoci()
Returns the native add ellipse from foci action.
Definition qgisinterface.h:764

QgisInterface::addPluginToMeshMenu
virtual void addPluginToMeshMenu(const QString &name, QAction *action)=0
Add action to the Mesh menu.

QgisInterface::actionDeleteSelected
virtual QAction * actionDeleteSelected()=0
Returns the native Delete Selected Features action.

QgisInterface::removePluginVectorMenu
virtual void removePluginVectorMenu(const QString &name, QAction *action)=0
Remove action from the Vector menu.

QgisInterface::actionSelect
virtual QAction * actionSelect()=0
Returns the native select action. Call trigger() on it to set the default select map tool.

QgisInterface::removeDockWidget
virtual void removeDockWidget(QDockWidget *dockwidget)=0
Removes the specified dock widget from main window (without deleting it).

QgisInterface::layoutDesignerClosed
void layoutDesignerClosed()
Emitted after a layout designer window is closed.

QgisInterface::actionZoomIn
virtual QAction * actionZoomIn()=0
Returns the native zoom in action. Call trigger() on it to set the default zoom in map tool.

QgisInterface::actionAddAfsLayer
virtual QAction * actionAddAfsLayer()=0
Returns the native Add ArcGIS REST Server action.

QgisInterface::reloadConnections
virtual void reloadConnections()=0
Triggered when connections have changed.

QgisInterface::actionAddFeature
virtual QAction * actionAddFeature()=0
Returns the native Add Feature action.

QgisInterface::addTiledSceneLayer
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.

QgisInterface::removeDatabaseToolBarIcon
virtual void removeDatabaseToolBarIcon(QAction *qAction)=0
Remove an action (icon) from the Database toolbar.

QgisInterface::activeDecorations
virtual QList< QgsMapDecoration * > activeDecorations()=0
Returns a list of the active decorations.

QgisInterface::actionEllipseCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionEllipseCenterPoint()
Returns the native add ellipse from center and a point action.
Definition qgisinterface.h:752

QgisInterface::iconSize
virtual QSize iconSize(bool dockedToolbar=false) const =0
Returns the toolbar icon size.

QgisInterface::registerApplicationExitBlocker
virtual void registerApplicationExitBlocker(QgsApplicationExitBlockerInterface *blocker)=0
Register a new application exit blocker, which can be used to prevent the QGIS application from exiti...

QgisInterface::removePluginDatabaseMenu
virtual void removePluginDatabaseMenu(const QString &name, QAction *action)=0
Remove action from the Database menu.

QgisInterface::setActiveLayer
virtual bool setActiveLayer(QgsMapLayer *)=0
Set the active layer (layer gets selected in the legend) returns true if the layer exists,...

QgisInterface::addMeshLayer
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.

QgisInterface::actionRegularPolygon2Points
virtual Q_DECL_DEPRECATED QAction * actionRegularPolygon2Points()
Returns the native add regular polygon from 2 points action.
Definition qgisinterface.h:794

QgisInterface::actionCustomProjection
virtual QAction * actionCustomProjection()=0

QgisInterface::actionSimplifyFeature
virtual QAction * actionSimplifyFeature()=0
Returns the native Simplify/Smooth Features action.

QgisInterface::takeAppScreenShots
virtual void takeAppScreenShots(const QString &saveDirectory, const int categories=0)
Take screenshots for user documentation.
Definition qgisinterface.h:834

QgisInterface::createProjectModelSubMenu
virtual QMenu * createProjectModelSubMenu(const QString &title)=0
Creates a new project model submenu in the "Projects" - "Models" submenu.

QgisInterface::registerMainWindowAction
virtual bool registerMainWindowAction(QAction *action, const QString &defaultShortcut)=0
Register action to the shortcuts manager so its shortcut can be changed in GUI.

QgisInterface::actionAddPointCloudLayer
virtual QAction * actionAddPointCloudLayer()=0
Returns the native Add Point Cloud Layer action.

QgisInterface::openMessageLog
virtual void openMessageLog(const QString &tabName=QString())=0
Opens the message log dock widget, and optionally activates a specific tab by name.

QgisInterface::removePluginWebMenu
virtual void removePluginWebMenu(const QString &name, QAction *action)=0
Remove action from the Web menu.

QgisInterface::addVectorToolBarWidget
virtual QAction * addVectorToolBarWidget(QWidget *widget)=0
Add a widget to the vector toolbar.

QgisInterface::addDockWidget
virtual void addDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget)=0
Adds a dock widget to the main window, in the specified dock area.

QgisInterface::registerCustomDropHandler
virtual void registerCustomDropHandler(QgsCustomDropHandler *handler)=0
Register a new custom drop handler.

QgisInterface::layoutDesignerOpened
void layoutDesignerOpened(QgsLayoutDesignerInterface *designer)
Emitted when a new layout designer has been opened.

QgisInterface::actionDeletePart
virtual QAction * actionDeletePart()=0
Returns the native Delete Part action.

QgisInterface::actionSaveEdits
virtual QAction * actionSaveEdits()=0

QgisInterface::actionShowSelectedLayers
virtual QAction * actionShowSelectedLayers()=0

QgisInterface::actionAllEdits
virtual QAction * actionAllEdits()=0

QgisInterface::pluginMenu
virtual QMenu * pluginMenu()=0
Returns a reference to the main window "Plugin" menu.

QgisInterface::cadDockWidget
virtual QgsAdvancedDigitizingDockWidget * cadDockWidget()=0
Advanced digitizing dock widget.

QgisInterface::actionAddOgrLayer
virtual QAction * actionAddOgrLayer()=0

QgisInterface::actionLayerProperties
virtual QAction * actionLayerProperties()=0

QgisInterface::actionAddRasterLayer
virtual QAction * actionAddRasterLayer()=0

QgisInterface::meshMenu
virtual QMenu * meshMenu()=0
Returns a reference to the main window "Mesh" menu.

QgisInterface::actionRectangleCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionRectangleCenterPoint()
Returns the native add rectangle from center and a point action.
Definition qgisinterface.h:770

QgisInterface::editableLayers
virtual QList< QgsMapLayer * > editableLayers(bool modified=false) const =0
Returns vector layers in edit mode.

QgisInterface::unregisterApplicationExitBlocker
virtual void unregisterApplicationExitBlocker(QgsApplicationExitBlockerInterface *blocker)=0
Unregister a previously registered application exit blocker.

QgisInterface::vectorLayerTools
virtual QgsVectorLayerTools * vectorLayerTools()=0
Access the vector layer tools instance.

QgisInterface::removeCustomActionForLayerType
virtual bool removeCustomActionForLayerType(QAction *action)=0
Remove action for layers in the layer tree previously added with addCustomActionForLayerType().

QgisInterface::actionAddVectorTileLayer
virtual QAction * actionAddVectorTileLayer()=0
Returns the native Add Vector Tile Layer action.

QgisInterface::shapeDigitizeToolBar
virtual QToolBar * shapeDigitizeToolBar()=0
Returns a reference to the main window "Shape Digitizing" toolbar.

QgisInterface::registerLocatorFilter
virtual void registerLocatorFilter(QgsLocatorFilter *filter)=0
Registers a locator filter for the app's locator bar.

QgisInterface::actionMeasure
virtual QAction * actionMeasure()=0
Returns the native measure action. Call trigger() on it to set the default measure map tool.

QgisInterface::layerTreeView
virtual QgsLayerTreeView * layerTreeView()=0

QgisInterface::addVectorToolBarIcon
virtual int addVectorToolBarIcon(QAction *qAction)=0
Add an icon to the Vector toolbar.

QgisInterface::actionCheckQgisVersion
virtual QAction * actionCheckQgisVersion()=0

QgisInterface::QgisInterface
QgisInterface()=default

QgisInterface::actionHideAllLayers
virtual QAction * actionHideAllLayers()=0

QgisInterface::unregisterMainWindowAction
virtual bool unregisterMainWindowAction(QAction *action)=0
Unregister a previously registered action. (e.g. when plugin is going to be unloaded).

QgisInterface::webToolBar
virtual QToolBar * webToolBar()=0
Returns a reference to the main window "Web" toolbar.

QgisInterface::actionSelectRadius
virtual QAction * actionSelectRadius()=0
Returns the native select radius action. Call trigger() on it to set the default select radius map to...

QgisInterface::userProfileManager
virtual QgsUserProfileManager * userProfileManager()=0
Returns a reference to the user profile manager.

QgisInterface::openDataSourceManagerPage
virtual void openDataSourceManagerPage(const QString &pageName)=0
Opens a page in the main window "Data Source Manager" dialog.

QgisInterface::advancedDigitizeToolBar
virtual QToolBar * advancedDigitizeToolBar()=0
Returns a reference to the main window "Advanced Digitizing" toolbar.

QgisInterface::registerCustomProjectOpenHandler
virtual void registerCustomProjectOpenHandler(QgsCustomProjectOpenHandler *handler)=0
Register a new custom project open handler.

QgisInterface::mainWindow
virtual QWidget * mainWindow()=0
Returns a pointer to the main window (instance of QgisApp in case of QGIS).

QgisInterface::removeProjectExportAction
virtual void removeProjectExportAction(QAction *action)=0
Adds an action to the QGIS "Export project" menu.

QgisInterface::addProjectExportAction
virtual void addProjectExportAction(QAction *action)=0
Adds an action to the QGIS "Export project" menu.

QgisInterface::actionCircleCenterPoint
virtual Q_DECL_DEPRECATED QAction * actionCircleCenterPoint()
Returns the native add circle from center action.
Definition qgisinterface.h:740

QgisInterface::actionSaveAllEdits
virtual QAction * actionSaveAllEdits()=0

QgisInterface::actionRemoveAllFromOverview
virtual QAction * actionRemoveAllFromOverview()=0

QgisInterface::addToolBar
virtual QToolBar * addToolBar(const QString &name)=0
Add toolbar with specified name.

QgisInterface::settingsMenu
virtual QMenu * settingsMenu()=0
Returns a reference to the main window "Settings" menu.

QgisInterface::actionDraw
virtual QAction * actionDraw()=0
Returns the native draw action.

QgisInterface::actionFeatureAction
virtual QAction * actionFeatureAction()=0
Returns the native run action feature action. Call trigger() on it to set the default run feature act...

QgisInterface::removeAddLayerAction
virtual void removeAddLayerAction(QAction *action)=0
Remove "add layer" action from layer menu.

QgisInterface::mapNavToolToolBar
virtual QToolBar * mapNavToolToolBar()=0
Returns a reference to the main window "Map Navigation" toolbar.

QgisInterface::addTabifiedDockWidget
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).

QgisInterface::blockActiveLayerChanges
virtual void blockActiveLayerChanges(bool blocked)=0
Sets whether changes to the active layer should be temporarily blocked.

QgisInterface::actionLayerSaveAs
virtual QAction * actionLayerSaveAs()=0

QgisInterface::newProjectCreated
void newProjectCreated()
Emitted when starting an entirely new project.

QgisInterface::actionCancelEdits
virtual QAction * actionCancelEdits()=0

QgisInterface::closeMapCanvas
virtual void closeMapCanvas(const QString &name)=0
Closes the additional map canvas with matching name.

QgisInterface::projectRead
void projectRead()
Emitted when a project file is successfully read.

QgisInterface::actionZoomFullExtent
virtual QAction * actionZoomFullExtent()=0
Returns the native zoom full extent action. Call trigger() on it to zoom to the full extent.

QgisInterface::addPluginToMenu
virtual void addPluginToMenu(const QString &name, QAction *action)=0
Add action to the plugins menu.

QgisInterface::actionCopyLayerStyle
virtual QAction * actionCopyLayerStyle()=0

QgisInterface::showOptionsDialog
virtual void showOptionsDialog(QWidget *parent=nullptr, const QString &currentPage=QString())=0
Opens the options dialog.

QgisInterface::addCustomActionForLayer
virtual void addCustomActionForLayer(QAction *action, QgsMapLayer *layer)=0
Add action to context menu for a specific layer in the layer tree.

QgisInterface::pluginHelpMenu
virtual QMenu * pluginHelpMenu()=0
Returns a reference to the main window "Plugin Help" sub-menu.

QgisInterface::addRasterToolBarWidget
virtual QAction * addRasterToolBarWidget(QWidget *widget)=0
Add a widget to the raster toolbar.

QgisInterface::addDatabaseToolBarWidget
virtual QAction * addDatabaseToolBarWidget(QWidget *widget)=0
Add a widget to the database toolbar.

QgisInterface::rasterMenu
virtual QMenu * rasterMenu()=0
Returns a reference to the main window "Raster" menu.

Qgis::DocumentationBrowser
DocumentationBrowser
Documentation API browser.
Definition qgis.h:6012

Qgis::DocumentationBrowser::DeveloperToolsPanel
@ DeveloperToolsPanel
Embedded webview in the DevTools panel.
Definition qgis.h:6013

Qgis::LayerType
LayerType
Types of layers that can be added to a map.
Definition qgis.h:190

Qgis::DocumentationApi
DocumentationApi
Documentation API.
Definition qgis.h:5998

Qgis::DocumentationApi::PyQgis
@ PyQgis
PyQgis API documentation.
Definition qgis.h:5999

Qgis::SceneMode
SceneMode
The 3D scene mode used in 3D map views.
Definition qgis.h:4168

Qgis::SceneMode::Local
@ Local
Local scene based on a projected CRS.
Definition qgis.h:4169

Qgs3DMapCanvas
Convenience wrapper to simplify the creation of a 3D window ready to be used with QGIS.
Definition qgs3dmapcanvas.h:84

QgsAbstractMapToolHandler
An abstract base class for map tool handlers, implementing application level UI logic.
Definition qgsabstractmaptoolhandler.h:64

QgsAdvancedDigitizingDockWidget
A dockable widget used to handle the CAD tools on top of a selection of map tools.
Definition qgsadvanceddigitizingdockwidget.h:52

QgsApplicationExitBlockerInterface
An interface that may be implemented to allow plugins or scripts to temporarily block the QGIS applic...
Definition qgsapplicationexitblockerinterface.h:57

QgsAttributeDialog
An attribute table dialog for a vector layer.
Definition qgsattributedialog.h:40

QgsBrowserGuiModel
A model for showing available data sources and other items in a structured tree.
Definition qgsbrowserguimodel.h:38

QgsCoordinateReferenceSystem
Represents a coordinate reference system (CRS).
Definition qgscoordinatereferencesystem.h:212

QgsCustomDropHandler
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS.
Definition qgscustomdrophandler.h:47

QgsCustomProjectOpenHandler
Abstract base class that may be implemented to handle new project file types within the QGIS applicat...
Definition qgscustomprojectopenhandler.h:39

QgsDataSourceManagerDialog
A dialog which embeds the browser panel and all the provider source select widgets.
Definition qgsdatasourcemanagerdialog.h:49

QgsDevToolWidgetFactory
Factory class for creating custom developer/debugging tool pages.
Definition qgsdevtoolwidgetfactory.h:35

QgsFeature
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58

QgsGpsConnection
Abstract base class for connections to a GPS device.
Definition qgsgpsconnection.h:50

QgsGpsToolsInterface
Abstract interface class for the QGIS GPS tools.
Definition qgsgpstoolsinterface.h:31

QgsLayerTreeGroup
Layer tree group node serves as a container for layers and further groups.
Definition qgslayertreegroup.h:41

QgsLayerTreeMapCanvasBridge
Takes care of updates of layer sets for a QgsMapCanvas from a layer tree.
Definition qgslayertreemapcanvasbridge.h:48

QgsLayerTreeView
Extends QTreeView and provides additional functionality when working with a layer tree.
Definition qgslayertreeview.h:429

QgsLayoutCustomDropHandler
Abstract base class that may be implemented to handle new types of data to be dropped or pasted in QG...
Definition qgslayoutcustomdrophandler.h:34

QgsLayoutDesignerInterface
A common interface for layout designer dialogs and widgets.
Definition qgslayoutdesignerinterface.h:56

QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:50

QgsLocatorFilter
Abstract base class for filters which collect locator results.
Definition qgslocatorfilter.h:177

QgsMapCanvas
Map canvas is a class for displaying all GIS data types on a canvas.
Definition qgsmapcanvas.h:91

QgsMapDecoration
Interface for map decorations.
Definition qgsmapdecoration.h:35

QgsMapLayerConfigWidgetFactory
Factory class for creating custom map layer property pages.
Definition qgsmaplayerconfigwidgetfactory.h:35

QgsMapLayer
Base class for all map layer types.
Definition qgsmaplayer.h:80

QgsMasterLayoutInterface
Interface for master layout type objects, such as print layouts and reports.
Definition qgsmasterlayoutinterface.h:43

QgsMeshLayer
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Definition qgsmeshlayer.h:101

QgsMessageBar
A bar for displaying non-blocking messages to the user.
Definition qgsmessagebar.h:61

QgsOptionsWidgetFactory
A factory class for creating custom options pages.
Definition qgsoptionswidgetfactory.h:113

QgsPluginManagerInterface
Abstract interface class for the QGIS plugin manager.
Definition qgspluginmanagerinterface.h:33

QgsPointCloudLayer
Represents a map layer supporting display of point clouds.
Definition qgspointcloudlayer.h:47

QgsRasterLayer
Represents a raster layer.
Definition qgsrasterlayer.h:78

QgsStatusBar
A proxy widget for QStatusBar.
Definition qgsstatusbar.h:47

QgsTiledSceneLayer
Represents a map layer supporting display of tiled scene objects.
Definition qgstiledscenelayer.h:36

QgsUserProfileManager
A manager for QGIS user profiles.
Definition qgsuserprofilemanager.h:41

QgsVectorLayerTools
Used to handle basic editing operations on vector layers.
Definition qgsvectorlayertools.h:44

QgsVectorLayer
Represents a vector layer which manages a vector based dataset.
Definition qgsvectorlayer.h:406

QgsVectorTileLayer
Implements a map layer that is dedicated to rendering of vector tiles.
Definition qgsvectortilelayer.h:90

qgis.h

Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:7170

Q_NOWARN_DEPRECATED_PUSH
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:7169

qgis_sip.h

SIP_DEPRECATED
#define SIP_DEPRECATED
Definition qgis_sip.h:114

SIP_EXTERNAL
#define SIP_EXTERNAL
Definition qgis_sip.h:124

SIP_TRANSFER
#define SIP_TRANSFER
Definition qgis_sip.h:36

SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:84

qgscoordinatereferencesystem.h

qgslayertreeregistrybridge.h

QgsLayerTreeRegistryBridge::InsertionPoint
A structure to define the insertion point to the layer tree.
Definition qgslayertreeregistrybridge.h:56