Correctly handle item focusing in layout designer

Author: nyalldawson

python/gui/layout/qgslayoutview.sip

@@ -229,6 +229,12 @@ class QgsLayoutView: QGraphicsView
 .. seealso:: pushStatusMessage()
 %End
 
+    void itemFocused( QgsLayoutItem *item );
+%Docstring
+ Emitted when an ``item`` is "focused" in the view, i.e. it becomes the active
+ item and should have its properties displayed in any designer windows.
+%End
+
   protected:
     virtual void mousePressEvent( QMouseEvent *event );
 

python/gui/layout/qgslayoutviewtool.sip

@@ -159,6 +159,12 @@ class QgsLayoutViewTool : QObject
  Emitted when the tool is deactivated.
 %End
 
+    void itemFocused( QgsLayoutItem *item );
+%Docstring
+ Emitted when an ``item`` is "focused" by the tool, i.e. it should become the active
+ item and should have its properties displayed in any designer windows.
+%End
+
   protected:
 
     void setFlags( const QgsLayoutViewTool::Flags flags );

src/app/layout/qgslayoutdesignerdialog.cpp

@@ -249,6 +249,11 @@ QgsLayoutDesignerDialog::QgsLayoutDesignerDialog( QWidget *parent, Qt::WindowFla
   connect( mHorizontalRuler, &QgsLayoutRuler::cursorPosChanged, this, &QgsLayoutDesignerDialog::updateStatusCursorPos );
   connect( mVerticalRuler, &QgsLayoutRuler::cursorPosChanged, this, &QgsLayoutDesignerDialog::updateStatusCursorPos );
 
+  connect( mView, &QgsLayoutView::itemFocused, this, [ = ]( QgsLayoutItem * item )
+  {
+    showItemOptions( item, false );
+  } );
+
   // Panel and toolbar submenus
   mToolbarMenu->addAction( mLayoutToolbar->toggleViewAction() );
   mToolbarMenu->addAction( mNavigationToolbar->toggleViewAction() );
@@ -372,7 +377,7 @@ void QgsLayoutDesignerDialog::setIconSizes( int size )
   }
 }
 
-void QgsLayoutDesignerDialog::showItemOptions( QgsLayoutItem *item )
+void QgsLayoutDesignerDialog::showItemOptions( QgsLayoutItem *item, bool bringPanelToFront )
 {
   if ( !item )
   {
@@ -394,7 +399,8 @@ void QgsLayoutDesignerDialog::showItemOptions( QgsLayoutItem *item )
   } );
 
   mItemPropertiesStack->setMainPanel( widget.release() );
-  mItemDock->setUserVisible( true );
+  if ( bringPanelToFront )
+    mItemDock->setUserVisible( true );
 
 }
 

src/app/layout/qgslayoutdesignerdialog.h

@@ -96,8 +96,11 @@ class QgsLayoutDesignerDialog: public QMainWindow, private Ui::QgsLayoutDesigner
 
     /**
      * Shows the configuration widget for the specified layout \a item.
+     *
+     * If \a bringPanelToFront is true, then the item properties panel will be automatically
+     * shown and raised to the top of the interface.
      */
-    void showItemOptions( QgsLayoutItem *item );
+    void showItemOptions( QgsLayoutItem *item, bool bringPanelToFront = true );
 
   public slots:
 

src/gui/layout/qgslayoutview.cpp

@@ -68,6 +68,8 @@ void QgsLayoutView::setCurrentLayout( QgsLayout *layout )
   setScene( layout );
 
   connect( layout->pageCollection(), &QgsLayoutPageCollection::changed, this, &QgsLayoutView::viewChanged );
+  connect( layout, &QgsLayout::selectedItemChanged, this, &QgsLayoutView::itemFocused );
+
   viewChanged();
 
   mSnapMarker.reset( new QgsLayoutViewSnapMarker() );
@@ -113,6 +115,7 @@ void QgsLayoutView::setTool( QgsLayoutViewTool *tool )
   if ( mTool )
   {
     mTool->deactivate();
+    disconnect( mTool, &QgsLayoutViewTool::itemFocused, this, &QgsLayoutView::itemFocused );
   }
 
   mSnapMarker->hide();
@@ -125,6 +128,7 @@ void QgsLayoutView::setTool( QgsLayoutViewTool *tool )
   // to respond to whatever the current tool is
   tool->activate();
   mTool = tool;
+  connect( mTool, &QgsLayoutViewTool::itemFocused, this, &QgsLayoutView::itemFocused );
 
   emit toolSet( mTool );
 }

src/gui/layout/qgslayoutview.h

@@ -268,6 +268,12 @@ class GUI_EXPORT QgsLayoutView: public QGraphicsView
      */
     void statusMessage( const QString &message );
 
+    /**
+     * Emitted when an \a item is "focused" in the view, i.e. it becomes the active
+     * item and should have its properties displayed in any designer windows.
+     */
+    void itemFocused( QgsLayoutItem *item );
+
   protected:
     void mousePressEvent( QMouseEvent *event ) override;
     void mouseReleaseEvent( QMouseEvent *event ) override;

src/gui/layout/qgslayoutviewtool.h

@@ -28,6 +28,7 @@ class QKeyEvent;
 class QgsLayoutView;
 class QgsLayoutViewMouseEvent;
 class QgsLayout;
+class QgsLayoutItem;
 
 #ifdef SIP_RUN
 % ModuleHeaderCode
@@ -178,6 +179,12 @@ class GUI_EXPORT QgsLayoutViewTool : public QObject
      */
     void deactivated();
 
+    /**
+     * Emitted when an \a item is "focused" by the tool, i.e. it should become the active
+     * item and should have its properties displayed in any designer windows.
+     */
+    void itemFocused( QgsLayoutItem *item );
+
   protected:
 
     /**

src/gui/layout/qgslayoutviewtoolselect.cpp

@@ -112,21 +112,17 @@ void QgsLayoutViewToolSelect::layoutPressEvent( QgsLayoutViewMouseEvent *event )
     selectedItem->setSelected( false );
 
     //Check if we have any remaining selected items, and if so, update the item panel
-    QList<QgsLayoutItem *> selectedItems = layout()->selectedLayoutItems();
+    const QList<QgsLayoutItem *> selectedItems = layout()->selectedLayoutItems();
     if ( !selectedItems.isEmpty() )
     {
-#if 0 //TODO
-      emit selectedItemChanged( selectedItems.at( 0 ) );
-#endif
+      emit itemFocused( selectedItems.at( 0 ) );
     }
   }
   else
   {
     selectedItem->setSelected( true );
     event->ignore();
-#if 0 //TODO
-    emit selectedItemChanged( selectedItem );
-#endif
+    emit itemFocused( selectedItem );
   }
 }
 
@@ -216,14 +212,12 @@ void QgsLayoutViewToolSelect::layoutReleaseEvent( QgsLayoutViewMouseEvent *event
     }
   }
 
-#if 0 //TODO
   //update item panel
-  QList<QgsComposerItem *> selectedItemList = composition()->selectedComposerItems();
+  const QList<QgsLayoutItem *> selectedItemList = layout()->selectedLayoutItems();
   if ( !selectedItemList.isEmpty() )
   {
-    emit selectedItemChanged( selectedItemList[0] );
+    emit itemFocused( selectedItemList.at( 0 ) );
   }
-#endif
 }
 
 void QgsLayoutViewToolSelect::wheelEvent( QWheelEvent *event )