QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsSvgAnnotation Class Reference

An annotation which renders the contents of an SVG file. More...

#include <qgssvgannotation.h>

Inheritance diagram for QgsSvgAnnotation:
Inheritance graph
[legend]

Public Member Functions

 QgsSvgAnnotation (QObject *parent=nullptr)
 Constructor for QgsSvgAnnotation. More...
 
QgsSvgAnnotationclone () const override
 Clones the annotation, returning a new copy of the annotation reflecting the annotation's current state. More...
 
QString filePath () const
 Returns the file path for the source SVG file. More...
 
void readXml (const QDomElement &itemElem, const QgsReadWriteContext &context) override
 Restores the annotation's state from a DOM element. More...
 
void setFilePath (const QString &file)
 Sets the file path for the source SVG file. 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...
 
 ~QgsAnnotation () override
 
virtual bool accept (QgsStyleEntityVisitorInterface *visitor) const
 Accepts the specified style entity visitor, causing it to visit all style entities associated within the annotation. More...
 
QgsFeature associatedFeature () const
 Returns the feature associated with the annotation, or an invalid feature if none has been set. More...
 
virtual QgsAnnotationclone () const =0
 Clones the annotation, returning a new copy of the annotation reflecting the annotation's current state. 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...
 
Q_DECL_DEPRECATED QPointF frameOffsetFromReferencePoint () const
 Returns the annotation's frame's offset (in pixels) from the mapPosition() reference point. More...
 
QPointF frameOffsetFromReferencePointMm () const
 Returns the annotation's frame's offset (in millimeters) from the mapPosition() reference point. More...
 
Q_DECL_DEPRECATED QSizeF frameSize () const
 Returns the size (in pixels) of the annotation's frame (the main area in which the annotation's content is drawn). More...
 
QSizeF frameSizeMm () const
 Returns the size (in millimeters) 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...
 
virtual void readXml (const QDomElement &itemElem, const QgsReadWriteContext &context)=0
 Restores the annotation's state from a DOM element. 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...
 
Q_DECL_DEPRECATED void setFrameOffsetFromReferencePoint (QPointF offset)
 Sets the annotation's frame's offset (in pixels) from the mapPosition() reference point. More...
 
void setFrameOffsetFromReferencePointMm (QPointF offset)
 Sets the annotation's frame's offset (in millimeters) from the mapPosition() reference point. More...
 
Q_DECL_DEPRECATED void setFrameSize (QSizeF size)
 Sets the size (in pixels) of the annotation's frame (the main area in which the annotation's content is drawn). More...
 
void setFrameSizeMm (QSizeF size)
 Sets the size (in millimeters) 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...
 
virtual void writeXml (QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const =0
 Writes the annotation state to a DOM element. More...
 

Static Public Member Functions

static QgsSvgAnnotationcreate ()
 Returns a new QgsSvgAnnotation 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...
 
virtual void renderAnnotation (QgsRenderContext &context, QSizeF size) const =0
 Renders the annotation's contents to a target /a context at the specified /a size. 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 which renders the contents of an SVG file.

Definition at line 30 of file qgssvgannotation.h.

Constructor & Destructor Documentation

◆ QgsSvgAnnotation()

QgsSvgAnnotation::QgsSvgAnnotation ( QObject *  parent = nullptr)

Constructor for QgsSvgAnnotation.

Definition at line 28 of file qgssvgannotation.cpp.

Member Function Documentation

◆ clone()

QgsSvgAnnotation * QgsSvgAnnotation::clone ( ) const
overridevirtual

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

Implements QgsAnnotation.

Definition at line 34 of file qgssvgannotation.cpp.

◆ create()

static QgsSvgAnnotation * QgsSvgAnnotation::create ( )
inlinestatic

Returns a new QgsSvgAnnotation object.

Definition at line 61 of file qgssvgannotation.h.

◆ filePath()

QString QgsSvgAnnotation::filePath ( ) const
inline

Returns the file path for the source SVG file.

See also
setFilePath()

Definition at line 56 of file qgssvgannotation.h.

◆ readXml()

void QgsSvgAnnotation::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 51 of file qgssvgannotation.cpp.

◆ renderAnnotation()

void QgsSvgAnnotation::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 62 of file qgssvgannotation.cpp.

◆ setFilePath()

void QgsSvgAnnotation::setFilePath ( const QString &  file)

Sets the file path for the source SVG file.

See also
filePath()

Definition at line 94 of file qgssvgannotation.cpp.

◆ writeXml()

void QgsSvgAnnotation::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 42 of file qgssvgannotation.cpp.


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