QGIS/python/core/auto_generated/annotations/qgsannotationitemeditoperation.sip.in
Nyall Dawson 1537d393e3 Add framework for retrieving the temporary results of a in-progress
edit operation on an annotation item

This is used for the item to return a representative geometry
of what the item would look like if the operation were to be
applied. It's used to generate a rubber band showing a preview
of the modification during interactive editing operations on
an annotation item.
2021-09-10 15:01:26 +10:00

120 lines
3.5 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationitemeditoperation.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsAbstractAnnotationItemEditOperation
{
%Docstring(signature="appended")
Abstract base class for annotation item edit operations
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsannotationitemeditoperation.h"
%End
public:
QgsAbstractAnnotationItemEditOperation( const QString &itemId );
%Docstring
Constructor for QgsAbstractAnnotationItemEditOperation, for the specified item id.
%End
virtual ~QgsAbstractAnnotationItemEditOperation();
QString itemId() const;
%Docstring
Returns the associated item ID.
%End
protected:
};
class QgsAnnotationItemEditOperationMoveNode : QgsAbstractAnnotationItemEditOperation
{
%Docstring(signature="appended")
Annotation item edit operation consisting of moving a node
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsannotationitemeditoperation.h"
%End
public:
QgsAnnotationItemEditOperationMoveNode( const QString &itemId, QgsVertexId nodeId, const QgsPointXY &before, const QgsPointXY &after );
%Docstring
Constructor for QgsAnnotationItemEditOperationMoveNode, where the node with the specified ``id`` moves
from ``before`` to ``after`` (in layer coordinates).
%End
QgsVertexId nodeId() const;
%Docstring
Returns the associated node ID.
%End
QgsPointXY before() const;
%Docstring
Returns the node position before the move occurred (in layer coordinates).
.. seealso:: :py:func:`after`
%End
QgsPointXY after() const;
%Docstring
Returns the node position after the move occurred (in layer coordinates).
.. seealso:: :py:func:`before`
%End
};
class QgsAnnotationItemEditOperationTransientResults
{
%Docstring(signature="appended")
Encapsulates the transient results of an in-progress annotation edit operation.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsannotationitemeditoperation.h"
%End
public:
QgsAnnotationItemEditOperationTransientResults( const QgsGeometry &representativeGeometry );
%Docstring
Constructor for QgsAnnotationItemEditOperationTransientResults.
The ``representativeGeometry`` parameter specifies a geometry (in layer CRS) which represents
the shape of the item if the operation were to be applied. It is used for creating a graphical
representation of the operation during interactive edits.
%End
QgsGeometry representativeGeometry() const;
%Docstring
Returns the geometry (in layer CRS) which represents the shape of the item if the operation were to be applied.
This is used for creating a graphical representation of the operation during interactive edits.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationitemeditoperation.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/