QGIS/python/core/auto_generated/annotations/qgsannotationpolygonitem.sip.in
2020-08-05 16:27:09 +10:00

88 lines
2.8 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationpolygonitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsAnnotationPolygonItem : QgsAnnotationItem
{
%Docstring
An annotation item which renders a fill symbol for a polygon geometry.
.. versionadded:: 3.16
%End
%TypeHeaderCode
#include "qgsannotationpolygonitem.h"
%End
public:
QgsAnnotationPolygonItem( const QgsPolygon &polygon, const QgsCoordinateReferenceSystem &crs );
%Docstring
Constructor for QgsAnnotationPolygonItem, with the specified ``polygon`` in the given ``crs``.
%End
~QgsAnnotationPolygonItem();
virtual QString type() const;
virtual void render( QgsRenderContext &context, QgsFeedback *feedback );
virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
static QgsAnnotationPolygonItem *create() /Factory/;
virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
virtual QgsAnnotationPolygonItem *clone() /Factory/;
QgsPolygon polygon() const;
%Docstring
Returns the polygon geometry of the item.
The coordinate reference system for the polygon can be retrieved through :py:func:`~QgsAnnotationPolygonItem.crs`.
.. seealso:: :py:func:`setPolygon`
%End
void setPolygon( const QgsPolygon &polygon );
%Docstring
Sets the ``polygon`` geometry of the item.
The coordinate reference system for the polygon can be set through :py:func:`~QgsAnnotationPolygonItem.setCrs`.
.. seealso:: :py:func:`polygon`
%End
const QgsFillSymbol *symbol() const;
%Docstring
Returns the symbol used to render the item.
.. seealso:: :py:func:`setSymbol`
%End
void setSymbol( QgsFillSymbol *symbol /Transfer/ );
%Docstring
Sets the ``symbol`` used to render the marker item.
The item takes ownership of the symbol.
.. seealso:: :py:func:`symbol`
%End
private:
QgsAnnotationPolygonItem( const QgsAnnotationPolygonItem &other );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationpolygonitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/