Add activeDecorations to iface object

Allow plugins and scripts to export animations with decorations
qgis · Jul 23, 2021 · 811a035 · 811a035
1 parent 09297ed
commit 811a035
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/python/gui/auto_generated/qgisinterface.sip.in b/python/gui/auto_generated/qgisinterface.sip.in
@@ -120,6 +120,11 @@ Returns a pointer to the active layer (layer selected in the legend)
     virtual QgsMapCanvas *mapCanvas() = 0;
 %Docstring
 Returns a pointer to the map canvas
+%End
+
+    virtual QList<QgsMapDecoration *> activeDecorations() = 0;
+%Docstring
+Returns a list of the active decorations
 %End
 
     virtual QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() = 0;

diff --git a/src/app/qgisappinterface.cpp b/src/app/qgisappinterface.cpp
@@ -902,3 +902,8 @@ void QgisAppInterface::setGpsPanelConnection( QgsGpsConnection *connection )
 {
   qgis->setGpsPanelConnection( connection );
 }
+
+QList<QgsMapDecoration *> QgisAppInterface::activeDecorations()
+{
+  return qgis->activeDecorations();
+}
diff --git a/src/app/qgisappinterface.h b/src/app/qgisappinterface.h
@@ -321,6 +321,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
     QgsBrowserGuiModel *browserModel() override;
     QgsLayerTreeRegistryBridge::InsertionPoint layerTreeInsertionPoint() override;
     void setGpsPanelConnection( QgsGpsConnection *connection ) override;
+    QList<QgsMapDecoration *> activeDecorations() override;
 
   private slots:
 

diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h
@@ -53,6 +53,7 @@ class QgsMapCanvas;
 class QgsMapLayer;
 enum class QgsMapLayerType;
 class QgsMapLayerConfigWidgetFactory;
+class QgsMapDecoration;
 class QgsMessageBar;
 class QgsPluginManagerInterface;
 class QgsRasterLayer;
@@ -165,6 +166,9 @@ class GUI_EXPORT QgisInterface : public QObject
     //! Returns a pointer to the map canvas
     virtual QgsMapCanvas *mapCanvas() = 0;
 
+    //! Returns a list of the active decorations
+    virtual QList<QgsMapDecoration *> activeDecorations() = 0;
+
     /**
      * Returns a pointer to the layer tree canvas bridge
      *