QGIS API Documentation  2.99.0-Master (19b062c)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsComposerNodesItem Class Referenceabstract

An abstract composer item that provides generic methods for nodes based shapes such as polygon or polylines. More...

#include <qgscomposernodesitem.h>

Inheritance diagram for QgsComposerNodesItem:
Inheritance graph
[legend]

Public Member Functions

 QgsComposerNodesItem (const QString &mTagName, QgsComposition *c)
 Constructor. More...
 
 QgsComposerNodesItem (const QString &mTagName, const QPolygonF &polygon, QgsComposition *c)
 Constructor. More...
 
bool addNode (QPointF pt, const bool checkArea=true, const double radius=10)
 Add a node in current shape. More...
 
void deselectNode ()
 Deselect a node. More...
 
bool moveNode (const int index, QPointF node)
 Move a node to a new position. More...
 
int nodeAtPosition (QPointF node, const bool searchInRadius=true, const double radius=10)
 Search the nearest node in shape within a maximal area. More...
 
bool nodePosition (const int index, QPointF &position)
 Gets the position of a node in scene coordinate. More...
 
int nodesSize ()
 Returns the number of nodes in the shape. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override
 Reimplementation of QCanvasItem::paint - draw on canvas. More...
 
bool readXml (const QDomElement &itemElem, const QDomDocument &doc) override
 Sets state from Dom document. More...
 
bool removeNode (const int index)
 Remove a node from the shape. More...
 
int selectedNode ()
 Returns the currently selected node. More...
 
void setDisplayNodes (const bool display=true)
 Set a tag to indicate if we want to draw or not the shape's nodes. More...
 
bool setSelectedNode (const int index)
 Select a node. More...
 
bool writeXml (QDomElement &elem, QDomDocument &doc) const override
 Stores state in Dom element. More...
 
- Public Member Functions inherited from QgsComposerItem
 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 Constructor. More...
 
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object. More...
 
virtual ~QgsComposerItem ()
 
bool _readXml (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document. Usually called from readXml methods of subclasses. More...
 
bool _writeXml (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. Usually called from writeXml methods of subclasses. More...
 
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default. More...
 
QColor backgroundColor () const
 Gets the background color for this item. More...
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
virtual void beginItemCommand (const QString &text)
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void cancelCommand ()
 
virtual QgsExpressionContext createExpressionContext () const override
 Creates an expression context relating to the item's current state. More...
 
virtual QString displayName () const
 Get item display name. More...
 
bool effectsEnabled () const
 Returns whether effects (e.g., blend modes) are enabled for the item. More...
 
void endCommand ()
 Finish current command and push it onto the undo stack. More...
 
virtual void endItemCommand ()
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
 Returns whether the item should be excluded from composer exports and prints. 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...
 
double frameStrokeWidth () const
 Returns the frame's stroke width. More...
 
bool hasBackground () const
 Whether this item has a Background or not. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
QString id () const
 Get item's id (which is not necessarly unique) More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
virtual bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
double itemOpacity () const
 Returns the item's opacity. More...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item, in degrees clockwise. More...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. More...
 
void move (double dx, double dy)
 Moves item in canvas coordinates. More...
 
virtual void moveContent (double dx, double dy)
 Move Content of item. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
int page () const
 Gets the page the item is currently on. More...
 
QPointF pagePos () const
 Returns the item's position relative to its current page. More...
 
bool positionLock () const
 Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
virtual void removeItems ()
 
virtual bool selected () const
 Is selected. More...
 
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item. More...
 
void setBackgroundEnabled (const bool drawBackground)
 Set whether this item has a Background drawn around it or not. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 
void setEffectsEnabled (const bool effectsEnabled)
 Sets whether effects (e.g., blend modes) are enabled for the item. More...
 
virtual void setExcludeFromExports (const bool exclude)
 Sets whether the item should be excluded from composer exports and prints. More...
 
virtual void setFrameEnabled (const bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
void setFrameJoinStyle (const Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame. More...
 
virtual void setFrameStrokeColor (const QColor &color)
 Sets frame stroke color. More...
 
virtual void setFrameStrokeWidth (const double strokeWidth)
 Sets frame stroke width. More...
 
virtual void setId (const QString &id)
 Set item's id (which is not necessarly unique) More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
void setItemOpacity (const double opacity)
 Sets the item's opacity. More...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
 Moves the item to a new position (in canvas coordinates) More...
 
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1)
 Sets item position and width / height in one go. More...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
virtual void setSceneRect (const QRectF &rectangle)
 Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
void setUpdatesEnabled (bool enabled)
 Sets whether updates to the item are enabled. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
virtual int type () const override
 Return correct graphics item type. More...
 
virtual void updateItem ()
 Updates (redraws) the item, with the possibility to do custom update for subclasses. More...
 
void updatePagePos (double newPageWidth, double newPageHeight)
 Moves the item so that it retains its relative position on the page when the paper size changes. More...
 
bool updatesEnabled () const
 Returns whether updates to the item are enabled. More...
 
QString uuid () const
 Get item identification name. More...
 
virtual void zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom)
 Zoom content of item. More...
 
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor. More...
 
virtual ~QgsComposerObject ()=default
 
const QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
QStringList customProperties () const
 Return 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...
 
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
 

Protected Member Functions

virtual bool _addNode (const int nodeIndex, QPointF newNode, const double radius)=0
 Method called in addNode. More...
 
virtual void _draw (QPainter *painter)=0
 Method called in paint. More...
 
virtual void _readXmlStyle (const QDomElement &elmt)=0
 Method called in readXml. More...
 
virtual bool _removeNode (const int nodeIndex)=0
 Method called in removeNode. More...
 
virtual void _writeXmlStyle (QDomDocument &doc, QDomElement &elmt) const =0
 Method called in writeXml. More...
 
double computeDistance (QPointF pt1, QPointF pt2) const
 Compute an euclidian distance between 2 nodes. More...
 
void rescaleToFitBoundingBox ()
 Rescale the current shape according to the boudning box. More...
 
void updateSceneRect ()
 Update the current scene rectangle for this item. More...
 
- Protected Member Functions inherited from QgsComposerItem
void deleteAlignItems ()
 
void deleteHAlignSnapItem ()
 
void deleteVAlignSnapItem ()
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawSelectionBoxes (QPainter *p)
 Draws additional graphics on selected items. More...
 
QRectF evalItemRect (const QRectF &newRect, const bool resizeOnly=false, const QgsExpressionContext *context=nullptr)
 Evaluates an item's bounding rect to consider data defined position and size of item and reference point. More...
 
QGraphicsLineItem * hAlignSnapItem ()
 Return horizontal align snap item. Creates a new graphics line if 0. More...
 
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view. More...
 
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item. Creates a new graphics line if 0. More...
 

Protected Attributes

QPolygonF mPolygon
 Storage meaning for shape's nodes. More...
 
- Protected Attributes inherited from QgsComposerItem
bool mBackground
 True if item background needs to be painted. More...
 
QColor mBackgroundColor
 Background color. More...
 
QPainter::CompositionMode mBlendMode
 Composition blend mode for item. More...
 
QGraphicsRectItem * mBoundingResizeRectangle = nullptr
 Rectangle used during move and resize actions. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
 
QgsComposerEffectmEffect = nullptr
 
bool mEffectsEnabled
 
bool mEvaluatedExcludeFromExports
 Temporary evaluated item exclusion. More...
 
double mEvaluatedItemRotation
 Temporary evaluated item rotation in degrees, clockwise. More...
 
bool mExcludeFromExports
 Whether item should be excluded in exports. More...
 
bool mFrame
 True if item fram needs to be painted. More...
 
QColor mFrameColor
 Item frame color. More...
 
Qt::PenJoinStyle mFrameJoinStyle = Qt::MiterJoin
 Frame join style. More...
 
double mFrameWidth = 0.3
 Item frame width. More...
 
QGraphicsLineItem * mHAlignSnapItem = nullptr
 
bool mIsGroupMember
 Whether or not this item is part of a group. More...
 
bool mItemPositionLocked
 True if item position and size cannot be changed with mouse move. More...
 
double mItemRotation
 Item rotation in degrees, clockwise. More...
 
QPointF mLastMouseEventPos
 Position of the last mouse move event (in scene coordinates) More...
 
ItemPositionMode mLastUsedPositionMode
 The item's position mode. More...
 
double mLastValidViewScaleFactor
 Backup to restore item appearance if no view scale factor is available. More...
 
QPointF mMouseMoveStartPos
 Start point of the last mouse move action (in scene coordinates) More...
 
double mOpacity = 1.0
 Item opacity, between 0 and 1. More...
 
bool mRemovedFromComposition
 True if item has been removed from the composition. More...
 
QGraphicsLineItem * mVAlignSnapItem = nullptr
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition = nullptr
 
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QgsPropertyCollection mDataDefinedProperties
 

Additional Inherited Members

- Public Types inherited from QgsComposerItem
enum  ItemPositionMode {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 
enum  ItemType {
  ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel,
  ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture,
  ComposerScaleBar, ComposerShape, ComposerPolygon, ComposerPolyline,
  ComposerTable, ComposerAttributeTable, ComposerTextTable, ComposerFrame
}
 
enum  MouseMoveAction {
  MoveItem, ResizeUp, ResizeDown, ResizeLeft,
  ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown,
  ResizeRightDown, NoAction
}
 Describes the action (move or resize in different directon) to be done during mouse move. More...
 
enum  ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom }
 Modes for zooming item content. More...
 
- Public Types inherited from QgsComposerObject
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, PictureSource, PictureSvgBackgroundColor, PictureSvgStrokeColor,
  PictureSvgStrokeWidth, SourceUrl, LegendTitle, LegendColumnCount,
  ScalebarFillColor, ScalebarFillColor2, ScalebarLineColor, ScalebarLineWidth
}
 Data defined properties for different item types. More...
 
enum  PropertyValueType { EvaluatedValue = 0, OriginalValue }
 Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
 
- Public Slots inherited from QgsComposerItem
virtual void refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties, const QgsExpressionContext *context=nullptr) override
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
void repaint () override
 
virtual void setItemRotation (const double rotation, const bool adjustPosition=false)
 Sets the item rotation, in degrees clockwise. More...
 
- Public Slots inherited from QgsComposerObject
virtual void refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties, const QgsExpressionContext *context=nullptr)
 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 repaint ()
 Triggers a redraw for the item. More...
 
- Signals inherited from QgsComposerItem
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 
- Static Public Member Functions inherited from QgsComposerObject
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the composer object property definitions. More...
 

Detailed Description

An abstract composer item that provides generic methods for nodes based shapes such as polygon or polylines.

Since
QGIS 2.16

Definition at line 31 of file qgscomposernodesitem.h.

Constructor & Destructor Documentation

◆ QgsComposerNodesItem() [1/2]

QgsComposerNodesItem::QgsComposerNodesItem ( const QString &  mTagName,
QgsComposition c 
)

Constructor.

Parameters
mTagNametag used in XML file
cparent composition

Definition at line 26 of file qgscomposernodesitem.cpp.

◆ QgsComposerNodesItem() [2/2]

QgsComposerNodesItem::QgsComposerNodesItem ( const QString &  mTagName,
const QPolygonF &  polygon,
QgsComposition c 
)

Constructor.

Parameters
mTagNametag used in XML file
polygonnodes of the shape
cparent composition

Definition at line 35 of file qgscomposernodesitem.cpp.

Member Function Documentation

◆ _addNode()

virtual bool QgsComposerNodesItem::_addNode ( const int  nodeIndex,
QPointF  newNode,
const double  radius 
)
protectedpure virtual

Method called in addNode.

Implemented in QgsComposerPolygon, and QgsComposerPolyline.

◆ _draw()

virtual void QgsComposerNodesItem::_draw ( QPainter *  painter)
protectedpure virtual

Method called in paint.

Implemented in QgsComposerPolygon, and QgsComposerPolyline.

◆ _readXmlStyle()

virtual void QgsComposerNodesItem::_readXmlStyle ( const QDomElement &  elmt)
protectedpure virtual

Method called in readXml.

Implemented in QgsComposerPolygon, and QgsComposerPolyline.

◆ _removeNode()

virtual bool QgsComposerNodesItem::_removeNode ( const int  nodeIndex)
protectedpure virtual

Method called in removeNode.

Implemented in QgsComposerPolygon, and QgsComposerPolyline.

◆ _writeXmlStyle()

virtual void QgsComposerNodesItem::_writeXmlStyle ( QDomDocument &  doc,
QDomElement &  elmt 
) const
protectedpure virtual

Method called in writeXml.

Implemented in QgsComposerPolygon, and QgsComposerPolyline.

◆ addNode()

bool QgsComposerNodesItem::addNode ( QPointF  pt,
const bool  checkArea = true,
const double  radius = 10 
)

Add a node in current shape.

Parameters
ptis the location of the new node
checkAreais a flag to indicate if there's a space constraint.
radiusis the space contraint and is used only if checkArea is true. Typically, if this flag is true, the new node has to be nearest than radius to the shape to be added.

Definition at line 56 of file qgscomposernodesitem.cpp.

◆ computeDistance()

double QgsComposerNodesItem::computeDistance ( QPointF  pt1,
QPointF  pt2 
) const
protected

Compute an euclidian distance between 2 nodes.

Definition at line 50 of file qgscomposernodesitem.cpp.

◆ deselectNode()

void QgsComposerNodesItem::deselectNode ( )
inline

Deselect a node.

Definition at line 127 of file qgscomposernodesitem.h.

◆ moveNode()

bool QgsComposerNodesItem::moveNode ( const int  index,
QPointF  node 
)

Move a node to a new position.

Parameters
indexthe index of the node to move
nodeis the new position in scene coordinate

Definition at line 256 of file qgscomposernodesitem.cpp.

◆ nodeAtPosition()

int QgsComposerNodesItem::nodeAtPosition ( QPointF  node,
const bool  searchInRadius = true,
const double  radius = 10 
)

Search the nearest node in shape within a maximal area.

Returns the index of the nearest node or -1.

Parameters
nodeis where a shape's node is searched
searchInRadiusis a flag to indicate if the area of research is limited in space.
radiusis only used if searchInRadius is true

Definition at line 211 of file qgscomposernodesitem.cpp.

◆ nodePosition()

bool QgsComposerNodesItem::nodePosition ( const int  index,
QPointF &  position 
)

Gets the position of a node in scene coordinate.

Parameters
indexof the node
positionthe position of the node
Returns
true if the index is valid and the position is set, false otherwise

Definition at line 235 of file qgscomposernodesitem.cpp.

◆ nodesSize()

int QgsComposerNodesItem::nodesSize ( )
inline

Returns the number of nodes in the shape.

Definition at line 110 of file qgscomposernodesitem.h.

◆ paint()

void QgsComposerNodesItem::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
override

Reimplementation of QCanvasItem::paint - draw on canvas.

Definition at line 182 of file qgscomposernodesitem.cpp.

◆ readXml()

bool QgsComposerNodesItem::readXml ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
overridevirtual

Sets state from Dom document.

Parameters
itemElemis Dom node corresponding to item tag
docis Dom document

Reimplemented from QgsComposerObject.

Definition at line 272 of file qgscomposernodesitem.cpp.

◆ removeNode()

bool QgsComposerNodesItem::removeNode ( const int  index)

Remove a node from the shape.

Parameters
indexof the node to delete

Definition at line 248 of file qgscomposernodesitem.cpp.

◆ rescaleToFitBoundingBox()

void QgsComposerNodesItem::rescaleToFitBoundingBox ( )
protected

Rescale the current shape according to the boudning box.

Useful when the shape is resized thanks to the rubber band.

Definition at line 309 of file qgscomposernodesitem.cpp.

◆ selectedNode()

int QgsComposerNodesItem::selectedNode ( )
inline

Returns the currently selected node.

Returns
the index of the selected node, -1 otherwise

Definition at line 122 of file qgscomposernodesitem.h.

◆ setDisplayNodes()

void QgsComposerNodesItem::setDisplayNodes ( const bool  display = true)
inline

Set a tag to indicate if we want to draw or not the shape's nodes.

Parameters
display

Definition at line 66 of file qgscomposernodesitem.h.

◆ setSelectedNode()

bool QgsComposerNodesItem::setSelectedNode ( const int  index)

Select a node.

Parameters
indexthe node to select

Definition at line 324 of file qgscomposernodesitem.cpp.

◆ updateSceneRect()

void QgsComposerNodesItem::updateSceneRect ( )
protected

Update the current scene rectangle for this item.

Definition at line 337 of file qgscomposernodesitem.cpp.

◆ writeXml()

bool QgsComposerNodesItem::writeXml ( QDomElement &  elem,
QDomDocument &  doc 
) const
overridevirtual

Stores state in Dom element.

Parameters
elemis Dom element corresponding to 'Composer' tag
docwrite template file

Reimplemented from QgsComposerObject.

Definition at line 354 of file qgscomposernodesitem.cpp.

Member Data Documentation

◆ mPolygon

QPolygonF QgsComposerNodesItem::mPolygon
protected

Storage meaning for shape's nodes.

Definition at line 139 of file qgscomposernodesitem.h.


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