QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
An annotation item which renders text along a line geometry. More...
#include <qgsannotationlinetextitem.h>
Public Member Functions | |
QgsAnnotationLineTextItem (const QString &text, QgsCurve *curve) | |
Constructor for QgsAnnotationLineTextItem, with the specified curve and text. | |
~QgsAnnotationLineTextItem () 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. | |
QgsAnnotationLineTextItem * | clone () const override |
Returns a clone of the item. | |
Qgis::AnnotationItemFlags | flags () const override |
Returns item flags. | |
QgsTextFormat | format () const |
Returns the text format used to render the text. | |
const QgsCurve * | geometry () const |
Returns the geometry of the item. | |
QList< QgsAnnotationItemNode > | nodesV2 (const QgsAnnotationItemEditContext &context) const override |
Returns the nodes for the item, used for editing the item. | |
double | offsetFromLine () const |
Returns the offset distance from the line geometry() to the text's baseline. | |
const QgsMapUnitScale & | offsetFromLineMapUnitScale () const |
Returns the map unit scale for the offset from line geometry() distance. | |
Qgis::RenderUnit | offsetFromLineUnit () const |
Returns the units for the offset from line geometry() distance. | |
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 | setFormat (const QgsTextFormat &format) |
Sets the text format used to render the text. | |
void | setGeometry (QgsCurve *geometry) |
Sets the geometry of the item. | |
void | setOffsetFromLine (double distance) |
Sets the offset distance from the line geometry() to the text's baseline. | |
void | setOffsetFromLineMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the offset from line geometry() distance. | |
void | setOffsetFromLineUnit (Qgis::RenderUnit unit) |
Sets the unit for the offset from line geometry() distance. | |
void | setText (const QString &text) |
Sets the text rendered by the item. | |
QString | text () const |
Returns the text rendered by the 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 QgsAnnotationLineTextItem * | create () |
Creates a new linestring 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 text along a line geometry.
Definition at line 34 of file qgsannotationlinetextitem.h.
QgsAnnotationLineTextItem::QgsAnnotationLineTextItem | ( | const QString & | text, |
QgsCurve * | curve | ||
) |
Constructor for QgsAnnotationLineTextItem, with the specified curve and text.
Definition at line 28 of file qgsannotationlinetextitem.cpp.
|
overridedefault |
|
overridevirtual |
Applies an edit operation to the item.
Reimplemented from QgsAnnotationItem.
Definition at line 120 of file qgsannotationlinetextitem.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 229 of file qgsannotationlinetextitem.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 234 of file qgsannotationlinetextitem.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 250 of file qgsannotationlinetextitem.cpp.
|
static |
Creates a new linestring annotation item.
Definition at line 195 of file qgsannotationlinetextitem.cpp.
|
overridevirtual |
Returns item flags.
Reimplemented from QgsAnnotationItem.
Definition at line 36 of file qgsannotationlinetextitem.cpp.
QgsTextFormat QgsAnnotationLineTextItem::format | ( | ) | const |
Returns the text format used to render the text.
Definition at line 266 of file qgsannotationlinetextitem.cpp.
|
inline |
Returns the geometry of the item.
The coordinate reference system for the line will be the parent layer's QgsAnnotationLayer::crs().
Definition at line 70 of file qgsannotationlinetextitem.h.
|
overridevirtual |
Returns the nodes for the item, used for editing the item.
Reimplemented from QgsAnnotationItem.
Definition at line 109 of file qgsannotationlinetextitem.cpp.
|
inline |
Returns the offset distance from the line geometry() to the text's baseline.
Units are specified through offsetFromLineUnit().
Definition at line 115 of file qgsannotationlinetextitem.h.
|
inline |
Returns the map unit scale for the offset from line geometry() distance.
Definition at line 157 of file qgsannotationlinetextitem.h.
|
inline |
Returns the units for the offset from line geometry() distance.
Definition at line 139 of file qgsannotationlinetextitem.h.
|
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 200 of file qgsannotationlinetextitem.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 50 of file qgsannotationlinetextitem.cpp.
void QgsAnnotationLineTextItem::setFormat | ( | const QgsTextFormat & | format | ) |
Sets the text format used to render the text.
Definition at line 271 of file qgsannotationlinetextitem.cpp.
void QgsAnnotationLineTextItem::setGeometry | ( | QgsCurve * | geometry | ) |
Sets the geometry of the item.
Ownership of geometry is transferred.
The coordinate reference system for the line will be the parent layer's QgsAnnotationLayer::crs().
Definition at line 261 of file qgsannotationlinetextitem.cpp.
|
inline |
Sets the offset distance from the line geometry() to the text's baseline.
Units are specified through setOffsetFromLineUnit().
Definition at line 123 of file qgsannotationlinetextitem.h.
|
inline |
Sets the map unit scale for the offset from line geometry() distance.
Definition at line 148 of file qgsannotationlinetextitem.h.
|
inline |
Sets the unit for the offset from line geometry() distance.
Definition at line 131 of file qgsannotationlinetextitem.h.
|
inline |
Sets the text rendered by the item.
Definition at line 93 of file qgsannotationlinetextitem.h.
|
inline |
Returns the text rendered by the item.
Definition at line 86 of file qgsannotationlinetextitem.h.
|
overridevirtual |
Retrieves the results of a transient (in progress) edit operation on the item.
Reimplemented from QgsAnnotationItem.
Definition at line 164 of file qgsannotationlinetextitem.cpp.
|
overridevirtual |
Returns a unique (untranslated) string identifying the type of item.
Implements QgsAnnotationItem.
Definition at line 45 of file qgsannotationlinetextitem.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 91 of file qgsannotationlinetextitem.cpp.