QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Types | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Friends | List of all members
QgsLayoutItemPolyline Class Reference

Layout item for node based polyline shapes. More...

#include <qgslayoutitempolyline.h>

Inheritance diagram for QgsLayoutItemPolyline:
Inheritance graph
[legend]

Public Types

enum  MarkerMode { NoMarker , ArrowHead , SvgMarker }
 Vertex marker mode. 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< FlagFlags
 
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 , 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 Member Functions

 QgsLayoutItemPolyline (const QPolygonF &polyline, QgsLayout *layout)
 Constructor for QgsLayoutItemPolyline for the specified polyline and layout. More...
 
 QgsLayoutItemPolyline (QgsLayout *layout)
 Constructor for QgsLayoutItemPolyline for the specified layout. More...
 
 ~QgsLayoutItemPolyline () 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...
 
QColor arrowHeadFillColor () const
 Returns the color used to fill the arrow head. More...
 
QColor arrowHeadStrokeColor () const
 Returns the color used to draw the stroke around the the arrow head. More...
 
double arrowHeadStrokeWidth () const
 Returns the pen width in millimeters for the stroke of the arrow head. More...
 
double arrowHeadWidth () const
 Returns the width of line arrow heads in mm. More...
 
QString displayName () const override
 Gets item display name. More...
 
MarkerMode endMarker () const
 Returns the end marker mode, which controls what marker is drawn at the end of the line. More...
 
QString endSvgMarkerPath () const
 Returns the path the an SVG marker drawn at the end of the line. More...
 
QIcon icon () const override
 Returns the item's icon. More...
 
void setArrowHeadFillColor (const QColor &color)
 Sets the color used to fill the arrow head. More...
 
void setArrowHeadStrokeColor (const QColor &color)
 Sets the color used to draw the stroke around the arrow head. More...
 
void setArrowHeadStrokeWidth (double width)
 Sets the pen width in millimeters for the stroke of the arrow head. More...
 
void setArrowHeadWidth (double width)
 Sets the width of line arrow heads in mm. More...
 
void setEndMarker (MarkerMode mode)
 Sets the end marker mode, which controls what marker is drawn at the end of the line. More...
 
void setEndSvgMarkerPath (const QString &path)
 Sets the path to a SVG marker to draw at the end of the line. More...
 
void setStartMarker (MarkerMode mode)
 Sets the start marker mode, which controls what marker is drawn at the start of the line. More...
 
void setStartSvgMarkerPath (const QString &path)
 Sets the path to a SVG marker to draw at the start of the line. More...
 
void setSymbol (QgsLineSymbol *symbol)
 Sets the symbol used to draw the shape. More...
 
QPainterPath shape () const override
 
MarkerMode startMarker () const
 Returns the start marker mode, which controls what marker is drawn at the start of the line. More...
 
QString startSvgMarkerPath () const
 Returns the path the an SVG marker drawn at the start of the line. More...
 
QgsLineSymbolsymbol ()
 Returns the line symbol used to draw the shape. More...
 
int type () const override
 
- Public Member Functions inherited from QgsLayoutNodesItem
bool addNode (QPointF point, bool checkArea=true, double radius=10)
 Add a node in current shape. More...
 
QRectF boundingRect () const override
 
void deselectNode ()
 Deselects any selected nodes. More...
 
double estimatedFrameBleed () const override
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool moveNode (int index, QPointF node)
 Moves a node to a new position. More...
 
int nodeAtPosition (QPointF point, bool searchInRadius=true, double radius=10) const
 Search for the nearest node in the shape within a maximal area. More...
 
bool nodePosition (int index, QPointF &position) const
 Gets the position of a node in scene coordinates. More...
 
QPolygonF nodes () const
 Returns the nodes the shape consists of. More...
 
int nodesSize () const
 Returns the number of nodes in the shape. More...
 
bool removeNode (int index)
 Remove a node with specified index from the shape. More...
 
int selectedNode () const
 Returns the currently selected node, or -1 if no node is selected. More...
 
void setDisplayNodes (bool display=true)
 Set whether the item's nodes should be displayed. More...
 
void setNodes (const QPolygonF &nodes)
 Sets the nodes the shape consists of. More...
 
bool setSelectedNode (int index)
 Selects a node by index. More...
 
- 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 (bool useDataDefined=true) 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 bool isRefreshing () const
 Returns true if the item is currently refreshing content in the background. 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 QgsLayoutItemPolylinecreate (QgsLayout *layout)
 Returns a new polyline item for the specified layout. 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 Slots

void updateBoundingRect () override
 
- Protected Slots inherited from QgsLayoutNodesItem
virtual void updateBoundingRect ()
 Called when the bounding rect of the item should recalculated. More...
 

Protected Member Functions

bool _addNode (int indexPoint, QPointF newPoint, double radius) override
 Method called in addNode. More...
 
void _draw (QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle=nullptr) override
 Method called in paint. More...
 
void _readXmlStyle (const QDomElement &elmt, const QgsReadWriteContext &context) override
 Method called in readXml. More...
 
bool _removeNode (int nodeIndex) override
 Method called in removeNode. More...
 
void _writeXmlStyle (QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context) const override
 Method called in writeXml. 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 QgsLayoutNodesItem
 QgsLayoutNodesItem (const QPolygonF &polygon, QgsLayout *layout)
 Constructor for a QgsLayoutNodesItem with the given polygon nodes, attached to the specified layout. More...
 
 QgsLayoutNodesItem (QgsLayout *layout)
 Constructor for QgsLayoutNodesItem, attached to the specified layout. More...
 
virtual bool _addNode (int nodeIndex, QPointF newNode, double radius)=0
 Method called in addNode. More...
 
virtual void _draw (QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle=nullptr)=0
 Method called in paint. More...
 
virtual void _readXmlStyle (const QDomElement &elmt, const QgsReadWriteContext &context)=0
 Method called in readXml. More...
 
virtual bool _removeNode (int nodeIndex)=0
 Method called in removeNode. More...
 
virtual void _writeXmlStyle (QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context) const =0
 Method called in writeXml. More...
 
double computeDistance (QPointF pt1, QPointF pt2) const
 Compute an euclidean distance between 2 nodes. More...
 
void draw (QgsLayoutItemRenderContext &context) override
 Draws the item's contents using the specified item render context. More...
 
QgsLayoutItem::Flags itemFlags () const override
 Returns the item's flags, which indicate how the item behaves. More...
 
bool readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
 Sets item state from a DOM element. More...
 
void rescaleToFitBoundingBox ()
 Rescale the current shape according to the item's bounding box. More...
 
void updateSceneRect ()
 Update the current scene rectangle for this item. 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 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...
 
void drawRefreshingOverlay (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle)
 Draws a "refreshing" overlay icon on 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 QgsCompositionConverter
 
class TestQgsLayoutPolyline
 

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::DataDefinedProperty::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 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 QgsLayoutNodesItem
QRectF mCurrentRectangle
 Current bounding rectangle of shape. More...
 
double mMaxSymbolBleed = 0.0
 Max symbol bleed. More...
 
QPolygonF mPolygon
 Shape's nodes. 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 node based polyline shapes.

Definition at line 32 of file qgslayoutitempolyline.h.

Member Enumeration Documentation

◆ MarkerMode

Vertex marker mode.

Enumerator
NoMarker 

Don't show marker.

ArrowHead 

Show arrow marker.

SvgMarker 

Show SVG marker.

Definition at line 39 of file qgslayoutitempolyline.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemPolyline() [1/2]

QgsLayoutItemPolyline::QgsLayoutItemPolyline ( QgsLayout layout)

Constructor for QgsLayoutItemPolyline for the specified layout.

Definition at line 35 of file qgslayoutitempolyline.cpp.

◆ ~QgsLayoutItemPolyline()

QgsLayoutItemPolyline::~QgsLayoutItemPolyline ( )
overridedefault

◆ QgsLayoutItemPolyline() [2/2]

QgsLayoutItemPolyline::QgsLayoutItemPolyline ( const QPolygonF &  polyline,
QgsLayout layout 
)

Constructor for QgsLayoutItemPolyline for the specified polyline and layout.

Definition at line 41 of file qgslayoutitempolyline.cpp.

Member Function Documentation

◆ _addNode()

bool QgsLayoutItemPolyline::_addNode ( int  nodeIndex,
QPointF  newNode,
double  radius 
)
overrideprotectedvirtual

Method called in addNode.

Implements QgsLayoutNodesItem.

Definition at line 64 of file qgslayoutitempolyline.cpp.

◆ _draw()

void QgsLayoutItemPolyline::_draw ( QgsLayoutItemRenderContext context,
const QStyleOptionGraphicsItem *  itemStyle = nullptr 
)
overrideprotectedvirtual

Method called in paint.

Implements QgsLayoutNodesItem.

Definition at line 281 of file qgslayoutitempolyline.cpp.

◆ _readXmlStyle()

void QgsLayoutItemPolyline::_readXmlStyle ( const QDomElement &  elmt,
const QgsReadWriteContext context 
)
overrideprotectedvirtual

Method called in readXml.

Implements QgsLayoutNodesItem.

Definition at line 299 of file qgslayoutitempolyline.cpp.

◆ _removeNode()

bool QgsLayoutItemPolyline::_removeNode ( int  nodeIndex)
overrideprotectedvirtual

Method called in removeNode.

Implements QgsLayoutNodesItem.

Definition at line 84 of file qgslayoutitempolyline.cpp.

◆ _writeXmlStyle()

void QgsLayoutItemPolyline::_writeXmlStyle ( QDomDocument &  doc,
QDomElement &  elmt,
const QgsReadWriteContext context 
) const
overrideprotectedvirtual

Method called in writeXml.

Implements QgsLayoutNodesItem.

Definition at line 412 of file qgslayoutitempolyline.cpp.

◆ accept()

bool QgsLayoutItemPolyline::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 400 of file qgslayoutitempolyline.cpp.

◆ arrowHeadFillColor()

QColor QgsLayoutItemPolyline::arrowHeadFillColor ( ) const
inline

Returns the color used to fill the arrow head.

See also
arrowHeadStrokeColor()
setArrowHeadFillColor()

Definition at line 170 of file qgslayoutitempolyline.h.

◆ arrowHeadStrokeColor()

QColor QgsLayoutItemPolyline::arrowHeadStrokeColor ( ) const
inline

Returns the color used to draw the stroke around the the arrow head.

See also
arrowHeadFillColor()
setArrowHeadStrokeColor()

Definition at line 156 of file qgslayoutitempolyline.h.

◆ arrowHeadStrokeWidth()

double QgsLayoutItemPolyline::arrowHeadStrokeWidth ( ) const
inline

Returns the pen width in millimeters for the stroke of the arrow head.

See also
setArrowHeadStrokeWidth()
arrowHeadStrokeColor()

Definition at line 191 of file qgslayoutitempolyline.h.

◆ arrowHeadWidth()

double QgsLayoutItemPolyline::arrowHeadWidth ( ) const
inline

Returns the width of line arrow heads in mm.

See also
setArrowHeadWidth()

Definition at line 121 of file qgslayoutitempolyline.h.

◆ create()

QgsLayoutItemPolyline * QgsLayoutItemPolyline::create ( QgsLayout layout)
static

Returns a new polyline item for the specified layout.

The caller takes responsibility for deleting the returned object.

Definition at line 49 of file qgslayoutitempolyline.cpp.

◆ displayName()

QString QgsLayoutItemPolyline::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 273 of file qgslayoutitempolyline.cpp.

◆ endMarker()

MarkerMode QgsLayoutItemPolyline::endMarker ( ) const
inline

Returns the end marker mode, which controls what marker is drawn at the end of the line.

See also
setEndMarker()
startMarker()

Definition at line 102 of file qgslayoutitempolyline.h.

◆ endSvgMarkerPath()

QString QgsLayoutItemPolyline::endSvgMarkerPath ( ) const
inline

Returns the path the an SVG marker drawn at the end of the line.

See also
setEndSvgMarkerPath()
startSvgMarkerPath

Definition at line 149 of file qgslayoutitempolyline.h.

◆ icon()

QIcon QgsLayoutItemPolyline::icon ( ) const
overridevirtual

Returns the item's icon.

Reimplemented from QgsLayoutItem.

Definition at line 59 of file qgslayoutitempolyline.cpp.

◆ readPropertiesFromElement()

bool QgsLayoutItemPolyline::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 QgsLayoutNodesItem.

Definition at line 441 of file qgslayoutitempolyline.cpp.

◆ setArrowHeadFillColor()

void QgsLayoutItemPolyline::setArrowHeadFillColor ( const QColor &  color)

Sets the color used to fill the arrow head.

See also
arrowHeadFillColor()
setArrowHeadStrokeColor()

Definition at line 387 of file qgslayoutitempolyline.cpp.

◆ setArrowHeadStrokeColor()

void QgsLayoutItemPolyline::setArrowHeadStrokeColor ( const QColor &  color)

Sets the color used to draw the stroke around the arrow head.

See also
setArrowHeadFillColor()
arrowHeadStrokeColor()

Definition at line 381 of file qgslayoutitempolyline.cpp.

◆ setArrowHeadStrokeWidth()

void QgsLayoutItemPolyline::setArrowHeadStrokeWidth ( double  width)

Sets the pen width in millimeters for the stroke of the arrow head.

See also
arrowHeadStrokeWidth()
setArrowHeadStrokeColor()

Definition at line 393 of file qgslayoutitempolyline.cpp.

◆ setArrowHeadWidth()

void QgsLayoutItemPolyline::setArrowHeadWidth ( double  width)

Sets the width of line arrow heads in mm.

See also
arrowHeadWidth()

Definition at line 322 of file qgslayoutitempolyline.cpp.

◆ setEndMarker()

void QgsLayoutItemPolyline::setEndMarker ( QgsLayoutItemPolyline::MarkerMode  mode)

Sets the end marker mode, which controls what marker is drawn at the end of the line.

See also
endMarker()
setStartMarker()

Definition at line 316 of file qgslayoutitempolyline.cpp.

◆ setEndSvgMarkerPath()

void QgsLayoutItemPolyline::setEndSvgMarkerPath ( const QString &  path)

Sets the path to a SVG marker to draw at the end of the line.

See also
endSvgMarkerPath()
setStartSvgMarkerPath()

Definition at line 364 of file qgslayoutitempolyline.cpp.

◆ setStartMarker()

void QgsLayoutItemPolyline::setStartMarker ( QgsLayoutItemPolyline::MarkerMode  mode)

Sets the start marker mode, which controls what marker is drawn at the start of the line.

See also
startMarker()
setEndMarker()

Definition at line 310 of file qgslayoutitempolyline.cpp.

◆ setStartSvgMarkerPath()

void QgsLayoutItemPolyline::setStartSvgMarkerPath ( const QString &  path)

Sets the path to a SVG marker to draw at the start of the line.

See also
startSvgMarkerPath()
setEndSvgMarkerPath()

Definition at line 347 of file qgslayoutitempolyline.cpp.

◆ setSymbol()

void QgsLayoutItemPolyline::setSymbol ( QgsLineSymbol symbol)

Sets the symbol used to draw the shape.

Ownership of symbol is not transferred.

See also
symbol()

Definition at line 304 of file qgslayoutitempolyline.cpp.

◆ shape()

QPainterPath QgsLayoutItemPolyline::shape ( ) const
override

Definition at line 329 of file qgslayoutitempolyline.cpp.

◆ startMarker()

MarkerMode QgsLayoutItemPolyline::startMarker ( ) const
inline

Returns the start marker mode, which controls what marker is drawn at the start of the line.

See also
setStartMarker()
endMarker()

Definition at line 88 of file qgslayoutitempolyline.h.

◆ startSvgMarkerPath()

QString QgsLayoutItemPolyline::startSvgMarkerPath ( ) const
inline

Returns the path the an SVG marker drawn at the start of the line.

See also
setStartSvgMarkerPath()
endSvgMarkerPath

Definition at line 135 of file qgslayoutitempolyline.h.

◆ symbol()

QgsLineSymbol * QgsLayoutItemPolyline::symbol ( )

Returns the line symbol used to draw the shape.

See also
setSymbol()

Definition at line 342 of file qgslayoutitempolyline.cpp.

◆ type()

int QgsLayoutItemPolyline::type ( ) const
override

Definition at line 54 of file qgslayoutitempolyline.cpp.

◆ updateBoundingRect

void QgsLayoutItemPolyline::updateBoundingRect ( )
overrideprotectedslot

Definition at line 461 of file qgslayoutitempolyline.cpp.

◆ writePropertiesToElement()

bool QgsLayoutItemPolyline::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 QgsLayoutNodesItem.

Definition at line 421 of file qgslayoutitempolyline.cpp.

Friends And Related Function Documentation

◆ QgsCompositionConverter

friend class QgsCompositionConverter
friend

Definition at line 271 of file qgslayoutitempolyline.h.

◆ TestQgsLayoutPolyline

friend class TestQgsLayoutPolyline
friend

Definition at line 270 of file qgslayoutitempolyline.h.


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