QGIS/python/core/auto_generated/annotations/qgsannotationitemnode.sip.in
2024-08-25 12:34:51 +10:00

109 lines
3.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationitemnode.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py 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();
QgsAnnotationItemNode( const QgsVertexId &id, const QgsPointXY &point, Qgis::AnnotationItemNodeType type, Qt::CursorShape cursor = Qt::CursorShape::ArrowCursor );
%Docstring
Constructor for QgsAnnotationItemNode, with the specified ``id``, ``point`` and ``type``.
%End
SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsAnnotationItemNode: %1 - %2 (%3, %4)>" ).arg( sipCpp->id().vertex )
.arg( qgsEnumValueToKey( sipCpp->type() ) )
.arg( sipCpp->point().x() )
.arg( sipCpp->point().y() );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
QgsVertexId id() const;
%Docstring
Returns the ID number of the node, used for uniquely identifying the node in the item.
%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
Qt::CursorShape cursor() const;
%Docstring
Returns the mouse cursor shape to use when hovering the node.
.. seealso:: :py:func:`setCursor`
.. versionadded:: 3.34
%End
void setCursor( Qt::CursorShape shape );
%Docstring
Sets the mouse cursor ``shape`` to use when hovering the node.
.. seealso:: :py:func:`cursor`
.. versionadded:: 3.34
%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.py again *
************************************************************************/