File: qgsannotationitemnode.sip.in

package info (click to toggle)
qgis 3.40.6%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,181,336 kB
  • sloc: cpp: 1,593,302; python: 370,494; xml: 23,474; perl: 3,664; sh: 3,482; ansic: 2,257; sql: 2,133; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 157
file content (110 lines) | stat: -rw-r--r-- 3,201 bytes parent folder | download | duplicates (18)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/************************************************************************
 * 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   *
 ************************************************************************/