QgsAnnotationPointTextItem Class Reference

An annotation item which renders a text string at a point location. More...

#include <qgsannotationpointtextitem.h>

Inheritance diagram for QgsAnnotationPointTextItem:

Public Member Functions
	QgsAnnotationPointTextItem (const QString &text, QgsPointXY point)
	Constructor for QgsAnnotationPointTextItem, containing the specified text at the specified point. More...
	~QgsAnnotationPointTextItem () override
Qt::Alignment	alignment () const
	Returns the text's alignment relative to the reference point(). More...
double	angle () const
	Returns the text's rotation angle, in degrees clockwise. More...
Qgis::AnnotationItemEditOperationResult	applyEdit (QgsAbstractAnnotationItemEditOperation *operation) override
	Applies an edit operation to the item. More...
QgsRectangle	boundingBox () const override
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...
QgsRectangle	boundingBox (QgsRenderContext &context) const override
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...
QgsAnnotationPointTextItem *	clone () override
	Returns a clone of the item. More...
Qgis::AnnotationItemFlags	flags () const override
	Returns item flags. More...
QgsTextFormat	format () const
	Returns the text format used to render the text. More...
QList< QgsAnnotationItemNode >	nodes () const override
	Returns the nodes for the item, used for editing the item. More...
QgsPointXY	point () const
	Returns the point location of the text. More...
bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads the item's state from the given DOM element. More...
void	render (QgsRenderContext &context, QgsFeedback *feedback) override
	Renders the item to the specified render context. More...
void	setAlignment (Qt::Alignment alignment)
	Sets the text's alignment relative to the reference point(). More...
void	setAngle (double angle)
	Sets the text's rotation angle, in degrees clockwise. More...
void	setFormat (const QgsTextFormat &format)
	Sets the text format used to render the text. More...
void	setPoint (QgsPointXY point)
	Sets the point location of the text. More...
void	setText (const QString &text)
	Sets the text rendered by the item. More...
QString	text () const
	Returns the text rendered by the item. More...
QgsAnnotationItemEditOperationTransientResults *	transientEditResults (QgsAbstractAnnotationItemEditOperation *operation) override
	Retrieves the results of a transient (in progress) edit operation on the item. More...
QString	type () const override
	Returns a unique (untranslated) string identifying the type of item. More...
bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
	Writes the item's state into an XML element. More...
Public Member Functions inherited from QgsAnnotationItem
	QgsAnnotationItem ()=default
	Constructor for an annotation item. More...
	QgsAnnotationItem (const QgsAnnotationItem &other)=delete
	QgsAnnotationItem cannot be copied. More...
virtual	~QgsAnnotationItem ()=default
virtual Qgis::AnnotationItemEditOperationResult	applyEdit (QgsAbstractAnnotationItemEditOperation *operation)
	Applies an edit operation to the item. More...
virtual QgsRectangle	boundingBox () const =0
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...
virtual QgsRectangle	boundingBox (QgsRenderContext &context) const
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...
virtual QgsAnnotationItem *	clone ()=0
	Returns a clone of the item. More...
virtual Qgis::AnnotationItemFlags	flags () const
	Returns item flags. More...
virtual QList< QgsAnnotationItemNode >	nodes () const
	Returns the nodes for the item, used for editing the item. More...
QgsAnnotationItem &	operator= (const QgsAnnotationItem &other)=delete
	QgsAnnotationItem cannot be copied. More...
virtual bool	readXml (const QDomElement &element, const QgsReadWriteContext &context)=0
	Reads the item's state from the given DOM element. More...
virtual void	render (QgsRenderContext &context, QgsFeedback *feedback)=0
	Renders the item to the specified render context. More...
void	setSymbologyReferenceScale (double scale)
	Sets the annotation's symbology reference scale. More...
void	setUseSymbologyReferenceScale (bool enabled)
	Sets whether the annotation item uses a symbology reference scale. More...
void	setZIndex (int index)
	Sets the item's z index, which controls the order in which annotation items are rendered in the layer. More...
double	symbologyReferenceScale () const
	Returns the annotation's symbology reference scale. More...
virtual QgsAnnotationItemEditOperationTransientResults *	transientEditResults (QgsAbstractAnnotationItemEditOperation *operation)
	Retrieves the results of a transient (in progress) edit operation on the item. More...
virtual QString	type () const =0
	Returns a unique (untranslated) string identifying the type of item. More...
bool	useSymbologyReferenceScale () const
	Returns true if the annotation item uses a symbology reference scale. More...
virtual bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const =0
	Writes the item's state into an XML element. More...
int	zIndex () const
	Returns the item's z index, which controls the order in which annotation items are rendered in the layer. More...

Static Public Member Functions
static QgsAnnotationPointTextItem *	create ()
	Creates a new text at point annotation item. More...

Additional Inherited Members
Protected Member Functions inherited from QgsAnnotationItem
void	copyCommonProperties (const QgsAnnotationItem *other)
	Copies common properties from the base class from an other item. More...
bool	readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context)
	Reads common properties from the base class from the given DOM element. More...
bool	writeCommonProperties (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
	Writes common properties from the base class into an XML element. More...

Detailed Description

An annotation item which renders a text string at a point location.

Since

QGIS 3.16

Definition at line 33 of file qgsannotationpointtextitem.h.

Constructor & Destructor Documentation

QgsAnnotationPointTextItem()

QgsAnnotationPointTextItem::QgsAnnotationPointTextItem	(	const QString &	text,
		QgsPointXY	point
	)

Constructor for QgsAnnotationPointTextItem, containing the specified text at the specified point.

Definition at line 24 of file qgsannotationpointtextitem.cpp.

~QgsAnnotationPointTextItem()

QgsAnnotationPointTextItem::~QgsAnnotationPointTextItem ( )

overridedefault

Member Function Documentation

alignment()

Qt::Alignment QgsAnnotationPointTextItem::alignment

(

)

const

Returns the text's alignment relative to the reference point().

See also

setAlignment().

Definition at line 209 of file qgsannotationpointtextitem.cpp.

angle()

double QgsAnnotationPointTextItem::angle ( ) const

inline

Returns the text's rotation angle, in degrees clockwise.

See also

setAngle()

Definition at line 112 of file qgsannotationpointtextitem.h.

applyEdit()

Qgis::AnnotationItemEditOperationResult QgsAnnotationPointTextItem::applyEdit ( QgsAbstractAnnotationItemEditOperation *  operation )

overridevirtual

Applies an edit operation to the item.

Since

QGIS 3.22

Reimplemented from QgsAnnotationItem.

Definition at line 145 of file qgsannotationpointtextitem.cpp.

boundingBox() [1/2]

QgsRectangle QgsAnnotationPointTextItem::boundingBox ( ) const

overridevirtual

Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system.

Implements QgsAnnotationItem.

Definition at line 119 of file qgsannotationpointtextitem.cpp.

boundingBox() [2/2]

QgsRectangle QgsAnnotationPointTextItem::boundingBox ( QgsRenderContext &  context ) const

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 124 of file qgsannotationpointtextitem.cpp.

clone()

QgsAnnotationPointTextItem * QgsAnnotationPointTextItem::clone ( )

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.

See also

copyCommonProperties()

Implements QgsAnnotationItem.

Definition at line 109 of file qgsannotationpointtextitem.cpp.

create()

QgsAnnotationPointTextItem * QgsAnnotationPointTextItem::create ( )

static

Creates a new text at point annotation item.

Definition at line 83 of file qgsannotationpointtextitem.cpp.

flags()

Qgis::AnnotationItemFlags QgsAnnotationPointTextItem::flags ( ) const

overridevirtual

Returns item flags.

Since

QGIS 3.22

Reimplemented from QgsAnnotationItem.

Definition at line 32 of file qgsannotationpointtextitem.cpp.

format()

QgsTextFormat QgsAnnotationPointTextItem::format

(

)

const

Returns the text format used to render the text.

See also

setFormat()

Definition at line 199 of file qgsannotationpointtextitem.cpp.

nodes()

QList< QgsAnnotationItemNode > QgsAnnotationPointTextItem::nodes ( ) const

overridevirtual

Returns the nodes for the item, used for editing the item.

Since

QGIS 3.22

Reimplemented from QgsAnnotationItem.

Definition at line 140 of file qgsannotationpointtextitem.cpp.

point()

QgsPointXY QgsAnnotationPointTextItem::point ( ) const

inline

Returns the point location of the text.

The coordinate reference system for the point will be the parent layer's QgsAnnotationLayer::crs().

See also

setPoint()

Definition at line 68 of file qgsannotationpointtextitem.h.

readXml()

bool QgsAnnotationPointTextItem::readXml ( const QDomElement &  element, const QgsReadWriteContext &  context  )

overridevirtual

Reads the item's state from the given DOM element.

Implementations should include a call to readCommonProperties() to read the base class properties.

See also

writeXml()

readCommonProperties()

Implements QgsAnnotationItem.

Definition at line 88 of file qgsannotationpointtextitem.cpp.

render()

void QgsAnnotationPointTextItem::render ( QgsRenderContext &  context, QgsFeedback *  feedback  )

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 45 of file qgsannotationpointtextitem.cpp.

setAlignment()

void QgsAnnotationPointTextItem::setAlignment

(

Qt::Alignment

alignment

)

Sets the text's alignment relative to the reference point().

See also

alignment().

Definition at line 214 of file qgsannotationpointtextitem.cpp.

setAngle()

void QgsAnnotationPointTextItem::setAngle ( double  angle )

inline

Sets the text's rotation angle, in degrees clockwise.

See also

angle()

Definition at line 119 of file qgsannotationpointtextitem.h.

setFormat()

void QgsAnnotationPointTextItem::setFormat

(

const QgsTextFormat &

format

)

Sets the text format used to render the text.

See also

format()

Definition at line 204 of file qgsannotationpointtextitem.cpp.

setPoint()

void QgsAnnotationPointTextItem::setPoint ( QgsPointXY  point )

inline

Sets the point location of the text.

The coordinate reference system for the point will be the parent layer's QgsAnnotationLayer::crs().

See also

point()

Definition at line 77 of file qgsannotationpointtextitem.h.

setText()

void QgsAnnotationPointTextItem::setText ( const QString &  text )

inline

Sets the text rendered by the item.

See also

text()

Definition at line 91 of file qgsannotationpointtextitem.h.

text()

QString QgsAnnotationPointTextItem::text ( ) const

inline

Returns the text rendered by the item.

See also

setText()

Definition at line 84 of file qgsannotationpointtextitem.h.

transientEditResults()

QgsAnnotationItemEditOperationTransientResults * QgsAnnotationPointTextItem::transientEditResults ( QgsAbstractAnnotationItemEditOperation *  operation )

overridevirtual

Retrieves the results of a transient (in progress) edit operation on the item.

Since

QGIS 3.22

Reimplemented from QgsAnnotationItem.

Definition at line 176 of file qgsannotationpointtextitem.cpp.

type()

QString QgsAnnotationPointTextItem::type ( ) const

overridevirtual

Returns a unique (untranslated) string identifying the type of item.

Implements QgsAnnotationItem.

Definition at line 40 of file qgsannotationpointtextitem.cpp.

writeXml()

bool QgsAnnotationPointTextItem::writeXml ( QDomElement &  element, QDomDocument &  document, const QgsReadWriteContext &  context  ) const

overridevirtual

Writes the item's state into an XML element.

Implementations should include a call to writeCommonProperties() to store the base class properties.

See also

readXml()

writeCommonProperties()

Implements QgsAnnotationItem.

Definition at line 67 of file qgsannotationpointtextitem.cpp.

---

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

• /build/qgis-3.28.0+99sid/src/core/annotations/qgsannotationpointtextitem.h
• /build/qgis-3.28.0+99sid/src/core/annotations/qgsannotationpointtextitem.cpp