QGIS API Documentation 3.29.0-Master (19d7edcfed)
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
18#include "qgslayoutitemshape.h"
19#include "qgslayoutitemmap.h"
20#include "qgslayoutitemlabel.h"
21#include "qgslayoutitemlegend.h"
24#include "qgslayoutitempage.h"
26#include "qgslayoutitemgroup.h"
27#include "qgslayoutitemhtml.h"
32#include "qgslayoutframe.h"
33#include "qgslayoutitemmarker.h"
35
36#include <QPainter>
37
39 : QObject( parent )
40{
41}
42
44{
45 qDeleteAll( mMetadata );
46 qDeleteAll( mMultiFrameMetadata );
47}
48
50{
51 if ( !mMetadata.isEmpty() )
52 return false;
53
54#if 0
55 // add temporary item to register
56 auto createTemporaryItem = []( QgsLayout * layout )->QgsLayoutItem *
57 {
58 return new TestLayoutItem( layout );
59 };
60
61 addLayoutItemType( new QgsLayoutItemMetadata( QgsLayoutItemRegistry::LayoutItem + 1002, QStringLiteral( "temp type" ), createTemporaryItem ) );
62#endif
63
64 addLayoutItemType( new QgsLayoutItemMetadata( LayoutGroup, QObject::tr( "Group" ), QObject::tr( "Groups" ), QgsLayoutItemGroup::create ) );
65 addLayoutItemType( new QgsLayoutItemMetadata( LayoutFrame, QObject::tr( "Frame" ), QObject::tr( "Frames" ), QgsLayoutFrame::create ) );
66 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPage, QObject::tr( "Page" ), QObject::tr( "Pages" ), QgsLayoutItemPage::create ) );
67 addLayoutItemType( new QgsLayoutItemMetadata( LayoutMap, QObject::tr( "Map" ), QObject::tr( "Maps" ), QgsLayoutItemMap::create ) );
68 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPicture, QObject::tr( "Picture" ), QObject::tr( "Pictures" ), QgsLayoutItemPicture::create ) );
69 addLayoutItemType( new QgsLayoutItemMetadata( LayoutLabel, QObject::tr( "Label" ), QObject::tr( "Labels" ), QgsLayoutItemLabel::create ) );
70 addLayoutItemType( new QgsLayoutItemMetadata( LayoutLegend, QObject::tr( "Legend" ), QObject::tr( "Legends" ), QgsLayoutItemLegend::create ) );
71 addLayoutItemType( new QgsLayoutItemMetadata( LayoutScaleBar, QObject::tr( "Scalebar" ), QObject::tr( "Scalebars" ), QgsLayoutItemScaleBar::create ) );
72 addLayoutItemType( new QgsLayoutItemMetadata( LayoutShape, QObject::tr( "Shape" ), QObject::tr( "Shapes" ), []( QgsLayout * layout )
73 {
74 QgsLayoutItemShape *shape = new QgsLayoutItemShape( layout );
76 return shape;
77 } ) );
78 addLayoutItemType( new QgsLayoutItemMetadata( LayoutMarker, QObject::tr( "Marker" ), QObject::tr( "Markers" ), QgsLayoutItemMarker::create ) );
79 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPolygon, QObject::tr( "Polygon" ), QObject::tr( "Polygons" ), QgsLayoutItemPolygon::create ) );
80 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPolyline, QObject::tr( "Polyline" ), QObject::tr( "Polylines" ), QgsLayoutItemPolyline::create ) );
81
82 addLayoutItemType( new QgsLayoutItemMetadata( LayoutElevationProfile, QObject::tr( "Elevation Profile" ), QObject::tr( "Elevation Profiles" ), QgsLayoutItemElevationProfile::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
138void 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
150QMap<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
167TestLayoutItem::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
186void 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
A paint effect which draws the source picture with minor or no alterations.
A paint effect which consists of a stack of other chained paint effects.
void appendEffect(QgsPaintEffect *effect)
Appends an effect to the end of the stack.
static QgsFillSymbol * createSimple(const QVariantMap &properties)
Create a fill symbol with one symbol layer: SimpleFill with specified properties.
A paint effect which draws a glow within a picture.
static QgsLayoutFrame * create(QgsLayout *layout)
Creates a new QgsLayoutFrame belonging to the specified layout.
Stores metadata about one layout item class.
QString visibleName() const
Returns a translated, user visible name for the layout item class.
int type() const
Returns the unique item type code for the layout item class.
static QgsLayoutItemAttributeTable * create(QgsLayout *layout)
Returns a new QgsLayoutItemAttributeTable for the specified parent layout.
static QgsLayoutItemElevationProfile * create(QgsLayout *layout)
Returns a new elevation profile item for the specified layout.
static QgsLayoutItemGroup * create(QgsLayout *layout)
Returns a new group item for the specified layout.
static QgsLayoutItemHtml * create(QgsLayout *layout)
Returns a new QgsLayoutItemHtml for the specified parent layout.
static QgsLayoutItemLabel * create(QgsLayout *layout)
Returns a new label item for the specified layout.
static QgsLayoutItemLegend * create(QgsLayout *layout)
Returns a new legend item for the specified layout.
static QgsLayoutItemManualTable * create(QgsLayout *layout)
Returns a new QgsLayoutItemManualTable for the specified parent layout.
static QgsLayoutItemMap * create(QgsLayout *layout)
Returns a new map item for the specified layout.
static QgsLayoutItemMarker * create(QgsLayout *layout)
Returns a new marker item for the specified layout.
Convenience metadata class that uses static functions to create layout items and their configuration ...
static QgsLayoutItemPage * create(QgsLayout *layout)
Returns a new page item for the specified layout.
static QgsLayoutItemPicture * create(QgsLayout *layout)
Returns a new picture item for the specified layout.
static QgsLayoutItemPolygon * create(QgsLayout *layout)
Returns a new polygon item for the specified layout.
static QgsLayoutItemPolyline * create(QgsLayout *layout)
Returns a new polyline item for the specified layout.
QgsLayoutItemRegistry(QObject *parent=nullptr)
Creates a new empty item registry.
void resolvePaths(int type, QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) const
Resolve paths in properties of a particular symbol layer.
bool addLayoutItemType(QgsLayoutItemAbstractMetadata *metadata)
Registers a new layout item type.
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.
QgsLayoutItemAbstractMetadata * itemMetadata(int type) const
Returns the metadata for the specified item type.
bool addLayoutMultiFrameType(QgsLayoutMultiFrameAbstractMetadata *metadata)
Registers a new layout multiframe type.
@ LayoutManualTable
Manual (fixed) table.
@ LayoutElevationProfile
Elevation profile item (since QGIS 3.30)
@ LayoutAttributeTable
Attribute table.
@ LayoutPolyline
Polyline shape item.
@ LayoutScaleBar
Scale bar item.
@ LayoutItem
Base class for items.
@ LayoutHtml
Html multiframe item.
@ LayoutTextTable
Preset text table.
@ LayoutFrame
Frame item, part of a QgsLayoutMultiFrame object.
@ LayoutPolygon
Polygon shape item.
QgsLayoutMultiFrameAbstractMetadata * multiFrameMetadata(int type) const
Returns the metadata for the specified multiframe type.
bool populate()
Populates the registry with standard item types.
void multiFrameTypeAdded(int type, const QString &name)
Emitted whenever a new multiframe type is added to the registry, with the specified type and visible ...
QgsLayoutItem * createItem(int type, QgsLayout *layout) const
Creates a new instance of a layout item given the item type, and target layout.
QMap< int, QString > itemTypes() const
Returns a map of available item types to translated name.
QgsLayoutMultiFrame * createMultiFrame(int type, QgsLayout *layout) const
Creates a new instance of a layout multiframe given the multiframe type, and target layout.
static QgsLayoutItemScaleBar * create(QgsLayout *layout)
Returns a new scale bar item for the specified layout.
Layout item for basic filled shapes (e.g.
void setShapeType(QgsLayoutItemShape::Shape type)
Sets the type of shape (e.g.
@ Rectangle
Rectangle shape.
static QgsLayoutItemTextTable * create(QgsLayout *layout)
Returns a new QgsLayoutItemTextTable for the specified parent layout.
Base class for graphical items within a QgsLayout.
Stores metadata about one layout multiframe class.
int type() const
Returns the unique item type code for the layout multiframe class.
QString visibleName() const
Returns a translated, user visible name for the layout multiframe class.
Convenience metadata class that uses static functions to create layout multiframes and their configur...
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:51
virtual void begin(QgsRenderContext &context)
Begins intercepting paint operations to a render context.
virtual void end(QgsRenderContext &context)
Ends interception of paint operations to a render context, and draws the result to the render context...
Resolves relative paths into absolute paths and vice versa.
Contains information about the context of a rendering operation.
QPainter * painter()
Returns the destination QPainter for the render operation.
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:169
QMap< QString, QString > QgsStringMap
Definition: qgis.h:3622