Show favorited legend patches in legend patch button menu

qgis · Apr 22, 2020 · ec2894e · ec2894e
1 parent 8a0e007
commit ec2894e
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 32 deletions.
diff --git a/python/core/auto_generated/symbology/qgsstyle.sip.in b/python/core/auto_generated/symbology/qgsstyle.sip.in
@@ -636,6 +636,15 @@ Changes a legend patch shape's name.
 %Docstring
 Returns a list of names of legend patch shapes in the style.
 
+.. versionadded:: 3.14
+%End
+
+    const QgsSymbol *previewSymbolForPatchShape( const QgsLegendPatchShape &shape ) const;
+%Docstring
+Returns a symbol to use for rendering preview icons for a patch ``shape``.
+
+Ownership of the symbol is not transferred.
+
 .. versionadded:: 3.14
 %End
 

diff --git a/src/core/symbology/qgsstyle.cpp b/src/core/symbology/qgsstyle.cpp
@@ -53,6 +53,13 @@ enum LegendPatchTable
 
 QgsStyle *QgsStyle::sDefaultStyle = nullptr;
 
+QgsStyle::QgsStyle()
+{
+  mPatchMarkerSymbol.reset( QgsMarkerSymbol::createSimple( QgsStringMap() ) );
+  mPatchLineSymbol.reset( QgsLineSymbol::createSimple( QgsStringMap() ) );
+  mPatchFillSymbol.reset( QgsFillSymbol::createSimple( QgsStringMap() ) );
+}
+
 QgsStyle::~QgsStyle()
 {
   clear();
@@ -1920,6 +1927,25 @@ QStringList QgsStyle::legendPatchShapeNames() const
   return mLegendPatchShapes.keys();
 }
 
+const QgsSymbol *QgsStyle::previewSymbolForPatchShape( const QgsLegendPatchShape &shape ) const
+{
+  switch ( shape.symbolType() )
+  {
+    case QgsSymbol::Marker:
+      return mPatchMarkerSymbol.get();
+
+    case QgsSymbol::Line:
+      return mPatchLineSymbol.get();
+
+    case QgsSymbol::Fill:
+      return mPatchFillSymbol.get();
+
+    case QgsSymbol::Hybrid:
+      break;
+  }
+  return nullptr;
+}
+
 int QgsStyle::tagId( const QString &name )
 {
   return getId( QStringLiteral( "tag" ), name );

diff --git a/src/core/symbology/qgsstyle.h b/src/core/symbology/qgsstyle.h
@@ -165,7 +165,7 @@ class CORE_EXPORT QgsStyle : public QObject
     /**
      * Constructor for QgsStyle.
      */
-    QgsStyle() = default;
+    QgsStyle();
     ~QgsStyle() override;
 
     /**
@@ -663,6 +663,15 @@ class CORE_EXPORT QgsStyle : public QObject
      */
     QStringList legendPatchShapeNames() const;
 
+    /**
+     * Returns a symbol to use for rendering preview icons for a patch \a shape.
+     *
+     * Ownership of the symbol is not transferred.
+     *
+     * \since QGIS 3.14
+     */
+    const QgsSymbol *previewSymbolForPatchShape( const QgsLegendPatchShape &shape ) const;
+
     /**
      * Returns the default legend patch shape for the given symbol \a type.
      *
@@ -1007,6 +1016,10 @@ class CORE_EXPORT QgsStyle : public QObject
 
     sqlite3_database_unique_ptr mCurrentDB;
 
+    std::unique_ptr< QgsSymbol > mPatchMarkerSymbol;
+    std::unique_ptr< QgsSymbol > mPatchLineSymbol;
+    std::unique_ptr< QgsSymbol > mPatchFillSymbol;
+
     mutable QHash< QgsSymbol::SymbolType, QHash< QSizeF, QgsLegendPatchShape > > mDefaultPatchCache;
     mutable QHash< QgsSymbol::SymbolType, QHash< QSizeF, QList< QList< QPolygonF > > > > mDefaultPatchQPolygonFCache;
 

diff --git a/src/core/symbology/qgsstylemodel.cpp b/src/core/symbology/qgsstylemodel.cpp
@@ -33,10 +33,6 @@ QgsStyleModel::QgsStyleModel( QgsStyle *style, QObject *parent )
 {
   Q_ASSERT( mStyle );
 
-  mPatchMarkerSymbol.reset( QgsMarkerSymbol::createSimple( QgsStringMap() ) );
-  mPatchLineSymbol.reset( QgsLineSymbol::createSimple( QgsStringMap() ) );
-  mPatchFillSymbol.reset( QgsFillSymbol::createSimple( QgsStringMap() ) );
-
   for ( QgsStyle::StyleEntity entity : ENTITIES )
   {
     mEntityNames.insert( entity, mStyle->allNames( entity ) );
@@ -165,7 +161,7 @@ QVariant QgsStyleModel::data( const QModelIndex &index, int role ) const
                 int height = static_cast< int >( width / 1.61803398875 ); // golden ratio
 
                 const QgsLegendPatchShape shape = mStyle->legendPatchShape( name );
-                if ( QgsSymbol *symbol = symbolForPatchShape( shape ) )
+                if ( const QgsSymbol *symbol = mStyle->previewSymbolForPatchShape( shape ) )
                 {
                   QPixmap pm = QgsSymbolLayerUtils::symbolPreviewPixmap( symbol, QSize( width, height ), height / 20, nullptr, false, nullptr, &shape );
                   QByteArray data;
@@ -304,7 +300,7 @@ QVariant QgsStyleModel::data( const QModelIndex &index, int role ) const
               const QgsLegendPatchShape shape = mStyle->legendPatchShape( name );
               if ( !shape.isNull() )
               {
-                if ( QgsSymbol *symbol = symbolForPatchShape( shape ) )
+                if ( const QgsSymbol *symbol = mStyle->previewSymbolForPatchShape( shape ) )
                 {
                   if ( mAdditionalSizes.isEmpty() )
                     icon.addPixmap( QgsSymbolLayerUtils::symbolPreviewPixmap( symbol, QSize( 24, 24 ), 1, nullptr, false, mExpressionContext.get(), &shape ) );
@@ -609,25 +605,6 @@ QgsStyle::StyleEntity QgsStyleModel::entityTypeFromRow( int row ) const
   return QgsStyle::SymbolEntity;
 }
 
-QgsSymbol *QgsStyleModel::symbolForPatchShape( const QgsLegendPatchShape &shape ) const
-{
-  switch ( shape.symbolType() )
-  {
-    case QgsSymbol::Marker:
-      return mPatchMarkerSymbol.get();
-
-    case QgsSymbol::Line:
-      return mPatchLineSymbol.get();
-
-    case QgsSymbol::Fill:
-      return mPatchFillSymbol.get();
-
-    case QgsSymbol::Hybrid:
-      break;
-  }
-  return nullptr;
-}
-
 int QgsStyleModel::offsetForEntity( QgsStyle::StyleEntity entity ) const
 {
   int offset = 0;

diff --git a/src/core/symbology/qgsstylemodel.h b/src/core/symbology/qgsstylemodel.h
@@ -118,14 +118,8 @@ class CORE_EXPORT QgsStyleModel: public QAbstractItemModel
 
     mutable QHash< QgsStyle::StyleEntity, QHash< QString, QIcon > > mIconCache;
 
-    std::unique_ptr< QgsSymbol > mPatchMarkerSymbol;
-    std::unique_ptr< QgsSymbol > mPatchLineSymbol;
-    std::unique_ptr< QgsSymbol > mPatchFillSymbol;
-
     QgsStyle::StyleEntity entityTypeFromRow( int row ) const;
 
-    QgsSymbol *symbolForPatchShape( const QgsLegendPatchShape &shape ) const;
-
     int offsetForEntity( QgsStyle::StyleEntity entity ) const;
 
 };

diff --git a/src/gui/qgslegendpatchshapebutton.cpp b/src/gui/qgslegendpatchshapebutton.cpp
@@ -16,6 +16,7 @@
 #include "qgslegendpatchshapebutton.h"
 #include "qgslegendpatchshapewidget.h"
 #include "qgis.h"
+#include "qgsguiutils.h"
 #include <QMenu>
 
 QgsLegendPatchShapeButton::QgsLegendPatchShapeButton( QWidget *parent, const QString &dialogTitle )
@@ -187,6 +188,35 @@ void QgsLegendPatchShapeButton::prepareMenu()
   mMenu->addAction( defaultAction );
   connect( defaultAction, &QAction::triggered, this, [ = ] { setToDefault(); emit changed(); } );
 
+  mMenu->addSeparator();
+
+  QStringList patchNames = QgsStyle::defaultStyle()->symbolsOfFavorite( QgsStyle::LegendPatchShapeEntity );
+  patchNames.sort();
+  const int iconSize = QgsGuiUtils::scaleIconSize( 16 );
+  for ( const QString &name : qgis::as_const( patchNames ) )
+  {
+    const QgsLegendPatchShape shape = QgsStyle::defaultStyle()->legendPatchShape( name );
+    if ( shape.symbolType() == mType )
+    {
+      if ( const QgsSymbol *symbol = QgsStyle::defaultStyle()->previewSymbolForPatchShape( shape ) )
+      {
+        QIcon icon = QgsSymbolLayerUtils::symbolPreviewPixmap( symbol, QSize( iconSize, iconSize ), 1, nullptr, false, nullptr, &shape );
+        QAction *action = new QAction( name, this );
+        action->setIcon( icon );
+        connect( action, &QAction::triggered, this, [ = ] { loadPatchFromStyle( name ); } );
+        mMenu->addAction( action );
+      }
+    }
+  }
+}
+
+void QgsLegendPatchShapeButton::loadPatchFromStyle( const QString &name )
+{
+  if ( !QgsStyle::defaultStyle()->legendPatchShapeNames().contains( name ) )
+    return;
+
+  const QgsLegendPatchShape newShape = QgsStyle::defaultStyle()->legendPatchShape( name );
+  setShape( newShape );
 }
 
 void QgsLegendPatchShapeButton::changeEvent( QEvent *e )

diff --git a/src/gui/qgslegendpatchshapebutton.h b/src/gui/qgslegendpatchshapebutton.h
@@ -145,6 +145,8 @@ class GUI_EXPORT QgsLegendPatchShapeButton : public QToolButton
      */
     void prepareMenu();
 
+    void loadPatchFromStyle( const QString &name );
+
   private:
 
     QgsLegendPatchShape mShape;