File: qgsmaptooledit.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (126 lines) | stat: -rw-r--r-- 4,218 bytes parent folder | download | duplicates (7)
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/maptools/qgsmaptooledit.h                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsMapToolEdit : QgsMapTool
{
%Docstring(signature="appended")
Base class for map tools that edit vector geometry
%End

%TypeHeaderCode
#include "qgsmaptooledit.h"
%End
  public:
    QgsMapToolEdit( QgsMapCanvas *canvas );

    virtual Flags flags() const;

    static double defaultZValue();
%Docstring
Returns default Z value. Used for setting Z coordinate to new vertex.
%End

    static double defaultMValue();
%Docstring
Returns default M value. Used for setting M coordinate to new vertex.

.. versionadded:: 3.20
%End

    QgsGeometryRubberBand *createGeometryRubberBand( Qgis::GeometryType geometryType = Qgis::GeometryType::Line, bool alternativeBand = false ) const /Factory/;
%Docstring
Creates a geometry rubber band with the color/line width from the QGIS
settings. The caller takes ownership of the returned object

:param geometryType: 
:param alternativeBand: if ``True``, rubber band will be set with more
                        transparency and a dash pattern. default is
                        ``False``.
%End

  protected:
    static QColor digitizingStrokeColor();
%Docstring
Returns stroke color for rubber bands (from global settings)
%End
    static int digitizingStrokeWidth();
%Docstring
Returns stroke width for rubber bands (from global settings)
%End
    static QColor digitizingFillColor();
%Docstring
Returns fill color for rubber bands (from global settings)
%End

    QgsRubberBand *createRubberBand( Qgis::GeometryType geometryType = Qgis::GeometryType::Line, bool alternativeBand = false ) /Factory/;
%Docstring
Creates a rubber band with the color/line width from the QGIS settings.
The caller takes ownership of the returned object

:param geometryType: 
:param alternativeBand: if ``True``, rubber band will be set with more
                        transparency and a dash pattern. default is
                        ``False``.
%End

    QgsVectorLayer *currentVectorLayer();
%Docstring
Returns the current vector layer of the map canvas or 0
%End

    enum TopologicalResult /BaseType=IntEnum/
    {
      Success,
      InvalidCanvas,
      InvalidLayer,
    };

 TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &vertices ) /Deprecated/;
%Docstring
Adds a list of ``vertices`` to other features to keep topology up to
date, e.g. to neighbouring polygons. The ``vertices`` list specifies a
set of topological points to add, in the layer's coordinate reference
system.

.. deprecated:: 3.12

   Will be removed in QGIS 4.0. Use the variant which accepts :py:class:`QgsPoint` objects instead of :py:class:`QgsPointXY`.
%End

    TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &vertices );
%Docstring
Adds a list of ``vertices`` to other features to keep topology up to
date, e.g. to neighbouring polygons. The ``vertices`` list specifies a
set of topological points to add, in the layer's coordinate reference
system.

.. versionadded:: 3.10
%End

    void notifyNotVectorLayer();
%Docstring
Display a timed message bar noting the active layer is not vector.
%End
    void notifyNotEditableLayer();
%Docstring
Display a timed message bar noting the active vector layer is not
editable.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/maptools/qgsmaptooledit.h                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/