QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgslayoutitemregistry.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutitemregistry.cpp
3  -------------------------
4  begin : June 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 /***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 
17 #include "qgslayoutitemregistry.h"
18 #include "qgslayoutitemshape.h"
19 #include "qgslayoutitemmap.h"
20 #include "qgslayoutitemlabel.h"
21 #include "qgslayoutitemlegend.h"
22 #include "qgslayoutitempolygon.h"
23 #include "qgslayoutitempolyline.h"
24 #include "qgslayoutitempage.h"
25 #include "qgslayoutitempicture.h"
26 #include "qgslayoutitemgroup.h"
27 #include "qgslayoutitemhtml.h"
28 #include "qgslayoutitemscalebar.h"
31 #include "qgslayoutitemtexttable.h"
32 #include "qgslayoutframe.h"
33 #include "qgslayoutitemmarker.h"
34 #include "qgsgloweffect.h"
35 #include "qgseffectstack.h"
36 #include "qgsvectorlayer.h"
37 
38 #include <QPainter>
39 
41  : QObject( parent )
42 {
43 }
44 
46 {
47  qDeleteAll( mMetadata );
48  qDeleteAll( mMultiFrameMetadata );
49 }
50 
52 {
53  if ( !mMetadata.isEmpty() )
54  return false;
55 
56 #if 0
57  // add temporary item to register
58  auto createTemporaryItem = []( QgsLayout * layout )->QgsLayoutItem *
59  {
60  return new TestLayoutItem( layout );
61  };
62 
63  addLayoutItemType( new QgsLayoutItemMetadata( QgsLayoutItemRegistry::LayoutItem + 1002, QStringLiteral( "temp type" ), createTemporaryItem ) );
64 #endif
65 
66  addLayoutItemType( new QgsLayoutItemMetadata( LayoutGroup, QObject::tr( "Group" ), QObject::tr( "Groups" ), QgsLayoutItemGroup::create ) );
67  addLayoutItemType( new QgsLayoutItemMetadata( LayoutFrame, QObject::tr( "Frame" ), QObject::tr( "Frames" ), QgsLayoutFrame::create ) );
68  addLayoutItemType( new QgsLayoutItemMetadata( LayoutPage, QObject::tr( "Page" ), QObject::tr( "Pages" ), QgsLayoutItemPage::create ) );
69  addLayoutItemType( new QgsLayoutItemMetadata( LayoutMap, QObject::tr( "Map" ), QObject::tr( "Maps" ), QgsLayoutItemMap::create ) );
70  addLayoutItemType( new QgsLayoutItemMetadata( LayoutPicture, QObject::tr( "Picture" ), QObject::tr( "Pictures" ), QgsLayoutItemPicture::create ) );
71  addLayoutItemType( new QgsLayoutItemMetadata( LayoutLabel, QObject::tr( "Label" ), QObject::tr( "Labels" ), QgsLayoutItemLabel::create ) );
72  addLayoutItemType( new QgsLayoutItemMetadata( LayoutLegend, QObject::tr( "Legend" ), QObject::tr( "Legends" ), QgsLayoutItemLegend::create ) );
73  addLayoutItemType( new QgsLayoutItemMetadata( LayoutScaleBar, QObject::tr( "Scalebar" ), QObject::tr( "Scalebars" ), QgsLayoutItemScaleBar::create ) );
74  addLayoutItemType( new QgsLayoutItemMetadata( LayoutShape, QObject::tr( "Shape" ), QObject::tr( "Shapes" ), []( QgsLayout * layout )
75  {
76  QgsLayoutItemShape *shape = new QgsLayoutItemShape( layout );
78  return shape;
79  } ) );
80  addLayoutItemType( new QgsLayoutItemMetadata( LayoutMarker, QObject::tr( "Marker" ), QObject::tr( "Markers" ), QgsLayoutItemMarker::create ) );
81  addLayoutItemType( new QgsLayoutItemMetadata( LayoutPolygon, QObject::tr( "Polygon" ), QObject::tr( "Polygons" ), QgsLayoutItemPolygon::create ) );
82  addLayoutItemType( new QgsLayoutItemMetadata( LayoutPolyline, QObject::tr( "Polyline" ), QObject::tr( "Polylines" ), QgsLayoutItemPolyline::create ) );
83 
88 
89  return true;
90 }
91 
93 {
94  return mMetadata.value( type );
95 }
96 
98 {
99  return mMultiFrameMetadata.value( type );
100 }
101 
103 {
104  if ( !metadata || mMetadata.contains( metadata->type() ) )
105  return false;
106 
107  mMetadata[metadata->type()] = metadata;
108  emit typeAdded( metadata->type(), metadata->visibleName() );
109  return true;
110 }
111 
113 {
114  if ( !metadata || mMultiFrameMetadata.contains( metadata->type() ) )
115  return false;
116 
117  mMultiFrameMetadata[metadata->type()] = metadata;
118  emit multiFrameTypeAdded( metadata->type(), metadata->visibleName() );
119  return true;
120 }
121 
123 {
124  if ( !mMetadata.contains( type ) )
125  return nullptr;
126 
127  return mMetadata[type]->createItem( layout );
128 }
129 
131 {
132  if ( !mMultiFrameMetadata.contains( type ) )
133  return nullptr;
134 
135  return mMultiFrameMetadata[type]->createMultiFrame( layout );
136 }
137 
138 void QgsLayoutItemRegistry::resolvePaths( int type, QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving ) const
139 {
140  if ( mMetadata.contains( type ) )
141  {
142  mMetadata[type]->resolvePaths( properties, pathResolver, saving );
143  }
144  else if ( mMultiFrameMetadata.contains( type ) )
145  {
146  mMultiFrameMetadata[type]->resolvePaths( properties, pathResolver, saving );
147  }
148 }
149 
150 QMap<int, QString> QgsLayoutItemRegistry::itemTypes() const
151 {
152  QMap<int, QString> types;
153  for ( auto it = mMetadata.constBegin(); it != mMetadata.constEnd(); ++it )
154  {
155  types.insert( it.key(), it.value()->visibleName() );
156  }
157  for ( auto it = mMultiFrameMetadata.constBegin(); it != mMultiFrameMetadata.constEnd(); ++it )
158  {
159  types.insert( it.key(), it.value()->visibleName() );
160  }
161 
162  return types;
163 }
164 
166 #if 0
167 TestLayoutItem::TestLayoutItem( QgsLayout *layout )
168  : QgsLayoutItem( layout )
169 {
170  int h = static_cast< int >( 360.0 * qrand() / ( RAND_MAX + 1.0 ) );
171  int s = ( qrand() % ( 200 - 100 + 1 ) ) + 100;
172  int v = ( qrand() % ( 130 - 255 + 1 ) ) + 130;
173  mColor = QColor::fromHsv( h, s, v );
174 
175  QgsStringMap properties;
176  properties.insert( QStringLiteral( "color" ), mColor.name() );
177  properties.insert( QStringLiteral( "style" ), QStringLiteral( "solid" ) );
178  properties.insert( QStringLiteral( "style_border" ), QStringLiteral( "solid" ) );
179  properties.insert( QStringLiteral( "color_border" ), QStringLiteral( "black" ) );
180  properties.insert( QStringLiteral( "width_border" ), QStringLiteral( "0.3" ) );
181  properties.insert( QStringLiteral( "joinstyle" ), QStringLiteral( "miter" ) );
182  mShapeStyleSymbol = QgsFillSymbol::createSimple( properties );
183 
184 }
185 
186 void TestLayoutItem::draw( QgsRenderContext &context, const QStyleOptionGraphicsItem *itemStyle )
187 {
188  Q_UNUSED( itemStyle )
189 
190  QgsEffectStack stack;
191  stack.appendEffect( new QgsDrawSourceEffect() );
192  stack.appendEffect( new QgsInnerGlowEffect() );
193  stack.begin( context );
194 
195  QPainter *painter = context.painter();
196 
197  painter->save();
198  painter->setRenderHint( QPainter::Antialiasing, false );
199  painter->setPen( Qt::NoPen );
200  painter->setBrush( mColor );
201 
202  double scale = context.convertToPainterUnits( 1, QgsUnitTypes::RenderMillimeters );
203 
204  QPolygonF shapePolygon = QPolygonF( QRectF( 0, 0, rect().width() * scale, rect().height() * scale ) );
205  QList<QPolygonF> rings; //empty list
206 
207  mShapeStyleSymbol->startRender( context );
208  mShapeStyleSymbol->renderPolygon( shapePolygon, &rings, nullptr, context );
209  mShapeStyleSymbol->stopRender( context );
210 
211 // painter->drawRect( r );
212  painter->restore();
213  stack.end( context );
214 }
215 #endif
216 
QgsLayoutItemRegistry::LayoutPolygon
@ LayoutPolygon
Polygon shape item.
Definition: qgslayoutitemregistry.h:322
qgslayoutitemgroup.h
QgsLayoutMultiFrameAbstractMetadata::visibleName
QString visibleName() const
Returns a translated, user visible name for the layout multiframe class.
Definition: qgslayoutitemregistry.h:202
qgslayoutitempolygon.h
QgsLayoutItemShape
Layout item for basic filled shapes (e.g. rectangles, ellipses).
Definition: qgslayoutitemshape.h:32
QgsRenderContext::convertToPainterUnits
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to painter units (pixels).
Definition: qgsrendercontext.cpp:287
qgslayoutitemattributetable.h
QgsLayoutItemRegistry::resolvePaths
void resolvePaths(int type, QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) const
Resolve paths in properties of a particular symbol layer.
Definition: qgslayoutitemregistry.cpp:138
QgsLayoutMultiFrameMetadata
Definition: qgslayoutitemregistry.h:243
QgsPaintEffect::begin
virtual void begin(QgsRenderContext &context)
Begins intercepting paint operations to a render context.
Definition: qgspainteffect.cpp:117
QgsLayoutItemPolyline::create
static QgsLayoutItemPolyline * create(QgsLayout *layout)
Returns a new polyline item for the specified layout.
Definition: qgslayoutitempolyline.cpp:44
QgsDrawSourceEffect
A paint effect which draws the source picture with minor or no alterations.
Definition: qgspainteffect.h:328
QgsLayoutItemRegistry::createItem
QgsLayoutItem * createItem(int type, QgsLayout *layout) const
Creates a new instance of a layout item given the item type, and target layout.
Definition: qgslayoutitemregistry.cpp:122
QgsRenderContext
Definition: qgsrendercontext.h:57
QgsUnitTypes::RenderMillimeters
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:168
qgslayoutitemlabel.h
QgsLayoutMultiFrame
Definition: qgslayoutmultiframe.h:48
QgsLayoutItemAbstractMetadata::type
int type() const
Returns the unique item type code for the layout item class.
Definition: qgslayoutitemregistry.h:66
QgsLayoutItemRegistry::QgsLayoutItemRegistry
QgsLayoutItemRegistry(QObject *parent=nullptr)
Creates a new empty item registry.
Definition: qgslayoutitemregistry.cpp:40
QgsLayoutItemMetadata
Definition: qgslayoutitemregistry.h:120
QgsLayoutItemRegistry::typeAdded
void typeAdded(int type, const QString &name)
Emitted whenever a new item type is added to the registry, with the specified type and visible name.
QgsLayoutItemRegistry::itemMetadata
QgsLayoutItemAbstractMetadata * itemMetadata(int type) const
Returns the metadata for the specified item type.
Definition: qgslayoutitemregistry.cpp:92
QgsLayoutItemRegistry::LayoutGroup
@ LayoutGroup
Grouped item.
Definition: qgslayoutitemregistry.h:309
qgslayoutframe.h
QgsLayoutItemAbstractMetadata
Stores metadata about one layout item class.
Definition: qgslayoutitemregistry.h:45
QgsLayoutItemGroup::create
static QgsLayoutItemGroup * create(QgsLayout *layout)
Returns a new group item for the specified layout.
Definition: qgslayoutitemgroup.cpp:64
QgsLayoutMultiFrameAbstractMetadata
Stores metadata about one layout multiframe class.
Definition: qgslayoutitemregistry.h:174
QgsLayoutItemLegend::create
static QgsLayoutItemLegend * create(QgsLayout *layout)
Returns a new legend item for the specified layout.
Definition: qgslayoutitemlegend.cpp:64
QgsLayoutItemMarker::create
static QgsLayoutItemMarker * create(QgsLayout *layout)
Returns a new marker item for the specified layout.
Definition: qgslayoutitemmarker.cpp:50
QgsLayoutItemRegistry::~QgsLayoutItemRegistry
~QgsLayoutItemRegistry() override
Definition: qgslayoutitemregistry.cpp:45
QgsLayoutItemTextTable::create
static QgsLayoutItemTextTable * create(QgsLayout *layout)
Returns a new QgsLayoutItemTextTable for the specified parent layout.
Definition: qgslayoutitemtexttable.cpp:39
QgsLayoutItemRegistry::addLayoutMultiFrameType
bool addLayoutMultiFrameType(QgsLayoutMultiFrameAbstractMetadata *metadata)
Registers a new layout multiframe type.
Definition: qgslayoutitemregistry.cpp:112
QgsLayoutItemRegistry::addLayoutItemType
bool addLayoutItemType(QgsLayoutItemAbstractMetadata *metadata)
Registers a new layout item type.
Definition: qgslayoutitemregistry.cpp:102
QgsLayoutItemRegistry::LayoutPolyline
@ LayoutPolyline
Polyline shape item.
Definition: qgslayoutitemregistry.h:323
qgsgloweffect.h
QgsLayoutItemPicture::create
static QgsLayoutItemPicture * create(QgsLayout *layout)
Returns a new picture item for the specified layout.
Definition: qgslayoutitempicture.cpp:82
QgsLayoutFrame::create
static QgsLayoutFrame * create(QgsLayout *layout)
Creates a new QgsLayoutFrame belonging to the specified layout.
Definition: qgslayoutframe.cpp:44
QgsLayoutItemMap::create
static QgsLayoutItemMap * create(QgsLayout *layout)
Returns a new map item for the specified layout.
Definition: qgslayoutitemmap.cpp:127
QgsPaintEffect::end
virtual void end(QgsRenderContext &context)
Ends interception of paint operations to a render context, and draws the result to the render context...
Definition: qgspainteffect.cpp:132
QgsLayoutItem
Base class for graphical items within a QgsLayout.
Definition: qgslayoutitem.h:112
QgsLayoutItemRegistry::populate
bool populate()
Populates the registry with standard item types.
Definition: qgslayoutitemregistry.cpp:51
qgseffectstack.h
qgslayoutitemmarker.h
QgsLayoutItemRegistry::LayoutScaleBar
@ LayoutScaleBar
Scale bar item.
Definition: qgslayoutitemregistry.h:324
QgsInnerGlowEffect
A paint effect which draws a glow within a picture.
Definition: qgsgloweffect.h:331
QgsLayoutItemShape::Rectangle
@ Rectangle
Rectangle shape.
Definition: qgslayoutitemshape.h:42
QgsLayoutItemPage::create
static QgsLayoutItemPage * create(QgsLayout *layout)
Returns a new page item for the specified layout.
Definition: qgslayoutitempage.cpp:55
qgsvectorlayer.h
qgslayoutitemmanualtable.h
qgslayoutitemlegend.h
QgsLayoutItemAttributeTable::create
static QgsLayoutItemAttributeTable * create(QgsLayout *layout)
Returns a new QgsLayoutItemAttributeTable for the specified parent layout.
Definition: qgslayoutitemattributetable.cpp:62
qgslayoutitempage.h
QgsStringMap
QMap< QString, QString > QgsStringMap
Definition: qgis.h:714
QgsLayoutItemRegistry::LayoutLabel
@ LayoutLabel
Label item.
Definition: qgslayoutitemregistry.h:319
QgsLayoutItemRegistry::multiFrameMetadata
QgsLayoutMultiFrameAbstractMetadata * multiFrameMetadata(int type) const
Returns the metadata for the specified multiframe type.
Definition: qgslayoutitemregistry.cpp:97
QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
QgsLayoutItemLabel::create
static QgsLayoutItemLabel * create(QgsLayout *layout)
Returns a new label item for the specified layout.
Definition: qgslayoutitemlabel.cpp:96
QgsLayoutItemRegistry::LayoutPicture
@ LayoutPicture
Picture item.
Definition: qgslayoutitemregistry.h:318
QgsEffectStack::appendEffect
void appendEffect(QgsPaintEffect *effect)
Appends an effect to the end of the stack.
Definition: qgseffectstack.cpp:217
QgsLayoutItemRegistry::LayoutMarker
@ LayoutMarker
Marker item.
Definition: qgslayoutitemregistry.h:339
QgsLayoutItemShape::setShapeType
void setShapeType(QgsLayoutItemShape::Shape type)
Sets the type of shape (e.g.
Definition: qgslayoutitemshape.cpp:94
QgsLayoutItemRegistry::LayoutMap
@ LayoutMap
Map item.
Definition: qgslayoutitemregistry.h:317
qgslayoutitempicture.h
qgslayoutitempolyline.h
QgsLayoutItemRegistry::LayoutTextTable
@ LayoutTextTable
Preset text table.
Definition: qgslayoutitemregistry.h:334
qgslayoutitemshape.h
QgsLayoutItemRegistry::itemTypes
QMap< int, QString > itemTypes() const
Returns a map of available item types to translated name.
Definition: qgslayoutitemregistry.cpp:150
QgsLayoutItemPolygon::create
static QgsLayoutItemPolygon * create(QgsLayout *layout)
Returns a new polygon item for the specified layout.
Definition: qgslayoutitempolygon.cpp:42
QgsFillSymbol::createSimple
static QgsFillSymbol * createSimple(const QgsStringMap &properties)
Create a fill symbol with one symbol layer: SimpleFill with specified properties.
Definition: qgssymbol.cpp:1440
QgsLayoutItemRegistry::LayoutHtml
@ LayoutHtml
Html multiframe item.
Definition: qgslayoutitemregistry.h:332
qgslayoutitemtexttable.h
QgsLayoutItemRegistry::createMultiFrame
QgsLayoutMultiFrame * createMultiFrame(int type, QgsLayout *layout) const
Creates a new instance of a layout multiframe given the multiframe type, and target layout.
Definition: qgslayoutitemregistry.cpp:130
QgsRenderContext::painter
QPainter * painter()
Returns the destination QPainter for the render operation.
Definition: qgsrendercontext.h:174
QgsLayoutItemRegistry::LayoutFrame
@ LayoutFrame
Frame item, part of a QgsLayoutMultiFrame object.
Definition: qgslayoutitemregistry.h:325
QgsLayoutItemRegistry::LayoutShape
@ LayoutShape
Shape item.
Definition: qgslayoutitemregistry.h:321
QgsLayoutItemHtml::create
static QgsLayoutItemHtml * create(QgsLayout *layout)
Returns a new QgsLayoutItemHtml for the specified parent layout.
Definition: qgslayoutitemhtml.cpp:93
QgsLayoutItemAbstractMetadata::visibleName
QString visibleName() const
Returns a translated, user visible name for the layout item class.
Definition: qgslayoutitemregistry.h:72
QgsLayoutItemRegistry::LayoutItem
@ LayoutItem
Base class for items.
Definition: qgslayoutitemregistry.h:308
QgsLayoutItemManualTable::create
static QgsLayoutItemManualTable * create(QgsLayout *layout)
Returns a new QgsLayoutItemManualTable for the specified parent layout.
Definition: qgslayoutitemmanualtable.cpp:50
qgslayoutitemregistry.h
QgsLayoutItemRegistry::LayoutAttributeTable
@ LayoutAttributeTable
Attribute table.
Definition: qgslayoutitemregistry.h:333
QgsLayoutItemRegistry::LayoutManualTable
@ LayoutManualTable
Manual (fixed) table.
Definition: qgslayoutitemregistry.h:338
QgsLayoutItemRegistry::LayoutLegend
@ LayoutLegend
Legend item.
Definition: qgslayoutitemregistry.h:320
qgslayoutitemscalebar.h
QgsPathResolver
Definition: qgspathresolver.h:31
QgsLayoutItemRegistry::LayoutPage
@ LayoutPage
Page items.
Definition: qgslayoutitemregistry.h:316
qgslayoutitemhtml.h
QgsLayoutItemRegistry::multiFrameTypeAdded
void multiFrameTypeAdded(int type, const QString &name)
Emitted whenever a new multiframe type is added to the registry, with the specified type and visible ...
qgslayoutitemmap.h
QgsLayoutItemScaleBar::create
static QgsLayoutItemScaleBar * create(QgsLayout *layout)
Returns a new scale bar item for the specified layout.
Definition: qgslayoutitemscalebar.cpp:63
QgsEffectStack
A paint effect which consists of a stack of other chained paint effects.
Definition: qgseffectstack.h:44
QgsLayoutMultiFrameAbstractMetadata::type
int type() const
Returns the unique item type code for the layout multiframe class.
Definition: qgslayoutitemregistry.h:192