QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Types | Public Slots | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
QgsLayoutItemPage Class Reference

Item representing the paper in a layout. More...

#include <qgslayoutitempage.h>

Inheritance diagram for QgsLayoutItemPage:
Inheritance graph
[legend]

Public Types

enum  Orientation { Portrait , Landscape }
 Page orientation. More...
 
enum  UndoCommand { UndoPageSymbol = 3000 }
 Page item undo commands, used for collapsing undo commands. 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 }
 Flags for controlling how an item behaves. More...
 
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 , UndoSetId ,
  UndoRotation , 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 , UndoCustomCommand
}
 Layout item undo commands, used for collapsing undo commands. More...
 
- Public Types inherited from QgsLayoutObject
enum  DataDefinedProperty {
  NoProperty = 0 , AllProperties , TestProperty , PresetPaperSize ,
  PaperWidth , PaperHeight , NumPages , PaperOrientation ,
  PageNumber , PositionX , PositionY , ItemWidth ,
  ItemHeight , ItemRotation , Transparency , Opacity ,
  BlendMode , ExcludeFromExports , FrameColor , BackgroundColor ,
  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 ,
  PictureSource , PictureSvgBackgroundColor , PictureSvgStrokeColor , PictureSvgStrokeWidth ,
  SourceUrl , LegendTitle , LegendColumnCount , ScalebarLeftSegments ,
  ScalebarRightSegments , ScalebarSegmentWidth , ScalebarMinimumWidth , ScalebarMaximumWidth ,
  ScalebarHeight , ScalebarRightSegmentSubdivisions , ScalebarSubdivisionHeight , ScalebarFillColor ,
  ScalebarFillColor2 , ScalebarLineColor , ScalebarLineWidth , AttributeTableSourceLayer ,
  MapCrs , StartDateTime , EndDateTime
}
 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 redraw () override
 
- Public Slots inherited from QgsLayoutItem
virtual void invalidateCache ()
 Forces a deferred update of any cached image the item uses. More...
 
virtual void redraw ()
 Triggers a redraw (update) of the item. More...
 
void refresh () override
 Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size. More...
 
virtual void refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
virtual void rotateItem (double angle, QPointF transformOrigin)
 Rotates the item by a specified angle in degrees clockwise around a specified reference point. More...
 
virtual void setItemRotation (double rotation, bool adjustPosition=true)
 Sets the layout item's rotation, in degrees clockwise. More...
 
- Public Slots inherited from QgsLayoutObject
virtual void refresh ()
 Refreshes the object, causing a recalculation of any property overrides. More...
 

Public Member Functions

 QgsLayoutItemPage (QgsLayout *layout)
 Constructor for QgsLayoutItemPage, with the specified parent layout. More...
 
 ~QgsLayoutItemPage () override
 
bool accept (QgsStyleEntityVisitorInterface *visitor) const override
 Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item. More...
 
void attemptResize (const QgsLayoutSize &size, bool includesFrame=false) override
 Attempts to resize the item to a specified target size. More...
 
QRectF boundingRect () const override
 
QgsAbstractLayoutUndoCommandcreateCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override
 Creates a new layout undo command with the specified text and parent. More...
 
QString displayName () const override
 Gets item display name. More...
 
ExportLayerBehavior exportLayerBehavior () const override
 Returns the behavior of this item during exporting to layered exports (e.g. More...
 
Orientation orientation () const
 Returns the page orientation. More...
 
QPageLayout pageLayout () const
 Returns the page layout for the page, suitable to pass to QPrinter::setPageLayout. More...
 
QgsLayoutSize pageSize () const
 Returns the size of the page. More...
 
const QgsFillSymbolpageStyleSymbol () const
 Returns the symbol to use for drawing the page background. More...
 
void setPageSize (const QgsLayoutSize &size)
 Sets the size of the page. More...
 
bool setPageSize (const QString &size, Orientation orientation=Portrait)
 Sets the page size to a known page size, e.g. More...
 
void setPageStyleSymbol (QgsFillSymbol *symbol)
 Sets the symbol to use for drawing the page background. More...
 
int type () const override
 
- Public Member Functions inherited from QgsLayoutItem
 QgsLayoutItem (QgsLayout *layout, bool manageZValue=true)
 Constructor for QgsLayoutItem, with the specified parent layout. More...
 
 ~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. More...
 
virtual void attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1)
 Attempts to move the item to a specified point. More...
 
void attemptMoveBy (double deltaX, double deltaY)
 Attempts to shift the item's position by a specified deltaX and deltaY, in layout units. More...
 
virtual void attemptResize (const QgsLayoutSize &size, bool includesFrame=false)
 Attempts to resize the item to a specified target size. More...
 
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. More...
 
QColor backgroundColor () const
 Returns the background color for this item. More...
 
void beginCommand (const QString &commandText, UndoCommand command=UndoNone)
 Starts new undo command for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void cancelCommand ()
 Cancels the current item command and discards it. More...
 
virtual void cleanup ()
 Called just before a batch of items are deleted, allowing them to run cleanup tasks. More...
 
virtual QgsGeometry clipPath () const
 Returns the clipping path generated by this item, in layout coordinates. More...
 
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. More...
 
QgsAbstractLayoutUndoCommandcreateCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override
 Creates a new layout undo command with the specified text and parent. More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
virtual QString displayName () const
 Gets item display name. More...
 
void endCommand ()
 Completes the current item command and push it onto the layout's undo stack. More...
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool excludeFromExports () const
 Returns whether the item should be excluded from layout exports and prints. More...
 
virtual ExportLayerBehavior exportLayerBehavior () const
 Returns the behavior of this item during exporting to layered exports (e.g. More...
 
virtual QgsLayoutItem::ExportLayerDetail exportLayerDetails () const
 Returns the details for the specified current export layer. More...
 
virtual void finalizeRestoreFromXml ()
 Called after all pending items have been restored from XML. More...
 
virtual QgsLayoutSize fixedSize () const
 Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
bool frameEnabled () const
 Returns true if the item includes a frame. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
QColor frameStrokeColor () const
 Returns the frame's stroke color. More...
 
QgsLayoutMeasurement frameStrokeWidth () const
 Returns the frame's stroke width. More...
 
bool hasBackground () const
 Returns true if the item has a background. More...
 
virtual QIcon icon () const
 Returns the item's icon. More...
 
QString id () const
 Returns the item's ID name. More...
 
bool isGroupMember () const
 Returns true if the item is part of a QgsLayoutItemGroup group. More...
 
bool isLocked () const
 Returns true if the item is locked, and cannot be interacted with using the mouse. More...
 
virtual Flags itemFlags () const
 Returns the item's flags, which indicate how the item behaves. More...
 
double itemOpacity () const
 Returns the item's opacity. More...
 
double itemRotation () const
 Returns the current rotation for the item, in degrees clockwise. More...
 
virtual QgsLayoutSize minimumSize () const
 Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
virtual void moveContent (double dx, double dy)
 Moves the content of the item, by a specified dx and dy in layout units. More...
 
virtual bool nextExportPart ()
 Moves to the next export part for a multi-layered export item, during a multi-layered export. More...
 
virtual Q_DECL_DEPRECATED int numberExportLayers () const
 Returns the number of layers that this item requires for exporting during layered exports (e.g. More...
 
int page () const
 Returns the page the item is currently on, with the first page returning 0. More...
 
QPointF pagePos () const
 Returns the item's position (in layout units) relative to the top left corner of its current page. More...
 
QgsLayoutPoint pagePositionWithUnits () const
 Returns the item's position (in item units) relative to the top left corner of its current page. More...
 
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. More...
 
QgsLayoutItemGroupparentGroup () const
 Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group. More...
 
QgsLayoutPoint positionWithUnits () const
 Returns the item's current position, including units. More...
 
bool readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets the item state from a DOM element. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
ReferencePoint referencePoint () const
 Returns the reference point for positioning of the layout item. More...
 
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. More...
 
void setBackgroundColor (const QColor &color)
 Sets the background color for this item. More...
 
void setBackgroundEnabled (bool drawBackground)
 Sets whether this item has a background drawn under it or not. More...
 
void setBlendMode (QPainter::CompositionMode mode)
 Sets the item's composition blending mode. More...
 
void setExcludeFromExports (bool exclude)
 Sets whether the item should be excluded from layout exports and prints. More...
 
virtual void setFrameEnabled (bool drawFrame)
 Sets whether this item has a frame drawn around it or not. More...
 
void setFrameJoinStyle (Qt::PenJoinStyle style)
 Sets the join style used when drawing the item's frame. More...
 
void setFrameStrokeColor (const QColor &color)
 Sets the frame stroke color. More...
 
virtual void setFrameStrokeWidth (QgsLayoutMeasurement width)
 Sets the frame stroke width. More...
 
virtual void setId (const QString &id)
 Set the item's id name. More...
 
void setItemOpacity (double opacity)
 Sets the item's opacity. More...
 
void setLocked (bool locked)
 Sets whether the item is locked, preventing mouse interactions with the item. More...
 
virtual void setMoveContentPreviewOffset (double dx, double dy)
 Sets temporary offset for the item, by a specified dx and dy in layout units. More...
 
void setParentGroup (QgsLayoutItemGroup *group)
 Sets the item's parent group. More...
 
void setReferencePoint (ReferencePoint point)
 Sets the reference point for positioning of the layout item. More...
 
virtual void setSelected (bool selected)
 Sets whether the item should be selected. More...
 
virtual void setVisibility (bool visible)
 Sets whether the item is visible. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
QgsLayoutSize sizeWithUnits () const
 Returns the item's current size, including units. More...
 
virtual void startLayeredExport ()
 Starts a multi-layer export operation. More...
 
virtual void stopLayeredExport ()
 Stops a multi-layer export operation. More...
 
int type () const override
 Returns a unique graphics item type identifier. More...
 
virtual QString uuid () const
 Returns the item identification string. More...
 
bool writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores the item state in a DOM element. More...
 
virtual void zoomContent (double factor, QPointF point)
 Zooms content of item. More...
 
- Public Member Functions inherited from QgsLayoutObject
 QgsLayoutObject (QgsLayout *layout)
 Constructor for QgsLayoutObject, with the specified parent layout. More...
 
QgsExpressionContext createExpressionContext () const override
 Creates an expression context relating to the objects' current state. More...
 
QStringList customProperties () const
 Returns list of keys stored in custom properties for the object. More...
 
QVariant customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const
 Read a custom property from the object. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
QgsLayoutlayout ()
 Returns the layout the object is attached to. More...
 
const QgsLayoutlayout () const
 Returns the layout the object is attached to. More...
 
void removeCustomProperty (const QString &key)
 Remove a custom property from the object. More...
 
void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for the object. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the objects's property collection, used for data defined overrides. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 
virtual QgsExpressionContext createExpressionContext () const =0
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
- Public Member Functions inherited from QgsLayoutUndoObjectInterface
virtual ~QgsLayoutUndoObjectInterface ()=default
 Destructor for QgsLayoutUndoObjectInterface. More...
 
virtual QgsAbstractLayoutUndoCommandcreateCommand (const QString &text, int id=0, QUndoCommand *parent=nullptr)=0
 Creates a new layout undo command with the specified text and parent. More...
 

Static Public Member Functions

static QgsLayoutItemPagecreate (QgsLayout *layout)
 Returns a new page item for the specified layout. More...
 
static QgsLayoutItemPage::Orientation decodePageOrientation (const QString &string, bool *ok=nullptr)
 Decodes a string representing a page orientation. More...
 
- 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. More...
 
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the layout object property definitions. More...
 

Protected Member Functions

void draw (QgsLayoutItemRenderContext &context) override
 Draws the item's contents using the specified item render context. More...
 
void drawBackground (QgsRenderContext &context) override
 Draws the background for the item. More...
 
void drawFrame (QgsRenderContext &context) override
 Draws the frame around the item. More...
 
bool readPropertiesFromElement (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context) override
 Sets item state from a DOM element. More...
 
bool writePropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override
 Stores item state within an XML DOM element. More...
 
- 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. More...
 
QgsLayoutSize applyDataDefinedSize (const QgsLayoutSize &size)
 Applies any present data defined size overrides to the specified layout size. More...
 
virtual QSizeF applyItemSizeConstraint (QSizeF targetSize)
 Applies any item-specific size constraint handling to a given targetSize in layout units. More...
 
virtual void draw (QgsLayoutItemRenderContext &context)=0
 Draws the item's contents using the specified item render context. More...
 
virtual void drawBackground (QgsRenderContext &context)
 Draws the background for the item. More...
 
virtual void drawDebugRect (QPainter *painter)
 Draws a debugging rectangle of the item's current bounds within the specified painter. More...
 
virtual void drawFrame (QgsRenderContext &context)
 Draws the frame around the item. More...
 
virtual QPainterPath framePath () const
 Returns the path to use when drawing the item's frame or background. More...
 
QPointF positionAtReferencePoint (ReferencePoint reference) const
 Returns the current position (in layout units) of a reference point for the item. More...
 
virtual bool readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets item state from a DOM element. More...
 
void refreshBackgroundColor (bool updateItem=true)
 Refresh item's background color, considering data defined colors. More...
 
void refreshBlendMode ()
 Refresh item's blend mode, considering data defined blend mode. More...
 
void refreshFrame (bool updateItem=true)
 Refresh item's frame, considering data defined colors and frame size. More...
 
void refreshItemPosition ()
 Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning. More...
 
void refreshItemRotation (QPointF *origin=nullptr)
 Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation. More...
 
void refreshItemSize ()
 Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes. More...
 
void refreshOpacity (bool updateItem=true)
 Refresh item's opacity, considering data defined opacity. More...
 
virtual void setFixedSize (const QgsLayoutSize &size)
 Sets a fixed size for the layout item, which prevents it from being freely resized. More...
 
virtual void setMinimumSize (const QgsLayoutSize &size)
 Sets the minimum allowed size for the layout item. More...
 
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. More...
 
virtual bool writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores item state within an XML DOM element. More...
 
- Protected Member Functions inherited from QgsLayoutObject
bool readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets object properties from a DOM element. More...
 
bool writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores object properties within an XML DOM element. More...
 

Friends

class TestQgsLayoutPage
 

Additional Inherited Members

- Signals inherited from QgsLayoutItem
void backgroundTaskCountChanged (int count)
 Emitted whenever the number of background tasks an item is executing changes. More...
 
void clipPathChanged ()
 Emitted when the item's clipping path has changed. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
void rotationChanged (double newRotation)
 Emitted on item rotation change. More...
 
void sizePositionChanged ()
 Emitted when the item's size or position changes. More...
 
- Signals inherited from QgsLayoutObject
void changed ()
 Emitted when the object's properties change. More...
 
- Protected Attributes inherited from QgsLayoutObject
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QgsPropertyCollection mDataDefinedProperties
 
QPointer< QgsLayoutmLayout
 
- Properties inherited from QgsLayoutItem
bool locked
 

Detailed Description

Item representing the paper in a layout.

Since
QGIS 3.0

Definition at line 58 of file qgslayoutitempage.h.

Member Enumeration Documentation

◆ Orientation

Page orientation.

Enumerator
Portrait 

Portrait orientation.

Landscape 

Landscape orientation.

Definition at line 66 of file qgslayoutitempage.h.

◆ UndoCommand

Page item undo commands, used for collapsing undo commands.

Enumerator
UndoPageSymbol 

Layout page symbol change.

Definition at line 73 of file qgslayoutitempage.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemPage()

QgsLayoutItemPage::QgsLayoutItemPage ( QgsLayout layout)
explicit

Constructor for QgsLayoutItemPage, with the specified parent layout.

Definition at line 32 of file qgslayoutitempage.cpp.

◆ ~QgsLayoutItemPage()

QgsLayoutItemPage::~QgsLayoutItemPage ( )
overridedefault

Member Function Documentation

◆ accept()

bool QgsLayoutItemPage::accept ( QgsStyleEntityVisitorInterface visitor) const
overridevirtual

Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item.

Returns true if the visitor should continue visiting other objects, or false if visiting should be canceled.

Since
QGIS 3.10

Reimplemented from QgsLayoutItem.

Definition at line 235 of file qgslayoutitempage.cpp.

◆ attemptResize()

void QgsLayoutItemPage::attemptResize ( const QgsLayoutSize size,
bool  includesFrame = false 
)
overridevirtual

Attempts to resize the item to a specified target size.

Note that the final size of the item may not match the specified target size, as items with a fixed or minimum size will place restrictions on the allowed item size. Data defined item size overrides will also override the specified target size.

If includesFrame is true, then the size specified by size includes the item's frame.

See also
minimumSize()
fixedSize()
attemptMove()
sizeWithUnits()

Reimplemented from QgsLayoutItem.

Definition at line 178 of file qgslayoutitempage.cpp.

◆ boundingRect()

QRectF QgsLayoutItemPage::boundingRect ( ) const
override

Definition at line 167 of file qgslayoutitempage.cpp.

◆ create()

QgsLayoutItemPage * QgsLayoutItemPage::create ( QgsLayout layout)
static

Returns a new page item for the specified layout.

The caller takes responsibility for deleting the returned object.

Definition at line 57 of file qgslayoutitempage.cpp.

◆ createCommand()

QgsAbstractLayoutUndoCommand * QgsLayoutItemPage::createCommand ( const QString &  text,
int  id,
QUndoCommand *  parent = nullptr 
)
overridevirtual

Creates a new layout undo command with the specified text and parent.

The id argument can be used to specify an id number for the source event - this is used to determine whether QUndoCommand command compression can apply to the command.

Reimplemented from QgsLayoutItem.

Definition at line 225 of file qgslayoutitempage.cpp.

◆ decodePageOrientation()

QgsLayoutItemPage::Orientation QgsLayoutItemPage::decodePageOrientation ( const QString &  string,
bool *  ok = nullptr 
)
static

Decodes a string representing a page orientation.

If specified, ok will be set to true if string could be successfully interpreted as a page orientation.

Definition at line 146 of file qgslayoutitempage.cpp.

◆ displayName()

QString QgsLayoutItemPage::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 67 of file qgslayoutitempage.cpp.

◆ draw()

void QgsLayoutItemPage::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 249 of file qgslayoutitempage.cpp.

◆ drawBackground()

void QgsLayoutItemPage::drawBackground ( QgsRenderContext context)
overrideprotectedvirtual

Draws the background for the item.

See also
framePath()

Reimplemented from QgsLayoutItem.

Definition at line 316 of file qgslayoutitempage.cpp.

◆ drawFrame()

void QgsLayoutItemPage::drawFrame ( QgsRenderContext context)
overrideprotectedvirtual

Draws the frame around the item.

See also
framePath()

Reimplemented from QgsLayoutItem.

Definition at line 313 of file qgslayoutitempage.cpp.

◆ exportLayerBehavior()

QgsLayoutItem::ExportLayerBehavior QgsLayoutItemPage::exportLayerBehavior ( ) const
overridevirtual

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

SVG).

See also
numberExportLayers()
exportLayerDetails()
Since
QGIS 3.10

Reimplemented from QgsLayoutItem.

Definition at line 230 of file qgslayoutitempage.cpp.

◆ orientation()

QgsLayoutItemPage::Orientation QgsLayoutItemPage::orientation ( ) const

Returns the page orientation.

Note
There is no direct setter for page orientation - use setPageSize() instead.

Definition at line 132 of file qgslayoutitempage.cpp.

◆ pageLayout()

QPageLayout QgsLayoutItemPage::pageLayout ( ) const

Returns the page layout for the page, suitable to pass to QPrinter::setPageLayout.

Since
QGIS 3.20

Definition at line 106 of file qgslayoutitempage.cpp.

◆ pageSize()

QgsLayoutSize QgsLayoutItemPage::pageSize ( ) const

Returns the size of the page.

See also
setPageSize()

Definition at line 127 of file qgslayoutitempage.cpp.

◆ pageStyleSymbol()

const QgsFillSymbol * QgsLayoutItemPage::pageStyleSymbol ( ) const
inline

Returns the symbol to use for drawing the page background.

See also
setPageStyleSymbol()
Since
QGIS 3.10

Definition at line 147 of file qgslayoutitempage.h.

◆ readPropertiesFromElement()

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

Sets item state from a DOM element.

Parameters
elementis the DOM element for the item
documentDOM document
contextread 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 326 of file qgslayoutitempage.cpp.

◆ redraw

void QgsLayoutItemPage::redraw ( )
overrideslot

Definition at line 243 of file qgslayoutitempage.cpp.

◆ setPageSize() [1/2]

void QgsLayoutItemPage::setPageSize ( const QgsLayoutSize size)

Sets the size of the page.

See also
pageSize()

Definition at line 72 of file qgslayoutitempage.cpp.

◆ setPageSize() [2/2]

bool QgsLayoutItemPage::setPageSize ( const QString &  size,
Orientation  orientation = Portrait 
)

Sets the page size to a known page size, e.g.

"A4" and orientation. The known page sizes are managed by QgsPageSizeRegistry. Valid page sizes can be retrieved via QgsPageSizeRegistry::entries(). The function returns true if size was a valid page size and the page size was changed. If false is returned then size could not be matched to a known page size.

See also
pageSize()

Definition at line 77 of file qgslayoutitempage.cpp.

◆ setPageStyleSymbol()

void QgsLayoutItemPage::setPageStyleSymbol ( QgsFillSymbol symbol)

Sets the symbol to use for drawing the page background.

Ownership of symbol is transferred to the page.

See also
pageStyleSymbol()
Since
QGIS 3.10

Definition at line 140 of file qgslayoutitempage.cpp.

◆ type()

int QgsLayoutItemPage::type ( ) const
override

Definition at line 62 of file qgslayoutitempage.cpp.

◆ writePropertiesToElement()

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

Stores item state within an XML DOM element.

Parameters
elementis the DOM element to store the item's properties in
documentDOM document
contextread write context
See also
writeXml()
readPropertiesFromElement()

Reimplemented from QgsLayoutItem.

Definition at line 319 of file qgslayoutitempage.cpp.

Friends And Related Function Documentation

◆ TestQgsLayoutPage

friend class TestQgsLayoutPage
friend

Definition at line 186 of file qgslayoutitempage.h.


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