QGIS API Documentation  3.5.0-Master (bc98f86)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsTextAnnotation Class Reference

An annotation item that displays formatted text from a QTextDocument document. More...

#include <qgstextannotation.h>

Inheritance diagram for QgsTextAnnotation:
Inheritance graph
[legend]

Public Member Functions

 QgsTextAnnotation (QObject *parent=nullptr)
 Constructor for QgsTextAnnotation. More...
 
QgsTextAnnotationclone () const override
 Clones the annotation, returning a new copy of the annotation reflecting the annotation's current state. More...
 
const QTextDocument * document () const
 Returns the text document which will be rendered within the annotation. More...
 
void readXml (const QDomElement &itemElem, const QgsReadWriteContext &context) override
 Restores the annotation's state from a DOM element. More...
 
void setDocument (const QTextDocument *doc)
 Sets the text document which will be rendered within the annotation. More...
 
void writeXml (QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override
 Writes the annotation state to a DOM element. More...
 
- Public Member Functions inherited from QgsAnnotation
 QgsAnnotation (QObject *parent=nullptr)
 Constructor for QgsAnnotation. More...
 
QgsFeature associatedFeature () const
 Returns the feature associated with the annotation, or an invalid feature if none has been set. More...
 
QgsMargins contentsMargin () const
 Returns the margins (in millimeters) between the outside of the frame and the annotation content. More...
 
QgsFillSymbolfillSymbol () const
 Returns the symbol that is used for rendering the annotation frame. More...
 
QPointF frameOffsetFromReferencePoint () const
 Returns the annotation's frame's offset from the mapPosition() reference point. More...
 
QSizeF frameSize () const
 Returns the size of the annotation's frame (the main area in which the annotation's content is drawn). More...
 
bool hasFixedMapPosition () const
 Returns true if the annotation is attached to a fixed map position, or false if the annotation uses a position relative to the current map extent. More...
 
bool isVisible () const
 Returns true if the annotation is visible and should be rendered. More...
 
QgsMapLayermapLayer () const
 Returns the map layer associated with the annotation. More...
 
QgsPointXY mapPosition () const
 Returns the map position of the annotation, if it is attached to a fixed map position. More...
 
QgsCoordinateReferenceSystem mapPositionCrs () const
 Returns the CRS of the map position, or an invalid CRS if the annotation does not have a fixed map position. More...
 
QgsMarkerSymbolmarkerSymbol () const
 Returns the symbol that is drawn at the annotation's map position. More...
 
QPointF relativePosition () const
 Returns the relative position of the annotation, if it is not attached to a fixed map position. More...
 
void render (QgsRenderContext &context) const
 Renders the annotation to a target render context. More...
 
virtual void setAssociatedFeature (const QgsFeature &feature)
 Sets the feature associated with the annotation. More...
 
void setContentsMargin (const QgsMargins &margins)
 Sets the margins (in millimeters) between the outside of the frame and the annotation content. More...
 
void setFillSymbol (QgsFillSymbol *symbol)
 Sets the fill symbol used for rendering the annotation frame. More...
 
void setFrameOffsetFromReferencePoint (QPointF offset)
 Sets the annotation's frame's offset from the mapPosition() reference point. More...
 
void setFrameSize (QSizeF size)
 Sets the size of the annotation's frame (the main area in which the annotation's content is drawn). More...
 
void setHasFixedMapPosition (bool fixed)
 Sets whether the annotation is attached to a fixed map position, or uses a position relative to the current map extent. More...
 
void setMapLayer (QgsMapLayer *layer)
 Sets the map layer associated with the annotation. More...
 
void setMapPosition (const QgsPointXY &position)
 Sets the map position of the annotation, if it is attached to a fixed map position. More...
 
void setMapPositionCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the CRS of the map position. More...
 
void setMarkerSymbol (QgsMarkerSymbol *symbol)
 Sets the symbol that is drawn at the annotation's map position. More...
 
void setRelativePosition (QPointF position)
 Sets the relative position of the annotation, if it is not attached to a fixed map position. More...
 
void setVisible (bool visible)
 Sets whether the annotation is visible and should be rendered. More...
 

Static Public Member Functions

static QgsTextAnnotationcreate ()
 Returns a new QgsTextAnnotation object. More...
 

Protected Member Functions

void renderAnnotation (QgsRenderContext &context, QSizeF size) const override
 Renders the annotation's contents to a target /a context at the specified /a size. More...
 
- Protected Member Functions inherited from QgsAnnotation
void _readXml (const QDomElement &annotationElem, const QgsReadWriteContext &context)
 Reads common annotation properties from a DOM element. More...
 
void _writeXml (QDomElement &itemElem, QDomDocument &doc, const QgsReadWriteContext &context) const
 Writes common annotation properties to a DOM element. More...
 
void copyCommonProperties (QgsAnnotation *target) const
 Copies common annotation properties to the targe annotation. More...
 
virtual QSizeF minimumFrameSize () const
 Returns the minimum frame size for the annotation. More...
 

Additional Inherited Members

- Signals inherited from QgsAnnotation
void appearanceChanged ()
 Emitted whenever the annotation's appearance changes. More...
 
void mapLayerChanged ()
 Emitted when the map layer associated with the annotation changes. More...
 
void moved ()
 Emitted when the annotation's position has changed and items need to be moved to reflect this. More...
 
- Properties inherited from QgsAnnotation
QSizeF frameSize
 
bool hasFixedMapPosition
 
QgsPointXY mapPosition
 
bool visible
 

Detailed Description

An annotation item that displays formatted text from a QTextDocument document.

Since
QGIS 3.0

Definition at line 31 of file qgstextannotation.h.

Constructor & Destructor Documentation

◆ QgsTextAnnotation()

QgsTextAnnotation::QgsTextAnnotation ( QObject *  parent = nullptr)

Constructor for QgsTextAnnotation.

Definition at line 22 of file qgstextannotation.cpp.

Member Function Documentation

◆ clone()

QgsTextAnnotation * QgsTextAnnotation::clone ( ) const
overridevirtual

Clones the annotation, returning a new copy of the annotation reflecting the annotation's current state.

Implements QgsAnnotation.

Definition at line 29 of file qgstextannotation.cpp.

◆ create()

static QgsTextAnnotation* QgsTextAnnotation::create ( )
inlinestatic

Returns a new QgsTextAnnotation object.

Definition at line 64 of file qgstextannotation.h.

◆ document()

const QTextDocument * QgsTextAnnotation::document ( ) const

Returns the text document which will be rendered within the annotation.

See also
setDocument()

Definition at line 37 of file qgstextannotation.cpp.

◆ readXml()

void QgsTextAnnotation::readXml ( const QDomElement &  itemElem,
const QgsReadWriteContext context 
)
overridevirtual

Restores the annotation's state from a DOM element.

Derived classes should call _readXml() within their implementation of this method.

See also
writeXml()
_readXml()

Implements QgsAnnotation.

Definition at line 84 of file qgstextannotation.cpp.

◆ renderAnnotation()

void QgsTextAnnotation::renderAnnotation ( QgsRenderContext context,
QSizeF  size 
) const
overrideprotectedvirtual

Renders the annotation's contents to a target /a context at the specified /a size.

Derived classes should implement their custom annotation drawing logic here.

Implements QgsAnnotation.

Definition at line 51 of file qgstextannotation.cpp.

◆ setDocument()

void QgsTextAnnotation::setDocument ( const QTextDocument *  doc)

Sets the text document which will be rendered within the annotation.

Ownership is not transferred.

See also
document()

Definition at line 42 of file qgstextannotation.cpp.

◆ writeXml()

void QgsTextAnnotation::writeXml ( QDomElement &  elem,
QDomDocument &  doc,
const QgsReadWriteContext context 
) const
overridevirtual

Writes the annotation state to a DOM element.

Derived classes should call _writeXml() within their implementation of this method.

See also
readXml()
_writeXml()

Implements QgsAnnotation.

Definition at line 73 of file qgstextannotation.cpp.


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