QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
An annotation item which renders a marker symbol at a point location. More...
#include <qgsannotationmarkeritem.h>
Public Member Functions | |
QgsAnnotationMarkerItem (const QgsPoint &point) | |
Constructor for QgsAnnotationMarkerItem, at the specified point. | |
~QgsAnnotationMarkerItem () override | |
Qgis::AnnotationItemEditOperationResult | applyEditV2 (QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context) override |
Applies an edit operation to the item. | |
QgsRectangle | boundingBox () const override |
Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. | |
QgsRectangle | boundingBox (QgsRenderContext &context) const override |
Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. | |
QgsAnnotationMarkerItem * | clone () const override |
Returns a clone of the item. | |
Qgis::AnnotationItemFlags | flags () const override |
Returns item flags. | |
QgsPointXY | geometry () const |
Returns the point geometry of the marker. | |
QList< QgsAnnotationItemNode > | nodesV2 (const QgsAnnotationItemEditContext &context) const override |
Returns the nodes for the item, used for editing the item. | |
bool | readXml (const QDomElement &element, const QgsReadWriteContext &context) override |
Reads the item's state from the given DOM element. | |
void | render (QgsRenderContext &context, QgsFeedback *feedback) override |
Renders the item to the specified render context. | |
void | setGeometry (const QgsPoint &geometry) |
Sets the point geometry location of the marker. | |
void | setSymbol (QgsMarkerSymbol *symbol) |
Sets the symbol used to render the marker item. | |
const QgsMarkerSymbol * | symbol () const |
Returns the symbol used to render the marker item. | |
QgsAnnotationItemEditOperationTransientResults * | transientEditResultsV2 (QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context) override |
Retrieves the results of a transient (in progress) edit operation on the item. | |
QString | type () const override |
Returns a unique (untranslated) string identifying the type of item. | |
bool | writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override |
Writes the item's state into an XML element. | |
Public Member Functions inherited from QgsAnnotationItem | |
QgsAnnotationItem () | |
QgsAnnotationItem (const QgsAnnotationItem &other)=delete | |
virtual | ~QgsAnnotationItem () |
virtual Q_DECL_DEPRECATED Qgis::AnnotationItemEditOperationResult | applyEdit (QgsAbstractAnnotationItemEditOperation *operation) |
Applies an edit operation to the item. | |
QgsCallout * | callout () const |
Returns the item's callout renderer, responsible for drawing item callouts. | |
QgsGeometry | calloutAnchor () const |
Returns the callout's anchor geometry. | |
bool | enabled () const |
Returns true if the item is enabled and will be rendered in the layer. | |
virtual Q_DECL_DEPRECATED QList< QgsAnnotationItemNode > | nodes () const |
Returns the nodes for the item, used for editing the item. | |
QSizeF | offsetFromCallout () const |
Returns the (optional) offset of the annotation item from the calloutAnchor(). | |
Qgis::RenderUnit | offsetFromCalloutUnit () const |
Returns the units for the offsetFromCallout(). | |
QgsAnnotationItem & | operator= (const QgsAnnotationItem &other)=delete |
void | setCallout (QgsCallout *callout) |
Sets the item's callout renderer, responsible for drawing item callouts. | |
void | setCalloutAnchor (const QgsGeometry &anchor) |
Sets the callout's anchor geometry. | |
void | setEnabled (bool enabled) |
Sets if the item will be rendered or not in the layer. | |
void | setOffsetFromCallout (const QSizeF &offset) |
Sets the offset of the annotation item from the calloutAnchor(). | |
void | setOffsetFromCalloutUnit (Qgis::RenderUnit unit) |
Sets the unit for the offsetFromCallout(). | |
void | setSymbologyReferenceScale (double scale) |
Sets the annotation's symbology reference scale. | |
void | setUseSymbologyReferenceScale (bool enabled) |
Sets whether the annotation item uses a symbology reference scale. | |
void | setZIndex (int index) |
Sets the item's z index, which controls the order in which annotation items are rendered in the layer. | |
double | symbologyReferenceScale () const |
Returns the annotation's symbology reference scale. | |
virtual Q_DECL_DEPRECATED QgsAnnotationItemEditOperationTransientResults * | transientEditResults (QgsAbstractAnnotationItemEditOperation *operation) |
Retrieves the results of a transient (in progress) edit operation on the item. | |
bool | useSymbologyReferenceScale () const |
Returns true if the annotation item uses a symbology reference scale. | |
int | zIndex () const |
Returns the item's z index, which controls the order in which annotation items are rendered in the layer. | |
Static Public Member Functions | |
static QgsAnnotationMarkerItem * | create () |
Creates a new marker annotation item. | |
Additional Inherited Members | |
Protected Member Functions inherited from QgsAnnotationItem | |
virtual void | copyCommonProperties (const QgsAnnotationItem *other) |
Copies common properties from the base class from an other item. | |
virtual bool | readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context) |
Reads common properties from the base class from the given DOM element. | |
void | renderCallout (QgsRenderContext &context, const QRectF &rect, double angle, QgsCallout::QgsCalloutContext &calloutContext, QgsFeedback *feedback) |
Renders the item's callout. | |
virtual bool | writeCommonProperties (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const |
Writes common properties from the base class into an XML element. | |
An annotation item which renders a marker symbol at a point location.
Definition at line 32 of file qgsannotationmarkeritem.h.
QgsAnnotationMarkerItem::QgsAnnotationMarkerItem | ( | const QgsPoint & | point | ) |
Constructor for QgsAnnotationMarkerItem, at the specified point.
Definition at line 25 of file qgsannotationmarkeritem.cpp.
|
overridedefault |
|
overridevirtual |
Applies an edit operation to the item.
Reimplemented from QgsAnnotationItem.
Definition at line 84 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system.
Implements QgsAnnotationItem.
Definition at line 165 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system.
Reimplemented from QgsAnnotationItem.
Definition at line 170 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Returns a clone of the item.
Ownership is transferred to the caller.
Implementations should include a call to copyCommonProperties() to copy the base class properties.
Implements QgsAnnotationItem.
Definition at line 157 of file qgsannotationmarkeritem.cpp.
|
static |
Creates a new marker annotation item.
Definition at line 138 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Returns item flags.
Reimplemented from QgsAnnotationItem.
Definition at line 72 of file qgsannotationmarkeritem.cpp.
|
inline |
Returns the point geometry of the marker.
The coordinate reference system for the point will be the parent layer's QgsAnnotationLayer::crs().
Definition at line 67 of file qgsannotationmarkeritem.h.
|
overridevirtual |
Returns the nodes for the item, used for editing the item.
Reimplemented from QgsAnnotationItem.
Definition at line 79 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Reads the item's state from the given DOM element.
Implementations should include a call to readCommonProperties() to read the base class properties.
Implements QgsAnnotationItem.
Definition at line 143 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Renders the item to the specified render context.
The feedback argument can be used to detect render cancellations during expensive render operations.
Implements QgsAnnotationItem.
Definition at line 40 of file qgsannotationmarkeritem.cpp.
|
inline |
Sets the point geometry location of the marker.
The coordinate reference system for the point will be the parent layer's QgsAnnotationLayer::crs().
Definition at line 76 of file qgsannotationmarkeritem.h.
void QgsAnnotationMarkerItem::setSymbol | ( | QgsMarkerSymbol * | symbol | ) |
Sets the symbol used to render the marker item.
The item takes ownership of the symbol.
Definition at line 204 of file qgsannotationmarkeritem.cpp.
const QgsMarkerSymbol * QgsAnnotationMarkerItem::symbol | ( | ) | const |
Returns the symbol used to render the marker item.
Definition at line 199 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Retrieves the results of a transient (in progress) edit operation on the item.
Reimplemented from QgsAnnotationItem.
Definition at line 115 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Returns a unique (untranslated) string identifying the type of item.
Implements QgsAnnotationItem.
Definition at line 35 of file qgsannotationmarkeritem.cpp.
|
overridevirtual |
Writes the item's state into an XML element.
Implementations should include a call to writeCommonProperties() to store the base class properties.
Implements QgsAnnotationItem.
Definition at line 61 of file qgsannotationmarkeritem.cpp.