Add iface.layerTreeCanvasBridge()

Author: m-kuhn

python/gui/qgisinterface.sip

@@ -159,6 +159,9 @@ class QgisInterface : QObject
     /** Return a pointer to the map canvas */
     virtual QgsMapCanvas * mapCanvas() = 0;
 
+    /** Returns a pointer to the layer tree canvas bridge */
+    virtual QgsLayerTreeMapCanvasBridge* layerTreeCanvasBridge() = 0;
+
     /** Return a pointer to the main window (instance of QgisApp in case of QGIS) */
     virtual QWidget * mainWindow() = 0;
 

src/app/qgisappinterface.cpp

@@ -311,6 +311,11 @@ QgsMapCanvas * QgisAppInterface::mapCanvas()
   return qgis->mapCanvas();
 }
 
+QgsLayerTreeMapCanvasBridge* QgisAppInterface::layerTreeCanvasBridge()
+{
+  return qgis->layerTreeCanvasBridge();
+}
+
 QWidget * QgisAppInterface::mainWindow()
 {
   return qgis;

src/app/qgisappinterface.h

@@ -168,6 +168,13 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
     /** Return a pointer to the map canvas used by qgisapp */
     QgsMapCanvas * mapCanvas() override;
 
+    /**
+     * Returns a pointer to the layer tree canvas bridge
+     *
+     * @note added in 2.12
+     */
+    QgsLayerTreeMapCanvasBridge* layerTreeCanvasBridge() override;
+
     /** Gives access to main QgisApp object
 
         Plugins don't need to know about QgisApp, as we pass it as QWidget,
@@ -243,7 +250,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
 
     /** Add "add layer" action to the layer menu */
     void insertAddLayerAction( QAction *action ) override;
-    /** remove "add layer" action from the layer menu */
+    /** Remove "add layer" action from the layer menu */
     void removeAddLayerAction( QAction *action ) override;
 
     /** Add a dock widget to the main window */
@@ -252,12 +259,12 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
     /** Remove specified dock widget from main window (doesn't delete it). */
     void removeDockWidget( QDockWidget * dockwidget ) override;
 
-    /** show layer properties dialog for layer
+    /** Show layer properties dialog for layer
      * @param l layer to show properties table for
      */
     virtual void showLayerProperties( QgsMapLayer *l ) override;
 
-    /** show layer attribute dialog for layer
+    /** Show layer attribute dialog for layer
      * @param l layer to show attribute table for
      */
     virtual void showAttributeTable( QgsVectorLayer *l ) override;

src/gui/qgisinterface.h

@@ -28,6 +28,7 @@ class QWidget;
 class QgsAttributeDialog;
 class QgsComposerView;
 class QgsFeature;
+class QgsLayerTreeMapCanvasBridge;
 class QgsLayerTreeView;
 class QgsLegendInterface;
 class QgsMapCanvas;
@@ -205,6 +206,13 @@ class GUI_EXPORT QgisInterface : public QObject
     /** Return a pointer to the map canvas */
     virtual QgsMapCanvas * mapCanvas() = 0;
 
+    /**
+     * Returns a pointer to the layer tree canvas bridge
+     *
+     * @note added in 2.12
+     */
+    virtual QgsLayerTreeMapCanvasBridge* layerTreeCanvasBridge() = 0;
+
     /** Return a pointer to the main window (instance of QgisApp in case of QGIS) */
     virtual QWidget * mainWindow() = 0;
 
@@ -291,10 +299,10 @@ class GUI_EXPORT QgisInterface : public QObject
     /** Remove specified dock widget from main window (doesn't delete it). */
     virtual void removeDockWidget( QDockWidget * dockwidget ) = 0;
 
-    /** open layer properties dialog */
+    /** Open layer properties dialog */
     virtual void showLayerProperties( QgsMapLayer *l ) = 0;
 
-    /** open attribute table dialog */
+    /** Open attribute table dialog */
     virtual void showAttributeTable( QgsVectorLayer *l ) = 0;
 
     /** Add window to Window menu. The action title is the window title
@@ -568,14 +576,14 @@ class GUI_EXPORT QgisInterface : public QObject
      * This signal is emitted when the initialization is complete
      */
     void initializationCompleted();
-    /** emitted when a project file is successfully read
+    /** Emitted when a project file is successfully read
         @note
         This is useful for plug-ins that store properties with project files.  A
         plug-in can connect to this signal.  When it is emitted, the plug-in
         knows to then check the project properties for any relevant state.
      */
     void projectRead();
-    /** emitted when starting an entirely new project
+    /** Emitted when starting an entirely new project
         @note
         This is similar to projectRead(); plug-ins might want to be notified
         that they're in a new project.  Yes, projectRead() could have been
@@ -585,7 +593,7 @@ class GUI_EXPORT QgisInterface : public QObject
       */
     void newProjectCreated();
 
-    /**This signal is emitted when a layer has been saved using save as
+    /** This signal is emitted when a layer has been saved using save as
        @note
        added in version 2.7
     */