QGIS/python/core/auto_generated/annotations/qgsannotationitem.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/annotations/qgsannotationitem.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/





class QgsAnnotationItem
{
%Docstring
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.

.. versionadded:: 3.16
%End

%TypeHeaderCode
#include "qgsannotationitem.h"
%End
  public:

    QgsAnnotationItem( const QgsCoordinateReferenceSystem &crs );
%Docstring
Constructor for an annotation item, with the specified ``crs`` for storing
its geographic location.
%End


    virtual ~QgsAnnotationItem();

    virtual QgsAnnotationItem *clone() = 0 /Factory/;
%Docstring
Returns a clone of the item. Ownership is transferred to the caller.
%End

    virtual QString type() const = 0;
%Docstring
Returns a unique (untranslated) string identifying the type of item.
%End

    QgsCoordinateReferenceSystem crs() const;
%Docstring
Returns the CRS used for storing the location of the item.

.. seealso:: :py:func:`setCrs`
%End

    void setCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the ``crs`` used for storing the location of the item.

.. seealso:: :py:func:`crs`
%End

    virtual void render( QgsRenderContext &context, QgsFeedback *feedback ) = 0;
%Docstring
Renders the item to the specified render ``context``.

The ``feedback`` argument can be used to detect render cancelations during expensive
render operations.
%End

    virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const = 0;
%Docstring
Writes the item's state the an XML ``element``.
%End

    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;
%Docstring
Reads the item's state from the given DOM ``element``.
%End

    int zIndex() const;
%Docstring
Returns the item's z index, which controls the order in which annotation items
are rendered in the layer.
%End

  private:
    QgsAnnotationItem( const QgsAnnotationItem &other );
};

class QgsMarkerItem : QgsAnnotationItem
{

%TypeHeaderCode
#include "qgsannotationitem.h"
%End
  public:

    QgsMarkerItem( QgsPointXY point, const QgsCoordinateReferenceSystem &crs );
    ~QgsMarkerItem();

    virtual QString type() const;

    virtual void render( QgsRenderContext &context, QgsFeedback *feedback );

    virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;

    static QgsMarkerItem *create() /Factory/;
    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );


    virtual QgsMarkerItem *clone() /Factory/;


    const QgsMarkerSymbol *symbol() const;
    void setSymbol( QgsMarkerSymbol *symbol /Transfer/ );

  private:
    QgsMarkerItem( const QgsMarkerItem &other );
};


class QgsLineStringItem : QgsAnnotationItem
{

%TypeHeaderCode
#include "qgsannotationitem.h"
%End
  public:

    QgsLineStringItem( const QgsLineString &linestring, const QgsCoordinateReferenceSystem &crs );
    ~QgsLineStringItem();

    virtual QString type() const;

    virtual void render( QgsRenderContext &context, QgsFeedback *feedback );

    virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;

    static QgsLineStringItem *create() /Factory/;
    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );


    virtual QgsLineStringItem *clone() /Factory/;


    const QgsLineSymbol *symbol() const;
    void setSymbol( QgsLineSymbol *symbol /Transfer/ );

  private:
    QgsLineStringItem( const QgsLineStringItem &other );
};


class QgsPolygonItem : QgsAnnotationItem
{

%TypeHeaderCode
#include "qgsannotationitem.h"
%End
  public:

    QgsPolygonItem( const QgsPolygon &polygon, const QgsCoordinateReferenceSystem &crs );
    ~QgsPolygonItem();

    virtual QString type() const;

    virtual void render( QgsRenderContext &context, QgsFeedback *feedback );

    virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;

    static QgsPolygonItem *create() /Factory/;
    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );


    virtual QgsPolygonItem *clone() /Factory/;


    const QgsFillSymbol *symbol() const;
    void setSymbol( QgsFillSymbol *symbol /Transfer/ );

  private:
    QgsPolygonItem( const QgsPolygonItem &other );
};
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/annotations/qgsannotationitem.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/