[layouts] add icons for items and use those in the items panel

qgis · Dec 21, 2017 · 0a40a81 · 0a40a81
1 parent 1f6d1a6
commit 0a40a81
Show file tree

Hide file tree

Showing 52 changed files with 161 additions and 2 deletions.
diff --git a/images/images.qrc b/images/images.qrc
@@ -434,6 +434,19 @@
         <file>themes/default/mIconWms.svg</file>
         <file>themes/default/mIconZip.png</file>
         <file>themes/default/mIconZoom.svg</file>
+        <file>themes/default/mLayoutItem.svg</file>
+        <file>themes/default/mLayoutItemShapeEllipse.svg</file>
+        <file>themes/default/mLayoutItemShapeRectangle.svg</file>
+        <file>themes/default/mLayoutItemShapeTriangle.svg</file>
+        <file>themes/default/mLayoutItemHtml.svg</file>
+        <file>themes/default/mLayoutItemPicture.svg</file>
+        <file>themes/default/mLayoutItemLabel.svg</file>
+        <file>themes/default/mLayoutItemLegend.svg</file>
+        <file>themes/default/mLayoutItemMap.svg</file>
+        <file>themes/default/mLayoutItemPolygon.svg</file>
+        <file>themes/default/mLayoutItemPolyline.svg</file>
+        <file>themes/default/mLayoutItemScaleBar.svg</file>
+        <file>themes/default/mLayoutItemTable.svg</file>
         <file>themes/default/mMessageLog.svg</file>
         <file>themes/default/mMessageLogRead.svg</file>
         <file>themes/default/north_arrow.png</file>

diff --git a/images/themes/default/mLayoutItem.svg b/images/themes/default/mLayoutItem.svg
diff --git a/images/themes/default/mLayoutItemHtml.svg b/images/themes/default/mLayoutItemHtml.svg
diff --git a/images/themes/default/mLayoutItemLabel.svg b/images/themes/default/mLayoutItemLabel.svg
diff --git a/images/themes/default/mLayoutItemLegend.svg b/images/themes/default/mLayoutItemLegend.svg
diff --git a/images/themes/default/mLayoutItemMap.svg b/images/themes/default/mLayoutItemMap.svg
diff --git a/images/themes/default/mLayoutItemPicture.svg b/images/themes/default/mLayoutItemPicture.svg
diff --git a/images/themes/default/mLayoutItemPolygon.svg b/images/themes/default/mLayoutItemPolygon.svg
diff --git a/images/themes/default/mLayoutItemPolyline.svg b/images/themes/default/mLayoutItemPolyline.svg
diff --git a/images/themes/default/mLayoutItemScaleBar.svg b/images/themes/default/mLayoutItemScaleBar.svg
diff --git a/images/themes/default/mLayoutItemShapeEllipse.svg b/images/themes/default/mLayoutItemShapeEllipse.svg
diff --git a/images/themes/default/mLayoutItemShapeRectangle.svg b/images/themes/default/mLayoutItemShapeRectangle.svg
diff --git a/images/themes/default/mLayoutItemShapeTriangle.svg b/images/themes/default/mLayoutItemShapeTriangle.svg
diff --git a/images/themes/default/mLayoutItemTable.svg b/images/themes/default/mLayoutItemTable.svg
diff --git a/python/core/layout/qgslayoutframe.sip b/python/core/layout/qgslayoutframe.sip
@@ -35,6 +35,8 @@ Creates a new QgsLayoutFrame belonging to the specified ``layout``.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
     virtual QString uuid() const;
 
 

diff --git a/python/core/layout/qgslayoutitem.sip b/python/core/layout/qgslayoutitem.sip
@@ -262,9 +262,14 @@ tasks.
     virtual int type() const;
 
 %Docstring
-Return unique graphics item type identifier.
+Returns a unique graphics item type identifier.
 
 Plugin based subclasses should return an identifier greater than QgsLayoutItemRegistry.PluginItem.
+%End
+
+    virtual QIcon icon() const;
+%Docstring
+Returns the item's icon.
 %End
 
     virtual QString uuid() const;

diff --git a/python/core/layout/qgslayoutitemattributetable.sip b/python/core/layout/qgslayoutitemattributetable.sip
@@ -39,6 +39,8 @@ Ownership is transferred to the layout.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
     virtual QString displayName() const;
 
 

diff --git a/python/core/layout/qgslayoutitemhtml.sip b/python/core/layout/qgslayoutitemhtml.sip
@@ -39,6 +39,8 @@ Ownership is transferred to the layout.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
 
     static QgsLayoutItemHtml *create( QgsLayout *layout ) /Factory/;
 %Docstring

diff --git a/python/core/layout/qgslayoutitemlabel.sip b/python/core/layout/qgslayoutitemlabel.sip
@@ -42,6 +42,8 @@ The caller takes responsibility for deleting the returned object.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
     virtual QString displayName() const;
 
 

diff --git a/python/core/layout/qgslayoutitemlegend.sip b/python/core/layout/qgslayoutitemlegend.sip
@@ -65,6 +65,8 @@ The caller takes responsibility for deleting the returned object.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
     virtual QString displayName() const;
 
 

diff --git a/python/core/layout/qgslayoutitemmap.sip b/python/core/layout/qgslayoutitemmap.sip
@@ -39,6 +39,8 @@ Constructor for QgsLayoutItemMap, with the specified parent ``layout``.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
 
     void assignFreeId();
 %Docstring

diff --git a/python/core/layout/qgslayoutitempicture.sip b/python/core/layout/qgslayoutitempicture.sip
@@ -51,6 +51,8 @@ Constructor for QgsLayoutItemPicture, with the specified parent ``layout``.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
 
     static QgsLayoutItemPicture *create( QgsLayout *layout ) /Factory/;
 %Docstring

diff --git a/python/core/layout/qgslayoutitempolygon.sip b/python/core/layout/qgslayoutitempolygon.sip
@@ -43,6 +43,8 @@ The caller takes responsibility for deleting the returned object.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
     virtual QString displayName() const;
 
 

diff --git a/python/core/layout/qgslayoutitempolyline.sip b/python/core/layout/qgslayoutitempolyline.sip
@@ -49,6 +49,8 @@ The caller takes responsibility for deleting the returned object.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
     virtual QString displayName() const;
 
 

diff --git a/python/core/layout/qgslayoutitemscalebar.sip b/python/core/layout/qgslayoutitemscalebar.sip
@@ -28,6 +28,8 @@ Constructor for QgsLayoutItemScaleBar, with the specified parent ``layout``.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
 
     static QgsLayoutItemScaleBar *create( QgsLayout *layout ) /Factory/;
 %Docstring

diff --git a/python/core/layout/qgslayoutitemshape.sip b/python/core/layout/qgslayoutitemshape.sip
@@ -36,6 +36,8 @@ Constructor for QgsLayoutItemShape, with the specified parent ``layout``.
 
     virtual int type() const;
 
+    virtual QIcon icon() const;
+
 
     virtual QString displayName() const;
 

diff --git a/python/core/layout/qgslayoutmultiframe.sip b/python/core/layout/qgslayoutmultiframe.sip
@@ -73,6 +73,11 @@ Returns the total size of the multiframe's content, in layout units.
     virtual int type() const = 0;
 %Docstring
 Returns unique multiframe type id.
+%End
+
+    virtual QIcon icon() const;
+%Docstring
+Returns the item's icon.
 %End
 
     virtual QSizeF fixedFrameSize( const int frameIndex = -1 ) const;

diff --git a/src/core/layout/qgslayoutframe.cpp b/src/core/layout/qgslayoutframe.cpp
@@ -110,6 +110,14 @@ int QgsLayoutFrame::type() const
   return QgsLayoutItemRegistry::LayoutFrame;
 }
 
+QIcon QgsLayoutFrame::icon() const
+{
+  if ( mMultiFrame )
+    return mMultiFrame->icon();
+  else
+    return QIcon();
+}
+
 QString QgsLayoutFrame::uuid() const
 {
   if ( mMultiFrame )

diff --git a/src/core/layout/qgslayoutframe.h b/src/core/layout/qgslayoutframe.h
@@ -46,6 +46,7 @@ class CORE_EXPORT QgsLayoutFrame: public QgsLayoutItem
     static QgsLayoutFrame *create( QgsLayout *layout ) SIP_FACTORY;
 
     int type() const override;
+    QIcon icon() const override;
     QString uuid() const override;
 
     //Overridden to allow multiframe to set display name

diff --git a/src/core/layout/qgslayoutitem.h b/src/core/layout/qgslayoutitem.h
@@ -25,6 +25,7 @@
 #include "qgslayoutundocommand.h"
 #include "qgslayoutmeasurement.h"
 #include <QGraphicsRectItem>
+#include <QIcon>
 #include <QPainter>
 
 class QgsLayout;
@@ -292,12 +293,17 @@ class CORE_EXPORT QgsLayoutItem : public QgsLayoutObject, public QGraphicsRectIt
     virtual void cleanup();
 
     /**
-     * Return unique graphics item type identifier.
+     * Returns a unique graphics item type identifier.
      *
      * Plugin based subclasses should return an identifier greater than QgsLayoutItemRegistry::PluginItem.
      */
     int type() const override;
 
+    /**
+     * Returns the item's icon.
+     */
+    virtual QIcon icon() const { return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItem.svg" ) ); }
+
     /**
      * Returns the item identification string. This is a unique random string set for the item
      * upon creation.

diff --git a/src/core/layout/qgslayoutitemattributetable.cpp b/src/core/layout/qgslayoutitemattributetable.cpp
@@ -95,6 +95,11 @@ int QgsLayoutItemAttributeTable::type() const
   return QgsLayoutItemRegistry::LayoutAttributeTable;
 }
 
+QIcon QgsLayoutItemAttributeTable::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemTable.svg" ) );
+}
+
 QgsLayoutItemAttributeTable *QgsLayoutItemAttributeTable::create( QgsLayout *layout )
 {
   return new QgsLayoutItemAttributeTable( layout );

diff --git a/src/core/layout/qgslayoutitemattributetable.h b/src/core/layout/qgslayoutitemattributetable.h
@@ -56,6 +56,7 @@ class CORE_EXPORT QgsLayoutItemAttributeTable: public QgsLayoutTable
     QgsLayoutItemAttributeTable( QgsLayout *layout SIP_TRANSFERTHIS );
 
     int type() const override;
+    QIcon icon() const override;
     QString displayName() const override;
 
     /**

diff --git a/src/core/layout/qgslayoutitemhtml.cpp b/src/core/layout/qgslayoutitemhtml.cpp
@@ -81,6 +81,11 @@ int QgsLayoutItemHtml::type() const
   return QgsLayoutItemRegistry::LayoutHtml;
 }
 
+QIcon QgsLayoutItemHtml::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemHtml.svg" ) );
+}
+
 QgsLayoutItemHtml *QgsLayoutItemHtml::create( QgsLayout *layout )
 {
   return new QgsLayoutItemHtml( layout );

diff --git a/src/core/layout/qgslayoutitemhtml.h b/src/core/layout/qgslayoutitemhtml.h
@@ -56,6 +56,7 @@ class CORE_EXPORT QgsLayoutItemHtml: public QgsLayoutMultiFrame
     ~QgsLayoutItemHtml() override;
 
     int type() const override;
+    QIcon icon() const override;
 
     /**
      * Returns a new QgsLayoutItemHtml for the specified parent \a layout.

diff --git a/src/core/layout/qgslayoutitemlabel.cpp b/src/core/layout/qgslayoutitemlabel.cpp
@@ -102,6 +102,11 @@ int QgsLayoutItemLabel::type() const
   return QgsLayoutItemRegistry::LayoutLabel;
 }
 
+QIcon QgsLayoutItemLabel::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemLabel.svg" ) );
+}
+
 void QgsLayoutItemLabel::draw( QgsRenderContext &context, const QStyleOptionGraphicsItem * )
 {
   QPainter *painter = context.painter();

diff --git a/src/core/layout/qgslayoutitemlabel.h b/src/core/layout/qgslayoutitemlabel.h
@@ -57,6 +57,7 @@ class CORE_EXPORT QgsLayoutItemLabel: public QgsLayoutItem
     static QgsLayoutItemLabel *create( QgsLayout *layout ) SIP_FACTORY;
 
     int type() const override;
+    QIcon icon() const override;
     //Overridden to contain part of label's text
     QString displayName() const override;
 

diff --git a/src/core/layout/qgslayoutitemlegend.cpp b/src/core/layout/qgslayoutitemlegend.cpp
@@ -58,6 +58,11 @@ int QgsLayoutItemLegend::type() const
   return QgsLayoutItemRegistry::LayoutLegend;
 }
 
+QIcon QgsLayoutItemLegend::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemLegend.svg" ) );
+}
+
 void QgsLayoutItemLegend::paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget )
 {
   if ( !painter )

diff --git a/src/core/layout/qgslayoutitemlegend.h b/src/core/layout/qgslayoutitemlegend.h
@@ -77,6 +77,7 @@ class CORE_EXPORT QgsLayoutItemLegend : public QgsLayoutItem
     static QgsLayoutItemLegend *create( QgsLayout *layout ) SIP_FACTORY;
 
     int type() const override;
+    QIcon icon() const override;
     //Overridden to show legend title
     QString displayName() const override;
 

diff --git a/src/core/layout/qgslayoutitemmap.cpp b/src/core/layout/qgslayoutitemmap.cpp
@@ -75,6 +75,11 @@ int QgsLayoutItemMap::type() const
   return QgsLayoutItemRegistry::LayoutMap;
 }
 
+QIcon QgsLayoutItemMap::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemMap.svg" ) );
+}
+
 void QgsLayoutItemMap::assignFreeId()
 {
   if ( !mLayout )

diff --git a/src/core/layout/qgslayoutitemmap.h b/src/core/layout/qgslayoutitemmap.h
@@ -70,6 +70,7 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem
     ~QgsLayoutItemMap() override;
 
     int type() const override;
+    QIcon icon() const override;
 
     /**
      * Sets the map id() to a number not yet used in the layout. The existing id() is kept if it is not in use.

diff --git a/src/core/layout/qgslayoutitempicture.cpp b/src/core/layout/qgslayoutitempicture.cpp
@@ -71,6 +71,11 @@ int QgsLayoutItemPicture::type() const
   return QgsLayoutItemRegistry::LayoutPicture;
 }
 
+QIcon QgsLayoutItemPicture::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemPicture.svg" ) );
+}
+
 QgsLayoutItemPicture *QgsLayoutItemPicture::create( QgsLayout *layout )
 {
   return new QgsLayoutItemPicture( layout );

diff --git a/src/core/layout/qgslayoutitempicture.h b/src/core/layout/qgslayoutitempicture.h
@@ -71,6 +71,7 @@ class CORE_EXPORT QgsLayoutItemPicture: public QgsLayoutItem
     QgsLayoutItemPicture( QgsLayout *layout );
 
     int type() const override;
+    QIcon icon() const override;
 
     /**
      * Returns a new picture item for the specified \a layout.

diff --git a/src/core/layout/qgslayoutitempolygon.cpp b/src/core/layout/qgslayoutitempolygon.cpp
@@ -47,6 +47,11 @@ int QgsLayoutItemPolygon::type() const
   return QgsLayoutItemRegistry::LayoutPolygon;
 }
 
+QIcon QgsLayoutItemPolygon::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemPolygon.svg" ) );
+}
+
 bool QgsLayoutItemPolygon::_addNode( const int indexPoint,
                                      QPointF newPoint,
                                      const double radius )

diff --git a/src/core/layout/qgslayoutitempolygon.h b/src/core/layout/qgslayoutitempolygon.h
@@ -52,6 +52,7 @@ class CORE_EXPORT QgsLayoutItemPolygon: public QgsLayoutNodesItem
     static QgsLayoutItemPolygon *create( QgsLayout *layout ) SIP_FACTORY;
 
     int type() const override;
+    QIcon icon() const override;
     QString displayName() const override;
 
     /**

diff --git a/src/core/layout/qgslayoutitempolyline.cpp b/src/core/layout/qgslayoutitempolyline.cpp
@@ -48,6 +48,11 @@ int QgsLayoutItemPolyline::type() const
   return QgsLayoutItemRegistry::LayoutPolyline;
 }
 
+QIcon QgsLayoutItemPolyline::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemPolyline.svg" ) );
+}
+
 bool QgsLayoutItemPolyline::_addNode( const int indexPoint,
                                       QPointF newPoint,
                                       const double radius )

diff --git a/src/core/layout/qgslayoutitempolyline.h b/src/core/layout/qgslayoutitempolyline.h
@@ -59,6 +59,7 @@ class CORE_EXPORT QgsLayoutItemPolyline: public QgsLayoutNodesItem
     static QgsLayoutItemPolyline *create( QgsLayout *layout ) SIP_FACTORY;
 
     int type() const override;
+    QIcon icon() const override;
     QString displayName() const override;
 
     /**

diff --git a/src/core/layout/qgslayoutitemscalebar.cpp b/src/core/layout/qgslayoutitemscalebar.cpp
@@ -52,6 +52,11 @@ int QgsLayoutItemScaleBar::type() const
   return QgsLayoutItemRegistry::LayoutScaleBar;
 }
 
+QIcon QgsLayoutItemScaleBar::icon() const
+{
+  return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemScaleBar.svg" ) );
+}
+
 QgsLayoutItemScaleBar *QgsLayoutItemScaleBar::create( QgsLayout *layout )
 {
   return new QgsLayoutItemScaleBar( layout );