QGIS API Documentation  3.6.0-Noosa (5873452)
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsLayoutItemShape Class Reference

Layout item for basic filled shapes (e.g. More...

#include <qgslayoutitemshape.h>

Inheritance diagram for QgsLayoutItemShape:
Inheritance graph
[legend]

Public Types

enum  Shape { Ellipse, Rectangle, Triangle }
 Shape type. More...
 
- Public Types inherited from QgsLayoutItem
enum  Flag { FlagOverridesPaint = 1 << 1 }
 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, UndoMapLabelMargin,
  UndoPictureRotation, UndoPictureFillColor, UndoPictureStrokeColor, UndoPictureStrokeWidth,
  UndoPictureNorthOffset, UndoLabelText, UndoLabelFont, UndoLabelMargin,
  UndoLabelFontColor, UndoLegendText, UndoLegendColumnCount, UndoLegendSymbolWidth,
  UndoLegendSymbolHeight, UndoLegendWmsLegendWidth, UndoLegendWmsLegendHeight, UndoLegendTitleSpaceBottom,
  UndoLegendGroupSpace, UndoLegendLayerSpace, UndoLegendSymbolSpace, UndoLegendIconSymbolSpace,
  UndoLegendFontColor, UndoLegendBoxSpace, UndoLegendColumnSpace, UndoLegendLineSpacing,
  UndoLegendRasterStrokeWidth, UndoLegendRasterStrokeColor, UndoLegendTitleFont, UndoLegendGroupFont,
  UndoLegendLayerFont, UndoLegendItemFont, UndoScaleBarLineWidth, UndoScaleBarSegmentSize,
  UndoScaleBarSegmentsLeft, UndoScaleBarSegments, UndoScaleBarHeight, 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, PictureSource, PictureSvgBackgroundColor,
  PictureSvgStrokeColor, PictureSvgStrokeWidth, SourceUrl, LegendTitle,
  LegendColumnCount, ScalebarFillColor, ScalebarFillColor2, ScalebarLineColor,
  ScalebarLineWidth, AttributeTableSourceLayer
}
 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 Member Functions

 QgsLayoutItemShape (QgsLayout *layout)
 Constructor for QgsLayoutItemShape, with the specified parent layout. More...
 
QRectF boundingRect () const override
 
QgsLayoutMeasurement cornerRadius () const
 Returns the corner radius for rounded rectangle corners. More...
 
QString displayName () const override
 Gets item display name. More...
 
double estimatedFrameBleed () const override
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
QIcon icon () const override
 Returns the item's icon. More...
 
void setCornerRadius (QgsLayoutMeasurement radius)
 Sets the corner radius for rounded rectangle corners. More...
 
void setShapeType (QgsLayoutItemShape::Shape type)
 Sets the type of shape (e.g. More...
 
void setSymbol (QgsFillSymbol *symbol)
 Sets the fill symbol used to draw the shape. More...
 
QgsLayoutItemShape::Shape shapeType () const
 Returns the type of shape (e.g. More...
 
QgsFillSymbolsymbol ()
 Returns the fill symbol used to draw the shape. 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 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 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...
 
void endCommand ()
 Completes the current item command and push it onto the layout's undo stack. More...
 
bool excludeFromExports () const
 Returns whether the item should be excluded from layout exports and prints. 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...
 
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 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...
 
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...
 
const QgsLayoutlayout () const
 Returns the layout the object is attached to. More...
 
QgsLayoutlayout ()
 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
 
- Public Member Functions inherited from QgsLayoutUndoObjectInterface
virtual ~QgsLayoutUndoObjectInterface ()=default
 Destructor for QgsLayoutUndoObjectInterface. More...
 

Static Public Member Functions

static QgsLayoutItemShapecreate (QgsLayout *layout)
 Returns a new shape item for the specified layout. More...
 
- Static Public Member Functions inherited from QgsLayoutObject
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...
 
bool readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
 Sets item state from a DOM element. More...
 
bool writePropertiesToElement (QDomElement &element, 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 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...
 
QPointF positionAtReferencePoint (ReferencePoint reference) const
 Returns the current position (in layout units) of a reference point for the item. 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...
 
- 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...
 

Additional Inherited Members

- 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...
 
- Signals inherited from QgsLayoutItem
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

Layout item for basic filled shapes (e.g.

rectangles, ellipses).

Since
QGIS 3.0

Definition at line 32 of file qgslayoutitemshape.h.

Member Enumeration Documentation

◆ Shape

Shape type.

Enumerator
Ellipse 

Ellipse shape.

Rectangle 

Rectangle shape.

Triangle 

Triangle shape.

Definition at line 39 of file qgslayoutitemshape.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemShape()

QgsLayoutItemShape::QgsLayoutItemShape ( QgsLayout layout)
explicit

Constructor for QgsLayoutItemShape, with the specified parent layout.

Definition at line 25 of file qgslayoutitemshape.cpp.

Member Function Documentation

◆ boundingRect()

QRectF QgsLayoutItemShape::boundingRect ( ) const
override

Definition at line 143 of file qgslayoutitemshape.cpp.

◆ cornerRadius()

QgsLayoutMeasurement QgsLayoutItemShape::cornerRadius ( ) const
inline

Returns the corner radius for rounded rectangle corners.

See also
setCornerRadius()

Definition at line 101 of file qgslayoutitemshape.h.

◆ create()

QgsLayoutItemShape * QgsLayoutItemShape::create ( QgsLayout layout)
static

Returns a new shape item for the specified layout.

The caller takes responsibility for deleting the returned object.

Definition at line 48 of file qgslayoutitemshape.cpp.

◆ displayName()

QString QgsLayoutItemShape::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 73 of file qgslayoutitemshape.cpp.

◆ draw()

void QgsLayoutItemShape::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 153 of file qgslayoutitemshape.cpp.

◆ estimatedFrameBleed()

double QgsLayoutItemShape::estimatedFrameBleed ( ) const
overridevirtual

Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.

For instance, if the item has a 2mm frame stroke, then 1mm of this frame is drawn outside the item's rect. In this case the return value will be 1.0.

Returned values are in layout units.

See also
rectWithFrame()

Reimplemented from QgsLayoutItem.

Definition at line 148 of file qgslayoutitemshape.cpp.

◆ icon()

QIcon QgsLayoutItemShape::icon ( ) const
overridevirtual

Returns the item's icon.

Reimplemented from QgsLayoutItem.

Definition at line 58 of file qgslayoutitemshape.cpp.

◆ readPropertiesFromElement()

bool QgsLayoutItemShape::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 225 of file qgslayoutitemshape.cpp.

◆ setCornerRadius()

void QgsLayoutItemShape::setCornerRadius ( QgsLayoutMeasurement  radius)
inline

Sets the corner radius for rounded rectangle corners.

See also
cornerRadius()

Definition at line 95 of file qgslayoutitemshape.h.

◆ setShapeType()

void QgsLayoutItemShape::setShapeType ( QgsLayoutItemShape::Shape  type)

Sets the type of shape (e.g.

rectangle, ellipse, etc).

See also
shapeType()

Definition at line 93 of file qgslayoutitemshape.cpp.

◆ setSymbol()

void QgsLayoutItemShape::setSymbol ( QgsFillSymbol symbol)

Sets the fill symbol used to draw the shape.

Ownership is not transferred and a clone of the symbol is made.

See also
symbol()

Definition at line 134 of file qgslayoutitemshape.cpp.

◆ shapeType()

QgsLayoutItemShape::Shape QgsLayoutItemShape::shapeType ( ) const
inline

Returns the type of shape (e.g.

rectangle, ellipse, etc).

See also
setShapeType()

Definition at line 70 of file qgslayoutitemshape.h.

◆ symbol()

QgsFillSymbol* QgsLayoutItemShape::symbol ( )
inline

Returns the fill symbol used to draw the shape.

See also
setSymbol()

Definition at line 89 of file qgslayoutitemshape.h.

◆ type()

int QgsLayoutItemShape::type ( ) const
override

Definition at line 53 of file qgslayoutitemshape.cpp.

◆ writePropertiesToElement()

bool QgsLayoutItemShape::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 214 of file qgslayoutitemshape.cpp.


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