[FEATURE][layout] Add actions to auto resize items in a selection

nyalldawson · nyalldawson · commit e3616f08c40b · 2017-10-06T17:48:25.000+10:00
Options are resize to narrowest, widest, shortest and tallest.
diff --git a/python/core/layout/qgslayoutaligner.sip b/python/core/layout/qgslayoutaligner.sip
@@ -44,6 +44,14 @@ class QgsLayoutAligner
       DistributeBottom,
     };
 
+    enum Resize
+    {
+      ResizeNarrowest,
+      ResizeWidest,
+      ResizeShortest,
+      ResizeTallest,
+    };
+
     static void alignItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Alignment alignment );
 %Docstring
  Aligns a set of ``items`` from a ``layout`` in place.
@@ -58,6 +66,13 @@ class QgsLayoutAligner
  The ``distribution`` argument specifies the method to use when distributing the items.
 %End
 
+    static void resizeItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Resize resize );
+%Docstring
+ Resizes a set of ``items`` from a ``layout`` in place.
+
+ The ``resize`` argument specifies the method to use when resizing the items.
+%End
+
 };
 
 /************************************************************************
diff --git a/python/gui/layout/qgslayoutview.sip b/python/gui/layout/qgslayoutview.sip
@@ -131,12 +131,21 @@ class QgsLayoutView: QGraphicsView
 %Docstring
  Aligns all selected items using the specified ``alignment``.
 .. seealso:: distributeSelectedItems()
+.. seealso:: resizeSelectedItems()
 %End
 
     void distributeSelectedItems( QgsLayoutAligner::Distribution distribution );
 %Docstring
  Distributes all selected items using the specified ``distribution``.
- see alignSelectedItems()
+.. seealso:: alignSelectedItems()
+.. seealso:: resizeSelectedItems()
+%End
+
+    void resizeSelectedItems( QgsLayoutAligner::Resize resize );
+%Docstring
+ Resizes all selected items using the specified ``resize`` mode.
+.. seealso:: alignSelectedItems()
+.. seealso:: distributeSelectedItems()
 %End
 
   public slots:
diff --git a/src/app/layout/qgslayoutdesignerdialog.cpp b/src/app/layout/qgslayoutdesignerdialog.cpp
@@ -205,6 +205,17 @@ QgsLayoutDesignerDialog::QgsLayoutDesignerDialog( QWidget *parent, Qt::WindowFla
   distributeToolButton->setDefaultAction( mActionDistributeLeft );
   mActionsToolbar->addWidget( distributeToolButton );
 
+  QToolButton *resizeToolButton = new QToolButton( this );
+  resizeToolButton->setPopupMode( QToolButton::InstantPopup );
+  resizeToolButton->setAutoRaise( true );
+  resizeToolButton->setToolButtonStyle( Qt::ToolButtonIconOnly );
+  resizeToolButton->addAction( mActionResizeNarrowest );
+  resizeToolButton->addAction( mActionResizeWidest );
+  resizeToolButton->addAction( mActionResizeShortest );
+  resizeToolButton->addAction( mActionResizeTallest );
+  resizeToolButton->setDefaultAction( mActionResizeNarrowest );
+  mActionsToolbar->addWidget( resizeToolButton );
+
   mAddItemTool = new QgsLayoutViewToolAddItem( mView );
   mPanTool = new QgsLayoutViewToolPan( mView );
   mPanTool->setAction( mActionPan );
@@ -287,6 +298,22 @@ QgsLayoutDesignerDialog::QgsLayoutDesignerDialog( QWidget *parent, Qt::WindowFla
   {
     mView->distributeSelectedItems( QgsLayoutAligner::DistributeBottom );
   } );
+  connect( mActionResizeNarrowest, &QAction::triggered, this, [ = ]
+  {
+    mView->resizeSelectedItems( QgsLayoutAligner::ResizeNarrowest );
+  } );
+  connect( mActionResizeWidest, &QAction::triggered, this, [ = ]
+  {
+    mView->resizeSelectedItems( QgsLayoutAligner::ResizeWidest );
+  } );
+  connect( mActionResizeShortest, &QAction::triggered, this, [ = ]
+  {
+    mView->resizeSelectedItems( QgsLayoutAligner::ResizeShortest );
+  } );
+  connect( mActionResizeTallest, &QAction::triggered, this, [ = ]
+  {
+    mView->resizeSelectedItems( QgsLayoutAligner::ResizeTallest );
+  } );
 
   connect( mActionAddPages, &QAction::triggered, this, &QgsLayoutDesignerDialog::addPages );
 
diff --git a/src/core/layout/qgslayoutaligner.cpp b/src/core/layout/qgslayoutaligner.cpp
@@ -176,6 +176,74 @@ void QgsLayoutAligner::distributeItems( QgsLayout *layout, const QList<QgsLayout
   layout->undoStack()->endMacro();
 }
 
+void QgsLayoutAligner::resizeItems( QgsLayout *layout, const QList<QgsLayoutItem *> &items, QgsLayoutAligner::Resize resize )
+{
+  if ( items.size() < 2 )
+    return;
+
+  auto collectSize = [resize]( QgsLayoutItem * item )->double
+  {
+    QRectF itemBBox = item->sceneBoundingRect();
+    switch ( resize )
+    {
+      case ResizeNarrowest:
+      case ResizeWidest:
+        return itemBBox.width();
+      case ResizeShortest:
+      case ResizeTallest:
+        return itemBBox.height();
+    }
+    // no warnings
+    return itemBBox.width();
+  };
+
+  double newSize = collectSize( items.at( 0 ) );
+  for ( QgsLayoutItem *item : items )
+  {
+    double size = collectSize( item );
+    switch ( resize )
+    {
+      case ResizeNarrowest:
+      case ResizeShortest:
+        newSize = std::min( size, newSize );
+        break;
+      case ResizeTallest:
+      case ResizeWidest:
+        newSize = std::max( size, newSize );
+        break;
+    }
+  }
+
+  auto resizeItemToSize = [layout, resize]( QgsLayoutItem * item, double size )
+  {
+    QSizeF newSize = item->rect().size();
+    switch ( resize )
+    {
+      case ResizeNarrowest:
+      case ResizeWidest:
+        newSize.setWidth( size );
+        break;
+      case ResizeTallest:
+      case ResizeShortest:
+        newSize.setHeight( size );
+        break;
+    }
+
+    // need to keep item units
+    QgsLayoutSize newSizeWithUnits = layout->convertFromLayoutUnits( newSize, item->sizeWithUnits().units() );
+    item->attemptResize( newSizeWithUnits );
+  };
+
+  layout->undoStack()->beginMacro( undoText( resize ) );
+  for ( QgsLayoutItem *item : items )
+  {
+    layout->undoStack()->beginCommand( item, QString() );
+    resizeItemToSize( item, newSize );
+    layout->undoStack()->endCommand();
+  }
+  layout->undoStack()->endMacro();
+}
+
 QRectF QgsLayoutAligner::boundingRectOfItems( const QList<QgsLayoutItem *> &items )
 {
   if ( items.empty() )
@@ -235,6 +303,22 @@ QString QgsLayoutAligner::undoText( Distribution distribution )
   return QString(); //no warnings
 }
 
+QString QgsLayoutAligner::undoText( QgsLayoutAligner::Resize resize )
+{
+  switch ( resize )
+  {
+    case ResizeNarrowest:
+      return QObject::tr( "Resized items to narrowest" );
+    case ResizeWidest:
+      return QObject::tr( "Resized items to widest" );
+    case ResizeShortest:
+      return QObject::tr( "Resized items to shortest" );
+    case ResizeTallest:
+      return QObject::tr( "Resized items to tallest" );
+  }
+  return QString(); //no warnings
+}
+
 QString QgsLayoutAligner::undoText( Alignment alignment )
 {
   switch ( alignment )
diff --git a/src/core/layout/qgslayoutaligner.h b/src/core/layout/qgslayoutaligner.h
@@ -60,6 +60,15 @@ class CORE_EXPORT QgsLayoutAligner
       DistributeBottom, //!< Distribute bottom edges
     };
 
+    //! Resize options
+    enum Resize
+    {
+      ResizeNarrowest, //!< Resize width to match narrowest width
+      ResizeWidest, //!< Resize width to match widest width
+      ResizeShortest, //!< Resize height to match shortest height
+      ResizeTallest, //!< Resize height to match tallest height
+    };
+
     /**
      * Aligns a set of \a items from a \a layout in place.
      *
@@ -74,6 +83,13 @@ class CORE_EXPORT QgsLayoutAligner
      */
     static void distributeItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Distribution distribution );
 
+    /**
+     * Resizes a set of \a items from a \a layout in place.
+     *
+     * The \a resize argument specifies the method to use when resizing the items.
+     */
+    static void resizeItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Resize resize );
+
   private:
 
     /**
@@ -84,6 +100,7 @@ class CORE_EXPORT QgsLayoutAligner
 
     static QString undoText( Alignment alignment );
     static QString undoText( Distribution distribution );
+    static QString undoText( Resize resize );
 
 
 
diff --git a/src/gui/layout/qgslayoutview.cpp b/src/gui/layout/qgslayoutview.cpp
@@ -242,6 +242,12 @@ void QgsLayoutView::distributeSelectedItems( QgsLayoutAligner::Distribution dist
   QgsLayoutAligner::distributeItems( currentLayout(), selectedItems, distribution );
 }
 
+void QgsLayoutView::resizeSelectedItems( QgsLayoutAligner::Resize resize )
+{
+  const QList<QgsLayoutItem *> selectedItems = currentLayout()->selectedLayoutItems();
+  QgsLayoutAligner::resizeItems( currentLayout(), selectedItems, resize );
+}
+
 void QgsLayoutView::zoomFull()
 {
   fitInView( scene()->sceneRect(), Qt::KeepAspectRatio );
diff --git a/src/gui/layout/qgslayoutview.h b/src/gui/layout/qgslayoutview.h
@@ -161,15 +161,24 @@ class GUI_EXPORT QgsLayoutView: public QGraphicsView
     /**
      * Aligns all selected items using the specified \a alignment.
      * \see distributeSelectedItems()
+     * \see resizeSelectedItems()
      */
     void alignSelectedItems( QgsLayoutAligner::Alignment alignment );
 
     /**
      * Distributes all selected items using the specified \a distribution.
-     * see alignSelectedItems()
+     * \see alignSelectedItems()
+     * \see resizeSelectedItems()
      */
     void distributeSelectedItems( QgsLayoutAligner::Distribution distribution );
 
+    /**
+     * Resizes all selected items using the specified \a resize mode.
+     * \see alignSelectedItems()
+     * \see distributeSelectedItems()
+     */
+    void resizeSelectedItems( QgsLayoutAligner::Resize resize );
+
   public slots:
 
     /**
diff --git a/src/ui/layout/qgslayoutdesignerbase.ui b/src/ui/layout/qgslayoutdesignerbase.ui
@@ -180,6 +180,16 @@
      <addaction name="mActionDistributeVCenter"/>
      <addaction name="mActionDistributeBottom"/>
     </widget>
+    <widget class="QMenu" name="menuResize">
+     <property name="title">
+      <string>Re&amp;size</string>
+     </property>
+     <addaction name="mActionResizeNarrowest"/>
+     <addaction name="mActionResizeWidest"/>
+     <addaction name="separator"/>
+     <addaction name="mActionResizeShortest"/>
+     <addaction name="mActionResizeTallest"/>
+    </widget>
     <addaction name="mActionRaiseItems"/>
     <addaction name="mActionLowerItems"/>
     <addaction name="mActionMoveItemsToTop"/>
@@ -190,6 +200,7 @@
     <addaction name="separator"/>
     <addaction name="menuAlign_Items"/>
     <addaction name="menu_Distribute_Items"/>
+    <addaction name="menuResize"/>
    </widget>
    <addaction name="mLayoutMenu"/>
    <addaction name="menuEdit"/>
@@ -835,6 +846,54 @@
     <string>Distributes bottom edges of items equidistantly</string>
    </property>
   </action>
+  <action name="mActionResizeNarrowest">
+   <property name="icon">
+    <iconset resource="../../../images/images.qrc">
+     <normaloff>:/images/themes/default/mActionAlignLeft.svg</normaloff>:/images/themes/default/mActionAlignLeft.svg</iconset>
+   </property>
+   <property name="text">
+    <string>&amp;Narrowest</string>
+   </property>
+   <property name="toolTip">
+    <string>Resizes item width to match the narrowest selected item</string>
+   </property>
+  </action>
+  <action name="mActionResizeWidest">
+   <property name="icon">
+    <iconset resource="../../../images/images.qrc">
+     <normaloff>:/images/themes/default/mActionAlignHCenter.svg</normaloff>:/images/themes/default/mActionAlignHCenter.svg</iconset>
+   </property>
+   <property name="text">
+    <string>&amp;Widest</string>
+   </property>
+   <property name="toolTip">
+    <string>Resizes item width to match the widest selected item</string>
+   </property>
+  </action>
+  <action name="mActionResizeShortest">
+   <property name="icon">
+    <iconset resource="../../../images/images.qrc">
+     <normaloff>:/images/themes/default/mActionAlignRight.svg</normaloff>:/images/themes/default/mActionAlignRight.svg</iconset>
+   </property>
+   <property name="text">
+    <string>&amp;Shortest</string>
+   </property>
+   <property name="toolTip">
+    <string>Resizes item height to match the shortest selected item</string>
+   </property>
+  </action>
+  <action name="mActionResizeTallest">
+   <property name="icon">
+    <iconset resource="../../../images/images.qrc">
+     <normaloff>:/images/themes/default/mActionAlignTop.svg</normaloff>:/images/themes/default/mActionAlignTop.svg</iconset>
+   </property>
+   <property name="text">
+    <string>&amp;Tallest</string>
+   </property>
+   <property name="toolTip">
+    <string>Resizes item height to match the tallest selected item</string>
+   </property>
+  </action>
  </widget>
  <resources>
   <include location="../../../images/images.qrc"/>
diff --git a/tests/src/python/test_qgslayoutaligner.py b/tests/src/python/test_qgslayoutaligner.py
@@ -188,6 +188,47 @@ def testDistribute(self):
         self.assertEqual(item3.positionWithUnits().units(), QgsUnitTypes.LayoutCentimeters)
         self.assertEqual(item3.sizeWithUnits(), QgsLayoutSize(1.8, 1.6, QgsUnitTypes.LayoutCentimeters))
 
+    def testResize(self):
+        p = QgsProject()
+        l = QgsLayout(p)
+
+        # add some items
+        item1 = QgsLayoutItemMap(l)
+        item1.attemptMove(QgsLayoutPoint(4, 8, QgsUnitTypes.LayoutMillimeters))
+        item1.attemptResize(QgsLayoutSize(18, 12, QgsUnitTypes.LayoutMillimeters))
+        l.addItem(item1)
+        item2 = QgsLayoutItemMap(l)
+        item2.attemptMove(QgsLayoutPoint(7, 10, QgsUnitTypes.LayoutMillimeters))
+        item2.attemptResize(QgsLayoutSize(10, 9, QgsUnitTypes.LayoutMillimeters))
+        l.addItem(item2)
+        item3 = QgsLayoutItemMap(l)
+        item3.attemptMove(QgsLayoutPoint(0.8, 1.2, QgsUnitTypes.LayoutCentimeters))
+        item3.attemptResize(QgsLayoutSize(1.8, 1.6, QgsUnitTypes.LayoutCentimeters))
+        l.addItem(item3)
+
+        QgsLayoutAligner.resizeItems(l, [item1, item2, item3], QgsLayoutAligner.ResizeNarrowest)
+        self.assertEqual(item1.sizeWithUnits(), QgsLayoutSize(10, 12, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item2.sizeWithUnits(), QgsLayoutSize(10, 9, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item3.sizeWithUnits(), QgsLayoutSize(1.0, 1.6, QgsUnitTypes.LayoutCentimeters))
+        l.undoStack().stack().undo()
+
+        QgsLayoutAligner.resizeItems(l, [item1, item2, item3], QgsLayoutAligner.ResizeWidest)
+        self.assertEqual(item1.sizeWithUnits(), QgsLayoutSize(18, 12, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item2.sizeWithUnits(), QgsLayoutSize(18, 9, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item3.sizeWithUnits(), QgsLayoutSize(1.8, 1.6, QgsUnitTypes.LayoutCentimeters))
+        l.undoStack().stack().undo()
+
+        QgsLayoutAligner.resizeItems(l, [item1, item2, item3], QgsLayoutAligner.ResizeShortest)
+        self.assertEqual(item1.sizeWithUnits(), QgsLayoutSize(18, 9, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item2.sizeWithUnits(), QgsLayoutSize(10, 9, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item3.sizeWithUnits(), QgsLayoutSize(1.8, 0.9, QgsUnitTypes.LayoutCentimeters))
+        l.undoStack().stack().undo()
+
+        QgsLayoutAligner.resizeItems(l, [item1, item2, item3], QgsLayoutAligner.ResizeTallest)
+        self.assertEqual(item1.sizeWithUnits(), QgsLayoutSize(18, 16, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item2.sizeWithUnits(), QgsLayoutSize(10, 16, QgsUnitTypes.LayoutMillimeters))
+        self.assertEqual(item3.sizeWithUnits(), QgsLayoutSize(1.8, 1.6, QgsUnitTypes.LayoutCentimeters))
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/tests/src/python/test_qgslayoutview.py b/tests/src/python/test_qgslayoutview.py

Original file line number	Diff line number	Diff line change
`@@ -242,6 +242,12 @@ void QgsLayoutView::distributeSelectedItems( QgsLayoutAligner::Distribution dist`
`242`	`242`	`QgsLayoutAligner::distributeItems( currentLayout(), selectedItems, distribution );`
`243`	`243`	`}`
`244`	`244`
	`245`	`+void QgsLayoutView::resizeSelectedItems( QgsLayoutAligner::Resize resize )`
	`246`	`+{`
	`247`	`+ const QList<QgsLayoutItem *> selectedItems = currentLayout()->selectedLayoutItems();`
	`248`	`+ QgsLayoutAligner::resizeItems( currentLayout(), selectedItems, resize );`
	`249`	`+}`
	`250`	`+`
`245`	`251`	`void QgsLayoutView::zoomFull()`
`246`	`252`	`{`
`247`	`253`	`fitInView( scene()->sceneRect(), Qt::KeepAspectRatio );`