Base class for frame items, which form a layout multiframe item. More...

#include <qgslayoutframe.h>

Inheritance diagram for QgsLayoutFrame:

[legend]

Public Member Functions
	QgsLayoutFrame (QgsLayout layout, QgsLayoutMultiFrame multiFrame)
	Constructor for QgsLayoutFrame, with the specified parent layout and belonging to a multiFrame.

	~QgsLayoutFrame () override

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

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

QString	displayName () const override
	Gets item display name.

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

QRectF	extent () const
	Returns the visible portion of the multi frame's content which is shown in this frame, in layout units.

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

bool	hideBackgroundIfEmpty () const
	Returns whether the background and frame stroke should be hidden if this frame is empty.

bool	hidePageIfEmpty () const
	Returns whether the page should be hidden (ie, not included in layout exports) if this frame is empty.

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

bool	isEmpty () const
	Returns whether the frame is empty.

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

QgsLayoutMultiFrame *	multiFrame () const
	Returns the parent multiframe for the frame.

void	setContentSection (const QRectF &section)
	Sets the visible part of the multiframe's content which is visible within this frame (relative to the total multiframe extent in layout units).

void	setHideBackgroundIfEmpty (bool hideBackgroundIfEmpty)
	Sets whether the background and frame stroke should be hidden if this frame is empty.

void	setHidePageIfEmpty (bool hidePageIfEmpty)
	Sets whether the page should be hidden (ie, not included in layout exports) if this frame is empty.

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 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.

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 QgsLayoutItem::ExportLayerDetail	exportLayerDetails () const
	Returns the details for the specified current export layer.

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

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 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 QgsLayoutFrame *	create (QgsLayout *layout)
	Creates a new QgsLayoutFrame belonging to 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
void	draw (QgsLayoutItemRenderContext &context) override
	Draws the item's contents using the specified item render context.

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

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

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

bool	writePropertiesToElement (QDomElement &parentElement, 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 QSizeF	applyItemSizeConstraint (QSizeF targetSize)
	Applies any item-specific size constraint handling to a given targetSize in layout units.

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

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	QgsLayoutMultiFrame

Additional Inherited Members
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 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 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.

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

QgsPropertyCollection	mDataDefinedProperties

QPointer< QgsLayout >	mLayout

Properties inherited from QgsLayoutItem
bool	locked

Detailed Description

Base class for frame items, which form a layout multiframe item.

Definition at line 30 of file qgslayoutframe.h.

Constructor & Destructor Documentation

◆ QgsLayoutFrame()

QgsLayoutFrame::QgsLayoutFrame	(	QgsLayout *	layout,
		QgsLayoutMultiFrame *	multiFrame
	)

Constructor for QgsLayoutFrame, with the specified parent layout and belonging to a multiFrame.

Definition at line 23 of file qgslayoutframe.cpp.

◆ ~QgsLayoutFrame()

QgsLayoutFrame::~QgsLayoutFrame ( )

override

Definition at line 45 of file qgslayoutframe.cpp.

Member Function Documentation

◆ cleanup()

void QgsLayoutFrame::cleanup ( )

overridevirtual

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

Reimplemented from QgsLayoutItem.

Definition at line 163 of file qgslayoutframe.cpp.

◆ create()

QgsLayoutFrame * QgsLayoutFrame::create ( QgsLayout * layout )

static

Creates a new QgsLayoutFrame belonging to the specified layout.

Definition at line 50 of file qgslayoutframe.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsLayoutFrame::createExpressionContext ( ) const

overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 129 of file qgslayoutframe.cpp.

◆ displayName()

QString QgsLayoutFrame::displayName ( ) const

overridevirtual

Gets item display name.

This is the item's id if set, and if not, a user-friendly string identifying item type.

See also: id(); setId()

Reimplemented from QgsLayoutItem.

Definition at line 148 of file qgslayoutframe.cpp.

◆ draw()

void QgsLayoutFrame::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 172 of file qgslayoutframe.cpp.

◆ drawBackground()

void QgsLayoutFrame::drawBackground ( QgsRenderContext & context )

overrideprotectedvirtual

Draws the background for the item.

See also: framePath()

Reimplemented from QgsLayoutItem.

Definition at line 191 of file qgslayoutframe.cpp.

◆ drawFrame()

void QgsLayoutFrame::drawFrame ( QgsRenderContext & context )

overrideprotectedvirtual

Draws the frame around the item.

See also: framePath()

Reimplemented from QgsLayoutItem.

Definition at line 183 of file qgslayoutframe.cpp.

◆ exportLayerBehavior()

QgsLayoutItem::ExportLayerBehavior QgsLayoutFrame::exportLayerBehavior ( ) const

overridevirtual

Returns the behavior of this item during exporting to layered exports (e.g.

SVG or geospatial PDF).

See also: numberExportLayers(); exportLayerDetails()

Since: QGIS 3.10

Reimplemented from QgsLayoutItem.

Definition at line 143 of file qgslayoutframe.cpp.

◆ extent()

QRectF QgsLayoutFrame::extent ( ) const

inline

Returns the visible portion of the multi frame's content which is shown in this frame, in layout units.

See also: setContentSection()

Definition at line 76 of file qgslayoutframe.h.

◆ fixedSize()

QgsLayoutSize QgsLayoutFrame::fixedSize ( ) const

overridevirtual

Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized.

See also: setFixedSize(); minimumSize()

Reimplemented from QgsLayoutItem.

Definition at line 71 of file qgslayoutframe.cpp.

◆ hideBackgroundIfEmpty()

bool QgsLayoutFrame::hideBackgroundIfEmpty ( ) const

inline

Returns whether the background and frame stroke should be hidden if this frame is empty.

Returns: true if background and stroke should be hidden if frame is empty

See also: setHideBackgroundIfEmpty()

Definition at line 97 of file qgslayoutframe.h.

◆ hidePageIfEmpty()

bool QgsLayoutFrame::hidePageIfEmpty ( ) const

inline

Returns whether the page should be hidden (ie, not included in layout exports) if this frame is empty.

Returns: true if page should be hidden if frame is empty

See also: setHidePageIfEmpty()

Definition at line 83 of file qgslayoutframe.h.

◆ icon()

QIcon QgsLayoutFrame::icon ( ) const

overridevirtual

Returns the item's icon.

Reimplemented from QgsLayoutItem.

Definition at line 87 of file qgslayoutframe.cpp.

◆ isEmpty()

bool QgsLayoutFrame::isEmpty ( ) const

Returns whether the frame is empty.

See also: hidePageIfEmpty()

Definition at line 111 of file qgslayoutframe.cpp.

◆ minimumSize()

QgsLayoutSize QgsLayoutFrame::minimumSize ( ) const

overridevirtual

Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized.

See also: setMinimumSize(); fixedSize()

Reimplemented from QgsLayoutItem.

Definition at line 60 of file qgslayoutframe.cpp.

◆ multiFrame()

QgsLayoutMultiFrame * QgsLayoutFrame::multiFrame ( ) const

Returns the parent multiframe for the frame.

Definition at line 55 of file qgslayoutframe.cpp.

◆ readPropertiesFromElement()

bool QgsLayoutFrame::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 212 of file qgslayoutframe.cpp.

◆ setContentSection()

void QgsLayoutFrame::setContentSection ( const QRectF & section )

inline

Sets the visible part of the multiframe's content which is visible within this frame (relative to the total multiframe extent in layout units).

See also: extent()

Definition at line 61 of file qgslayoutframe.h.

◆ setHideBackgroundIfEmpty()

void QgsLayoutFrame::setHideBackgroundIfEmpty ( bool hideBackgroundIfEmpty )

Sets whether the background and frame stroke should be hidden if this frame is empty.

Parameters

hideBackgroundIfEmpty set to true if background and stroke should be hidden if frame is empty

See also: hideBackgroundIfEmpty()

Definition at line 100 of file qgslayoutframe.cpp.

◆ setHidePageIfEmpty()

void QgsLayoutFrame::setHidePageIfEmpty ( bool hidePageIfEmpty )

Sets whether the page should be hidden (ie, not included in layout exports) if this frame is empty.

Parameters

hidePageIfEmpty set to true if page should be hidden if frame is empty

See also: hidePageIfEmpty()

Definition at line 95 of file qgslayoutframe.cpp.

◆ type()

int QgsLayoutFrame::type ( ) const

override

Definition at line 82 of file qgslayoutframe.cpp.

◆ writePropertiesToElement()

bool QgsLayoutFrame::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 199 of file qgslayoutframe.cpp.

Friends And Related Symbol Documentation

◆ QgsLayoutMultiFrame

friend class QgsLayoutMultiFrame

friend

Definition at line 134 of file qgslayoutframe.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/layout/qgslayoutframe.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/layout/qgslayoutframe.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLayoutFrame()

◆ ~QgsLayoutFrame()

Member Function Documentation

◆ cleanup()

◆ create()

◆ createExpressionContext()

◆ displayName()

◆ draw()

◆ drawBackground()

◆ drawFrame()

◆ exportLayerBehavior()

◆ extent()

◆ fixedSize()

◆ hideBackgroundIfEmpty()

◆ hidePageIfEmpty()

◆ icon()

◆ isEmpty()

◆ minimumSize()

◆ multiFrame()

◆ readPropertiesFromElement()

◆ setContentSection()

◆ setHideBackgroundIfEmpty()

◆ setHidePageIfEmpty()

◆ type()

◆ writePropertiesToElement()

Friends And Related Symbol Documentation

◆ QgsLayoutMultiFrame