QGIS API Documentation 3.99.0-Master (9e5f463f1a9)
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 "moc_qgslayoutitemregistry.cpp"
19#include "qgslayoutitemshape.h"
20#include "qgslayoutitemmap.h"
21#include "qgslayoutitemlabel.h"
22#include "qgslayoutitemlegend.h"
25#include "qgslayoutitempage.h"
27#include "qgslayoutitemgroup.h"
28#include "qgslayoutitemhtml.h"
33#include "qgslayoutframe.h"
34#include "qgslayoutitemmarker.h"
36
37#include <QPainter>
38
40 : QObject( parent )
41{
42}
43
45{
46 qDeleteAll( mMetadata );
47 qDeleteAll( mMultiFrameMetadata );
48}
49
51{
52 if ( !mMetadata.isEmpty() )
53 return false;
54
55#if 0
56 // add temporary item to register
57 auto createTemporaryItem = []( QgsLayout * layout )->QgsLayoutItem *
58 {
59 return new TestLayoutItem( layout );
60 };
61
62 addLayoutItemType( new QgsLayoutItemMetadata( QgsLayoutItemRegistry::LayoutItem + 1002, QStringLiteral( "temp type" ), createTemporaryItem ) );
63#endif
64
65 addLayoutItemType( new QgsLayoutItemMetadata( LayoutGroup, QObject::tr( "Group" ), QObject::tr( "Groups" ), QgsLayoutItemGroup::create ) );
66 addLayoutItemType( new QgsLayoutItemMetadata( LayoutFrame, QObject::tr( "Frame" ), QObject::tr( "Frames" ), QgsLayoutFrame::create ) );
67 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPage, QObject::tr( "Page" ), QObject::tr( "Pages" ), QgsLayoutItemPage::create ) );
68 addLayoutItemType( new QgsLayoutItemMetadata( LayoutMap, QObject::tr( "Map" ), QObject::tr( "Maps" ), QgsLayoutItemMap::create ) );
69 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPicture, QObject::tr( "Picture" ), QObject::tr( "Pictures" ), QgsLayoutItemPicture::create ) );
70 addLayoutItemType( new QgsLayoutItemMetadata( LayoutLabel, QObject::tr( "Label" ), QObject::tr( "Labels" ), QgsLayoutItemLabel::create ) );
71 addLayoutItemType( new QgsLayoutItemMetadata( LayoutLegend, QObject::tr( "Legend" ), QObject::tr( "Legends" ), QgsLayoutItemLegend::create ) );
72 addLayoutItemType( new QgsLayoutItemMetadata( LayoutScaleBar, QObject::tr( "Scalebar" ), QObject::tr( "Scalebars" ), QgsLayoutItemScaleBar::create ) );
73 addLayoutItemType( new QgsLayoutItemMetadata( LayoutShape, QObject::tr( "Shape" ), QObject::tr( "Shapes" ), []( QgsLayout * layout )
74 {
75 QgsLayoutItemShape *shape = new QgsLayoutItemShape( layout );
77 return shape;
78 } ) );
79 addLayoutItemType( new QgsLayoutItemMetadata( LayoutMarker, QObject::tr( "Marker" ), QObject::tr( "Markers" ), QgsLayoutItemMarker::create ) );
80 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPolygon, QObject::tr( "Polygon" ), QObject::tr( "Polygons" ), QgsLayoutItemPolygon::create ) );
81 addLayoutItemType( new QgsLayoutItemMetadata( LayoutPolyline, QObject::tr( "Polyline" ), QObject::tr( "Polylines" ), QgsLayoutItemPolyline::create ) );
82
83 addLayoutItemType( new QgsLayoutItemMetadata( LayoutElevationProfile, QObject::tr( "Elevation Profile" ), QObject::tr( "Elevation Profiles" ), QgsLayoutItemElevationProfile::create ) );
84
89
90 return true;
91}
92
94{
95 return mMetadata.value( type );
96}
97
99{
100 return mMultiFrameMetadata.value( type );
101}
102
104{
105 if ( !metadata || mMetadata.contains( metadata->type() ) )
106 return false;
107
108 mMetadata[metadata->type()] = metadata;
109 emit typeAdded( metadata->type(), metadata->visibleName() );
110 return true;
111}
112
114{
115 if ( !mMetadata.contains( typeId ) )
116 return false;
117 mMetadata.remove( typeId );
118 emit typeRemoved( typeId );
119 return true;
120}
121
126
128{
129 if ( !metadata || mMultiFrameMetadata.contains( metadata->type() ) )
130 return false;
131
132 mMultiFrameMetadata[metadata->type()] = metadata;
133 emit multiFrameTypeAdded( metadata->type(), metadata->visibleName() );
134 return true;
135}
136
138{
139 if ( !mMultiFrameMetadata.contains( typeId ) )
140 return false;
141 mMultiFrameMetadata.remove( typeId );
142 emit multiFrameTypeRemoved( typeId );
143 return true;
144}
145
150
152{
153 if ( !mMetadata.contains( type ) )
154 return nullptr;
155
156 return mMetadata[type]->createItem( layout );
157}
158
160{
161 if ( !mMultiFrameMetadata.contains( type ) )
162 return nullptr;
163
164 return mMultiFrameMetadata[type]->createMultiFrame( layout );
165}
166
167void QgsLayoutItemRegistry::resolvePaths( int type, QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving ) const
168{
169 if ( mMetadata.contains( type ) )
170 {
171 mMetadata[type]->resolvePaths( properties, pathResolver, saving );
172 }
173 else if ( mMultiFrameMetadata.contains( type ) )
174 {
175 mMultiFrameMetadata[type]->resolvePaths( properties, pathResolver, saving );
176 }
177}
178
179QMap<int, QString> QgsLayoutItemRegistry::itemTypes() const
180{
181 QMap<int, QString> types;
182 for ( auto it = mMetadata.constBegin(); it != mMetadata.constEnd(); ++it )
183 {
184 types.insert( it.key(), it.value()->visibleName() );
185 }
186 for ( auto it = mMultiFrameMetadata.constBegin(); it != mMultiFrameMetadata.constEnd(); ++it )
187 {
188 types.insert( it.key(), it.value()->visibleName() );
189 }
190
191 return types;
192}
193
195#if 0
196TestLayoutItem::TestLayoutItem( QgsLayout *layout )
197 : QgsLayoutItem( layout )
198{
199 int h = static_cast< int >( 360.0 * qrand() / ( RAND_MAX + 1.0 ) );
200 int s = ( qrand() % ( 200 - 100 + 1 ) ) + 100;
201 int v = ( qrand() % ( 130 - 255 + 1 ) ) + 130;
202 mColor = QColor::fromHsv( h, s, v );
203
204 QgsStringMap properties;
205 properties.insert( QStringLiteral( "color" ), mColor.name() );
206 properties.insert( QStringLiteral( "style" ), QStringLiteral( "solid" ) );
207 properties.insert( QStringLiteral( "style_border" ), QStringLiteral( "solid" ) );
208 properties.insert( QStringLiteral( "color_border" ), QStringLiteral( "black" ) );
209 properties.insert( QStringLiteral( "width_border" ), QStringLiteral( "0.3" ) );
210 properties.insert( QStringLiteral( "joinstyle" ), QStringLiteral( "miter" ) );
211 mShapeStyleSymbol = QgsFillSymbol::createSimple( properties );
212
213}
214
215void TestLayoutItem::draw( QgsRenderContext &context, const QStyleOptionGraphicsItem *itemStyle )
216{
217 Q_UNUSED( itemStyle )
218
219 QgsEffectStack stack;
220 stack.appendEffect( new QgsDrawSourceEffect() );
221 stack.appendEffect( new QgsInnerGlowEffect() );
222 stack.begin( context );
223
224 QPainter *painter = context.painter();
225
226 painter->save();
227 painter->setRenderHint( QPainter::Antialiasing, false );
228 painter->setPen( Qt::NoPen );
229 painter->setBrush( mColor );
230
231 double scale = context.convertToPainterUnits( 1, QgsUnitTypes::RenderMillimeters );
232
233 QPolygonF shapePolygon = QPolygonF( QRectF( 0, 0, rect().width() * scale, rect().height() * scale ) );
234 QList<QPolygonF> rings; //empty list
235
236 mShapeStyleSymbol->startRender( context );
237 mShapeStyleSymbol->renderPolygon( shapePolygon, &rings, nullptr, context );
238 mShapeStyleSymbol->stopRender( context );
239
240// painter->drawRect( r );
241 painter->restore();
242 stack.end( context );
243}
244#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 std::unique_ptr< 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.
bool removeLayoutMultiFrameType(int typeId)
Unregisters a layout multiframe type.
bool removeLayoutItemType(int typeId)
Unregisters a layout item type.
void multiFrameTypeRemoved(int type)
Emitted whenever an multiframe type is removed from the registry with the specified 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.
@ LayoutAttributeTable
Attribute table.
@ LayoutPolyline
Polyline shape 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.
void typeRemoved(int type)
Emitted whenever an item type is removed from the registry with the specified type.
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:49
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.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QPainter * painter()
Returns the destination QPainter for the render operation.
QMap< QString, QString > QgsStringMap
Definition qgis.h:6906