QGIS/python/core/auto_generated/annotations/qgsannotationitemnode.sip.in
Nyall Dawson 4ff1e55a21 [api] Add method to retrieve the nodes for an annotation item
For now all nodes just directly represent vertices in the item,
but the intention here is that they can represent any form of handle
which can be used to manipulate an item (e.g. a bezier curve point,
some "smart shape" handle for resizing or rotating an item, etc)
2021-09-03 08:06:48 +10:00

88 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationitemnode.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsAnnotationItemNode
{
%Docstring(signature="appended")
Contains information about a node used for editing an annotation item.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsannotationitemnode.h"
%End
public:
QgsAnnotationItemNode();
%Docstring
Default constructor
%End
QgsAnnotationItemNode( const QgsPointXY &point, Qgis::AnnotationItemNodeType type );
%Docstring
Constructor for QgsAnnotationItemNode, with the specified ``point`` and ``type``.
%End
SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsAnnotationItemNode: %1 (%2, %3)>" ).arg( qgsEnumValueToKey( sipCpp->type() ) )
.arg( sipCpp->point().x() )
.arg( sipCpp->point().y() );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
QgsPointXY point() const;
%Docstring
Returns the node's position, in geographic coordinates.
The coordinates will match the annotation item's CRS.
.. seealso:: :py:func:`setPoint`
%End
void setPoint( QgsPointXY point );
%Docstring
Sets the node's position, in geographic coordinates.
The coordinates will match the annotation item's CRS.
.. seealso:: :py:func:`point`
%End
Qgis::AnnotationItemNodeType type() const;
%Docstring
Returns the node type.
.. seealso:: :py:func:`setType`
%End
void setType( Qgis::AnnotationItemNodeType type );
%Docstring
Sets the node type.
.. seealso:: :py:func:`type`
%End
bool operator==( const QgsAnnotationItemNode &other ) const;
bool operator!=( const QgsAnnotationItemNode &other ) const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationitemnode.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/