QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
qgslayoutitem.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutitem.h
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#ifndef QGSLAYOUTITEM_H
18#define QGSLAYOUTITEM_H
19
20#include "qgis_core.h"
21#include "qgslayoutobject.h"
22#include "qgslayoutsize.h"
23#include "qgslayoutpoint.h"
24#include "qgsrendercontext.h"
27#include <QGraphicsRectItem>
28#include <QIcon>
29#include <QPainter>
30
31class QgsLayout;
32class QPainter;
34class QgsLayoutEffect;
36
43{
44 public:
45
56 QgsLayoutItemRenderContext( QgsRenderContext &context, double viewScaleFactor = 1.0 );
57
60
63
70 QgsRenderContext &renderContext() { return mRenderContext; }
71
80 const QgsRenderContext &renderContext() const { return mRenderContext; } SIP_SKIP
81
92 double viewScaleFactor() const { return mViewScaleFactor; }
93
94 private:
95
96#ifdef SIP_RUN
98#endif
99
100 QgsRenderContext &mRenderContext;
101 double mViewScaleFactor = 1.0;
102};
103
109class CORE_EXPORT QgsLayoutItem : public QgsLayoutObject, public QGraphicsRectItem, public QgsLayoutUndoObjectInterface
110{
111#ifdef SIP_RUN
112#include "qgslayoutitemgroup.h"
113#include "qgslayoutitemmap.h"
114#include "qgslayoutitempicture.h"
115#include "qgslayoutitemlabel.h"
116#include "qgslayoutitemlegend.h"
117#include "qgslayoutitempolygon.h"
120#include "qgslayoutframe.h"
121#include "qgslayoutitemshape.h"
122#include "qgslayoutitempage.h"
123#include "qgslayoutitemmarker.h"
125#endif
126
127#ifdef SIP_RUN
129
130 // FREAKKKKIIN IMPORTANT!!!!!!!!!!!
131 // IF YOU PUT SOMETHING HERE, PUT IT IN QgsLayoutObject CASTING *****ALSO******
132 // (it's not enough for it to be in only one of the places, as sip inconsistently
133 // decides which casting code to perform here)
134
135 // the conversions have to be static, because they're using multiple inheritance
136 // (seen in PyQt4 .sip files for some QGraphicsItem classes)
137 switch ( sipCpp->type() )
138 {
139 // really, these *should* use the constants from QgsLayoutItemRegistry, but sip doesn't like that!
140 case QGraphicsItem::UserType + 101:
141 sipType = sipType_QgsLayoutItemGroup;
142 *sipCppRet = static_cast<QgsLayoutItemGroup *>( sipCpp );
143 break;
144 case QGraphicsItem::UserType + 102:
145 sipType = sipType_QgsLayoutItemPage;
146 *sipCppRet = static_cast<QgsLayoutItemPage *>( sipCpp );
147 break;
148 case QGraphicsItem::UserType + 103:
149 sipType = sipType_QgsLayoutItemMap;
150 *sipCppRet = static_cast<QgsLayoutItemMap *>( sipCpp );
151 break;
152 case QGraphicsItem::UserType + 104:
153 sipType = sipType_QgsLayoutItemPicture;
154 *sipCppRet = static_cast<QgsLayoutItemPicture *>( sipCpp );
155 break;
156 case QGraphicsItem::UserType + 105:
157 sipType = sipType_QgsLayoutItemLabel;
158 *sipCppRet = static_cast<QgsLayoutItemLabel *>( sipCpp );
159 break;
160 case QGraphicsItem::UserType + 106:
161 sipType = sipType_QgsLayoutItemLegend;
162 *sipCppRet = static_cast<QgsLayoutItemLegend *>( sipCpp );
163 break;
164 case QGraphicsItem::UserType + 107:
165 sipType = sipType_QgsLayoutItemShape;
166 *sipCppRet = static_cast<QgsLayoutItemShape *>( sipCpp );
167 break;
168 case QGraphicsItem::UserType + 108:
169 sipType = sipType_QgsLayoutItemPolygon;
170 *sipCppRet = static_cast<QgsLayoutItemPolygon *>( sipCpp );
171 break;
172 case QGraphicsItem::UserType + 109:
173 sipType = sipType_QgsLayoutItemPolyline;
174 *sipCppRet = static_cast<QgsLayoutItemPolyline *>( sipCpp );
175 break;
176 case QGraphicsItem::UserType + 110:
177 sipType = sipType_QgsLayoutItemScaleBar;
178 *sipCppRet = static_cast<QgsLayoutItemScaleBar *>( sipCpp );
179 break;
180 case QGraphicsItem::UserType + 111:
181 sipType = sipType_QgsLayoutFrame;
182 *sipCppRet = static_cast<QgsLayoutFrame *>( sipCpp );
183 break;
184 case QGraphicsItem::UserType + 117:
185 sipType = sipType_QgsLayoutItemMarker;
186 *sipCppRet = static_cast<QgsLayoutItemMarker *>( sipCpp );
187 break;
188 case QGraphicsItem::UserType + 118:
189 sipType = sipType_QgsLayoutItemElevationProfile;
190 *sipCppRet = static_cast<QgsLayoutItemElevationProfile *>( sipCpp );
191 break;
192
193 // did you read that comment above? NO? Go read it now. You're about to break stuff.
194
195 default:
196 sipType = NULL;
197 }
198 SIP_END
199#endif
200
201
202 Q_OBJECT
203 Q_PROPERTY( bool locked READ isLocked WRITE setLocked NOTIFY lockChanged )
204
205 public:
206
220
223 {
224 UndoNone = -1,
225 UndoIncrementalMove = 1,
324
326 };
327
332 enum Flag SIP_ENUM_BASETYPE( IntFlag )
333 {
334 FlagOverridesPaint = 1 << 1,
335 FlagProvidesClipPath = 1 << 2,
336 FlagDisableSceneCaching = 1 << 3,
337 };
338 Q_DECLARE_FLAGS( Flags, Flag )
339
340
346 explicit QgsLayoutItem( QgsLayout *layout, bool manageZValue = true );
347
348 ~QgsLayoutItem() override;
349
354 virtual void cleanup();
355
361 int type() const override;
362
366 virtual QIcon icon() const;
367
375 virtual QString uuid() const { return mUuid; }
376
381 virtual Flags itemFlags() const;
382
389 QString id() const { return mId; }
390
397 virtual void setId( const QString &id );
398
405 virtual QString displayName() const;
406
410 virtual void setSelected( bool selected );
411
418 virtual void setVisibility( bool visible );
419
425 void setLocked( bool locked );
426
432 bool isLocked() const { return mIsLocked; }
433
439 bool isGroupMember() const;
440
446 QgsLayoutItemGroup *parentGroup() const;
447
453 void setParentGroup( QgsLayoutItemGroup *group );
454
466
475 virtual ExportLayerBehavior exportLayerBehavior() const;
476
490 Q_DECL_DEPRECATED virtual int numberExportLayers() const SIP_DEPRECATED;
491
499 virtual void startLayeredExport();
500
508 virtual void stopLayeredExport();
509
517 virtual bool nextExportPart();
518
524 struct CORE_EXPORT ExportLayerDetail
525 {
527 QString name;
528
530 QString mapLayerId;
531
536 QPainter::CompositionMode compositionMode = QPainter::CompositionMode_SourceOver;
537
542 double opacity = 1.0;
543
545 QString mapTheme;
546
552 QString groupName;
553 };
554
562 virtual QgsLayoutItem::ExportLayerDetail exportLayerDetails() const;
563
569 void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override;
570
577 void setReferencePoint( ReferencePoint point );
578
585 ReferencePoint referencePoint() const { return mReferencePoint; }
586
593 virtual QgsLayoutSize fixedSize() const { return mFixedSize; }
594
601 virtual QgsLayoutSize minimumSize() const { return mMinimumSize; }
602
617 virtual void attemptResize( const QgsLayoutSize &size, bool includesFrame = false );
618
644 virtual void attemptMove( const QgsLayoutPoint &point, bool useReferencePoint = true, bool includesFrame = false, int page = -1 );
645
661 void attemptSetSceneRect( const QRectF &rect, bool includesFrame = false );
662
675 void attemptMoveBy( double deltaX, double deltaY );
676
685 QgsLayoutPoint positionWithUnits() const { return mItemPosition; }
686
691 int page() const;
692
698 QPointF pagePos() const;
699
705 QgsLayoutPoint pagePositionWithUnits() const;
706
712 QgsLayoutSize sizeWithUnits() const { return mItemSize; }
713
724 double itemRotation() const;
725
733 bool writeXml( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const;
734
750 bool readXml( const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context );
751
760 virtual void finalizeRestoreFromXml();
761
762 QgsAbstractLayoutUndoCommand *createCommand( const QString &text, int id, QUndoCommand *parent = nullptr ) override SIP_FACTORY;
763
771 bool frameEnabled() const { return mFrame; }
772
780 virtual void setFrameEnabled( bool drawFrame );
781
789 void setFrameStrokeColor( const QColor &color );
790
798 QColor frameStrokeColor() const { return mFrameColor; }
799
807 virtual void setFrameStrokeWidth( QgsLayoutMeasurement width );
808
816 QgsLayoutMeasurement frameStrokeWidth() const { return mFrameWidth; }
817
825 Qt::PenJoinStyle frameJoinStyle() const { return mFrameJoinStyle; }
826
834 void setFrameJoinStyle( Qt::PenJoinStyle style );
835
841 bool hasBackground() const { return mBackground; }
842
848 void setBackgroundEnabled( bool drawBackground );
849
857 QColor backgroundColor( bool useDataDefined = true ) const;
858
864 void setBackgroundColor( const QColor &color );
865
870 QPainter::CompositionMode blendMode() const { return mBlendMode; }
871
876 void setBlendMode( QPainter::CompositionMode mode );
877
885 double itemOpacity() const { return mOpacity; }
886
894 void setItemOpacity( double opacity );
895
900 bool excludeFromExports() const;
901
906 void setExcludeFromExports( bool exclude );
907
917 virtual bool containsAdvancedEffects() const;
918
924 virtual bool requiresRasterization() const;
925
936 virtual double estimatedFrameBleed() const;
937
947 virtual QRectF rectWithFrame() const;
948
955 virtual void moveContent( double dx, double dy );
956
963 virtual void setMoveContentPreviewOffset( double dx, double dy );
964
971 virtual void zoomContent( double factor, QPointF point );
972
981 void beginCommand( const QString &commandText, UndoCommand command = UndoNone );
982
988 void endCommand();
989
995 void cancelCommand();
996
1000 bool shouldDrawItem() const;
1001
1002 QgsExpressionContext createExpressionContext() const override;
1003
1013 virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
1014
1023 virtual QgsGeometry clipPath() const;
1024
1030 virtual bool isRefreshing() const;
1031
1032 public slots:
1033
1038 void refresh() override;
1039
1043 virtual void invalidateCache();
1044
1048 virtual void redraw();
1049
1056 virtual void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::DataDefinedProperty::AllProperties );
1057
1067 virtual void setItemRotation( double rotation, bool adjustPosition = true );
1068
1074 virtual void rotateItem( double angle, QPointF transformOrigin );
1075
1076 signals:
1077
1082
1089
1093 void rotationChanged( double newRotation );
1094
1099
1106
1115
1116 protected:
1117
1123 virtual void drawDebugRect( QPainter *painter );
1124
1131 virtual void draw( QgsLayoutItemRenderContext &context ) = 0;
1132
1140 virtual QPainterPath framePath() const;
1141
1147 virtual void drawFrame( QgsRenderContext &context );
1148
1154 virtual void drawBackground( QgsRenderContext &context );
1155
1161 void drawRefreshingOverlay( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle );
1162
1169 virtual void setFixedSize( const QgsLayoutSize &size );
1170
1177 virtual void setMinimumSize( const QgsLayoutSize &size );
1178
1187 virtual QSizeF applyItemSizeConstraint( QSizeF targetSize );
1188
1196 void refreshItemSize();
1197
1203 void refreshItemPosition();
1204
1215 void refreshItemRotation( QPointF *origin = nullptr );
1216
1222 void refreshOpacity( bool updateItem = true );
1223
1229 void refreshFrame( bool updateItem = true );
1230
1236 void refreshBackgroundColor( bool updateItem = true );
1237
1241 void refreshBlendMode();
1242
1247 QPointF adjustPointForReferencePosition( QPointF point, QSizeF size, ReferencePoint reference ) const;
1248
1252 QPointF positionAtReferencePoint( ReferencePoint reference ) const;
1253
1258 QgsLayoutPoint topLeftToReferencePoint( const QgsLayoutPoint &point ) const;
1259
1268 virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
1269
1285 virtual bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );
1286
1290 QgsLayoutSize applyDataDefinedSize( const QgsLayoutSize &size );
1291
1292 private:
1293
1294 // true if layout manages the z value for this item
1295 bool mLayoutManagesZValue = false;
1296
1298 QString mId;
1299
1301 QString mUuid;
1302
1304 QString mTemplateUuid;
1305
1307 QString mParentGroupUuid;
1308
1309 ReferencePoint mReferencePoint = UpperLeft;
1310 QgsLayoutSize mFixedSize;
1311 QgsLayoutSize mMinimumSize;
1312
1313 QgsLayoutSize mItemSize;
1314 QgsLayoutPoint mItemPosition;
1315 double mItemRotation = 0.0;
1316
1318 bool mExcludeFromExports = false;
1319
1324 bool mEvaluatedExcludeFromExports = false;
1325
1327 QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
1329 QPainter::CompositionMode mEvaluatedBlendMode = QPainter::CompositionMode_SourceOver;
1330
1331 QPainter::CompositionMode blendModeForRender() const;
1332
1334 double mOpacity = 1.0;
1335 double mEvaluatedOpacity = 1.0;
1336
1337 QImage mItemCachedImage;
1338 double mItemCacheDpi = -1;
1339
1340 bool mIsLocked = false;
1341
1343 bool mFrame = false;
1345 QColor mFrameColor = QColor( 0, 0, 0 );
1349 Qt::PenJoinStyle mFrameJoinStyle = Qt::MiterJoin;
1350
1352 bool mBackground = true;
1354 QColor mBackgroundColor = QColor( 255, 255, 255 );
1355
1356 bool mBlockUndoCommands = false;
1357
1358 void initConnectionsToLayout();
1359
1361 void preparePainter( QPainter *painter );
1362 bool shouldDrawAntialiased() const;
1363 bool shouldDrawDebugRect() const;
1364 QSizeF applyMinimumSize( QSizeF targetSize );
1365 QSizeF applyFixedSize( QSizeF targetSize );
1366 QgsLayoutPoint applyDataDefinedPosition( const QgsLayoutPoint &position );
1367
1368 double applyDataDefinedRotation( double rotation );
1369 void updateStoredItemPosition();
1370 QPointF itemPositionAtReferencePoint( ReferencePoint reference, QSizeF size ) const;
1371 void setScenePos( QPointF destinationPos );
1372 bool shouldBlockUndoCommands() const;
1373
1374 void applyDataDefinedOrientation( double &width, double &height, const QgsExpressionContext &context );
1375
1376 friend class TestQgsLayoutItem;
1377 friend class TestQgsLayoutView;
1378 friend class QgsLayout;
1380 friend class QgsLayoutItemMap;
1384};
1385
1387
1388#endif //QGSLAYOUTITEM_H
1389
1390
1391
@ Millimeters
Millimeters.
Base class for commands to undo/redo layout and layout object changes.
QgsCompositionConverter class converts a QGIS 2.x composition to a QGIS 3.x layout.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
A geometry is the spatial representation of a feature.
A QGraphicsEffect subclass used for rendering layout items onto a scene with custom composition modes...
Base class for frame items, which form a layout multiframe item.
A layout item subclass for elevation profile plots.
A container for grouping several QgsLayoutItems.
A layout item subclass for text labels.
A layout item subclass for map legends.
Layout graphical items for displaying a map.
A layout item for showing marker symbols.
Item representing the paper in a layout.
A layout item subclass that displays SVG files or raster format images (jpg, png, ....
Layout item for node based polygon shapes.
Layout item for node based polyline shapes.
Contains settings and helpers relating to a render of a QgsLayoutItem.
QgsLayoutItemRenderContext & operator=(const QgsLayoutItemRenderContext &other)=delete
QgsLayoutItemRenderContext cannot be copied.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
double viewScaleFactor() const
Returns the current view zoom (scale factor).
QgsLayoutItemRenderContext(const QgsLayoutItemRenderContext &other)=delete
QgsLayoutItemRenderContext cannot be copied.
const QgsRenderContext & renderContext() const
Returns a reference to the context's render context.
A layout item subclass for scale bars.
Layout item for basic filled shapes (e.g.
Base class for graphical items within a QgsLayout.
QgsLayoutSize sizeWithUnits() const
Returns the item's current size, including units.
UndoCommand
Layout item undo commands, used for collapsing undo commands.
@ UndoScaleBarSubdivisionsHeight
Scalebar subdivisions height.
@ UndoPictureStrokeWidth
Picture stroke width.
@ UndoLegendMinSymbolSize
Legend minimum symbol size.
@ UndoArrowHeadStrokeColor
Arrow head stroke color.
@ UndoLegendTitleSpaceBottom
Legend title space.
@ UndoScaleBarLabelBarSize
Scalebar label bar size.
@ UndoLegendIconSymbolSpace
Legend icon symbol space.
@ UndoLegendLayerFont
Legend layer font.
@ UndoShapeCornerRadius
Shape corner radius.
@ UndoLegendLineSpacing
Legend line spacing.
@ UndoLegendBoxSpace
Legend box space.
@ UndoScaleBarFillColor
Scalebar fill color.
@ UndoArrowHeadFillColor
Arrow head fill color.
@ UndoLegendRasterStrokeColor
Legend raster stroke color.
@ UndoLabelFontColor
Label color.
@ UndoScaleBarMapUnitsSegment
Scalebar map units per segment.
@ UndoElevationProfileElevationMajorGridlines
Change elevation profile elevation axis major gridlines.
@ UndoLegendTitleFont
Legend title font.
@ UndoBackgroundColor
Background color adjustment.
@ UndoLegendFontColor
Legend font color.
@ UndoElevationProfileMaximumDistance
Change elevation profile maximum distance.
@ UndoScaleBarBoxContentSpace
Scalebar box context space.
@ UndoOverviewStyle
Map overview style.
@ UndoElevationProfileChartBackground
Change elevation profile chart background.
@ UndoGridFramePenColor
Map grid frame pen color.
@ UndoMapRotation
Map rotation changed.
@ UndoOpacity
Opacity adjustment.
@ UndoIncrementalResize
Incremental resize.
@ UndoArrowHeadWidth
Arrow head width.
@ UndoElevationProfileDistanceMinorGridlines
Change elevation profile distance axis minor gridlines.
@ UndoScaleBarSegmentSize
Scalebar segment size.
@ UndoMarginTop
Top margin (since QGIS 3.30)
@ UndoLegendItemFont
Legend item font.
@ UndoLegendWmsLegendWidth
Legend WMS width.
@ UndoMapGridIntervalRange
Grid interval range.
@ UndoLegendLayerSpace
Legend layer spacing.
@ UndoLabelMargin
Label margin.
@ UndoRotation
Rotation adjustment.
@ UndoLegendColumnSpace
Legend column space.
@ UndoPictureRotation
Picture rotation.
@ UndoStrokeWidth
Stroke width adjustment.
@ UndoScaleBarFillColor2
Scalebar secondary fill color.
@ UndoScaleBarHeight
Scalebar height.
@ UndoLegendMaxSymbolSize
Legend maximum symbol size.
@ UndoArrowStrokeWidth
Arrow stroke width.
@ UndoElevationProfileChartBorder
Change elevation profile chart border.
@ UndoMapGridLineSymbol
Grid line symbol.
@ UndoExportLayerName
Export layer name (since QGIS 3.40)
@ UndoZoomContent
Item content zoomed.
@ UndoScaleBarFontColor
Scalebar font color.
@ UndoElevationProfileMaximumElevation
Change elevation profile maximum elevation.
@ UndoMarginLeft
Left margin (since QGIS 3.30)
@ UndoMarginRight
Right margin (since QGIS 3.30)
@ UndoMapGridMarkerSymbol
Grid marker symbol.
@ UndoAtlasMargin
Map atlas margin changed.
@ UndoPictureFillColor
Picture fill color.
@ UndoLegendSymbolSpace
Legend symbol spacing.
@ UndoMapGridFrameFill1Color
Map grid frame fill color 1.
@ UndoElevationProfileTolerance
Change elevation profile distance tolerance.
@ UndoElevationProfileElevationFormat
Change elevation profile elevation axis number format.
@ UndoLegendSymbolWidth
Legend symbol width.
@ UndoLegendColumnCount
Legend column count.
@ UndoScaleBarSegments
Scalebar number of segments.
@ UndoLegendSymbolHeight
Legend symbol height.
@ UndoElevationProfileMinimumElevation
Change elevation profile minimum elevation.
@ UndoElevationProfileDistanceLabels
Change elevation profile distance axis label interval.
@ UndoLegendGroupSpace
Legend group spacing.
@ UndoScaleBarSubdivisions
Scalebar number of subdivisions.
@ UndoMarginBottom
Bottom margin (since QGIS 3.30)
@ UndoSetId
Change item ID.
@ UndoLegendSubgroupIndent
Legend subgroup indent.
@ UndoScaleBarLineWidth
Scalebar line width.
@ UndoElevationProfileElevationFont
Change elevation profile elevation axis number font.
@ UndoLegendRasterStrokeWidth
Legend raster stroke width.
@ UndoLegendGroupIndent
Legend group indent.
@ UndoElevationProfileDistanceFormat
Change elevation profile distance axis number format.
@ UndoMapGridAnnotationFontColor
Map frame annotation color.
@ UndoPictureNorthOffset
Picture north offset.
@ UndoElevationProfileElevationMinorGridlines
Change elevation profile elevation axis minor gridlines.
@ UndoCustomCommand
Base id for plugin based item undo commands.
@ UndoLabelFont
Label font.
@ UndoPictureStrokeColor
Picture stroke color.
@ UndoElevationProfileDistanceFont
Change elevation profile distance axis number font.
@ UndoMapAnnotationDistance
Map frame annotation distance.
@ UndoScaleBarStrokeColor
Scalebar stroke color.
@ UndoShapeStyle
Shape symbol style.
@ UndoStrokeColor
Stroke color adjustment.
@ UndoElevationProfileElevationLabels
Change elevation profile elevation axis label interval.
@ UndoScaleBarSegmentsLeft
Scalebar segments left.
@ UndoElevationProfileDistanceMajorGridlines
Change elevation profile distance axis major gridlines.
@ UndoLegendText
Legend text.
@ UndoNodeMove
Node move.
@ UndoMapGridFrameFill2Color
Map grid frame fill color 2.
@ UndoScaleBarUnitText
Scalebar unit text.
@ UndoMapLabelMargin
Margin for labels from edge of map.
@ UndoLegendWmsLegendHeight
Legend WMS height.
@ UndoElevationProfileMinimumDistance
Change elevation profile minimum distance.
@ UndoLabelText
Label text.
@ UndoLegendGroupFont
Legend group font.
void rotationChanged(double newRotation)
Emitted on item rotation change.
QgsLayoutMeasurement frameStrokeWidth() const
Returns the frame's stroke width.
bool isLocked() const
Returns true if the item is locked, and cannot be interacted with using the mouse.
double itemOpacity() const
Returns the item's opacity.
ReferencePoint referencePoint() const
Returns the reference point for positioning of the layout item.
QgsLayoutPoint positionWithUnits() const
Returns the item's current position, including units.
ReferencePoint
Fixed position reference point.
@ LowerMiddle
Lower center of item.
@ MiddleLeft
Middle left of item.
@ Middle
Center of item.
@ UpperRight
Upper right corner of item.
@ LowerLeft
Lower left corner of item.
@ UpperLeft
Upper left corner of item.
@ UpperMiddle
Upper center of item.
@ MiddleRight
Middle right of item.
@ LowerRight
Lower right corner of item.
virtual QgsLayoutSize minimumSize() const
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely r...
Flag
Flags for controlling how an item behaves.
virtual QgsLayoutSize fixedSize() const
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized.
void sizePositionChanged()
Emitted when the item's size or position changes.
void lockChanged()
Emitted if the item's lock status changes.
virtual QString uuid() const
Returns the item identification string.
QString id() const
Returns the item's ID name.
void frameChanged()
Emitted if the item's frame style changes.
ExportLayerBehavior
Behavior of item when exporting to layered outputs.
@ ItemContainsSubLayers
Item contains multiple sublayers which must be individually exported.
@ MustPlaceInOwnLayer
Item must be placed in its own individual layer.
@ CanGroupWithItemsOfSameType
Item can only be placed on layers with other items of the same type, but multiple items of this type ...
@ CanGroupWithAnyOtherItem
Item can be placed on a layer with any other item (default behavior)
void clipPathChanged()
Emitted when the item's clipping path has changed.
bool hasBackground() const
Returns true if the item has a background.
QFlags< Flag > Flags
QColor frameStrokeColor() const
Returns the frame's stroke color.
QPainter::CompositionMode blendMode() const
Returns the item's composition blending mode.
virtual void draw(QgsLayoutItemRenderContext &context)=0
Draws the item's contents using the specified item render context.
void backgroundTaskCountChanged(int count)
Emitted whenever the number of background tasks an item is executing changes.
Qt::PenJoinStyle frameJoinStyle() const
Returns the join style used for drawing the item's frame.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
A base class for objects which belong to a layout.
DataDefinedProperty
Data defined properties for different item types.
@ AllProperties
All properties for item.
This class provides a method of storing points, consisting of an x and y coordinate,...
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Interface for layout objects which support undo/redo commands.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
An interface for classes which can visit style entity (e.g.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_FORCE
Definition qgis_sip.h:131
#define SIP_ENUM_BASETYPE(type)
Definition qgis_sip.h:278
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_END
Definition qgis_sip.h:208
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)
Contains details of a particular export layer relating to a layout item.
QString mapLayerId
Associated map layer ID, or an empty string if this export layer is not associated with a map layer.
QString name
User-friendly name for the export layer.
QString groupName
Associated group name, if this layer is associated with an export group.
QString mapTheme
Associated map theme, or an empty string if this export layer does not need to be associated with a m...