A layout item subclass that displays SVG files or raster format images (jpg, png, ...). More...

#include <qgslayoutitempicture.h>

Inheritance diagram for QgsLayoutItemPicture:

[legend]

Public Types
enum	NorthMode { GridNorth = 0 , TrueNorth }
	Method for syncing rotation to a map's North direction. More...

enum	ResizeMode { Zoom , Stretch , Clip , ZoomResizeFrame , FrameToImageSize }
	Controls how pictures are scaled within the item's frame. More...

Public Types inherited from QgsLayoutItem
enum	ExportLayerBehavior { CanGroupWithAnyOtherItem , CanGroupWithItemsOfSameType , MustPlaceInOwnLayer , ItemContainsSubLayers }
	Behavior of item when exporting to layered outputs. More...

enum	Flag { FlagOverridesPaint = 1 << 1 , FlagProvidesClipPath = 1 << 2 , FlagDisableSceneCaching = 1 << 3 }
	Flags for controlling how an item behaves. More...

typedef QFlags< Flag >	Flags

enum	ReferencePoint { UpperLeft , UpperMiddle , UpperRight , MiddleLeft , Middle , MiddleRight , LowerLeft , LowerMiddle , LowerRight }
	Fixed position reference point. More...

enum	UndoCommand { UndoNone = -1 , UndoIncrementalMove = 1 , UndoIncrementalResize , UndoStrokeColor , UndoStrokeWidth , UndoBackgroundColor , UndoOpacity , UndoMarginLeft , UndoMarginTop , UndoMarginBottom , UndoMarginRight , UndoSetId , UndoRotation , UndoExportLayerName , UndoShapeStyle , UndoShapeCornerRadius , UndoNodeMove , UndoAtlasMargin , UndoMapRotation , UndoZoomContent , UndoOverviewStyle , UndoGridFramePenColor , UndoMapGridFrameFill1Color , UndoMapGridFrameFill2Color , UndoMapAnnotationDistance , UndoMapGridAnnotationFontColor , UndoMapGridLineSymbol , UndoMapGridMarkerSymbol , UndoMapGridIntervalRange , UndoMapLabelMargin , UndoPictureRotation , UndoPictureFillColor , UndoPictureStrokeColor , UndoPictureStrokeWidth , UndoPictureNorthOffset , UndoLabelText , UndoLabelFont , UndoLabelMargin , UndoLabelFontColor , UndoLegendText , UndoLegendColumnCount , UndoLegendSymbolWidth , UndoLegendSymbolHeight , UndoLegendMaxSymbolSize , UndoLegendMinSymbolSize , UndoLegendWmsLegendWidth , UndoLegendWmsLegendHeight , UndoLegendTitleSpaceBottom , UndoLegendGroupSpace , UndoLegendGroupIndent , UndoLegendSubgroupIndent , UndoLegendLayerSpace , UndoLegendSymbolSpace , UndoLegendIconSymbolSpace , UndoLegendFontColor , UndoLegendBoxSpace , UndoLegendColumnSpace , UndoLegendLineSpacing , UndoLegendRasterStrokeWidth , UndoLegendRasterStrokeColor , UndoLegendTitleFont , UndoLegendGroupFont , UndoLegendLayerFont , UndoLegendItemFont , UndoScaleBarLineWidth , UndoScaleBarSegmentSize , UndoScaleBarSegmentsLeft , UndoScaleBarSegments , UndoScaleBarHeight , UndoScaleBarSubdivisions , UndoScaleBarSubdivisionsHeight , UndoScaleBarFontColor , UndoScaleBarFillColor , UndoScaleBarFillColor2 , UndoScaleBarStrokeColor , UndoScaleBarUnitText , UndoScaleBarMapUnitsSegment , UndoScaleBarLabelBarSize , UndoScaleBarBoxContentSpace , UndoArrowStrokeWidth , UndoArrowHeadWidth , UndoArrowHeadFillColor , UndoArrowHeadStrokeColor , UndoElevationProfileTolerance , UndoElevationProfileChartBackground , UndoElevationProfileChartBorder , UndoElevationProfileDistanceMajorGridlines , UndoElevationProfileDistanceMinorGridlines , UndoElevationProfileDistanceFormat , UndoElevationProfileDistanceFont , UndoElevationProfileDistanceLabels , UndoElevationProfileElevationMajorGridlines , UndoElevationProfileElevationMinorGridlines , UndoElevationProfileElevationFormat , UndoElevationProfileElevationFont , UndoElevationProfileElevationLabels , UndoElevationProfileMinimumDistance , UndoElevationProfileMaximumDistance , UndoElevationProfileMinimumElevation , UndoElevationProfileMaximumElevation , UndoCustomCommand }
	Layout item undo commands, used for collapsing undo commands. More...

Public Types inherited from QgsLayoutObject
enum class	DataDefinedProperty : int { NoProperty = 0 , AllProperties , TestProperty , PresetPaperSize , PaperWidth , PaperHeight , NumPages , PaperOrientation , PageNumber , PositionX , PositionY , ItemWidth , ItemHeight , ItemRotation , Transparency , Opacity , BlendMode , ExcludeFromExports , FrameColor , BackgroundColor , MarginLeft , MarginTop , MarginRight , MarginBottom , MapRotation , MapScale , MapXMin , MapYMin , MapXMax , MapYMax , MapAtlasMargin , MapLayers , MapStylePreset , MapLabelMargin , MapGridEnabled , MapGridIntervalX , MapGridIntervalY , MapGridOffsetX , MapGridOffsetY , MapGridFrameSize , MapGridFrameMargin , MapGridLabelDistance , MapGridCrossSize , MapGridFrameLineThickness , MapGridAnnotationDisplayLeft , MapGridAnnotationDisplayRight , MapGridAnnotationDisplayTop , MapGridAnnotationDisplayBottom , MapGridFrameDivisionsLeft , MapGridFrameDivisionsRight , MapGridFrameDivisionsTop , MapGridFrameDivisionsBottom , MapCrs , StartDateTime , EndDateTime , MapZRangeLower , MapZRangeUpper , PictureSource , PictureSvgBackgroundColor , PictureSvgStrokeColor , PictureSvgStrokeWidth , SourceUrl , LegendTitle , LegendColumnCount , ScalebarLeftSegments , ScalebarRightSegments , ScalebarSegmentWidth , ScalebarMinimumWidth , ScalebarMaximumWidth , ScalebarHeight , ScalebarRightSegmentSubdivisions , ScalebarSubdivisionHeight , ScalebarFillColor , ScalebarFillColor2 , ScalebarLineColor , ScalebarLineWidth , AttributeTableSourceLayer , ElevationProfileTolerance , ElevationProfileDistanceMajorInterval , ElevationProfileDistanceMinorInterval , ElevationProfileDistanceLabelInterval , ElevationProfileElevationMajorInterval , ElevationProfileElevationMinorInterval , ElevationProfileElevationLabelInterval , ElevationProfileMinimumDistance , ElevationProfileMaximumDistance , ElevationProfileMinimumElevation , ElevationProfileMaximumElevation }
	Data defined properties for different item types. More...

enum	PropertyValueType { EvaluatedValue = 0 , OriginalValue }
	Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...

Public Slots
void	recalculateSize ()
	Forces a recalculation of the picture's frame size.

void	refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::DataDefinedProperty::AllProperties) override

void	refreshPicture (const QgsExpressionContext *context=nullptr)
	Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.

void	setPictureRotation (double rotation)
	Sets the picture rotation within the item bounds, in degrees clockwise.

void	setResizeMode (QgsLayoutItemPicture::ResizeMode mode)
	Sets the resize mode used for drawing the picture within the item bounds.

Public Slots inherited from QgsLayoutItem
virtual void	invalidateCache ()
	Forces a deferred update of any cached image the item uses.

virtual void	redraw ()
	Triggers a redraw (update) of the item.

void	refresh () override
	Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size.

virtual void	refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::DataDefinedProperty::AllProperties)
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.

virtual void	rotateItem (double angle, QPointF transformOrigin)
	Rotates the item by a specified angle in degrees clockwise around a specified reference point.

virtual void	setItemRotation (double rotation, bool adjustPosition=true)
	Sets the layout item's rotation, in degrees clockwise.

Public Slots inherited from QgsLayoutObject
virtual void	refresh ()
	Refreshes the object, causing a recalculation of any property overrides.

Signals
void	pictureRotationChanged (double newRotation)
	Emitted on picture rotation change.

Signals inherited from QgsLayoutItem
void	backgroundTaskCountChanged (int count)
	Emitted whenever the number of background tasks an item is executing changes.

void	clipPathChanged ()
	Emitted when the item's clipping path has changed.

void	frameChanged ()
	Emitted if the item's frame style changes.

void	lockChanged ()
	Emitted if the item's lock status changes.

void	rotationChanged (double newRotation)
	Emitted on item rotation change.

void	sizePositionChanged ()
	Emitted when the item's size or position changes.

Signals inherited from QgsLayoutObject
void	changed ()
	Emitted when the object's properties change.

Public Member Functions
	QgsLayoutItemPicture (QgsLayout *layout)
	Constructor for QgsLayoutItemPicture, with the specified parent layout.

QString	evaluatedPath () const
	Returns the current evaluated picture path, which includes the result of data defined path overrides.

void	finalizeRestoreFromXml () override
	Called after all pending items have been restored from XML.

QIcon	icon () const override
	Returns the item's icon.

bool	isMissingImage () const
	Returns `true` if the source image is missing and the picture cannot be rendered.

QgsLayoutItemMap *	linkedMap () const
	Returns the linked rotation map, if set.

Qgis::PictureFormat	mode () const
	Returns the current picture mode (image format), FormatUnknown if given picture format is unknown.

NorthMode	northMode () const
	Returns the mode used to align the picture to a map's North.

double	northOffset () const
	Returns the offset added to the picture's rotation from a map's North.

Qgis::PictureFormat	originalMode () const
	Returns the original set picture mode (image format).

QgsLayoutItem::ReferencePoint	pictureAnchor () const
	Returns the picture's current anchor, which controls how it is placed within the picture item's frame.

QString	picturePath () const
	Returns the path of the source image.

double	pictureRotation () const
	Returns the rotation used for drawing the picture within the item's frame, in degrees clockwise.

ResizeMode	resizeMode () const
	Returns the resize mode used for drawing the picture within the layout item's frame.

void	setLinkedMap (QgsLayoutItemMap *map)
	Sets the map object for rotation.

void	setMode (Qgis::PictureFormat mode)
	Sets the current picture mode (image format).

void	setNorthMode (NorthMode mode)
	Sets the mode used to align the picture to a map's North.

void	setNorthOffset (double offset)
	Sets the offset added to the picture's rotation from a map's North.

void	setPictureAnchor (QgsLayoutItem::ReferencePoint anchor)
	Sets the picture's anchor point, which controls how it is placed within the picture item's frame.

void	setPicturePath (const QString &path, Qgis::PictureFormat format=Qgis::PictureFormat::Unknown)
	Sets the source path of the image (may be svg or a raster format).

void	setSvgDynamicParameters (const QMap< QString, QgsProperty > &parameters)
	Sets the SVG dynamic parameters.

void	setSvgFillColor (const QColor &color)
	Sets the fill color used for parametrized SVG files.

void	setSvgStrokeColor (const QColor &color)
	Sets the stroke color used for parametrized SVG files.

void	setSvgStrokeWidth (double width)
	Sets the stroke width (in layout units) used for parametrized SVG files.

QMap< QString, QgsProperty >	svgDynamicParameters () const
	Returns the SVG dynamic parameters.

QColor	svgFillColor () const
	Returns the fill color used for parametrized SVG files.

QColor	svgStrokeColor () const
	Returns the stroke color used for parametrized SVG files.

double	svgStrokeWidth () const
	Returns the stroke width (in layout units) used for parametrized SVG files.

int	type () const override

Public Member Functions inherited from QgsLayoutItem
	QgsLayoutItem (QgsLayout *layout, bool manageZValue=true)
	Constructor for QgsLayoutItem, with the specified parent layout.

	~QgsLayoutItem () override

virtual bool	accept (QgsStyleEntityVisitorInterface *visitor) const
	Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item.

virtual void	attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1)
	Attempts to move the item to a specified point.

void	attemptMoveBy (double deltaX, double deltaY)
	Attempts to shift the item's position by a specified deltaX and deltaY, in layout units.

virtual void	attemptResize (const QgsLayoutSize &size, bool includesFrame=false)
	Attempts to resize the item to a specified target size.

void	attemptSetSceneRect (const QRectF &rect, bool includesFrame=false)
	Attempts to update the item's position and size to match the passed rect in layout coordinates.

QColor	backgroundColor (bool useDataDefined=true) const
	Returns the background color for this item.

void	beginCommand (const QString &commandText, UndoCommand command=UndoNone)
	Starts new undo command for this item.

QPainter::CompositionMode	blendMode () const
	Returns the item's composition blending mode.

void	cancelCommand ()
	Cancels the current item command and discards it.

virtual void	cleanup ()
	Called just before a batch of items are deleted, allowing them to run cleanup tasks.

virtual QgsGeometry	clipPath () const
	Returns the clipping path generated by this item, in layout coordinates.

virtual bool	containsAdvancedEffects () const
	Returns `true` if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item.

QgsAbstractLayoutUndoCommand *	createCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override
	Creates a new layout undo command with the specified text and parent.

QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.

virtual QString	displayName () const
	Gets item display name.

void	endCommand ()
	Completes the current item command and push it onto the layout's undo stack.

virtual double	estimatedFrameBleed () const
	Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.

bool	excludeFromExports () const
	Returns whether the item should be excluded from layout exports and prints.

virtual ExportLayerBehavior	exportLayerBehavior () const
	Returns the behavior of this item during exporting to layered exports (e.g.

virtual QgsLayoutItem::ExportLayerDetail	exportLayerDetails () const
	Returns the details for the specified current export layer.

virtual QgsLayoutSize	fixedSize () const
	Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized.

bool	frameEnabled () const
	Returns `true` if the item includes a frame.

Qt::PenJoinStyle	frameJoinStyle () const
	Returns the join style used for drawing the item's frame.

QColor	frameStrokeColor () const
	Returns the frame's stroke color.

QgsLayoutMeasurement	frameStrokeWidth () const
	Returns the frame's stroke width.

bool	hasBackground () const
	Returns `true` if the item has a background.

QString	id () const
	Returns the item's ID name.

bool	isGroupMember () const
	Returns `true` if the item is part of a QgsLayoutItemGroup group.

bool	isLocked () const
	Returns `true` if the item is locked, and cannot be interacted with using the mouse.

virtual bool	isRefreshing () const
	Returns `true` if the item is currently refreshing content in the background.

virtual Flags	itemFlags () const
	Returns the item's flags, which indicate how the item behaves.

double	itemOpacity () const
	Returns the item's opacity.

double	itemRotation () const
	Returns the current rotation for the item, in degrees clockwise.

virtual QgsLayoutSize	minimumSize () const
	Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized.

virtual void	moveContent (double dx, double dy)
	Moves the content of the item, by a specified dx and dy in layout units.

virtual bool	nextExportPart ()
	Moves to the next export part for a multi-layered export item, during a multi-layered export.

virtual Q_DECL_DEPRECATED int	numberExportLayers () const
	Returns the number of layers that this item requires for exporting during layered exports (e.g.

int	page () const
	Returns the page the item is currently on, with the first page returning 0.

QPointF	pagePos () const
	Returns the item's position (in layout units) relative to the top left corner of its current page.

QgsLayoutPoint	pagePositionWithUnits () const
	Returns the item's position (in item units) relative to the top left corner of its current page.

void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget) override
	Handles preparing a paint surface for the layout item and painting the item's content.

QgsLayoutItemGroup *	parentGroup () const
	Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group.

QgsLayoutPoint	positionWithUnits () const
	Returns the item's current position, including units.

bool	readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context)
	Sets the item state from a DOM element.

virtual QRectF	rectWithFrame () const
	Returns the item's rectangular bounds, including any bleed caused by the item's frame.

ReferencePoint	referencePoint () const
	Returns the reference point for positioning of the layout item.

virtual bool	requiresRasterization () const
	Returns `true` if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats.

void	setBackgroundColor (const QColor &color)
	Sets the background color for this item.

void	setBackgroundEnabled (bool drawBackground)
	Sets whether this item has a background drawn under it or not.

void	setBlendMode (QPainter::CompositionMode mode)
	Sets the item's composition blending mode.

void	setExcludeFromExports (bool exclude)
	Sets whether the item should be excluded from layout exports and prints.

virtual void	setFrameEnabled (bool drawFrame)
	Sets whether this item has a frame drawn around it or not.

void	setFrameJoinStyle (Qt::PenJoinStyle style)
	Sets the join style used when drawing the item's frame.

void	setFrameStrokeColor (const QColor &color)
	Sets the frame stroke color.

virtual void	setFrameStrokeWidth (QgsLayoutMeasurement width)
	Sets the frame stroke width.

virtual void	setId (const QString &id)
	Set the item's id name.

void	setItemOpacity (double opacity)
	Sets the item's opacity.

void	setLocked (bool locked)
	Sets whether the item is locked, preventing mouse interactions with the item.

virtual void	setMoveContentPreviewOffset (double dx, double dy)
	Sets temporary offset for the item, by a specified dx and dy in layout units.

void	setParentGroup (QgsLayoutItemGroup *group)
	Sets the item's parent group.

void	setReferencePoint (ReferencePoint point)
	Sets the reference point for positioning of the layout item.

virtual void	setSelected (bool selected)
	Sets whether the item should be selected.

virtual void	setVisibility (bool visible)
	Sets whether the item is visible.

bool	shouldDrawItem () const
	Returns whether the item should be drawn in the current context.

QgsLayoutSize	sizeWithUnits () const
	Returns the item's current size, including units.

virtual void	startLayeredExport ()
	Starts a multi-layer export operation.

virtual void	stopLayeredExport ()
	Stops a multi-layer export operation.

int	type () const override
	Returns a unique graphics item type identifier.

virtual QString	uuid () const
	Returns the item identification string.

bool	writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
	Stores the item state in a DOM element.

virtual void	zoomContent (double factor, QPointF point)
	Zooms content of item.

Public Member Functions inherited from QgsLayoutObject
	QgsLayoutObject (QgsLayout *layout)
	Constructor for QgsLayoutObject, with the specified parent layout.

QgsExpressionContext	createExpressionContext () const override
	Creates an expression context relating to the objects' current state.

QStringList	customProperties () const
	Returns list of keys stored in custom properties for the object.

QVariant	customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const
	Read a custom property from the object.

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the object's property collection, used for data defined overrides.

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the object's property collection, used for data defined overrides.

QgsLayout *	layout ()
	Returns the layout the object is attached to.

const QgsLayout *	layout () const
	Returns the layout the object is attached to.

void	removeCustomProperty (const QString &key)
	Remove a custom property from the object.

void	setCustomProperty (const QString &key, const QVariant &value)
	Set a custom property for the object.

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the objects's property collection, used for data defined overrides.

Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Public Member Functions inherited from QgsLayoutUndoObjectInterface
virtual	~QgsLayoutUndoObjectInterface ()=default

Static Public Member Functions
static QgsLayoutItemPicture *	create (QgsLayout *layout)
	Returns a new picture item for the specified layout.

Static Public Member Functions inherited from QgsLayoutObject
static bool	propertyAssociatesWithParentMultiframe (DataDefinedProperty property)
	Returns `true` if the specified property key is normally associated with the parent QgsLayoutMultiFrame object instead of a child QgsLayoutFrame object.

static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the layout object property definitions.

Protected Member Functions
QSizeF	applyItemSizeConstraint (QSizeF targetSize) override
	Applies any item-specific size constraint handling to a given targetSize in layout units.

void	draw (QgsLayoutItemRenderContext &context) override
	Draws the item's contents using the specified item render context.

bool	readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
	Sets item state from a DOM element.

bool	writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
	Stores item state within an XML DOM element.

Protected Member Functions inherited from QgsLayoutItem
QPointF	adjustPointForReferencePosition (QPointF point, QSizeF size, ReferencePoint reference) const
	Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.

QgsLayoutSize	applyDataDefinedSize (const QgsLayoutSize &size)
	Applies any present data defined size overrides to the specified layout size.

virtual void	drawBackground (QgsRenderContext &context)
	Draws the background for the item.

virtual void	drawDebugRect (QPainter *painter)
	Draws a debugging rectangle of the item's current bounds within the specified painter.

virtual void	drawFrame (QgsRenderContext &context)
	Draws the frame around the item.

void	drawRefreshingOverlay (QPainter painter, const QStyleOptionGraphicsItem itemStyle)
	Draws a "refreshing" overlay icon on the item.

virtual QPainterPath	framePath () const
	Returns the path to use when drawing the item's frame or background.

QPointF	positionAtReferencePoint (ReferencePoint reference) const
	Returns the current position (in layout units) of a reference point for the item.

void	refreshBackgroundColor (bool updateItem=true)
	Refresh item's background color, considering data defined colors.

void	refreshBlendMode ()
	Refresh item's blend mode, considering data defined blend mode.

void	refreshFrame (bool updateItem=true)
	Refresh item's frame, considering data defined colors and frame size.

void	refreshItemPosition ()
	Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning.

void	refreshItemRotation (QPointF *origin=nullptr)
	Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation.

void	refreshItemSize ()
	Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes.

void	refreshOpacity (bool updateItem=true)
	Refresh item's opacity, considering data defined opacity.

virtual void	setFixedSize (const QgsLayoutSize &size)
	Sets a fixed size for the layout item, which prevents it from being freely resized.

virtual void	setMinimumSize (const QgsLayoutSize &size)
	Sets the minimum allowed size for the layout item.

QgsLayoutPoint	topLeftToReferencePoint (const QgsLayoutPoint &point) const
	Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point.

Protected Member Functions inherited from QgsLayoutObject
bool	readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
	Sets object properties from a DOM element.

bool	writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
	Stores object properties within an XML DOM element.

Friends
class	QgsCompositionConverter

class	TestQgsCompositionConverter

Additional Inherited Members
Protected Attributes inherited from QgsLayoutObject
QgsObjectCustomProperties	mCustomProperties
	Custom properties for object.

QgsPropertyCollection	mDataDefinedProperties

QPointer< QgsLayout >	mLayout

Properties inherited from QgsLayoutItem
bool	locked

Detailed Description

A layout item subclass that displays SVG files or raster format images (jpg, png, ...).

Definition at line 34 of file qgslayoutitempicture.h.

Member Enumeration Documentation

◆ NorthMode

enum QgsLayoutItemPicture::NorthMode

Method for syncing rotation to a map's North direction.

Enumerator
GridNorth	Align to grid north.
TrueNorth	Align to true north.

Definition at line 52 of file qgslayoutitempicture.h.

◆ ResizeMode

enum QgsLayoutItemPicture::ResizeMode

Controls how pictures are scaled within the item's frame.

Enumerator
Zoom	Enlarges image to fit frame while maintaining aspect ratio of picture.
Stretch	Stretches image to fit frame, ignores aspect ratio.
Clip	Draws image at original size and clips any portion which falls outside frame.
ZoomResizeFrame	Enlarges image to fit frame, then resizes frame to fit resultant image.
FrameToImageSize	Sets size of frame to match original size of image without scaling.

Definition at line 42 of file qgslayoutitempicture.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemPicture()

QgsLayoutItemPicture::QgsLayoutItemPicture ( QgsLayout * layout )

Constructor for QgsLayoutItemPicture, with the specified parent layout.

Definition at line 50 of file qgslayoutitempicture.cpp.

Member Function Documentation

◆ applyItemSizeConstraint()

QSizeF QgsLayoutItemPicture::applyItemSizeConstraint ( QSizeF targetSize )

overrideprotectedvirtual

Applies any item-specific size constraint handling to a given targetSize in layout units.

Subclasses can override this method if they need to apply advanced logic regarding item sizes, which cannot be covered by setFixedSize() or setMinimumSize(). Item size constraints are applied after fixed, minimum and data defined size constraints.

See also: setFixedSize(); setMinimumSize()

Reimplemented from QgsLayoutItem.

Definition at line 211 of file qgslayoutitempicture.cpp.

◆ create()

QgsLayoutItemPicture * QgsLayoutItemPicture::create ( QgsLayout * layout )

static

Returns a new picture item for the specified layout.

The caller takes responsibility for deleting the returned object.

Definition at line 80 of file qgslayoutitempicture.cpp.

◆ draw()

void QgsLayoutItemPicture::draw ( QgsLayoutItemRenderContext & context )

overrideprotectedvirtual

Draws the item's contents using the specified item render context.

Note that the context's painter has been scaled so that painter units are pixels. Use the QgsRenderContext methods to convert from millimeters or other units to the painter's units.

Implements QgsLayoutItem.

Definition at line 85 of file qgslayoutitempicture.cpp.

◆ evaluatedPath()

QString QgsLayoutItemPicture::evaluatedPath ( ) const

Returns the current evaluated picture path, which includes the result of data defined path overrides.

See also: picturePath()

Since: QGIS 3.6

Definition at line 633 of file qgslayoutitempicture.cpp.

◆ finalizeRestoreFromXml()

void QgsLayoutItemPicture::finalizeRestoreFromXml ( )

overridevirtual

Called after all pending items have been restored from XML.

Items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. a scalebar can use this to connect to its linked map item after restoration from XML.

See also: readXml()

Reimplemented from QgsLayoutItem.

Definition at line 908 of file qgslayoutitempicture.cpp.

◆ icon()

QIcon QgsLayoutItemPicture::icon ( ) const

overridevirtual

Returns the item's icon.

Reimplemented from QgsLayoutItem.

Definition at line 75 of file qgslayoutitempicture.cpp.

◆ isMissingImage()

bool QgsLayoutItemPicture::isMissingImage ( ) const

Returns true if the source image is missing and the picture cannot be rendered.

Since: QGIS 3.6

Definition at line 628 of file qgslayoutitempicture.cpp.

◆ linkedMap()

QgsLayoutItemMap * QgsLayoutItemPicture::linkedMap ( ) const

Returns the linked rotation map, if set.

An nullptr means map rotation is disabled. If this is set then the picture is rotated by the same amount as the specified map object.

See also: setLinkedMap()

Definition at line 849 of file qgslayoutitempicture.cpp.

◆ mode()

Qgis::PictureFormat QgsLayoutItemPicture::mode ( ) const

inline

Returns the current picture mode (image format), FormatUnknown if given picture format is unknown.

See also: setMode(); originalMode()

Definition at line 226 of file qgslayoutitempicture.h.

◆ northMode()

QgsLayoutItemPicture::NorthMode QgsLayoutItemPicture::northMode ( ) const

Returns the mode used to align the picture to a map's North.

See also: setNorthMode(); northOffset()

Definition at line 854 of file qgslayoutitempicture.cpp.

◆ northOffset()

double QgsLayoutItemPicture::northOffset ( ) const

Returns the offset added to the picture's rotation from a map's North.

See also: setNorthOffset(); northMode()

Definition at line 864 of file qgslayoutitempicture.cpp.

◆ originalMode()

Qgis::PictureFormat QgsLayoutItemPicture::originalMode ( ) const

inline

Returns the original set picture mode (image format).

It could differ from mode() if given picture format is unknown

See also: setMode(); mode()

Since: QGIS 3.22

Definition at line 235 of file qgslayoutitempicture.h.

◆ pictureAnchor()

QgsLayoutItem::ReferencePoint QgsLayoutItemPicture::pictureAnchor ( ) const

inline

Returns the picture's current anchor, which controls how it is placed within the picture item's frame.

See also: setPictureAnchor()

Definition at line 169 of file qgslayoutitempicture.h.

◆ picturePath()

QString QgsLayoutItemPicture::picturePath ( ) const

Returns the path of the source image.

Data defined picture source may override this value. The path can either be a local path or a remote (http) path.

Returns: path for the source image

See also: setPicturePath(); evaluatedPath()

Definition at line 742 of file qgslayoutitempicture.cpp.

◆ pictureRotation()

double QgsLayoutItemPicture::pictureRotation ( ) const

inline

Returns the rotation used for drawing the picture within the item's frame, in degrees clockwise.

See also: setPictureRotation(); linkedMap()

Definition at line 100 of file qgslayoutitempicture.h.

◆ pictureRotationChanged

void QgsLayoutItemPicture::pictureRotationChanged ( double newRotation )

signal

Emitted on picture rotation change.

◆ readPropertiesFromElement()

bool QgsLayoutItemPicture::readPropertiesFromElement	(	const QDomElement &	element,
		const QDomDocument &	document,
		const QgsReadWriteContext &	context
	)

overrideprotectedvirtual

Sets item state from a DOM element.

Parameters

element	is the DOM element for the item
document	DOM document
context	read write context

Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring a scalebar, the connection to the linked map's signals should be implemented in finalizeRestoreFromXml(), not readPropertiesFromElement().

See also: writePropertiesToElement(); readXml()

Reimplemented from QgsLayoutItem.

Definition at line 783 of file qgslayoutitempicture.cpp.

◆ recalculateSize

void QgsLayoutItemPicture::recalculateSize ( )

slot

Forces a recalculation of the picture's frame size.

Definition at line 714 of file qgslayoutitempicture.cpp.

◆ refreshDataDefinedProperty

void QgsLayoutItemPicture::refreshDataDefinedProperty ( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::DataDefinedProperty::AllProperties )

overrideslot

Definition at line 721 of file qgslayoutitempicture.cpp.

◆ refreshPicture

void QgsLayoutItemPicture::refreshPicture ( const QgsExpressionContext * context = nullptr )

slot

Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.

Parameters

context expression context for evaluating data defined picture sources

Definition at line 339 of file qgslayoutitempicture.cpp.

◆ resizeMode()

ResizeMode QgsLayoutItemPicture::resizeMode ( ) const

inline

Returns the resize mode used for drawing the picture within the layout item's frame.

See also: setResizeMode()

Definition at line 155 of file qgslayoutitempicture.h.

◆ setLinkedMap()

void QgsLayoutItemPicture::setLinkedMap ( QgsLayoutItemMap * map )

Sets the map object for rotation.

If this is set then the picture will be rotated by the same amount as the specified map object. This is useful especially for syncing north arrows with a map item.

See also: setPictureRotation(); linkedMap()

Definition at line 697 of file qgslayoutitempicture.cpp.

◆ setMode()

void QgsLayoutItemPicture::setMode ( Qgis::PictureFormat mode )

Sets the current picture mode (image format).

See also: mode()

Since: QGIS 3.14

Definition at line 898 of file qgslayoutitempicture.cpp.

◆ setNorthMode()

void QgsLayoutItemPicture::setNorthMode ( QgsLayoutItemPicture::NorthMode mode )

Sets the mode used to align the picture to a map's North.

See also: northMode(); setNorthOffset()

Definition at line 859 of file qgslayoutitempicture.cpp.

◆ setNorthOffset()

void QgsLayoutItemPicture::setNorthOffset ( double offset )

Sets the offset added to the picture's rotation from a map's North.

See also: northOffset(); setNorthMode()

Definition at line 869 of file qgslayoutitempicture.cpp.

◆ setPictureAnchor()

void QgsLayoutItemPicture::setPictureAnchor ( QgsLayoutItem::ReferencePoint anchor )

Sets the picture's anchor point, which controls how it is placed within the picture item's frame.

See also: pictureAnchor()

Definition at line 874 of file qgslayoutitempicture.cpp.

◆ setPicturePath()

void QgsLayoutItemPicture::setPicturePath	(	const QString &	path,
		Qgis::PictureFormat	format = `Qgis::PictureFormat::Unknown`
	)

Sets the source path of the image (may be svg or a raster format).

Data defined picture source may override this value. The path can either be a local path or a remote (http) path.

Ideally, the format argument should specify the image format.

See also: picturePath()

Definition at line 734 of file qgslayoutitempicture.cpp.

◆ setPictureRotation

void QgsLayoutItemPicture::setPictureRotation ( double rotation )

slot

Sets the picture rotation within the item bounds, in degrees clockwise.

This does not affect the item's frame, only the way the picture is drawn within the item.

See also: pictureRotation()

Definition at line 661 of file qgslayoutitempicture.cpp.

◆ setResizeMode

void QgsLayoutItemPicture::setResizeMode ( QgsLayoutItemPicture::ResizeMode mode )

slot

Sets the resize mode used for drawing the picture within the item bounds.

Parameters

mode	ResizeMode to use for image file

See also: resizeMode

Definition at line 702 of file qgslayoutitempicture.cpp.

◆ setSvgDynamicParameters()

void QgsLayoutItemPicture::setSvgDynamicParameters ( const QMap< QString, QgsProperty > & parameters )

Sets the SVG dynamic parameters.

Since: QGIS 3.20

Definition at line 644 of file qgslayoutitempicture.cpp.

◆ setSvgFillColor()

void QgsLayoutItemPicture::setSvgFillColor ( const QColor & color )

Sets the fill color used for parametrized SVG files.

Note: This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.

See also: svgFillColor(); setSvgStrokeColor()

Definition at line 880 of file qgslayoutitempicture.cpp.

◆ setSvgStrokeColor()

void QgsLayoutItemPicture::setSvgStrokeColor ( const QColor & color )

Sets the stroke color used for parametrized SVG files.

Parameters

color stroke color.

Note: This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.

See also: svgStrokeColor(); setSvgFillColor()

Definition at line 886 of file qgslayoutitempicture.cpp.

◆ setSvgStrokeWidth()

void QgsLayoutItemPicture::setSvgStrokeWidth ( double width )

Sets the stroke width (in layout units) used for parametrized SVG files.

Note: This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.

See also: svgStrokeWidth(); setSvgStrokeColor()

Definition at line 892 of file qgslayoutitempicture.cpp.

◆ svgDynamicParameters()

QMap< QString, QgsProperty > QgsLayoutItemPicture::svgDynamicParameters ( ) const

Returns the SVG dynamic parameters.

Since: QGIS 3.20

Definition at line 638 of file qgslayoutitempicture.cpp.

◆ svgFillColor()

QColor QgsLayoutItemPicture::svgFillColor ( ) const

inline

Returns the fill color used for parametrized SVG files.

See also: setSvgFillColor(); svgStrokeColor()

Definition at line 176 of file qgslayoutitempicture.h.

◆ svgStrokeColor()

QColor QgsLayoutItemPicture::svgStrokeColor ( ) const

inline

Returns the stroke color used for parametrized SVG files.

See also: setSvgStrokeColor(); svgFillColor()

Definition at line 192 of file qgslayoutitempicture.h.

◆ svgStrokeWidth()

double QgsLayoutItemPicture::svgStrokeWidth ( ) const

inline

Returns the stroke width (in layout units) used for parametrized SVG files.

See also: setSvgStrokeWidth(); svgStrokeColor()

Definition at line 209 of file qgslayoutitempicture.h.

◆ type()

int QgsLayoutItemPicture::type ( ) const

override

Definition at line 70 of file qgslayoutitempicture.cpp.

◆ writePropertiesToElement()

bool QgsLayoutItemPicture::writePropertiesToElement	(	QDomElement &	element,
		QDomDocument &	document,
		const QgsReadWriteContext &	context
	)		const

overrideprotectedvirtual

Stores item state within an XML DOM element.

Parameters

element	is the DOM element to store the item's properties in
document	DOM document
context	read write context

See also: writeXml(); readPropertiesFromElement()

Reimplemented from QgsLayoutItem.

Definition at line 747 of file qgslayoutitempicture.cpp.

Friends And Related Symbol Documentation

◆ QgsCompositionConverter

friend class QgsCompositionConverter

friend

Definition at line 387 of file qgslayoutitempicture.h.

◆ TestQgsCompositionConverter

friend class TestQgsCompositionConverter

friend

Definition at line 388 of file qgslayoutitempicture.h.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/layout/qgslayoutitempicture.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/layout/qgslayoutitempicture.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ NorthMode

◆ ResizeMode

Constructor & Destructor Documentation

◆ QgsLayoutItemPicture()

Member Function Documentation

◆ applyItemSizeConstraint()

◆ create()

◆ draw()

◆ evaluatedPath()

◆ finalizeRestoreFromXml()

◆ icon()

◆ isMissingImage()

◆ linkedMap()

◆ mode()

◆ northMode()

◆ northOffset()

◆ originalMode()

◆ pictureAnchor()

◆ picturePath()

◆ pictureRotation()

◆ pictureRotationChanged

◆ readPropertiesFromElement()

◆ recalculateSize

◆ refreshDataDefinedProperty

◆ refreshPicture

◆ resizeMode()

◆ setLinkedMap()

◆ setMode()

◆ setNorthMode()

◆ setNorthOffset()

◆ setPictureAnchor()

◆ setPicturePath()

◆ setPictureRotation

◆ setResizeMode

◆ setSvgDynamicParameters()

◆ setSvgFillColor()

◆ setSvgStrokeColor()

◆ setSvgStrokeWidth()

◆ svgDynamicParameters()

◆ svgFillColor()

◆ svgStrokeColor()

◆ svgStrokeWidth()

◆ type()

◆ writePropertiesToElement()

Friends And Related Symbol Documentation

◆ QgsCompositionConverter

◆ TestQgsCompositionConverter