QGIS API Documentation
3.0.2-Girona (307d082)
|
Layout item for node based polygon shapes. More...
#include <qgslayoutitempolygon.h>
Public Member Functions | |
QgsLayoutItemPolygon (QgsLayout *layout) | |
Constructor for QgsLayoutItemPolygon for the specified layout. More... | |
QgsLayoutItemPolygon (const QPolygonF &polygon, QgsLayout *layout) | |
Constructor for QgsLayoutItemPolygon for the specified polygon and layout. More... | |
QString | displayName () const override |
Get item display name. More... | |
QIcon | icon () const override |
Returns the item's icon. More... | |
void | setSymbol (QgsFillSymbol *symbol) |
Sets the symbol used to draw the shape. More... | |
QgsFillSymbol * | symbol () |
Returns the fill 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 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... | |
QgsAbstractLayoutUndoCommand * | createCommand (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... | |
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... | |
QgsLayoutItemGroup * | parentGroup () 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 (const 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 (const 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 (const 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 (const 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 (const 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 (const 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 |
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... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. More... | |
QgsLayout * | layout () |
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 QgsLayoutItemPolygon * | create (QgsLayout *layout) |
Returns a new polygon item for the specified layout. More... | |
Static Public Member Functions inherited from QgsLayoutObject | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. More... | |
Protected Member Functions | |
bool | _addNode (const int indexPoint, QPointF newPoint, const 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 (const int nodeIndex) override |
Method called in removeNode. More... | |
void | _writeXmlStyle (QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context) const override |
Method called in writeXml. More... | |
Protected Member Functions inherited from QgsLayoutNodesItem | |
QgsLayoutNodesItem (QgsLayout *layout) | |
Constructor for QgsLayoutNodesItem, attached to the specified layout. More... | |
QgsLayoutNodesItem (const QPolygonF &polygon, QgsLayout *layout) | |
Constructor for a QgsLayoutNodesItem with the given polygon nodes, attached to the specified layout. More... | |
double | computeDistance (QPointF pt1, QPointF pt2) const |
Compute an euclidian distance between 2 nodes. More... | |
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... | |
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 (const QPointF &point, const QSizeF &size, const 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 (const 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 (const 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... | |
Layout item for node based polygon shapes.
Definition at line 30 of file qgslayoutitempolygon.h.
QgsLayoutItemPolygon::QgsLayoutItemPolygon | ( | QgsLayout * | layout | ) |
Constructor for QgsLayoutItemPolygon for the specified layout.
Definition at line 28 of file qgslayoutitempolygon.cpp.
QgsLayoutItemPolygon::QgsLayoutItemPolygon | ( | const QPolygonF & | polygon, |
QgsLayout * | layout | ||
) |
Constructor for QgsLayoutItemPolygon for the specified polygon and layout.
Definition at line 34 of file qgslayoutitempolygon.cpp.
|
overrideprotectedvirtual |
Method called in addNode.
Implements QgsLayoutNodesItem.
Definition at line 55 of file qgslayoutitempolygon.cpp.
|
overrideprotectedvirtual |
Method called in paint.
Implements QgsLayoutNodesItem.
Definition at line 100 of file qgslayoutitempolygon.cpp.
|
overrideprotectedvirtual |
Method called in readXml.
Implements QgsLayoutNodesItem.
Definition at line 116 of file qgslayoutitempolygon.cpp.
|
overrideprotectedvirtual |
Method called in removeNode.
Implements QgsLayoutNodesItem.
Definition at line 136 of file qgslayoutitempolygon.cpp.
|
overrideprotectedvirtual |
Method called in writeXml.
Implements QgsLayoutNodesItem.
Definition at line 127 of file qgslayoutitempolygon.cpp.
|
static |
Returns a new polygon item for the specified layout.
The caller takes responsibility for deleting the returned object.
Definition at line 40 of file qgslayoutitempolygon.cpp.
|
overridevirtual |
Get item display name.
This is the item's id if set, and if not, a user-friendly string identifying item type.
Reimplemented from QgsLayoutItem.
Definition at line 92 of file qgslayoutitempolygon.cpp.
|
overridevirtual |
Returns the item's icon.
Reimplemented from QgsLayoutItem.
Definition at line 50 of file qgslayoutitempolygon.cpp.
void QgsLayoutItemPolygon::setSymbol | ( | QgsFillSymbol * | symbol | ) |
Sets the symbol used to draw the shape.
Ownership of symbol is not transferred.
Definition at line 121 of file qgslayoutitempolygon.cpp.
|
inline |
Returns the fill symbol used to draw the shape.
Definition at line 62 of file qgslayoutitempolygon.h.
|
override |
Definition at line 45 of file qgslayoutitempolygon.cpp.